查询实例的组件列表
调试
您可以在API Explorer中调试该接口。
URI
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|
project_id |
String |
是 |
租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 |
instance_id |
String |
是 |
实例ID。 |
limit |
Integer |
否 |
查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。 |
offset |
Integer |
否 |
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 |
component_type |
String |
否 |
组件类型，过滤拿到需要的组件类型的组件信息，默认为ALL。传参数会查询对应组件信息， "ALL": 查询所有组件类型。 "CM": 查询CMS组件类型。枚举值：
|
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，用于区分是否是同一个分片下的组件。其他组件为空字符串。 |
请求示例
查询实例的组件列表。
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": ""
},
{
"id": "etcd_7001",
"role": "master",
"status": "StateLeader",
"distributed_id": ""
},
{
"id": "dn_6001",
"role": "master",
"status": "Primary",
"distributed_id": "60011"
}
],
"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": ""
},
{
"id": "etcd_7003",
"role": "slave",
"status": "StateFollower",
"distributed_id": ""
},
{
"id": "dn_6003",
"role": "slave",
"status": "Standby",
"distributed_id": "60011"
}
],
"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": ""
},
{
"id": "etcd_7002",
"role": "slave",
"status": "StateFollower",
"distributed_id": ""
},
{
"id": "dn_6002",
"role": "slave",
"status": "Standby",
"distributed_id": "60011"
}
],
"id": "d6c6c6e6b48c41d79d99d7240751d744no14",
"name": "gauss-9e1a_root_1",
"availability_zone_id": "cn-southwest-244a",
"description": "az1",
"status": "normal"
}
],
"total_count": 3
}
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
