ListDataAgentWorkspace - 获取主账号下的协作空间

更新时间:
复制 MD 格式

获取主账号下的协作空间(分页)

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListDataAgentWorkspace

list

*全部资源

*

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DMSUnit

string

当前 DMS 单元

cn-hangzhou

WorkspaceType

string

查询空间类型

MY

WorkspaceName

string

工作空间名称

workspaceTest

PageNumber

string

开始页号

1

PageSize

string

每页记录数(个)

10

MaxResults

integer

分页大小

no use

NextToken

string

令牌(Token)信息。

no use

Order

string

排序方式

DESC

OrderBy

string

排序字段名称

CreateTime

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID

E0D2-*****-A63B6

Success

string

请求是否成功

true

ErrorCode

string

错误码

DMS-DA-40114

ErrorMessage

string

调用失败时,返回的错误信息

Specified parameter is not valid.

Data

object

返回结构体

PageSize

integer

每页空间数量(个)

50

PageNumber

integer

总共页数(页)

12

Content

array<object>

配置内容

object

数据内容

Creator

string

空间创建者的 uid

20282*****7591

ModifyTime

integer

空间最近的修改时间(时间戳/秒)

1765961516

CreateTime

integer

空间的创建时间(时间戳/秒)

1765960516

RoleName

string

用户在空间中的角色名称

admin

Description

string

空间描述信息

space for test

WorkspaceName

string

空间的名称

workspaceTest

TotalMember

integer

空间成员数量(个)

11

WorkspaceStatus

string

空间的状态

active

WorkspaceId

string

空间 ID

20923*****7291

IsSessionShareEnabled

boolean

Type

string

TotalElements

integer

总空间数量(个)

122

TotalPages

integer

总页数(页)

12

MaxResults

integer

分页大小

nu use

NextToken

string

令牌(Token)信息

no use

示例

正常返回示例

JSON格式

{
  "RequestId": "E0D2-*****-A63B6",
  "Success": "true",
  "ErrorCode": "DMS-DA-40114",
  "ErrorMessage": "Specified parameter is not valid.",
  "Data": {
    "PageSize": 50,
    "PageNumber": 12,
    "Content": [
      {
        "Creator": "\t\n20282*****7591",
        "ModifyTime": 1765961516,
        "CreateTime": 1765960516,
        "RoleName": "admin",
        "Description": "space for test",
        "WorkspaceName": "workspaceTest",
        "TotalMember": 11,
        "WorkspaceStatus": "active",
        "WorkspaceId": "20923*****7291",
        "IsSessionShareEnabled": true,
        "Type": ""
      }
    ],
    "TotalElements": 122,
    "TotalPages": 12
  },
  "MaxResults": 0,
  "NextToken": "no use"
}

错误码

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

变更历史

更多信息,参考变更详情