Queries the detection points that are provided by carriers.

This topic provides an example on how to query the detection points that are provided by China Unicom in Guiyang.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSiteMonitorISPCityList

The operation that you want to perform. Set the value to DescribeSiteMonitorISPCityList.

Isp String No China Unicom

The name or ID of the carrier.

Note Carrier names support fuzzy match.
City String No Guiyang

The name or ID of the city.

Note City names support fuzzy match.
IPV6 Boolean No true

Specifies whether to query IPv6 probes. Valid values:

  • true (default value): IPv6 probes are queried.
  • false: IPv6 probes are not queried.
IPV4 Boolean No true

Specifies whether to query IPv4 probes. Valid values:

  • true (default value): IPv4 probes are queried.
  • false: IPv4 probes are not queried.
ViewAll Boolean No true

Specifies whether to return all detection points. Valid values:

  • true (default value): returns all detection points.
  • false: returns only available detection points.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Message String successful

The returned message.

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

The ID of the request.

Success String true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
IspCityList Array of IspCity

The detection points.

IspCity
CityName.en String Guiyang

The name of the city.

IPV4ProbeCount String 4

The number of IPv4 probes.

City String 4

The ID of the city.

Isp String 232

The ID of the carrier.

CityName.zh_CN String Guiyang

The name of the city.

Note This parameter can be returned only on the China site (aliyun.com).
Region.zh_CN String Guizhou

The name of the province.

Note This parameter can be returned only on the China site (aliyun.com).
IspName.zh_CN String China Unicom

The name of the carrier.

Note This parameter can be returned only on the China site (aliyun.com).
Country.en String China

The name of the country.

IPV6ProbeCount String 3

The number of IPv6 probes.

Region String 264

The code of the province.

Country String 629

The code of the country.

IspName.en String China Unicom

The name of the carrier.

Region.en String Guizhou

The name of the province.

Country.zh_CN String China

The name of the country.

Note This parameter can be returned only on the China site (aliyun.com).
Area.zh_CN String Southwest China

The name of the area.

Note This parameter can be returned only on the China site (aliyun.com).
Area.en String XiNan

The name of the area.

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

The IP address pool.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSiteMonitorISPCityList
&Isp=China Unicom
&City=Guiyang
&<Common request parameters>

Sample success responses

XML format 

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>China</Country.zh_CN>
			<Area.zh_CN>Southwest China</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>Guiyang</CityName.zh_CN>
			<Area.en>XiNan</Area.en>
			<Region.zh_CN>Guizhou</Region.zh_CN>
			<APIProbeCount>0</APIProbeCount>
			<Region>264</Region>
			<Country>629</Country>
			<IspName.zh_CN>China Unicom</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 format 

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" : "China",
      "Area.zh_CN" : "Southwest China",
      "CityName.en" : "Guiyang",
      "IPV4ProbeCount" : 4,
      "Isp" : "232",
      "City" : "4",
      "IspName.en" : "China Unicom",
      "Country.en" : "China",
      "IPV6ProbeCount" : 0,
      "CityName.zh_CN" : "Guiyang",
      "Area.en" : "XiNan",
      "Region.zh_CN" : "Guizhou",
      "APIProbeCount" : 0,
      "Region" : "264",
      "Country" : "629",
      "IspName.zh_CN" : "China Unicom",
      "Region.en" : "Guizhou",
      "IPPool" : {
        "IPPool" : [ "192.168.XX.XX", "192.168.XX.XX" ]
      }
    } ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.