查询节点属性

最近更新时间:2024-03-12 01:40:19

我的收藏

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口用于查询节点的属性,包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。

默认接口请求频率限制:3次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceNodeProperty。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
示例值:cmgo-p8vnipr5
NodeIds.N Array of String 节点ID。
示例值:["cmgo-6heje4jp_0-node-slave0","cmgo-6heje4jp_1-node-slave0"]
Roles.N Array of String 节点角色。可选值包括:
  • PRIMARY:主节点。
  • SECONDARY:从节点。
  • READONLY:只读节点。
  • ARBITER:仲裁节点。

示例值:PRIMARY
OnlyHidden Boolean 该参数指定节点是否为Hidden节点,默认为false。
示例值:false
Priority Integer 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
示例值:10
Votes Integer 该参数指定节点投票权。
  • 1:具有投票权。
  • 0:无投票权。

示例值:1
Tags.N Array of NodeTag 节点标签。

3. 输出参数

参数名称 类型 描述
Mongos Array of NodeProperty Mongos节点属性。
注意:此字段可能返回 null,表示取不到有效值。
ReplicateSets Array of ReplicateSetInfo 副本集节点信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例节点信息

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceNodeProperty
<公共请求参数>

{
    "InstanceId": "cmgo-by909vwp"
}

输出示例

{
    "Response": {
        "Mongos": [
            {
                "Address": "10.8.16.37:30000",
                "Hidden": false,
                "NodeName": "mongos-0",
                "Priority": 0,
                "ReplicateSetId": "",
                "Role": "MONGOS",
                "SlaveDelay": 0,
                "Status": "NORMAL",
                "Tags": null,
                "Votes": 0,
                "Zone": "ap-guangzhou-3"
            },
            {
                "Address": "10.8.16.37:30001",
                "Hidden": false,
                "NodeName": "mongos-1",
                "Priority": 0,
                "ReplicateSetId": "",
                "Role": "MONGOS",
                "SlaveDelay": 0,
                "Status": "NORMAL",
                "Tags": null,
                "Votes": 0,
                "Zone": "ap-guangzhou-3"
            },
            {
                "Address": "10.8.16.37:30002",
                "Hidden": false,
                "NodeName": "mongos-2",
                "Priority": 0,
                "ReplicateSetId": "",
                "Role": "MONGOS",
                "SlaveDelay": 0,
                "Status": "NORMAL",
                "Tags": null,
                "Votes": 0,
                "Zone": "ap-guangzhou-3"
            }
        ],
        "ReplicateSets": [
            {
                "Nodes": [
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_0-node-slave0",
                        "Priority": 1,
                        "ReplicateSetId": "cmgo-by909vwp_0",
                        "Role": "SECONDARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_0-node-primary",
                        "Priority": 1,
                        "ReplicateSetId": "cmgo-by909vwp_0",
                        "Role": "PRIMARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": true,
                        "NodeName": "cmgo-by909vwp_0-node-slave1",
                        "Priority": 0,
                        "ReplicateSetId": "cmgo-by909vwp_0",
                        "Role": "SECONDARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_0-node-readonly0",
                        "Priority": 0,
                        "ReplicateSetId": "cmgo-by909vwp_0",
                        "Role": "READONLY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "readonly-group"
                            }
                        ],
                        "Votes": 0,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_0-node-readonly1",
                        "Priority": 0,
                        "ReplicateSetId": "cmgo-by909vwp_0",
                        "Role": "READONLY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "readonly-group"
                            }
                        ],
                        "Votes": 0,
                        "Zone": "ap-guangzhou-3"
                    }
                ]
            },
            {
                "Nodes": [
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_1-node-slave0",
                        "Priority": 1,
                        "ReplicateSetId": "cmgo-by909vwp_1",
                        "Role": "SECONDARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_1-node-primary",
                        "Priority": 1,
                        "ReplicateSetId": "cmgo-by909vwp_1",
                        "Role": "PRIMARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": true,
                        "NodeName": "cmgo-by909vwp_1-node-slave1",
                        "Priority": 0,
                        "ReplicateSetId": "cmgo-by909vwp_1",
                        "Role": "SECONDARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_1-node-readonly0",
                        "Priority": 0,
                        "ReplicateSetId": "cmgo-by909vwp_1",
                        "Role": "READONLY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "readonly-group"
                            }
                        ],
                        "Votes": 0,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_1-node-readonly1",
                        "Priority": 0,
                        "ReplicateSetId": "cmgo-by909vwp_1",
                        "Role": "READONLY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "readonly-group"
                            }
                        ],
                        "Votes": 0,
                        "Zone": "ap-guangzhou-3"
                    },
                    {
                        "Address": "",
                        "Hidden": false,
                        "NodeName": "cmgo-by909vwp_1-node-slave2",
                        "Priority": 1,
                        "ReplicateSetId": "cmgo-by909vwp_1",
                        "Role": "SECONDARY",
                        "SlaveDelay": 0,
                        "Status": "NORMAL",
                        "Tags": [
                            {
                                "TagKey": "role-cmgo",
                                "TagValue": "primary-secondary-group"
                            }
                        ],
                        "Votes": 1,
                        "Zone": "ap-guangzhou-3"
                    }
                ]
            }
        ],
        "RequestId": "14ab088a-9d69-44b4-b39d-e4b8fbbb8f25"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.KernelResponseTimeout 内核响应超时。
InternalError 内部错误。
InternalError.CheckAppIdFailed appId校验失败。
InvalidParameter 参数错误。
InvalidParameter.PermissionDenied 当前子账号无权执行该操作。