调用DescribeSiteMonitorISPCityList接口查询所有运营商探测点详情。

本文将提供一个示例,查询运营商“联通”在“贵阳市”的探测点详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSiteMonitorISPCityList

要执行的操作,取值:DescribeSiteMonitorISPCityList

Isp String 联通

运营商探测点的名称或ID。

说明 运营商名称支持模糊查询。
City String 贵阳市

运营商探测点所在城市的名称或ID。

说明 城市名称支持模糊查询。
IPV6 Boolean true

是否查询IPv6探针。取值:

  • true(默认值):查询IPv6探针。
  • false:不查询IPv6探针。
IPV4 Boolean true

是否查询IPv4探针。取值:

  • true(默认值):查询IPv4探针。
  • false:不查询IPv4探针。
ViewAll Boolean true

是否返回所有探测点。取值:

  • true(默认值):返回所有探测点。
  • false:只返回可用探测点。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
Message String successful

返回信息。

RequestId String B35D7D84-547B-4E61-B909-48A1F8A0C756

请求ID。

Success String true

操作是否成功。取值:

  • true:成功。
  • false:失败。
IspCityList Array of IspCity

探测点列表。

IspCity
CityName.en String Guiyang

城市名称(英文)。

IPV4ProbeCount String 4

IPv4探针数量。

City String 4

城市ID。

Isp String 232

运营商ID。

CityName.zh_CN String 贵阳市

城市名称(简体中文)。

说明 该参数仅适用于中国站。
Region.zh_CN String 贵州省

省份(简体中文)。

说明 该参数仅适用于中国站。
IspName.zh_CN String 联通

运营商名称(简体中文)。

说明 该参数仅适用于中国站。
Country.en String China

国家(英文)。

IPV6ProbeCount String 3

IPv6探针数量。

Region String 264

省份代码。

Country String 629

国家代码。

IspName.en String China-Unicom

运营商名称(英文)。

Region.en String Guizhou

省份(英文)。

Country.zh_CN String 中国

国家(简体中文)。

说明 该参数仅适用于中国站。
Area.zh_CN String 西南

区域(简体中文)。

说明 该参数仅适用于中国站。
Area.en String XiNan

区域(汉语拼音)。

IPPool Array of String ["192.68.XX.XX","192.68.XX.XX"]

IP地址池。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSiteMonitorISPCityList
&Isp=联通
&City=贵阳市
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSiteMonitorISPCityListResponse>
	<Message>successful</Message>
	<RequestId>B35D7D84-547B-4E61-B909-48A1F8A0C756</RequestId>
	<Code>200</Code>
	<Success>true</Success>
	<IspCityList>
		<IspCity>
			<Country.zh_CN>中国</Country.zh_CN>
			<Area.zh_CN>西南</Area.zh_CN>
			<CityName.en>Guiyang</CityName.en>
			<IPV4ProbeCount>4</IPV4ProbeCount>
			<Isp>232</Isp>
			<City>4</City>
			<IspName.en>China-Unicom</IspName.en>
			<Country.en>China</Country.en>
			<IPV6ProbeCount>0</IPV6ProbeCount>
			<CityName.zh_CN>贵阳市</CityName.zh_CN>
			<Area.en>XiNan</Area.en>
			<Region.zh_CN>贵州省</Region.zh_CN>
			<APIProbeCount>0</APIProbeCount>
			<Region>264</Region>
			<Country>629</Country>
			<IspName.zh_CN>联通</IspName.zh_CN>
			<Region.en>Guizhou</Region.en>
			<IPPool>
				<IPPool>192.168.XX.XX</IPPool>
				<IPPool>192.168.XX.XX</IPPool>
			</IPPool>
		</IspCity>
	</IspCityList>
</DescribeSiteMonitorISPCityListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "successful",
  "RequestId" : "B35D7D84-547B-4E61-B909-48A1F8A0C756",
  "Code" : "200",
  "Success" : true,
  "IspCityList" : {
    "IspCity" : [ {
      "Country.zh_CN" : "中国",
      "Area.zh_CN" : "西南",
      "CityName.en" : "Guiyang",
      "IPV4ProbeCount" : 4,
      "Isp" : "232",
      "City" : "4",
      "IspName.en" : "China-Unicom",
      "Country.en" : "China",
      "IPV6ProbeCount" : 0,
      "CityName.zh_CN" : "贵阳市",
      "Area.en" : "XiNan",
      "Region.zh_CN" : "贵州省",
      "APIProbeCount" : 0,
      "Region" : "264",
      "Country" : "629",
      "IspName.zh_CN" : "联通",
      "Region.en" : "Guizhou",
      "IPPool" : {
        "IPPool" : [ "192.168.XX.XX", "192.168.XX.XX" ]
      }
    } ]
  }
}

错误码

访问错误中心查看更多错误码。