Retrieves a list of applications.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The page number. Pages start from page 1. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| ProjectIdList |
string |
Yes |
The ID of the workspace based on which you want to query the basic information of applications. You can specify multiple IDs. Separate them with commas (,). You must specify at least one workspace ID. You can specify a maximum of 50 workspace IDs. |
10000,100001 |
| TenantId |
integer |
No |
The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section. |
100002 |
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 |
Indicates whether the request was successful. |
true |
| ErrorCode |
string |
The error code. |
0 |
| Data |
object |
The returned data. |
|
| PageNumber |
integer |
The page number. The value of this parameter is the same as that of the PageNumber parameter in the request. |
1 |
| PageSize |
integer |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| TotalCount |
integer |
The total number of entries returned. |
100 |
| Applications |
array<object> |
The basic information of the applications. |
|
|
object |
|||
| ApplicationName |
string |
The name of the application. |
My application |
| ApplicationId |
integer |
The application ID. |
20000 |
| ProjectId |
integer |
The workspace ID. |
10000 |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG***",
"ErrorMessage": "Normal",
"Success": true,
"ErrorCode": "0",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Applications": [
{
"ApplicationName": "My application",
"ApplicationId": 20000,
"ProjectId": 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.