文档

ListDataServiceApis - 获取数据服务API开发中的信息列表

更新时间:

调用ListDataServiceApis获取数据服务API开发中的信息列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

页码,从 1 开始,默认值为 1。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
ProjectIdlong

工作空间的 ID。

10000
TenantIdlong

租户 ID。您可登录 DataWorks 控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户 ID。

10001
ApiNameKeywordstring

API 名称的关键词,过滤得到 API 名称包含该关键词的 API。

我的API名称
ApiPathKeywordstring

API 路径的关键词,过滤得到 API 路径包含该关键词的 API。

/test/
CreatorIdstring

API 创建者的阿里云 ID,过滤得到该用户创建的 API。

12345

返回参数

名称类型描述示例值
object

返回对象

HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID,一次请求的唯一标识。

0000-ABCD-EFG****
ErrorMessagestring

错误信息。

The connection does not exist.
Successboolean

调用是否成功。

true
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Dataobject

返回开发中 API 的信息。

PageNumberinteger

页码,和请求中的 PageNumber 一致。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TotalCountinteger

总记录数。

100
Apisarray<object>

API 开发态信息列表。

object

返回对象

Timeoutinteger

超时时间,单位为毫秒(ms)。

10000
Statusinteger

API 的状态,可选枚举值包括 0(未发布)和 1(已发布)。

0
ApiIdlong

API 的 ID。

10002
ApiModeinteger

API 的类型,可选枚举值包括 0(向导 API)、1(脚本 API)和 2(注册 API)。

0
ProjectIdlong

工作空间的 ID。

10000
ResponseContentTypeinteger

API 的返回数据类型,可选枚举值包括 0(JSON)和 1(XML)。向导和脚本 API 支持 JSON,注册 API 支持 JSON 和 XML。

0
CreatorIdstring

创建人的阿里云 ID。

1234567
VisibleRangeinteger

可见范围,可选枚举值包括 0(工作空间)和 1(私有)。

0
ModifiedTimestring

最新修改时间。

2020-06-23T00:21:01+0800
OperatorIdstring

最新编辑人的阿里云 ID。

2345678
GroupIdstring

分组 ID。

abcde123456789
Descriptionstring

API 的描述信息。

测试API描述
FolderIdlong

文件夹 ID。

0
RequestMethodinteger

API 的请求方式,可选枚举值包括 0(GET)、1(POST)、2(PUT)和 3(DELTE)。向导和脚本 API 支持 GET 和 POST。注册 API 支持 GET、POST、PUT 和 DELETE。

0
CreatedTimestring

创建时间。

2020-06-23T00:21:01+0800
ApiNamestring

API 的名称。

我的API名称
TenantIdlong

租户 ID。

10000
ApiPathstring

API 的路径。

/test/1
Protocolsarray

字段列表

integer

API 的协议,多值列表,可选枚举值包括 0(HTTP)和 1(HTTPS)。

0
RegistrationDetailsobject

注册 API 的详情,只有注册 API 返回。

ServiceHoststring

后端服务地址。

http://example.aliyundoc.com
ServiceContentTypeinteger

API 的返回数据类型,可选枚举值包括 0(JSON)和 1(XML)。向导和脚本 API 支持 JSON,注册 API 支持 JSON 和 XML。

0
ServicePathstring

后端服务路径。

/index
SuccessfulResultSamplestring

正常返回示例。

{"success": true}
FailedResultSamplestring

错误返回示例。

{"success": false}
ServiceRequestBodyDescriptionstring

后端请求 body 内容的描述信息。

{"abc":1}
RegistrationErrorCodesarray<object>

注册 API 的错误码列表。

object

返回对象

ErrorMessagestring

错误信息。

fail to call
ErrorCodestring

错误码。

1001
ErrorSolutionstring

错误解决方案。

retry
RegistrationRequestParametersarray<object>

注册 API 的请求参数列表。

object

返回对象

ColumnNamestring

绑定的表字段名称,仅向导模式支持。

column1
ParameterNamestring

参数的名称。

name1
ParameterPositioninteger

参数的位置,可选枚举值包括 0(Path)、1(Query)、2(Head)和 3(Body)。向导和脚本 API 仅支持 Query。注册 API 中的 GET、DELETE 方法支持 Query、Head,PUT、POST 方法支持 Query、Head 和 Body。

0
ParameterDescriptionstring

描述的信息。

description1
DefaultValuestring

默认值。

default1
ParameterOperatorinteger

运算符,可选枚举值包括 0(Equal)、1(Like)、2(Const)和 3(In)。向导模式 API 支持 Equal、Like 和 In,脚本模式 API 支持 Equal,注册 API 支持 Equal 和 Const。

0
ParameterDataTypeinteger

数据类型,可选枚举值:

  • 0:String
  • 1:Int
  • 2:Long
  • 3:Float
  • 4:Double
  • 5:Boolean
  • 6:StringList
  • 7:IntList
  • 8:LongList
  • 9:FloatList
  • 10:DoubleList
  • 11:BooleanList
0
ExampleValuestring

示例值。

example1
IsRequiredParameterboolean

是否必填。

true
ScriptDetailsobject

脚本 API 的详情,只有脚本 API 返回。

Scriptstring

SQL 脚本。

select a from t
IsPagedResponseboolean

返回是否分页。

true
ScriptRequestParametersarray<object>

脚本 API 的请求参数列表。

object

返回对象

ColumnNamestring

绑定的表字段名称,仅向导模式支持。

column1
ParameterNamestring

参数名称

param1
ParameterPositioninteger

参数位置,可选枚举值有:

  • 0:Path
  • 1:Query
  • 2:Head
  • 3:Body

