文档

ListDataServiceApplications

更新时间:

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListDataServiceApplications

系统规定参数。取值:ListDataServiceApplications

PageNumber Integer 1

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

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

ProjectIdList String 10000,100001

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

TenantId Long 100002

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

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG***

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

ErrorMessage String 正常

错误信息。

Success Boolean true

调用是否成功。

ErrorCode String 0

错误码。

Data Object

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

PageNumber Integer 1

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

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

TotalCount Integer 100

总记录数。

Applications Array of Application

应用的基础信息列表。

ApplicationName String 我的应用

应用的名称。

ApplicationId Long 20000

应用ID。

ProjectId Long 10000

工作空间的ID。

示例

请求示例

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

正常返回示例

XML格式

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

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

JSON格式

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "0000-ABCD-EFG***",
  "ErrorMessage" : "正常",
  "Success" : true,
  "ErrorCode" : 0,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "Applications" : {
      "ApplicationName" : "我的应用",
      "ApplicationId" : 20000,
      "ProjectId" : 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)
文档反馈