获取工作空间列表的ListWorkspaces API参考-云监控-阿里云

获取工作空间列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:ListWorkspaces

list

*Workspace

acs:cms::{#accountId}:workspace/*

无

请求语法

GET /workspace HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
workspaceName	string	否	工作空间名称，模糊查找	workspace-test-001
nextToken	string	否	分页 Token	xxxxxxxxxx
maxResults	integer	否	分页大小默认值: 50 最大值: 50	10
workspaceNameList	array	否	工作空间名称，精确查找	workspace-test-001
	string	否	工作空间名称，精确查找	workspace-test-001
region	string	否	地域。	cn-heyuan

返回参数

名称	类型	描述	示例值
	object	Schema of Response
maxResults	integer	分页大小默认值: 50 最大值: 50	10
nextToken	string	分页 Token	xxxxxxxxxx
requestId	string	请求 ID	264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
total	integer	总数	1
workspaces	array<object>	工作空间列表
	object	WorkspaceItemType
createTime	string	创建时间	2025-03-11T08:21:58Z
displayName	string	工作空间展示名称	workspace-test
description	string	工作空间描述	workspace test
lastModifyTime	string	更新时间	2025-03-11T08:21:58Z
regionId	string	地域 ID	cn-heyuan
slsProject	string	日志服务项目名称	sls-project-test-001
workspaceName	string	工作空间名称	workspace-test-001

示例

正常返回示例

JSON格式

{
  "maxResults": 10,
  "nextToken": "xxxxxxxxxx",
  "requestId": "264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC",
  "total": 1,
  "workspaces": [
    {
      "createTime": "2025-03-11T08:21:58Z",
      "displayName": "workspace-test",
      "description": "workspace test",
      "lastModifyTime": "2025-03-11T08:21:58Z",
      "regionId": "cn-heyuan",
      "slsProject": "sls-project-test-001",
      "workspaceName": "workspace-test-001"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。