1. 接口描述
接口请求域名: cat.tencentcloudapi.com 。
查询拨测节点
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProbeNodes。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-09。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
NodeType | 否 | Integer | 节点类型 示例值:1 |
Location | 否 | Integer | 节点区域 示例值:1 |
IsIPv6 | 否 | Boolean | 是否IPv6 示例值:false |
NodeName | 否 | String | 名字模糊搜索 示例值:沈阳 |
PayMode | 否 | Integer | 付费模式 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NodeSet | Array of NodeDefine | 节点列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"Code":1000, "Type":1, "Name":"北京"}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询拨测节点
查询拨测节点
输入示例
POST / HTTP/1.1
Host: cat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProbeNodes
<公共请求参数>
{
"NodeType": 0,
"Location": 0,
"IsIPv6": true,
"NodeName": "广东",
"PayMode": 0
}
输出示例
{
"Response": {
"NodeSet": [
{
"Name": "北京-北京市-中国电信[IDC]",
"Code": "10000",
"Type": 1,
"NetService": "中国电信",
"District": "北京",
"City": "北京市",
"IPType": 1,
"Location": 1,
"CodeType": "",
"NodeDefineStatus": 1
}
],
"RequestId": "avb"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DbQueryFailed | 数据库查询错误。 |
InvalidParameter | 参数错误。 |