Queries the basic information of applications in DataService Studio.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListDataServiceApplications |
The operation that you want to perform. |
PageNumber | Integer | Yes | 1 |
The number of the page. Pages start from 1. Default value: 1. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
ProjectIdList | String | Yes | 10000,100001 |
Specify a workspace ID to query the application. Multiple values are supported, and multiple values are separated by a comma (,). At least one workspace ID can be specified. A maximum of 50 workspaces can be specified. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where your project resides. |
TenantId | Long | Yes | 100002 |
The ID of the tenant. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
The obtained basic information of the application. |
|
Applications | Array of Application |
The basic information of the application. |
|
ApplicationId | Long | 20000 |
The ID of the application. |
ApplicationName | String | My Applications |
The name of the application. |
ProjectId | Long | 10000 |
The ID of the DataWorks workspace. |
PageNumber | Integer | 1 |
The number of the page, which is consistent with the PageNumber value in the request. |
PageSize | Integer | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
TotalCount | Integer | 100 |
The total number of entries. |
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=ListDataServiceApplications &PageNumber=1 &PageSize=10 &ProjectIdList=10000,100001 &RegionId=cn-shanghai &TenantId=100002 &<common request parameters>
Sample success responses
XML
format
<RequestId> 0000-abcd-efg**** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <TotalCount> 100 </TotalCount> <PageSize> 10 </PageSize> <Applications> <ApplicationName> my application </ApplicationName> <ProjectId> 10000 </ProjectId> <ApplicationId> 20000 </ApplicationId> </Applications> <PageNumber> 1 </PageNumber> </Data> <ErrorCode> 0 </ErrorCode> <ErrorMessage> normal </ErrorMessage> <Success> true </Success>
JSON
Format
{"RequestId": "0000-abcd-EFG ${{*", "HttpStatusCode": 200, "Data": { "TotalCount": 100, "PageSize": 10, "Applications": { "ApplicationName": "My Applications", "ProjectId": 100000, "ApplicationId": 20000 }, "PageNumber": 1 }, "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 CenterFor more information, see error codes.