ListClusters - 集群列表--ByteHouse 企业版-火山引擎

文档中心

立即注册

ByteHouse 企业版

集群管理

ListClusters - 集群列表

集群列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListClusters	要执行的操作，取值：ListClusters。
Version	String	是	2025-05-31	API的版本，取值：2025-05-31。
TagFilters.N.Key	Array of String	否	TagFilters.1.Key=k1	标签过滤：Key
TagFilters.N.Values.N	Array of String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2	标签过滤：Value
Offset	String	否	0	分页位置索引
Limit	String	否	1000	分页条数
ProjectName	String	否	default	项目

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	[ { "Project": "default", "PrivateAddress": "2000000**********.bytehouse-ce.ivolces.com", "EnableRowPolicy": false, "ID": 1459, "Status": "RUNNING", "CreatedAt": "2025-12-09T09:21:02.01Z", "BHCEID": "Bytehouse_enterprise2000000********", "EnableCommonTable": false, "RegionID": "cn-beijing", "Description": "", "LastModifiedAt": "2025-12-09T09:24:51.49Z", "Tags": [], "Name": "bytehouse_cluster_k751", "AccountID": 2100****, "PublicAddress": " " } ]	集群列表
Meta	Object	{ "Offset": 0, "Total": 1 }	分页信息

请求示例

GET /?Action=ListClusters&Version=2025-05-31 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20250516T065208Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250516/cn-beijing/bytehouse_ce_rc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250516145218227193220112351748",
    "Action": "ListClusters",
    "Version": "2025-05-31",
    "Service": "bytehouse_ce",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "ID": 635,
        "Name": "bytehouse_cluster",
        "RegionID": "cn-shanghai",
        "Project": "mvZsC8",
        "PrivateAddress": "D",
        "PublicAddress": "UrA9Cy",
        "EnableCommonTable": false,
        "EnableRowPolicy": false,
        "CreatedAt": "2025-05-09T04:11:09.527Z",
        "LastModifiedAt": "2025-05-09T04:28:20.529Z"
      }
    ],
    "Meta": {
      "Offset": 390,
      "Total": 754
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	Bad Request	api service received invalid request format	参数错误
500	InternalError	The request has failed due to an unknown error.

最近更新时间：2026.01.06 10:38:00

这个页面对您有帮助吗？

有用

无用