调用ListDataServiceApiAuthorities获取授权给他人的API列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListDataServiceApiAuthorities | 系统规定参数。取值:ListDataServiceApiAuthorities。 |
ProjectId | Long | 是 | 10000 | 工作空间的ID。 |
PageNumber | Integer | 是 | 1 | 页码,从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 | 正常 | 错误信息。 |
Success | Boolean | Boolean | 调用是否成功。 |
ErrorCode | String | 0 | 错误码。 |
Data | Object | 授权给他人的API列表。 |
|
PageNumber | Integer | 1 | 页码,和请求中的PageNumber一致。 |
PageSize | Integer | 10 | 每页显示的条数,默认为10条,最大100条。 |
TotalCount | Integer | 100 | 总记录数。 |
ApiAuthorizationList | Array of ApiAuthorization | 返回数据结构。 |
|
ApiStatus | Integer | 0 | API的状态,可选枚举值包括0(未发布)和1(已发布)。 |
ApiId | Long | 10002 | API的ID。 |
ModifiedTime | String | 2020-06-23T00:21:01+0800 | API的最近更新时间。 |
GroupId | String | ab123 | 分组ID。 |
ProjectId | Long | 10000 | 工作空间的ID。 |
CreatorId | String | 12345 | API负责人的阿里云ID。 |
CreatedTime | String | 2020-06-23T00:21:01+0800 | API的创建时间。 |
ApiName | String | 我的API名称 | API的名称。 |
TenantId | Long | 10001 | 租户ID。 |
ApiPath | String | /test/1 | API的路径。 |
AuthorizationRecords | Array of AuthorizationRecord | 授权给他人的授权详情列表。 |
|
EndTime | String | 2020-06-24T00:21:01+0800 | 授权有效期的截止时间。 |
CreatorId | String | 12345 | API负责人的阿里云ID。 |
CreatedTime | String | 2020-06-23T00:21:01+0800 | 授权时间。 |
ProjectId | Long | 10004 | 获得授权的工作空间ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListDataServiceApiAuthorities
&ProjectId=10000
&PageNumber=1
&PageSize=10
&TenantId=10001
&ApiNameKeyword=我的API名称
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListDataServiceApiAuthoritiesResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorMessage>正常</ErrorMessage>
<Success>false</Success>
<ErrorCode>0</ErrorCode>
<Data>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>100</TotalCount>
<ApiAuthorizationList>
<ApiStatus>0</ApiStatus>
<ApiId>10002</ApiId>
<ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>
<GroupId>ab123</GroupId>
<ProjectId>10000</ProjectId>
<CreatorId>12345</CreatorId>
<CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
<ApiName>我的API名称</ApiName>
<TenantId>10001</TenantId>
<ApiPath>/test/1</ApiPath>
<AuthorizationRecords>
<EndTime>2020-06-24T00:21:01+0800</EndTime>
<CreatorId>12345</CreatorId>
<CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
<ProjectId>10004</ProjectId>
</AuthorizationRecords>
</ApiAuthorizationList>
</Data>
</ListDataServiceApiAuthoritiesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"RequestId" : "0000-ABCD-EFG****",
"ErrorMessage" : "正常",
"Success" : false,
"ErrorCode" : 0,
"Data" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 100,
"ApiAuthorizationList" : {
"ApiStatus" : 0,
"ApiId" : 10002,
"ModifiedTime" : "2020-06-23T00:21:01+0800",
"GroupId" : "ab123",
"ProjectId" : 10000,
"CreatorId" : 12345,
"CreatedTime" : "2020-06-23T00:21:01+0800",
"ApiName" : "我的API名称",
"TenantId" : 10001,
"ApiPath" : "/test/1",
"AuthorizationRecords" : {
"EndTime" : "2020-06-24T00:21:01+0800",
"CreatorId" : 12345,
"CreatedTime" : "2020-06-23T00:21:01+0800",
"ProjectId" : 10004
}
}
}
}
错误码
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)
文档反馈