Call GetDataServiceApplication to query the details of a dataservice studio application.

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 Required 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 Required 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 Valid

The returned 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 call is 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 the application",
        "ApplicationSecret": "SECRET123",
        "ProjectId": 10001,
        "ApplicationId": 10000,
        "ApplicationCode": "CODE123"
    },
    "ErrorCode": 0,
    "ErrorMessage": "normal",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
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.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
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.

For a list of error codes, visit the API Error Center.