向导和脚本 API,只支持 Query;注册 API,GET、DELETE 方法支持 Query、Head,PUT、POST 方法支持 Query、Head、Body。

0
ParameterDescriptionstring

描述

description1
DefaultValuestring

默认值

default1
ParameterOperatorinteger

运算符,可选枚举值有:

  • 0:Equal
  • 1:Like
  • 2:Const
  • 3:In

向导 API 支持 Equal、Like、In;脚本 API 支持 Equal;注册 API 支持 Equal、Const。

0
ParameterDataTypeinteger

数据类型,可选枚举值:

  • 0:String
  • 1:Int
  • 2:Long
  • 3:Float
  • 4:Double
  • 5:Boolean
  • 6:StringList
  • 7:IntList
  • 8:LongList
  • 9:FloatList
  • 10:DoubleList
  • 11:BooleanList
0
ExampleValuestring

示例值

example1
IsRequiredParameterboolean

是否必填

true
ScriptResponseParametersarray<object>

脚本 API 的返回参数列表。

object

返回对象

ParameterDescriptionstring

描述

description2
ColumnNamestring

绑定的表字段名称,仅向导模式有

column2
ParameterNamestring

参数名称

param2
ParameterDataTypeinteger

数据类型,可选枚举值:

  • 0:String
  • 1:Int
  • 2:Long
  • 3:Float
  • 4:Double
  • 5:Boolean
  • 6:StringList
  • 7:IntList
  • 8:LongList
  • 9:FloatList
  • 10:DoubleList
  • 11:BooleanList
0
ExampleValuestring

示例值

example2
ScriptConnectionobject

脚本 API 的数据源信息。

TableNamestring

数据源表的名称。

t
ConnectionIdlong

数据源 ID。

123
WizardDetailsobject

向导 API 的详情,只有向导 API 返回。

IsPagedResponseboolean

返回是否分页。

true
WizardRequestParametersarray<object>

向导 API 的请求参数列表。

object

返回对象

ColumnNamestring

绑定的表字段名称,仅向导模式支持。

column1
ParameterNamestring

参数名称。

param1
ParameterPositioninteger

参数的位置,可选枚举值包括 0(Path)、1(Query)、2(Head)和 3(Body)。向导和脚本 API 仅支持 Query。注册 API 中的 GET、DELETE 方法支持 Query、Head,PUT、POST 方法支持 Query、Head 和 Body。

0
ParameterDescriptionstring

描述信息。

description1
DefaultValuestring

默认值。

default1
ParameterOperatorinteger

运算符,可选枚举值包括 0(Equal)、1(Like)、2(Const)和 3(In)。向导 API 支持 Equal、Like 和 In,脚本 API 支持 Equal,注册 API 支持 Equal 和 Const。

0
ParameterDataTypeinteger

数据类型,可选枚举值:

  • 0:String
  • 1:Int
  • 2:Long
  • 3:Float
  • 4:Double
  • 5:Boolean
  • 6:StringList
  • 7:IntList
  • 8:LongList
  • 9:FloatList
  • 10:DoubleList
  • 11:BooleanList
0
ExampleValuestring

示例值。

example1
IsRequiredParameterboolean

是否必填。

true
WizardResponseParametersarray<object>

向导模式的返回参数列表。

object

返回对象

ParameterDescriptionstring

描述信息。

description2
ColumnNamestring

绑定的表字段名称,仅向导模式支持。

column2
ParameterNamestring

参数的名称。

param2
ParameterDataTypeinteger

数据类型,可选枚举值:

  • 0:String
  • 1:Int
  • 2:Long
  • 3:Float
  • 4:Double
  • 5:Boolean
  • 6:StringList
  • 7:IntList
  • 8:LongList
  • 9:FloatList
  • 10:DoubleList
  • 11:BooleanList
0
ExampleValuestring

示例值。

example2
WizardConnectionobject

向导 API 的数据源信息。

TableNamestring

数据源表的名称。

t
ConnectionIdlong

数据源 ID。

123

不同类型 API 的详情信息通过不同字段返回。向导 API 使用 WizardDetails 字段,脚本 API 使用 ScriptDetails 字段,注册 API 使用 RegistrationDetails 字段。

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Apis": [
      {
        "Timeout": 10000,
        "Status": 0,
        "ApiId": 10002,
        "ApiMode": 0,
        "ProjectId": 10000,
        "ResponseContentType": 0,
        "CreatorId": "1234567",
        "VisibleRange": 0,
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "OperatorId": "2345678",
        "GroupId": "abcde123456789",
        "Description": "测试API描述",
        "FolderId": 0,
        "RequestMethod": 0,
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "我的API名称",
        "TenantId": 10000,
        "ApiPath": "/test/1",
        "Protocols": [
          0
        ],
        "RegistrationDetails": {
          "ServiceHost": "http://example.aliyundoc.com",
          "ServiceContentType": 0,
          "ServicePath": "/index",
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "ServiceRequestBodyDescription": "{\"abc\":1}",
          "RegistrationErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "RegistrationRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "name1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ]
        },
        "ScriptDetails": {
          "Script": "select a from t",
          "IsPagedResponse": true,
          "ScriptRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ],
          "ScriptResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ColumnName": "column2",
              "ParameterName": "param2",
              "ParameterDataType": 0,
              "ExampleValue": "example2"
            }
          ],
          "ScriptConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        },
        "WizardDetails": {
          "IsPagedResponse": true,
          "WizardRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ],
          "WizardResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ColumnName": "column2",
              "ParameterName": "param2",
              "ParameterDataType": 0,
              "ExampleValue": "example2"
            }
          ],
          "WizardConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-09OpenAPI 错误码发生变更查看变更详情