调用ListProjects,分页列出用户所在租户下的DataWorks工作空间列表。

调试

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

请求参数

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

系统规定参数。取值:ListProjects

PageNumber Integer 1

分页的页码。

PageSize Integer 10

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

ResourceManagerResourceGroupId String rg-acfmzbn7pti3zfa

资源组ID。

Tags Array

标签。

Key String Env

标签键。

Value String Test

标签值。

返回数据

名称 类型 示例值 描述
RequestId String 20658801***

请求ID。

PageResult Object

查询的结果。

PageNumber Integer 1

当前的页码。

PageSize Integer 10

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

TotalCount Integer 123

结果的总条数。

ProjectList Array of Project

DataWorks工作空间的结果列表。

ProjectStatusCode String AVAILABLE

工作空间的状态码。

  • AVAILABLE:状态取值为0,表示正常。
  • DELETED:状态取值为1,表示已删除。
  • INITIALIZING:状态取值为2,表示初始化。
  • INIT_FAILED:状态取值为3,表示初始化失败。
  • FORBIDDEN:状态取值为4,表示手动禁用。
  • DELETING:状态取值为5,表示删除中。
  • DEL_FAILED:状态取值为6,表示删除失败。
  • FROZEN:状态取值为7,表示欠费冻结。
  • UPDATING:状态取值为8,表示项目更新(为项目添加并初始化计算引擎)中。
  • UPDATE_FAILED:状态取值为9,表示项目更新(为项目添加并初始化计算引擎)失败。
ProjectStatus Integer 0

工作空间的状态。

  • AVAILABLE:状态取值为0,表示正常。
  • DELETED:状态取值为1,表示已删除。
  • INITIALIZING:状态取值为2,表示初始化。
  • INIT_FAILED:状态取值为3,表示初始化失败。
  • FORBIDDEN:状态取值为4,表示手动禁用。
  • DELETING:状态取值为5,表示删除中。
  • DEL_FAILED:状态取值为6,表示删除失败。
  • FROZEN:状态取值为7,表示欠费冻结。
  • UPDATING:状态取值为8,表示项目更新(为项目添加并初始化计算引擎)中。
  • UPDATE_FAILED:状态取值为9,表示项目更新(为项目添加并初始化计算引擎)失败。
ProjectName String 测试空间

工作空间的名称。

ProjectIdentifier String test

工作空间的编码。

ProjectId Long 1212

工作空间的ID。

ProjectDescription String 测试空间

工作空间的详细描述信息。

ProjectOwnerBaseId String 122222

工作空间所有者的用户ID。

ResourceManagerResourceGroupId String rg-acfmzbn7pti3zfa

资源组ID。

Tags Array of Tag

标签。

Key String Env

标签键。

Value String Test

标签值。

DisableDevelopment Boolean true

是否禁用开发角色,取值如下:

  • false,开启开发角色。
  • true,禁用开发角色。
  • 默认取值为false。
UseProxyOdpsAccount Boolean true

访问MaxCompute引擎是否使用代理账号。

TablePrivacyMode Integer 1

MaxCompute表的可见性权限,取值如下:

  • 0,租户内用户不可见MaxCompute表。
  • 1,租户内用户可见MaxCompute表。
IsDefault Integer 1

是否为默认工作空间,取值如下:

  • 1,是。
  • 0,否。

示例

请求示例

http(s)://[Endpoint]/?Action=ListProjects
&PageNumber=1
&PageSize=10
&ResourceManagerResourceGroupId=rg-acfmzbn7pti3zfa
&Tags=[{"Key":"Env","Value":"Test"}]
&公共请求参数

正常返回示例

XML格式

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

<ListProjectsResponse>
    <RequestId>20658801***</RequestId>
    <PageResult>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>123</TotalCount>
        <ProjectList>
            <ProjectStatusCode>AVAILABLE</ProjectStatusCode>
            <ProjectStatus>0</ProjectStatus>
            <ProjectName>测试空间</ProjectName>
            <ProjectIdentifier>test</ProjectIdentifier>
            <ProjectId>1212</ProjectId>
            <ProjectDescription>测试空间</ProjectDescription>
            <ProjectOwnerBaseId>122222</ProjectOwnerBaseId>
            <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>
            <Tags>
                <Key>Env</Key>
                <Value>Test</Value>
            </Tags>
            <DisableDevelopment>true</DisableDevelopment>
            <UseProxyOdpsAccount>true</UseProxyOdpsAccount>
            <TablePrivacyMode>1</TablePrivacyMode>
            <IsDefault>1</IsDefault>
        </ProjectList>
    </PageResult>
</ListProjectsResponse>

JSON格式

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

{
  "RequestId" : "20658801***",
  "PageResult" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 123,
    "ProjectList" : {
      "ProjectStatusCode" : "AVAILABLE",
      "ProjectStatus" : 0,
      "ProjectName" : "测试空间",
      "ProjectIdentifier" : "test",
      "ProjectId" : 1212,
      "ProjectDescription" : "测试空间",
      "ProjectOwnerBaseId" : "122222",
      "ResourceManagerResourceGroupId" : "rg-acfmzbn7pti3zfa",
      "Tags" : {
        "Key" : "Env",
        "Value" : "Test"
      },
      "DisableDevelopment" : true,
      "UseProxyOdpsAccount" : true,
      "TablePrivacyMode" : 1,
      "IsDefault" : 1
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. 数据源不存在。
400 Invalid.Tenant.ProjectNotExists The project does not exist. 项目不存在。
400 Invalid.Tenant.UserAlreadyInProject The user already exists in the project. 待添加用户已经存在于工作空间中。
400 Invalid.Tenant.UserNotInProject The user is not in the project. 用户不在项目中。
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. 用户不是项目负责人或者项目管理员。
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. 用户不在租户中。

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