Grants access permissions for an API in DataService Studio.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TenantId |
integer |
No |
The tenant ID. |
1004 |
| ProjectId |
integer |
Yes |
The ID of the workspace. |
10003 |
| ApiId |
integer |
Yes |
The ID of the API. |
10001 |
| AuthorizedProjectId |
integer |
Yes |
The ID of the workspace to which API access permissions are granted. |
10002 |
| EndTime |
integer |
Yes |
The expiration time of the access permissions, in seconds. Specify a UNIX timestamp. Example: 1600531564, which indicates 2020-09-20 00:06:04 (UTC+8). |
1600531564 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Success |
boolean |
Whether the authorization was successful. |
true |
| RequestId |
string |
The request ID. |
0000-ABCD-EF**** |
Examples
Success response
JSON format
{
"Success": true,
"RequestId": "0000-ABCD-EF****"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.