调用DescribeSyntheticProbeList接口查询拨测节点列表。
接口说明
本文将提供一个示例,查询运营商“联通”在“北京市”的探测点详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
 调试
        
            调试
        
    
授权信息
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
| cms:DescribeSyntheticProbeList | none | *全部资源 
 | 无 | 无 | 
请求语法
GET  HTTP/1.1请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
| Isp | string | 否 | 运营商探测点的名称或 ID。 | 联通 | 
| City | string | 否 | 运营商探测点所在城市的名称或 ID。 | 北京市 | 
| Ipv4 | boolean | 否 | 只展示 ipv4 节点。 | false | 
| Ipv6 | boolean | 否 | 只展示 ipv6 节点。 | false | 
| ViewAll | boolean | 否 | 是否返回所有探测点。取值: 
 | true | 
| MbProbe | boolean | 否 | 只查询移动端探测点。 | false | 
| LmProbe | boolean | 否 | 只查询 Lastmile 网民家宽节点。 | false | 
| IdcProbe | boolean | 否 | 只查询 IDC 机房探测点。 | false | 
返回参数
| 名称 | 类型 | 描述 | 示例值 | 
| object | Schema of Response | ||
| Code | string | 状态码。 | 200 | 
| IspCityList | array<object> | 探测点列表。 | |
| object | 探测点列表。 | ||
| AreaCn | string | 大区中文。 | 华北 | 
| AreaEn | string | 大区英文。 | Huabei | 
| City | string | 城市 ID。 | 738 | 
| CityCn | string | 城市中文。 | 北京 | 
| CityEn | string | 城市英文。 | Beijing | 
| Country | string | 国家代码。 | 629 | 
| CountryCn | string | 国家中文。 | 中国 | 
| CountryEn | string | 国家(或地区)英文 | China | 
| IpPool | array | 节点 ip 列表。 | |
| string | 节点 ip。 | 1.1.1.1 | |
| Isp | string | 运营商 ID。 | 232 | 
| IspCn | string | 运营商中文。 | 联通 | 
| IspEn | string | 运营商英文。 | China-Unicom | 
| LmProbeCount | integer | lastmile 探测点数量。 | 1 | 
| MbProbeCount | integer | 移动端探测点数量。 | 1 | 
| Region | string | 省份代码。 | 264 | 
| RegionCn | string | 省份中文。 | 江西省 | 
| RegionEn | string | 省份英文。 | Jiangxi | 
| IdcV4ProbeCount | integer | idc ipv4 节点数量。 | 1 | 
| IdcV6ProbeCount | integer | idc ipv6 节点数量。 | 1 | 
| Message | string | 错误信息。 | The specified resource is not found. | 
| RequestId | string | 请求 ID。 | 87170bc7-e28a-4c93-b9bf-90a1dbe84736 | 
| Success | string | 操作是否成功。取值:true:成功。false:失败。 | true | 
示例
正常返回示例
JSON格式
{
  "Code": "200",
  "IspCityList": [
    {
      "AreaCn": "华北",
      "AreaEn": "Huabei",
      "City": "738",
      "CityCn": "北京",
      "CityEn": "Beijing",
      "Country": "629",
      "CountryCn": "中国",
      "CountryEn": "China",
      "IpPool": [
        "1.1.1.1"
      ],
      "Isp": "232",
      "IspCn": "联通",
      "IspEn": "China-Unicom",
      "LmProbeCount": 1,
      "MbProbeCount": 1,
      "Region": "264",
      "RegionCn": "江西省",
      "RegionEn": "Jiangxi",
      "IdcV4ProbeCount": 1,
      "IdcV6ProbeCount": 1
    }
  ],
  "Message": "The specified resource is not found.",
  "RequestId": "87170bc7-e28a-4c93-b9bf-90a1dbe84736",
  "Success": "true"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 400 | InvalidParameterValue | Illegal parameters. | 参数错误。 | 
| 401 | AccessDeniedException | You donot have sufficient access to perform this action. | |
| 500 | InternalUnknownError | The request processing has failed due to some unknown error. | 服务运行错误。 | 
| 402 | LimitExceeded | The quota for this customer had been reached. | |
| 403 | Forbidden | You are not authorized to operate the specified resource. | 没有权限,请使用RAM进行授权 | 
| 406 | ExceedingQuota | Exceeding quota limits. | 任务数量超出限额 | 
| 429 | ThrottlingException | The request was denied due to request throttling. | 
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。