文档

GetDataServiceApplication

更新时间:

调用GetDataServiceApplication查询数据服务App的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String GetDataServiceApplication

系统规定参数。取值:GetDataServiceApplication

TenantId Long 10002

租户ID。您可登录DataWorks控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户ID。

ProjectId Long 10001

工作空间的ID。

ApplicationId Long 10000

App的ID,可在API网关控制台上查看应用信息。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

请求ID,一次请求的唯一标识。

ErrorMessage String 正常

错误信息。

Success Boolean true

调用是否成功。

ErrorCode String 0

错误码。

Data Object

App详情。

ApplicationCode String CODE123

API调用认证方式一,简单身份认证中的AppCode。

ApplicationKey String KEY123

API调用认证方式二,加密签名身份认证中的AppKey。

ApplicationSecret String SECRET123

API调用认证方式二,加密签名身份认证中的AppSecret。

ProjectId Long 10001

关联工作空间的ID。

ApplicationName String 测试应用

应用名称。

ApplicationId Long 10000

App的ID。

ApplicationCode或ApplicationSecre参数的泄露会威胁您数据服务API资源的安全,本OpenAPI会对ApplicationCode和ApplicationSecre参数进行脱敏后再返回。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDataServiceApplication
&TenantId=10002
&ProjectId=10001
&ApplicationId=10000
&公共请求参数

正常返回示例

XML格式

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

<GetDataServiceApplicationResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>正常</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>0</ErrorCode>
    <Data>
        <ApplicationCode>CODE123</ApplicationCode>
        <ApplicationKey>KEY123</ApplicationKey>
        <ApplicationSecret>SECRET123</ApplicationSecret>
        <ProjectId>10001</ProjectId>
        <ApplicationName>测试应用</ApplicationName>
        <ApplicationId>10000</ApplicationId>
    </Data>
</GetDataServiceApplicationResponse>

JSON格式

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "正常",
  "Success" : true,
  "ErrorCode" : 0,
  "Data" : {
    "ApplicationCode" : "CODE123",
    "ApplicationKey" : "KEY123",
    "ApplicationSecret" : "SECRET123",
    "ProjectId" : 10001,
    "ApplicationName" : "测试应用",
    "ApplicationId" : 10000
  }
}

错误码

HttpCode

错误码

错误信息

描述

429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