获取节点列表

最近更新时间:2024-03-12 01:29:20

我的收藏

1. 接口描述

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

获取节点列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNode。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
Filters.N Array of Filter 过滤条件,name取值为: InstanceFamily-实例系列

3. 输出参数

参数名称 类型 描述
NodeSet Array of Node 节点详细信息的列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 所有的节点数量。
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看地域列表

查看地域列表

输入示例

https://ecm.tencentcloudapi.com/?Action=DescribeNode
&Filters.0.Name=InstanceFamily
&Filters.0.Values.0=SN3ne
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "187c16d5-1f53-4e88-b684-077f0c7123b2",
        "NodeSet": [
            {
                "ZoneInfo": {
                    "ZoneId": 10110001,
                    "ZoneName": "杭州一区",
                    "Zone": "ap-hangzhou-ecm-1"
                },
                "Country": {
                    "CountryId": "china",
                    "CountryName": "中国"
                },
                "Area": {
                    "AreaId": "china-east",
                    "AreaName": "华东"
                },
                "Province": {
                    "ProvinceId": "china-east-zhejiang",
                    "ProvinceName": "浙江"
                },
                "City": {
                    "CityId": "china-east-zhejiang-hangzhou",
                    "CityName": "杭州"
                },
                "RegionInfo": {
                    "RegionId": 1011,
                    "Region": "ap-hangzhou-ecm",
                    "RegionName": "杭州"
                },
                "ISPSet": [
                    {
                        "ISPId": "CMCC",
                        "ISPName": "移动"
                    },
                    {
                        "ISPId": "CUCC",
                        "ISPName": "联通"
                    },
                    {
                        "ISPId": "CTCC",
                        "ISPName": "电信"
                    },
                    {
                        "ISPId": "CTCC;CUCC;CMCC",
                        "ISPName": "三网"
                    }
                ],
                "ISPNum": 3
            },
            {
                "ZoneInfo": {
                    "ZoneId": 10510001,
                    "ZoneName": "深圳五区(电信)",
                    "Zone": "ap-shenzhen-ecm-ct2"
                },
                "Country": {
                    "CountryId": "china",
                    "CountryName": "中国"
                },
                "Area": {
                    "AreaId": "china-south",
                    "AreaName": "华南"
                },
                "Province": {
                    "ProvinceId": "china-south-guangdong",
                    "ProvinceName": "广东"
                },
                "City": {
                    "CityId": "china-south-guangdong-shenzhen",
                    "CityName": "深圳"
                },
                "RegionInfo": {
                    "RegionId": 1051,
                    "Region": "ap-shenzhen-ecm-ct2",
                    "RegionName": "深圳"
                },
                "ISPSet": [
                    {
                        "ISPId": "CTCC",
                        "ISPName": "电信"
                    }
                ],
                "ISPNum": 1
            }
        ],
        "TotalCount": 2
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
MissingParameter.MissingNodeParameter 节点操作参数不全。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。