DescribeSiteMonitorISPCityList - CloudMonitor - Alibaba Cloud Documentation Center

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:DescribeSiteMonitorISPCityList	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Isp	string	No	The name or ID of the carrier. Note Carrier names support fuzzy match.
City	string	No	The name or ID of the city. Note City names support fuzzy match.
IPV6	boolean	No	Specifies whether to query IPv6 probes. Valid values: true (default): IPv6 probes are queried. false: IPv6 probes are not queried.	true
IPV4	boolean	No	Specifies whether to query IPv4 probes. Valid values: true (default): IPv4 probes are queried. false: IPv4 probes are not queried.	true
ViewAll	boolean	No	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

Parameter	Type	Description	Example
	object
Code	string	The status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	successful
RequestId	string	The request ID.	B35D7D84-547B-4E61-B909-48A1F8A0C756
Success	string	Indicates whether the request was successful. Valid values: true false	true
IspCityList	array<object>	The queried detection points.
IspCity	object	The queried detection point.
CityName.en	string	The city name.	Guiyang
IPV4ProbeCount	string	The number of IPv4 probes.	4
City	string	The city ID.	4
Isp	string	The carrier ID.	232
CityName.zh_CN	string	The city name. Note This parameter is valid only on the China site (aliyun.com).
Region.zh_CN	string	The name of the province. Note This parameter can be returned only on the China site (aliyun.com).
IspName.zh_CN	string	The carrier name. Note This parameter is valid only on the China site (aliyun.com).
Country.en	string	The name of the country.	China
IPV6ProbeCount	string	The number of IPv6 probes.	3
Region	string	The province name.	264
Country	string	The country name. Note This parameter is valid only on the China site (aliyun.com).	629
IspName.en	string	The carrier name.	China-Unicom
Region.en	string	The name of the province.	Guizhou
Country.zh_CN	string	The name of the country. Note This parameter can be returned only on the China site (aliyun.com).
Area.zh_CN	string	The area name. Note This parameter is valid only on the China site (aliyun.com).
Area.en	string	The area name.	XiNan
IPPool	array	The IP address pool.
IPPool	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 code	Error code	Error message	Description
400	InvalidQueryParameter	%s	-
401	AccessDeniedException	You donot have sufficient access to perform this action.	-
402	LimitExceeded	The quota for this customer had been reached.	-
403	Forbidden	You are not authorized to operate the specified resource.	No permission, please use RAM to authorize
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
409	%s	%s	-
429	ThrottlingException	The request was denied due to request throttling.	-
500	InternalError	%s	-

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

Change history

Change time	Summary of changes	Operation
2023-04-03	The Error code has changed	View Change Details