GetDataServiceApplication -

Queries the information about an application 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	GetDataServiceApplication	The operation that you want to perform. Set the value to GetDataServiceApplication.
TenantId	Long	No	10002	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.
ProjectId	Long	Yes	10001	The workspace ID.
ApplicationId	Long	Yes	10000	The application ID. You can view the information about the application in the API Gateway console.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	0000-ABCD-EFG****	The request ID.
ErrorMessage	String	Yes	The error message.
Success	Boolean	true	Indicates whether the request was successful.
ErrorCode	String	0	The error code.
Data	Object		The details of the application.
ApplicationCode	String	CODE123	The AppCode for simple authentication. You can select simple authentication or signature authentication when you call an API operation.
ApplicationKey	String	KEY123	The AppKey for signature authentication. You can select simple authentication or signature authentication when you call an API operation.
ApplicationSecret	String	SECRET123	The AppSecret for signature authentication. You can select simple authentication or signature authentication when you call an API operation.
ProjectId	Long	10001	The workspace ID.
ApplicationName	String	Test application	The name of the application.
ApplicationId	Long	10000	The application ID.

The disclosure of the value of the ApplicationCode or ApplicationSecret parameter may threaten the security of your API resources in DataService Studio. Therefore, the values of the ApplicationCode and ApplicationSecret parameters are masked before they are returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetDataServiceApplication
&TenantId=10002
&ProjectId=10001
&ApplicationId=10000
&<Common request parameters>

Sample success responses

XML format

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

<GetDataServiceApplicationResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>Normal</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>0</ErrorCode>
    <Data>
        <ApplicationCode>CODE123</ApplicationCode>
        <ApplicationKey>KEY123</ApplicationKey>
        <ApplicationSecret>SECRET123</ApplicationSecret>
        <ProjectId>10001</ProjectId>
        <ApplicationName>Test application</ApplicationName>
        <ApplicationId>10000</ApplicationId>
    </Data>
</GetDataServiceApplicationResponse>

JSON format

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

{
  "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
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 occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error occurred. Try again later.

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