Queries the details of an application in DataService Studio.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetDataServiceApplication |
The operation that you want to perform. |
ApplicationId | Long | Yes | 10000 |
The ID of the application. |
ProjectId | Long | Yes | 10001 |
The ID of the DataWorks workspace. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where your project resides. |
TenantId | Long | Yes | 10002 |
The ID of the tenant. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
App Details |
|
ApplicationCode | String | CODE123 |
AppCode. |
ApplicationId | Long | 10000 |
The ID of the application. |
ApplicationKey | String | KEY123 |
AppKey. |
ApplicationName | String | Test application |
The name of the application. |
ApplicationSecret | String | SECRET123 |
AppSecret. |
ProjectId | Long | 10001 |
The ID of the associated workspace. |
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=GetDataServiceApplication &ApplicationId=10000 &ProjectId=10001 &RegionId=cn-shanghai &TenantId=10002 &<common request parameters>
Sample success responses
XML
format
<RequestId> 0000-abcd-efg****** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <ApplicationKey> KEY123 </ApplicationKey> <ApplicationName> test application </ApplicationName> <ApplicationSecret> SECRET123 </ApplicationSecret> <ProjectId> 10001 </ProjectId> <ApplicationId> 10000 </ApplicationId> <ApplicationCode> CODE123 </ApplicationCode> </Data> <ErrorCode> 0 </ErrorCode> <ErrorMessage> normal </ErrorMessage> <Success> true </Success>
JSON
Format
{"RequestId": "0000-abcd-EFG ******", "HttpStatusCode": 200, "Data": { "ApplicationKey": "KEY123", "ApplicationName": "Test application", "ApplicationSecret": "SECRET123", "ProjectId": 10001, "ApplicationId": 100000, "ApplicationCode": "" "CODE123" }, "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.