查询集群与操作记录
更新时间：2026-07-31
本页覆盖查询集群列表、查询集群详情和查询操作记录接口。公共约定、状态枚举和错误响应见集群生命周期 OpenAPI。
查询集群列表
分页查询当前账号下的 TSDB 专享版集群，并按名称、集群 ID 或状态筛选。
Http
1GET /v1/dedicated/cluster?pageNo=1&pageSize=20&keyword=prod&statuses=Running&statuses=CreatingQuery 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
pageNo |
number | 否 | 页码，从 1 开始，默认 1。 |
pageSize |
number | 否 | 每页数量，默认 20，最大 100。 |
keyword |
string | 否 | 按集群名称或集群 ID 筛选。 |
statuses |
array | 否 | 按集群状态筛选。多个状态使用重复 Query 参数。 |
响应结构
JSON
1{
2 "items": [],
3 "totalCount": 0,
4 "pageNo": 1,
5 "pageSize": 20
6}items 中是集群摘要，节点等详情字段可能省略。页码超出数据范围时，items 为空，
totalCount 仍返回筛选后的集群总数，pageNo 和 pageSize 返回本次请求对应的分页值。
查询集群详情
查询指定 TSDB 专享版集群的资源、网络、版本、计费、访问地址和当前操作进度。
Http
1GET /v1/dedicated/cluster/{clusterId}Path 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
clusterId |
string | 是 | 集群 ID。 |
响应示例
JSON
1{
2 "cluster": {
3 "clusterId": "tsdb-cl-abc123",
4 "clusterName": "prod-tsdb",
5 "status": "Running",
6 "statusText": "运行中",
7 "progress": {
8 "operation": "cluster.create",
9 "stage": "Ready",
10 "stageText": "已就绪",
11 "percent": 100
12 },
13 "region": "bj",
14 "vpcId": "vpc-abc123",
15 "zones": ["cn-bj-a", "cn-bj-b", "cn-bj-c"],
16 "subnets": [{"zoneName": "cn-bj-a", "subnetId": "sbn-a"}],
17 "nodeCount": 3,
18 "specCode": "tsdb.c8m32",
19 "storageUsedBytes": 0,
20 "version": "3.1.0",
21 "upgrade": {
22 "upgradeable": true,
23 "recommendedVersion": "3.1.1",
24 "targetVersion": null,
25 "inProgress": false
26 },
27 "billing": {
28 "paymentTiming": "Prepaid",
29 "expireAt": "2026-08-08T00:00:00Z",
30 "autoRenew": false
31 },
32 "access": {
33 "privateEndpoint": "<private-endpoint>",
34 "port": 80,
35 "publicAccessStatus": "Unbound",
36 "publicIp": null,
37 "eipId": null
38 },
39 "adminToken": {
40 "state": "initialized",
41 "lastIssuedAt": "2026-07-08T10:00:00Z",
42 "lastIssuedBy": "user-id",
43 "operationInProgress": false
44 },
45 "nodes": [],
46 "createdAt": "2026-07-08T10:00:00Z"
47 }
48}调用异步操作后，应同时检查 status、progress.stage 和操作记录。不要仅根据 HTTP 请求成功判断集群已达到目标状态。
示例中的版本号、连接地址和资源数据仅用于说明响应结构。连接时应使用当前响应中的 access.privateEndpoint 和 access.port；不要根据集群 ID 拼接连接地址。
查询操作记录
分页查询指定集群的创建、变配、升级、公网访问等操作记录，并按操作类型、分类或状态筛选。
Http
1GET /v1/dedicated/cluster/{clusterId}/operations?pageNo=1&pageSize=20&operationCategory=cluster&status=successPath 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
clusterId |
string | 是 | 集群 ID。 |
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
pageNo |
number | 否 | 页码，从 1 开始，默认 1。 |
pageSize |
number | 否 | 每页数量，默认 20，最大 100。 |
operationType |
string | 否 | 按具体操作类型精确过滤，例如 cluster.create、cluster.resize、cluster.upgrade、token.issue、token.reset、eip.bind 或 eip.unbind。 |
operationCategory |
string | 否 | 按操作分类过滤，可选 cluster、token、eip 或 maintenance。 |
status |
string | 否 | trying、success 或 failed。 |
operationType 和 operationCategory 描述同一类过滤能力，一次请求只能提供其中一个；同时提供或传入未知值会返回参数错误。
响应示例
JSON
1{
2 "items": [
3 {
4 "operationId": "123",
5 "operationType": "cluster.create",
6 "operationText": "创建集群",
7 "operator": "user-id",
8 "status": "success",
9 "statusText": "成功",
10 "paramsSummary": "规格 tsdb.c8m32，3 节点",
11 "failureReason": null,
12 "operatedAt": "2026-07-08T10:00:00Z"
13 }
14 ],
15 "totalCount": 1,
16 "pageNo": 1,
17 "pageSize": 20
18}当异步操作长时间未完成或失败时，请保存 operationId、operationType、failureReason 和请求错误中的 requestId。
操作记录按操作时间倒序返回。paramsSummary 是脱敏后的参数摘要，failureReason 只在失败时返回，二者均不包含访问令牌、密码、STS 凭证或签名 URL。操作记录的 status 表示系统是否已接受用户请求；创建、变配、升级和删除的执行结果仍以集群状态和进度为准。
评价此篇文章