调用ListDataServiceApiAuthorities获取授权给他人的API列表。

调试

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

请求参数

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

要执行的操作。

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列表。

ApiAuthorizationList Array of ApiAuthorization

授权给他人的API列表和授权详情。

ApiId Long 10002

API的ID。

ApiName String 我的API名称

API的名称。

ApiPath String /test/1

API的路径。

ApiStatus Integer 0

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

AuthorizationRecords Array of AuthorizationRecord

授权给他人的授权详情列表。

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

授权时间。

CreatorId String 12345

授权者的阿里云用户ID。

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

授权有效期的截止时间。

ProjectId Long 10004

获得授权的工作空间ID。

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

API的创建时间。

CreatorId String 12345

API负责人的阿里云ID。

GroupId String ab123

分组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 0

错误码。

ErrorMessage String 正常

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

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

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDataServiceApiAuthorities
&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>
    <ApiAuthorizationList>
        <TenantId>10001</TenantId>
        <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
        <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>
        <ApiName>我的API名称</ApiName>
        <CreatorId>12345</CreatorId>
        <ApiStatus>0</ApiStatus>
        <ProjectId>10000</ProjectId>
        <ApiId>10002</ApiId>
        <ApiPath>/test/1</ApiPath>
        <GroupId>ab123</GroupId>
    </ApiAuthorizationList>
    <ApiAuthorizationList>
        <AuthorizationRecords>
            <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
            <EndTime>2020-06-24T00:21:01+0800</EndTime>
            <CreatorId>12345</CreatorId>
            <ProjectId>10004</ProjectId>
        </AuthorizationRecords>
    </ApiAuthorizationList>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>正常</ErrorMessage>
<Success>true</Success>

JSON 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "ApiAuthorizationList": [
            {
                "TenantId": 10001,
                "CreatedTime": "2020-06-23T00:21:01+0800",
                "ModifiedTime": "2020-06-23T00:21:01+0800",
                "ApiName": "我的API名称",
                "CreatorId": 12345,
                "ApiStatus": 0,
                "ProjectId": 10000,
                "ApiId": 10002,
                "ApiPath": "/test/1",
                "GroupId": "ab123"
            },
            {
                "AuthorizationRecords": {
                    "CreatedTime": "2020-06-23T00:21:01+0800",
                    "EndTime": "2020-06-24T00:21:01+0800",
                    "CreatorId": 12345,
                    "ProjectId": 10004
                }
            }
        ]
    },
    "ErrorCode": 0,
    "ErrorMessage": "正常",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 您的请求过于频繁,请尝试放缓请求速度。

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