ListWorkspaces--持续交付-火山引擎

文档中心

立即注册

导航

ListWorkspaces

最近更新时间：2024.09.27 14:46:37首次发布时间：2024.07.02 21:03:12

查询工作区列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListWorkspaces&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListWorkspaces	接口名称。当前 API 的名称为 `ListWorkspaces`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
PageNumber	Long	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Long	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10
Filter	Object of WorkspaceFilter	否	-	待查询工作区的过滤条件。

WorkspaceFilter

参数	类型	是否必选	示例值	描述
Name	String	否	work	按工作区名称过滤，模糊查询。
Ids	Array of String	否	["2c7a85e4ac034eb790b096705694****"]	按工作区 ID 过滤，精确查询。

请求示例

POST https://open.volcengineapi.com/?Action=ListWorkspaces&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Name": "work",
        "Ids": [
            "2c7a85e4ac034eb790b096705694****"
        ]
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	20	工作区总数。
Items	Array of Workspace	-	工作区列表。
PageNumber	Long	1	当前页码。
PageSize	Long	10	单页数量。

Workspace

参数	类型	示例值	描述
Id	String	18be9d623fba45a1aca409f5e19c****	工作区 ID。
Name	String	workspace-test	工作区名称。
Description	String	这是一段描述	工作区描述。
Creator	Object of IAMUser	{ "AccountId": 24506499****, "UserId": 0 }	工作区创建人。
Visibility	String	Specified	工作区成员可见方式。 Account：所有用户可见 Specified：指定用户可见
VisibleUsers	Array of IAMUser	[ { "AccountId": 24506499**, "UserId": 0 }, { "AccountId": 24506499, "UserId": 1454* } ]	当工作区成员可见方式设置为 Specified 时，将进一步展示可见用户列表。
CreateTime	String	2023-05-10T14:11:28+08:00	工作区创建时间。
UpdateTime	String	2023-05-10T14:11:28+08:00	工作区更新时间。

IAMUser

参数	类型	示例值	描述
AccountId	Long	210048****	火山引擎账号（主账号）ID。
UserId	Long	28****	子用户（IAM 用户）ID。

返回示例

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***
                    }
                ]
            }
        ]
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。