Queries the APIs on which other users are granted the access permissions.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | ListDataServiceApiAuthorities |
The operation that you want to perform. |
| PageNumber | Integer | Yes | 1 |
The number of the page. Pages start from 1. Default value: 1. |
| PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
| ProjectId | Long | Yes | 10000 |
The ID of the DataWorks workspace. |
| RegionId | String | Yes | cn-shanghai |
The ID of the region where your project resides. |
| TenantId | Long | Yes | 10001 |
The ID of the tenant. |
| ApiNameKeyword | String | No | My API name |
The keyword of the API name. You can obtain all APIs whose names contain the keyword from the specified filtering condition. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| Data | Struct |
The list of APIs authorized to other users. |
|
| ApiAuthorizationList | Array of ApiAuthorization |
The list of APIs authorized to others and the corresponding authorization details. |
|
| ApiId | Long | 10002 |
The ID of the API to query. |
| ApiName | String | My API name |
The operation that you want to perform. |
| ApiPath | String | /test/1 |
The path to the API. |
| ApiStatus | Integer | 0 |
The status of the API. Valid values: 0 (unpublished) and 1 (published). |
| AuthorizationRecords | Array of AuthorizationRecord |
The details of the permission granted to others. |
|
| CreatedTime | String | 2020-06-23T00:21:01+0800 |
The time when the policy was attached. |
| CreatorId | String | 12345 |
The Alibaba Cloud User ID of the authorizer. |
| EndTime | String | 2020-06-24T00:21:01+0800 |
The validity period of the authorization. |
| ProjectId | Long | 10004 |
The ID of the workspace to which the role is attached. |
| CreatedTime | String | 2020-06-23T00:21:01+0800 |
The time when the API was created. |
| CreatorId | String | 12345 |
The Alibaba Cloud ID of the API owner. |
| GroupId | String | ab123 |
The ID of the group. |
| ModifiedTime | String | 2020-06-23T00:21:01+0800 |
The time when the API was last updated. |
| ProjectId | Long | 10000 |
The ID of the DataWorks workspace. |
| TenantId | Long | 10001 |
The ID of the tenant. |
| PageNumber | Integer | 1 |
The number of the page, which is consistent with the PageNumber value in the request. |
| PageSize | Integer | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
| TotalCount | Integer | 100 |
The total number of entries. |
| ErrorCode | String | 0 |
The error code. |
| ErrorMessage | String | Normal |
The error message. |
| HttpStatusCode | Integer | 200 |
The HTTP status code. |
| RequestId | String | 0000-ABCD-EFG**** |
The unique ID of the request. |
| Success | Boolean | true |
Indicates whether the request was successful. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListDataServiceApiAuthorities &PageNumber=1 &PageSize=10 &ProjectId=10000 &RegionId=cn-shanghai &TenantId=10001 &<common request parameters>
Sample success responses
XML format
<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-23 T00:21:01+0800 </ModifiedTime> <ApiName> I name of the 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-23 T00:21:01+0800 </CreatedTime> <EndTime> 2020-06-24 T00:21:01+0800 </EndTime> <CreatorId> 12345 </CreatorId> <ProjectId> 10004 </ProjectId> </AuthorizationRecords> </ApiAuthorizationList> </Data> <ErrorCode> 0 </ErrorCode> <ErrorMessage> normal </ErrorMessage> <Success> true </Success>
JSON Format
{"RequestId": "0000-abcd-EFG %}*", "HttpStatusCode": 200, "Data": { "TotalCount": 100, "PageSize": 10, "PageNumber": 1, "ApiAuthorizationList": [ { "TenantId": 10001, "CreatedTime": "20-0206-23t00: 21:01+0800", "ModifiedTime": "2020-06-23T00:21:01+0800", "ApiName": "My API name", " 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": "normal", "Success": true}
Error codes
| HttpCode | Error codes | Error message | Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | The request for the resource exceeds your available upper limit. |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks the system is busy, please try again later. |
| 429 | Throttling.User | Your request is too frequent. Try again later. | Your request is too frequent, please try to slow down the request speed. |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
Go to the Error Center For more information, see error codes.