更新时间：2025-10-14 GMT+08:00
查询实例的组件列表
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/{instance_id}/components
|
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
|
instance_id |
String |
是 |
参数解释： 实例ID，此参数是用户创建实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 |
|
limit |
Integer |
否 |
参数解释： 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 约束限制： 不涉及。 取值范围： 最小值为1，最大值为100。 默认取值： 100 |
|
offset |
Integer |
否 |
参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 约束限制： 必须为数字，不能为负数。 取值范围： 最小值为1，最大值为100。 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 |
|
component_type |
String |
否 |
参数解释： 组件类型，过滤拿到需要的组件类型的组件信息。传参数会查询对应组件信息。 约束限制： 不涉及。 取值范围：
默认取值： ALL |
|
availability_zone_id |
String |
否 |
参数解释： 主组件所在可用区编号，筛选符合条件的组件，默认为ALL，查询实例所有可用区上的节点的组件信息。 当调用接口传入可用区编号时： 相对于DN组件，会查询出的DN分片中的主组件在该可用区上的这个分片的所有副本的组件信息。 相对于CN组件，CN组件没有主备关系，会查询出该可用区上的CN组件信息。 相对于其他组件，会查询该可用区上有没有某个组件类型的主组件，有则会返回该组件类型的所有组件信息，没有则不返回该组件类型的信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值 |
请求参数
无。
响应参数
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
nodes |
Array of objects |
参数解释： 组件详情。 详情请参见表3。 |
|
total_count |
Integer |
参数解释： 总记录数。 取值范围： 不涉及。 |
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
id |
String |
参数解释： 节点ID。 取值范围： 不涉及。 |
|
components |
Array of objects |
该实例节点下的组件信息列表，详情请参见表4。 |
|
name |
String |
参数解释： 节点名称。 取值范围： 不涉及。 |
|
availability_zone_id |
String |
参数解释： 节点所在可用区编码。 取值范围： 不涉及。 |
|
description |
String |
参数解释： 可用区描述信息。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 节点状态。 取值范围： 不涉及。 |
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
id |
String |
参数解释： 组件ID。 取值范围：
|
|
role |
String |
参数解释： 节点角色。 取值范围：
|
|
status |
String |
参数解释： 组件状态。 取值范围：
|
|
distributed_id |
String |
参数解释： 分组ID，只有DN组件有分组DN，用于区分是否是同一个分片下的组件。其他组件为空字符串。 取值范围： 不涉及。 |
|
type |
String |
参数解释： 节点类型。 取值范围：
|
|
detail |
String |
参数解释： 详情。 取值范围： 不涉及。 |
请求示例
查询实例的组件列表。
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/components
响应示例
查询集中式版实例组件列表。
{
"nodes": [
{
"components": [
{
"id": "cm_1",
"role": "master",
"status": "Primary",
"distributed_id": "",
"type" : "CM",
"detail" : ""
},
{
"id": "etcd_7001",
"role": "master",
"status": "StateLeader",
"distributed_id": "",
"type" : "ETCD",
"detail" : ""
},
{
"id": "dn_6001",
"role": "master",
"status": "Primary",
"distributed_id": "60011",
"type" : "DN",
"detail" : "Normal"
}
],
"id": "7d19f72f8f514564bd92962a6fbddb7dno14",
"name": "gauss-9e1a_root_0",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "cm_3",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type" : "CM",
"detail" : ""
},
{
"id": "etcd_7003",
"role": "slave",
"status": "StateFollower",
"distributed_id": "",
"type" : "ETCD",
"detail" : ""
},
{
"id": "dn_6003",
"role": "slave",
"status": "Standby",
"distributed_id": "60011",
"type" : "DN",
"detail" : "Normal"
}
],
"id": "aafc2e14234d4c9eadb481fb0a09a865no14",
"name": "gauss-9e1a_root_2",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "cm_2",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type" : "CM",
"detail" : ""
},
{
"id": "etcd_7002",
"role": "slave",
"status": "StateFollower",
"distributed_id": "",
"type" : "ETCD",
"detail" : ""
},
{
"id": "dn_6002",
"role": "slave",
"status": "Standby",
"distributed_id": "60011",
"type" : "DN",
"detail" : "Normal"
}
],
"id": "d6c6c6e6b48c41d79d99d7240751d744no14",
"name": "gauss-9e1a_root_1",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
}
],
"total_count": 3
}
查询分布式独立部署实例组件列表。
{
"nodes": [
{
"components": [
{
"id": "cn_5001",
"role": "master",
"status": "Normal",
"distributed_id": "",
"type": "CN",
"detail": ""
}
],
"id": "e0c39a9b9e91421cacbfbf75c47e0c9dno14",
"name": "gauss-6b36_gaussdbv5cn_0",
"hostname": null,
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "gtm_1002",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type": "GTM",
"detail": "Connection ok"
}
],
"id": "a19a1844ab93407489d8a63ca298f908no14",
"name": "gauss-6b36_gaussdbv5gtm_0",
"hostname": null,
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "gtm_1003",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type": "GTM",
"detail": "Connection ok"
}
],
"id": "fd949ad6b00c4d72b7af5f015817d4d9no14",
"name": "gauss-6b36_gaussdbv5gtm_1",
"hostname": null,
"availability_zone_id": "cn-southwest-244b",
"description": "az2",
"status": "normal"
},
{
"components": [
{
"id": "cm_2",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type": "CM",
"detail": ""
},
{
"id": "etcd_7002",
"role": "slave",
"status": "StateFollower",
"distributed_id": "",
"type": "ETCD",
"detail": ""
}
],
"id": "ac7e24fc9626479c96ab6215f2107faeno14",
"name": "gauss-6b36_gaussdbv5cms_1",
"hostname": null,
"availability_zone_id": "cn-southwest-244b",
"description": "az2",
"status": "normal"
},
{
"components": [
{
"id": "dn_6001",
"role": "master",
"status": "Primary",
"distributed_id": "60011",
"type": "DN",
"detail": "Normal"
}
],
"id": "0989068696f94631a45b3f2b13ac7810no14",
"name": "gauss-6b36_gaussdbv5dn1_0",
"hostname": null,
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "cm_1",
"role": "master",
"status": "Primary",
"distributed_id": "",
"type": "CM",
"detail": ""
},
{
"id": "etcd_7001",
"role": "master",
"status": "StateFollower",
"distributed_id": "",
"type": "ETCD",
"detail": ""
}
],
"id": "912ca1f9f12f41968d60d82a7f630bedno14",
"name": "gauss-6b36_gaussdbv5cms_2",
"hostname": null,
"availability_zone_id": "cn-southwest-244c",
"description": "az3",
"status": "normal"
},
{
"components": [
{
"id": "dn_6002",
"role": "slave",
"status": "Standby",
"distributed_id": "60011",
"type": "DN",
"detail": "Normal"
}
],
"id": "365261e60ac14dff846480e8cc555d66no14",
"name": "gauss-6b36_gaussdbv5dn1_1",
"hostname": null,
"availability_zone_id": "cn-southwest-244b",
"description": "az2",
"status": "normal"
},
{
"components": [
{
"id": "dn_6003",
"role": "slave",
"status": "Standby",
"distributed_id": "60011",
"type": "DN",
"detail": "Normal"
}
],
"id": "3ce7e13a25524e7b81d78cad9afd9464no14",
"name": "gauss-6b36_gaussdbv5dn1_2",
"hostname": null,
"availability_zone_id": "cn-southwest-244c",
"description": "az3",
"status": "normal"
},
{
"components": [
{
"id": "cm_3",
"role": "slave",
"status": "Standby",
"distributed_id": "",
"type": "CM",
"detail": ""
},
{
"id": "etcd_7003",
"role": "slave",
"status": "StateLeader",
"distributed_id": "",
"type": "ETCD",
"detail": ""
}
],
"id": "e0deb77337604d149a76ce02b5060d86no14",
"name": "gauss-6b36_gaussdbv5cms_0",
"hostname": null,
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
},
{
"components": [
{
"id": "gtm_1001",
"role": "master",
"status": "Primary",
"distributed_id": "",
"type": "GTM",
"detail": "Connection ok"
}
],
"id": "9a88dc2a3f3e4f8c844f86dc032fde84no14",
"name": "gauss-6b36_gaussdbv5gtm_2",
"hostname": null,
"availability_zone_id": "cn-southwest-244c",
"description": "az3",
"status": "normal"
}
],
"total_count": 10
}
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
父主题： 实例管理
