All Products
Search
Document Center

DataWorks:CreateDataServiceApiAuthority

Last Updated:Nov 21, 2024

Grants the access permissions on an API in DataService Studio.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TenantIdlongNo

The tenant ID.

1004
ProjectIdlongYes

The ID of the workspace.

10003
ApiIdlongYes

The ID of the API.

10001
AuthorizedProjectIdlongYes

The ID of the workspace to which the access permissions on the API are granted.

10002
EndTimelongYes

The end time of the validity period of the access permissions. The time must be a UNIX timestamp. Unit: seconds. Example: 1600531564, which indicates 2020-09-20 00:06:04 (UTC+8).

1600531564

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the authorization was successful.

true
RequestIdstring

The request ID.

0000-ABCD-EF****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "0000-ABCD-EF****"
}

Error codes

HTTP status codeError codeError messageDescription
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-10The Error code has changedView Change Details