文档

ListDataServiceAuthorizedApis

更新时间:

调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListDataServiceAuthorizedApis

系统规定参数。取值:ListDataServiceAuthorizedApis

ProjectId Long 10000

工作空间的ID。

PageNumber Integer PageNumber

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

PageSize Integer 10

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

TenantId Long 10001

该字段已废弃。租户ID。

ApiNameKeyword String 我的API名称

API名称的关键词,通过过滤获取API名称包含该关键词的API。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

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

ErrorMessage String The specified parameters are invalid.

错误信息

Success Boolean true

调用是否成功。

ErrorCode String 1031203110005

错误码。

Data Object

获得授权的API信息。

PageNumber Integer 1

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

PageSize Integer 10

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

TotalCount Integer 100

总记录数。

ApiAuthorizedList Array of ApiAuthorized

获得授权的API列表。

ApiId Long 10002

API的ID。

ApiStatus Integer 0

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

GrantOperatorId String 23456

授权者的阿里云ID。

ProjectId Long 10000

工作空间的ID。

CreatorId String 12345

API负责人阿里云ID

GrantEndTime String 2020-06-24T00:21:01+0800

API的授权到期时间。

ModifiedTime String 2020-06-23T00:21:01+0800

API的最近更新时间。

GroupId String abcde123456789

分组ID。

GrantCreatedTime String 2020-06-23T00:21:01+0800

API的授权时间。

CreatedTime String 2020-06-23T00:21:01+0800

API的创建时间。

ApiName String 我的API名称

API的名称。

TenantId Long 10001

租户ID。

ApiPath String /test/1

API的路径。

示例

请求示例

POST /?Action=ListDataServiceAuthorizedApis&公共请求参数 HTTP/1.1

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDataServiceAuthorizedApisResponse>
    <Data>
        <ApiAuthorizedList/>
    </Data>
</ListDataServiceAuthorizedApisResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "ApiAuthorizedList" : [ { } ]
  }
}

错误码

HttpCode

错误码

错误信息

描述

429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。

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

  • 本页导读 (1)
文档反馈