Queries authorized APIs.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListDataServiceAuthorizedApis |
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 information about the authorized API. |
|
ApiAuthorizedList | Array of ApiAuthorized |
The list of authorized APIs. |
|
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). |
CreatedTime | String | 2020-06-23T00:21:01+0800 |
The time when the API was created. |
CreatorId | String | 12345 |
Alibaba Cloud ID of the API owner |
GrantCreatedTime | String | 2020-06-23T00:21:01+0800 |
The time when the API was authorized. |
GrantEndTime | String | 2020-06-24T00:21:01+0800 |
The time when the API authorization expires. |
GrantOperatorId | String | 23456 |
The Alibaba Cloud ID of the authorizer. |
GroupId | String | abcde123456789 |
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 | 1031203110005 |
The error code. |
ErrorMessage | String | The specified parameters are invalid. |
The error message that is returned. |
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=ListDataServiceAuthorizedApis &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> <ApiAuthorizedList> <GrantEndTime> 2020-06-24t00:21:01+0800 </GrantEndTime> <CreatedTime> 2020-06-23t00:21:01+0800 </CreatedTime> <ApiName> I name of the API </ApiName> <CreatorId> 12345 </CreatorId> <ApiStatus> 0 </ApiStatus> <ProjectId> 10000 </ProjectId> <GrantCreatedTime> 2020-06-23 T00:21:01+0800 </GrantCreatedTime> <GroupId> abcde123456789 </GroupId> <TenantId> 10001 </TenantId> <ModifiedTime> 2020-06-23 T00: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
Format
{"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 ": " My API name ", " 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}
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.