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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListDataServiceAuthorizedApis

要执行的操作。
PageNumber Integer 是 1

页码，从1开始，默认值为1。
PageSize Integer 是 10

每页显示的条数，默认为10条，最大100条。
ProjectId Long 是 10000

工作空间的ID。
RegionId String 是 cn-shanghai

地域ID。
TenantId Long 是 10001

租户ID。
ApiNameKeyword String 否 我的API名称

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

返回数据

名称 类型 示例值 描述
Data Struct

获得授权的API信息。
ApiAuthorizedList Array of ApiAuthorized

获得授权的API列表。
ApiId Long 10002

API的ID。
ApiName String 我的API名称

API的名称。
ApiPath String /test/1

API的路径。
ApiStatus Integer 0

API的状态，可选枚举值包括0（未发布）和1（已发布）。
CreatedTime String 2020-06-23T00:21:01+0800

API的创建时间。
CreatorId String 12345

API负责人阿里云ID
GrantCreatedTime String 2020-06-23T00:21:01+0800

API的授权时间。
GrantEndTime String 2020-06-24T00:21:01+0800

API的授权到期时间。
GrantOperatorId String 23456

授权者的阿里云ID。
GroupId String abcde123456789

分组ID。
ModifiedTime String 2020-06-23T00:21:01+0800

API的最近更新时间。
ProjectId Long 10000

工作空间的ID。
TenantId Long 10001

租户ID。
PageNumber Integer 1

页码，和请求中的PageNumber一致。
PageSize Integer 10

每页显示的条数，默认为10条，最大100条。
TotalCount Integer 100

总记录数。
ErrorCode String 1031203110005

错误码。
ErrorMessage String The specified parameters are invalid.

错误信息
HttpStatusCode Integer 200

HTTP状态码。
RequestId String 0000-ABCD-EFG****

请求ID，一次请求的唯一标识。
Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDataServiceAuthorizedApis
&PageNumber=1
&PageSize=10
&ProjectId=10000
&RegionId=cn-shanghai
&TenantId=10001
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <ApiAuthorizedList>
        <GrantEndTime>2020-06-24T00:21:01+0800</GrantEndTime>
        <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
        <ApiName>我的API名称</ApiName>
        <CreatorId>12345</CreatorId>
        <ApiStatus>0</ApiStatus>
        <ProjectId>10000</ProjectId>
        <GrantCreatedTime>2020-06-23T00:21:01+0800</GrantCreatedTime>
        <GroupId>abcde123456789</GroupId>
        <TenantId>10001</TenantId>
        <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>
        <GrantOperatorId>23456</GrantOperatorId>
        <ApiId>10002</ApiId>
        <ApiPath>/test/1</ApiPath>
    </ApiAuthorizedList>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON 格式 

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "ApiAuthorizedList": {
            "GrantEndTime": "2020-06-24T00:21:01+0800",
            "CreatedTime": "2020-06-23T00:21:01+0800",
            "ApiName": "我的API名称",
            "CreatorId": 12345,
            "ApiStatus": 0,
            "ProjectId": 10000,
            "GrantCreatedTime": "2020-06-23T00:21:01+0800",
            "GroupId": "abcde123456789",
            "TenantId": 10001,
            "ModifiedTime": "2020-06-23T00:21:01+0800",
            "GrantOperatorId": 23456,
            "ApiId": 10002,
            "ApiPath": "/test/1"
        }
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误，请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误，请稍后再试。
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. 您的请求过于频繁，请尝试放缓请求速度。
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 您被限制访问，请开通DataWorks企业版或旗舰版。

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