Grants the access permissions on an API in DataService Studio.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateDataServiceApiAuthority |
The operation that you want to perform. |
ApiId | Long | Yes | 10001 |
The ID of the API to query. |
AuthorizedProjectId | Long | Yes | 10002 |
The ID of the workspace to which the permissions are applied. |
EndTime | Long | Yes | 1600531564 |
The end of the time range where the authorization is performed. The value is a Unix timestamp in seconds. For example, 1600531564 indicates 00:06:04 (Beijing Time) on 2020-09-20. |
ProjectId | Long | Yes | 10003 |
The ID of the DataWorks workspace. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where your project resides. |
TenantId | Long | Yes | 1004 |
The ID of the tenant. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 0000-ABCD-EF**** |
The unique ID of the request. |
Success | Boolean | true |
Indicates whether the authorization is successful. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=CreateDataServiceApiAuthority &ApiId=10001 &AuthorizedProjectId=10002 &EndTime=1600531564 &ProjectId=10003 &RegionId=cn-shanghai &TenantId=1004 &<common request parameters>
Sample success responses
XML
format
<RequestId>0000-ABCD-EFo****</RequestId> <Success>true</Success>
JSON
Format
{ "RequestId": "0000-ABCD-EFo****", "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.