获取拨测点组

最近更新时间:2025-05-07 01:12:55

我的收藏

1. 接口描述

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

获取拨测点组(可用性拨测点组、高级拨测点组、我的拨测点组)

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNodeGroups。
Version String 公共参数,本接口取值:2018-04-09。
Region String 公共参数,此参数为可选参数。
NodeType.N Array of Integer 节点类型。0: 全部 1: IDC 2: LastMile 3: Mobile,不填默认为0
示例值:[1, 2]
TaskCategory Integer 节点分类。0: 全部 1: PC 2:Mobile,不填默认为0。PC分类包括IDC和LM节点类型,Mobile分类包括Mobile节点类型。与NodeType参数取交集。
示例值:1
IPType Integer IP类型。0: 全部 1: IPv4 2: IPv6,不填默认为0
示例值:1
Name String 拨测点描述关键词。
示例值:广州
RegionID Integer 地域ID。0: 精选拨测点 1: 国内 2: 港澳台 3: 亚太 4: 欧洲与美洲 5: 非洲与大洋洲,不填默认为0
示例值:1
DistrictID Integer 省份或国家ID。0表示全部,不填默认为0
示例值:1
NetServiceID Integer 运营商ID。0: 全部 1: 中国电信 2: 中国联通 3: 中国移动 99: 其他,不填默认为0
示例值:1
NodeGroupType Integer 节点组类型。0: 高级拨测点组 1: 可用性节点 2: 我的拨测点组,不填默认为0
示例值:1
TaskType Integer 任务类型,如1、2、3、4、5、6、7;1-页面性能、2-文件上传、3-文件下载、4-端口性能、5-网络质量、6-音视频体验、7-域名whois,不填默认为0,不对任务类型做过滤
示例值:1
ProbeType Integer 测试类型,包含定时测试与即时测试。0-定时拨测,其它表示即时拨测。
示例值:1

3. 输出参数

参数名称 类型 描述
NodeList Array of NodeTree 树状节点列表,总共两级
注意:此字段可能返回 null,表示取不到有效值。
DistrictList Array of DistinctOrNetServiceInfo 省份或国家列表
注意:此字段可能返回 null,表示取不到有效值。
NetServiceList Array of DistinctOrNetServiceInfo 运营商列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取拨测点组

获取拨测点组

输入示例

POST / HTTP/1.1
Host: cat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNodeGroups
X-TC-Language: zh-CN
<公共请求参数>

{
    "RegionID": 1,
    "NetServiceID": 99
}

输出示例

{
    "Response": {
        "DistrictList": [
            {
                "ID": "0",
                "Name": "全部"
            },
            {
                "ID": "1100100",
                "Name": "黑龙江"
            }
        ],
        "NetServiceList": [
            {
                "ID": "0",
                "Name": "全部"
            },
            {
                "ID": "99",
                "Name": "其他"
            }
        ],
        "NodeList": [
            {
                "ID": "1102700",
                "Content": "黑龙江",
                "Children": [
                    {
                        "ID": "1102701",
                        "Content": "哈尔滨市",
                        "Children": [
                            {
                                "ID": "11537",
                                "Content": "黑龙江-哈尔滨市-广电宽带[LM]"
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "fyy3-g7ujmxbouxshy3plmkmhlnmdbfh"
    }
}

示例2 获取定时任务拨测点组

获取定时任务中网络质量任务类型,PC类任务的可用性拨测点组

输入示例

POST / HTTP/1.1
Host: cat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNodeGroups
X-TC-Language: zh-CN
<公共请求参数>

{
    "NodeGroupType": 1,
    "IPType": 0,
    "NodeType": [
        1
    ],
    "TaskType": 5,
    "ProbeType": 0
}

输出示例

{
    "Response": {
        "DistrictList": [],
        "NetServiceList": [],
        "NodeList": [
            {
                "ID": "PC",
                "Content": "PC",
                "Children": [
                    {
                        "ID": "125",
                        "Content": "国内区域可用性探测",
                        "Children": [
                            {
                                "ID": "12136",
                                "Content": "广东-深圳市[IDC]"
                            }
                        ]
                    },
                    {
                        "ID": "126",
                        "Content": "国内十大城市",
                        "Children": [
                            {
                                "ID": "12136",
                                "Content": "广东-深圳市[IDC]"
                            }
                        ]
                    },
                    {
                        "ID": "127",
                        "Content": "国内主要城市运营商",
                        "Children": [
                            {
                                "ID": "12058",
                                "Content": "广东-广州市-中国移动[IDC]"
                            }
                        ]
                    },
                    {
                        "ID": "141",
                        "Content": "海外主要城市",
                        "Children": [
                            {
                                "ID": "12170",
                                "Content": "美国-弗吉尼亚州[IDC]"
                            }
                        ]
                    },
                    {
                        "ID": "142",
                        "Content": "港澳台主要城市",
                        "Children": [
                            {
                                "ID": "12181",
                                "Content": "香港-香港特区[IDC]"
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "3ea82ed9-5901-4c69-b5e2-c4c84c9538e5"
    }
}

示例3 获取即时拨测拨测点组

获取即时拨测任务中网络质量任务类型,PC类任务的精选拨测点组

输入示例

POST / HTTP/1.1
Host: cat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNodeGroups
X-TC-Language: zh-CN
<公共请求参数>

{
    "NodeGroupType": 0,
    "TaskCategory": 1,
    "IPType": 0,
    "NodeType": [
        1,
        2
    ],
    "TaskType": 5,
    "ProbeType": 1
}

输出示例

{
    "Response": {
        "DistrictList": [],
        "NetServiceList": [
            {
                "ID": "0",
                "Name": "全部"
            }
        ],
        "NodeList": [
            {
                "ID": "IDC",
                "Content": "IDC",
                "Children": [
                    {
                        "ID": "560",
                        "Content": "境内主要城市运营商",
                        "Children": [
                            {
                                "ID": "10000",
                                "Content": "北京-北京市-中国电信[IDC]"
                            }
                        ]
                    }
                ]
            },
            {
                "ID": "LastMile",
                "Content": "LastMile",
                "Children": [
                    {
                        "ID": "27",
                        "Content": "省会城市-电信(Last Mile)",
                        "Children": [
                            {
                                "ID": "10103",
                                "Content": "北京-北京市-中国电信[LM]"
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "248cfe54-6cb6-46c7-b73d-9c78108add00"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
UnknownParameter 未知参数错误。