You need to enable JavaScript to run this app.
导航

ListClusters - 集群列表

最近更新时间2024.04.23 14:17:36

首次发布时间2023.02.10 20:00:02

集群列表

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ListClusters

要执行的操作,取值:ListClusters

Version
String

2021-03-04

API的版本,取值:2021-03-04

PageNumber
Integer

1

分页页码

PageSize
Integer

10

分页页长

Filter
ListClustersFilter

null

筛选条件

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Items
Array of ClusterItem

[]

集群列表

TotalCount
Integer

1

集群总数

PageSize
Integer

10

分页页长

PageNumber
Integer

1

分页页码

请求示例

POST /?Action=ListClusters&Version=2021-03-04
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "IDs": ["ucxxxxxxxxxxxxxxxxxxx"],
        "Status": ["Running"],
        "Type": ["shared"],
        "Public": false,
        "Keyword": "test-cluster"
    }
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListClusters",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "ID": "ucxxxxxxxxxxxxxxxxxxx",
                "Name": "name",
                "Status": "Running",
                "StartTime": "1673525239",
                "Description": "description",
                "Bound": true,
                "Public": false,
                "SharedConfig": {},
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ParamErr
<透传错误内容>

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

500
InternalErr
<透传错误内容>

内部错误