Retrieves the details of an application.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TenantId |
integer |
No |
The tenant ID. You can find the tenant ID by logging on to the DataWorks console, navigating to DataStudio, and then clicking the username in the upper-right corner and selecting User Info. |
10002 |
| ProjectId |
integer |
Yes |
The ID of the workspace. |
10001 |
| ApplicationId |
integer |
Yes |
The application ID. You can view application details in the API Gateway console. |
10000 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The request ID. |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
The error message. |
Normal |
| Success |
boolean |
Whether the request was successful. |
true |
| ErrorCode |
string |
The error code. |
0 |
| Data |
object |
The details of the application. |
|
| ApplicationCode |
string |
The AppCode used for simple authentication. When calling an API operation, you can choose between simple authentication and signature authentication. |
CODE123 |
| ApplicationKey |
string |
The AppKey used for signature authentication. When calling an API operation, you can choose between simple authentication and signature authentication. |
KEY123 |
| ApplicationSecret |
string |
The AppSecret used for signature authentication. When calling an API operation, you can choose between simple authentication and signature authentication. |
SECRET123 |
| ProjectId |
integer |
The workspace ID. |
10001 |
| ApplicationName |
string |
The name of the application. |
Test application |
| ApplicationId |
integer |
The application ID. |
10000 |
Exposing the ApplicationCode or ApplicationSecret values may compromise the security of your API resources in DataService Studio. These values are masked in the response.
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "Normal",
"Success": true,
"ErrorCode": "0",
"Data": {
"ApplicationCode": "CODE123",
"ApplicationKey": "KEY123",
"ApplicationSecret": "SECRET123",
"ProjectId": 10001,
"ApplicationName": "Test application",
"ApplicationId": 10000
}
}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.