查询工作区列表。
请求方式:POST
请求地址:https://open.volcengineapi.com/?Action=ListWorkspaces&Version=2023-05-01
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListWorkspaces | 公共参数,本接口值:ListWorkspaces。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
PageNumber | Integer | 否 | 1 | 分页查询时的起始页码,从 1 开始,默认为 1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的记录数,取值:
|
Filter | Object WorkspaceFilter | 否 | 待查询工作区的过滤条件。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Name | String | 否 | work | 按工作区名称过滤,模糊查询。 |
Ids | Array of String | 否 | ["2c7a85e4ac034eb790b096705694****"] | 按工作区 ID 过滤,精确查询。 |
POST /?Action=ListWorkspaces&Version=2023-05-01 HTTP/1.1 Content-Type:application/json { "PageNumber":1, "PageSize":10, "Filter":{ "Name":"work", "Ids":[ "2c7a85e4ac034eb790b096705694****" ] } }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 20 | 工作区总数。 |
Items | Array of Workspace | 工作区列表。 | |
PageNumber | Integer | 1 | 当前页码。 |
PageSize | Integer | 10 | 单页数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 18be9d623fba45a1aca409f5e19c**** | 工作区 ID。 |
Name | String | workspace-test | 工作区名称。 |
Description | String | 这是一段描述 | 工作区描述。 |
Creator | Object IAMUser | { | 工作区创建人。 |
Visibility | String | Specified | 工作区成员可见方式。
|
VisibleUsers | Array of IAMUser | [ | 当工作区成员可见方式设置为 Specified 时,将进一步展示可见用户列表。 |
CreateTime | String | 2023-05-10T14:11:28+08:00 | 工作区创建时间。 |
UpdateTime | String | 2023-05-10T14:11:28+08:00 | 工作区更新时间。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202404031430323BAEA57387980A0B****", "Action": "ListWorkspaces", "Version": "2023-05-01", "Service": "cp", "Region": "cn-beijing", }, "Result": { "TotalCount": 1, "PageNumber": 1, "PageSize": 10, "Items": [ { "Id": "18be9d623fba45a1aca409f5e19c****", "Name": "workspace-test", "CreateTime": "2023-05-10T14:11:28+08:00", "UpdateTime": "2023-05-10T14:11:28+08:00", "Creator": { "AccountId": 24506499****, "UserId": 0 }, "Visiblity": "Specified", "VisibleUsers": [ { "AccountId": 24506499****, "UserId": 0 }, { "AccountId": 24506499****, "UserId": 1454*** } ] } ] } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。