All Products
Search
Document Center

CloudMonitor:DescribeSiteMonitorISPCityList

Last Updated:Jul 26, 2024

Queries the detection points that are provided by carriers.

Operation description

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
IspstringNo

The name or ID of the carrier.

Note Carrier names support fuzzy match.
CitystringNo

The name or ID of the city.

Note City names support fuzzy match.
IPV6booleanNo

Specifies whether to query IPv6 probes. Valid values:

  • true (default): IPv6 probes are queried.
  • false: IPv6 probes are not queried.
true
IPV4booleanNo

Specifies whether to query IPv4 probes. Valid values:

  • true (default): IPv4 probes are queried.
  • false: IPv4 probes are not queried.
true
ViewAllbooleanNo

Specifies whether to return all detection points. Valid values:

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

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

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Note The status code 200 indicates that the request was successful.
200
Messagestring

The returned message.

successful
RequestIdstring

The request ID.

B35D7D84-547B-4E61-B909-48A1F8A0C756
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
IspCityListarray<object>

The queried detection points.

object

The queried detection point.

CityName.enstring

The city name.

Guiyang
IPV4ProbeCountstring

The number of IPv4 probes.

4
Citystring

The city ID.

4
Ispstring

The carrier ID.

232
CityName.zh_CNstring

The city name.

Note This parameter is valid only on the China site (aliyun.com).
Region.zh_CNstring

The name of the province.

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

The carrier name.

Note This parameter is valid only on the China site (aliyun.com).
Country.enstring

The name of the country.

China
IPV6ProbeCountstring

The number of IPv6 probes.

3
Regionstring

The province name.

264
Countrystring

The country name.

Note This parameter is valid only on the China site (aliyun.com).
629
IspName.enstring

The carrier name.

China-Unicom
Region.enstring

The name of the province.

Guizhou
Country.zh_CNstring

The name of the country.

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

The area name.

Note This parameter is valid only on the China site (aliyun.com).
Area.enstring

The area name.

XiNan
IPPoolarray

The IP address pool.

string

The IP address pool.

["192.68.XX.XX","192.68.XX.XX"]

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "B35D7D84-547B-4E61-B909-48A1F8A0C756",
  "Success": "true",
  "IspCityList": {
    "IspCity": [
      {
        "CityName.en": "Guiyang",
        "IPV4ProbeCount": "4",
        "City": "4",
        "Isp": "232",
        "CityName.zh_CN": "",
        "Region.zh_CN": "",
        "IspName.zh_CN": "",
        "Country.en": "China",
        "IPV6ProbeCount": "3",
        "Region": "264",
        "Country": "629",
        "IspName.en": "China-Unicom",
        "Region.en": "Guizhou",
        "Country.zh_CN": "",
        "Area.zh_CN": "",
        "Area.en": "XiNan",
        "IPPool": {
          "IPPool": [
            "[\"192.68.XX.XX\",\"192.68.XX.XX\"]"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidQueryParameter%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403ForbiddenYou are not authorized to operate the specified resource.No permission, please use RAM to authorize
406ExceedingQuotaExceeding quota limits.-
409%s%s-
429ThrottlingExceptionThe request was denied due to request throttling.-
500InternalError%s-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-03The Error code has changedView Change Details