调用ListDataServiceApplications获取数据服务应用的基础信息列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDataServiceApplications

要执行的操作。

PageNumber Integer 1

页码,从1开始,默认值为1。

PageSize Integer 10

每页的大小。最小值为1,最大值为50,默认值为10。

ProjectIdList String 10000,100001

指定工作空间ID查询应用。支持多值,多值之间使用英文逗号(,)分隔。最少指定1个工作空间ID,最多指定50个工作空间ID。

RegionId String cn-shanghai

地域ID。

TenantId Long 100002

租户ID。

返回数据

名称 类型 示例值 描述
Data Struct

查询得到的应用基础信息。

Applications Array

应用的基础信息列表。

ApplicationId Long 20000

应用ID。

ApplicationName String 我的应用

应用的名称。

ProjectId Long 10000

工作空间的ID。

PageNumber Integer 1

页码,和请求中的PageNumber一致。

PageSize Integer 10

每页的大小,和请求中的PageSize一致。

TotalCount Integer 100

总记录数。

ErrorCode String 0

错误码。

ErrorMessage String 正常

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG***

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

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDataServiceApplications
&PageNumber=1
&PageSize=10
&ProjectIdList=10000,100001
&RegionId=cn-shanghai
&TenantId=100002
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <Applications>
        <ApplicationName>我的应用</ApplicationName>
        <ProjectId>10000</ProjectId>
        <ApplicationId>20000</ApplicationId>
    </Applications>
    <PageNumber>1</PageNumber>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>正常</ErrorMessage>
<Success>true</Success>

JSON 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 10,
        "Applications": {
            "ApplicationName": "我的应用",
            "ProjectId": 10000,
            "ApplicationId": 20000
        },
        "PageNumber": 1
    },
    "ErrorCode": 0,
    "ErrorMessage": "正常",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 您的请求过于频繁,请尝试放缓请求速度。

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