文档

ListDataServicePublishedApis - 获取数据服务API的发布态信息列表

更新时间:

调用ListDataServicePublishedApis获取数据服务API的发布态信息列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Read
  • 全部资源
    *

请求参数

名称类型必填描述示例值
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
Apisobject []

API 发布态信息列表。

Timeoutinteger

超时时间,单位毫秒 ms

10000
Statusinteger

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

1
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。

ab123
Descriptionstring

描述信息。

测试API描述
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。

10001
ApiPathstring

API 的路径。

/test/1
Protocolsarray

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

integer

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

0
RegistrationDetailsobject

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

ServiceHoststring

后端服务地址。

http://www.abc.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}
RegistrationErrorCodesobject []

注册 API 的错误码列表。

ErrorMessagestring

错误信息

fail to call
ErrorCodestring

错误码

1001
ErrorSolutionstring

错误解决方案

retry
RegistrationRequestParametersobject []

注册 API 的请求参数列表。

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
ExampleValuestring

示例值

example1
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
IsRequiredParameterboolean

是否必填

true
ScriptDetailsobject

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

IsPagedResponseboolean

返回是否分页

true
SuccessfulResultSamplestring

正常返回示例

{"success": true}
FailedResultSamplestring

错误返回示例

{"success": false}
Scriptstring

SQL 脚本

select a from t
ScriptErrorCodesobject []

脚本 API 错误码列表

ErrorMessagestring

错误信息

fail to call
ErrorCodestring

错误码

1001
ErrorSolutionstring

错误解决方案

retry
ScriptRequestParametersobject []

脚本 API 请求参数列表

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
ExampleValuestring

示例值

example1
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
IsRequiredParameterboolean

是否必填

true
ScriptResponseParametersobject []

脚本 API 返回参数列表

ParameterDescriptionstring

描述

description2
ParameterNamestring

参数名称

param2
ExampleValuestring

示例值

example2
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
ScriptConnectionobject

脚本 API 数据源信息

TableNamestring

数据源表名

t
ConnectionIdlong

数据源 ID

123
WizardDetailsobject

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

IsPagedResponseboolean

返回是否分页。

true
SuccessfulResultSamplestring

正常返回示例。

{"success": true}
FailedResultSamplestring

错误返回示例。

{"success": false}
WizardErrorCodesobject []

向导 API 的错误码列表。

ErrorMessagestring

错误信息。

fail to call
ErrorCodestring

错误码。

1001
ErrorSolutionstring

错误解决方案。

retry
WizardRequestParametersobject []

向导 API 的请求参数列表。

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
ExampleValuestring

示例值。

example1
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
IsRequiredParameterboolean

是否必填。

true
WizardResponseParametersobject []

向导 API 的返回参数列表。

ParameterDescriptionstring

描述信息。

description2
ParameterNamestring

参数的名称。

param2
ExampleValuestring

示例值。

example2
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
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": 1,
        "ApiId": 10002,
        "ApiMode": 0,
        "ProjectId": 10000,
        "ResponseContentType": 0,
        "CreatorId": "1234567",
        "VisibleRange": 0,
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "OperatorId": "2345678",
        "GroupId": "ab123",
        "Description": "测试API描述",
        "RequestMethod": 0,
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "我的API名称",
        "TenantId": 10001,
        "ApiPath": "/test/1",
        "Protocols": [
          0
        ],
        "RegistrationDetails": {
          "ServiceHost": "http://www.abc.com",
          "ServiceContentType": 0,
          "ServicePath": "/index",
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "ServiceRequestBodyDescription": "{\"abc\":1}",
          "RegistrationErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "RegistrationRequestParameters": [
            {
              "ParameterName": "name1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ExampleValue": "example1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ]
        },
        "ScriptDetails": {
          "IsPagedResponse": true,
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "Script": "select a from t",
          "ScriptErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "ScriptRequestParameters": [
            {
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ExampleValue": "example1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ],
          "ScriptResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ParameterName": "param2",
              "ExampleValue": "example2",
              "ParameterDataType": 0
            }
          ],
          "ScriptConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        },
        "WizardDetails": {
          "IsPagedResponse": true,
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "WizardErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "WizardRequestParameters": [
            {
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ExampleValue": "example1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ],
          "WizardResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ParameterName": "param2",
              "ExampleValue": "example2",
              "ParameterDataType": 0
            }
          ],
          "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 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
  • 本页导读 (1)