GetDataServiceApplication - DataWorks

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetDataServiceApplication	要执行的操作。
ApplicationId	Long	是	10000	App的ID，可在API网关控制台上查看应用信息。
ProjectId	Long	是	10001	工作空间的ID。
RegionId	String	是	cn-shanghai	地域ID。
TenantId	Long	是	10002	租户ID。

返回数据


名称	类型	示例值	描述
Data	Struct		App详情。
ApplicationCode	String	CODE123	API调用认证方式一，简单身份认证中的AppCode。
ApplicationId	Long	10000	App的ID。
ApplicationKey	String	KEY123	API调用认证方式二，加密签名身份认证中的AppKey。
ApplicationName	String	测试应用	应用名称。
ApplicationSecret	String	SECRET123	API调用认证方式二，加密签名身份认证中的AppSecret。
ProjectId	Long	10001	关联工作空间的ID。
ErrorCode	String	0	错误码。
ErrorMessage	String	正常	错误信息。
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	0000-ABCD-EFG****	请求ID，一次请求的唯一标识。
Success	Boolean	true	调用是否成功。

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

示例

请求示例

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

正常返回示例

XML格式

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

JSON格式

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

错误码


HttpCode	错误码	错误信息	描述
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
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.	您的请求过于频繁，请尝试放缓请求速度。
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	您被限制访问，请开通DataWorks企业版或旗舰版。

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