Queries a list of applications in DataService Studio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListDataServiceApplications

The operation that you want to perform. Set the value to ListDataServiceApplications.

PageNumber Integer Yes 1

The number of the page to return. Pages start from page 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

The ID of the workspace based on which you want to query the basic information of applications. If you specify multiple IDs, separate them with commas (,). You can specify 1 to 50 workspace IDs.

TenantId Long Yes 100002

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 username for the logon in the upper-right corner and click User Info in the Menu section.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG***

The request ID.

ErrorMessage String Normal

The error message.

Success Boolean true

Indicates whether the request was successful.

ErrorCode String 0

The error code.

Data Object

The data returned.

PageNumber Integer 1

The page number of the returned page. The value of this parameter is the same as that of the PageNumber parameter in the request.

PageSize Integer 10

The number of entries returned per page. Default value: 10. Maximum value: 100.

TotalCount Integer 100

The total number of entries returned.

Applications Array of Application

The basic information of the applications.

ApplicationName String My application

The name of the application.

ApplicationId Long 20000

The application ID.

ProjectId Long 10000

The workspace ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDataServiceApplications
&PageNumber=1
&PageSize=10
&ProjectIdList=10000,100001
&TenantId=100002
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDataServiceApplicationsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG***</RequestId>
    <ErrorMessage>Normal</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>0</ErrorCode>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Applications>
            <ApplicationName>My application</ApplicationName>
            <ApplicationId>20000</ApplicationId>
            <ProjectId>10000</ProjectId>
        </Applications>
    </Data>
</ListDataServiceApplicationsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
429 Throttling.Api The request for this resource has exceeded your available limit. The number of requests for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. Excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. An internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal error has occurred. Try again later.

For a list of error codes, see Service error codes.