查询集群列表
更新时间：2023-07-05
该接口用于查询用户在该区域中所有使用中的集群列表信息。
请求结构
GET /v{version}/clusters HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，需要设置为集群ID |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000，缺省值为1000 |
| clusterName | String | 否 | Query参数 | 集群名模糊匹配 |
| state | String | 否 | Query参数 | 用于指定查询的集群状态，具体可选状态参见ClusterState。如果不传入该参数，则表示查询所有状态的集群。 |
| mode | String | 否 | Query参数 | 集群部署模式，可选的值为HA（高可用），HP（高性能） |
| kafkaVersion | String | 否 | Query参数 | 集群的版本，当前取值：2.7.2 |
| payment | String | 否 | Query参数 | 付费方式，可选的值为：Prepaid（预付费）和 Postpaid（后付费） |
| tagKey | String | 否 | Query参数 | 集群标签键，集群资源标签键为 KAFKA-Cluster |
| tagValue | String | 否 | Query参数 | 集群标签值 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置，与请求接口时传入的marker参数值保持一致 |
| maxKeys | int | 每页包含的最大数量，，最大数量不超过1000，缺省值为1000 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 下一页所需要传递的marker值，当isTruncated为false时，该值为null |
| clusters | List<Cluster> | 集群信息列表，由 Cluster 组成的集合 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
GET http://kafka-api.bj.baidubce.com/v2/clusters
Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
Host: kafka-api.bj.baidubce.com返回示例
HTTP/1.1 200 OK
x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
Date: Mon, 08 May 2023 09:39:11 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"marker": null,
"isTruncated": false,
"nextMarker": null,
"maxKeys": 1000,
"clusters": [
{
"clusterId": "33a168bb70c0459787416077114ab233",
"clusterSid": "kafka-o8uu8JKS",
"name": "demo",
"region": "bj"
"type": "PROVISIONED",
"mode":"HP",
"state": "ACTIVE",
"kafkaVersion": "2.7.2",
"logicalZones": [
"cn-fwh-a"
],
"payment": "Postpaid",
"aclEnabled": true,
"publicIpEnabled": false,
"intranetIpEnabled": false,
"authenticationModes": [
"NONE",
"SASL_SCRAM"
],
"tags": [
{
"tagKey": "KAFKA-Cluster",
"tagValue": ""
}
],
"createTime": "2023-05-10T03:06:01Z",
"expireTime": -1
}
]
}