DescribeSyntheticProbeList - - Alibaba Cloud Documentation Center

Queries a list of detection points.

Operation description

This topic provides an example of how to call the DescribeSyntheticProbeList operation to query detection point details for the China Unicom carrier in Beijing.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeSyntheticProbeList

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Isp	string	No	The name or ID of the carrier.	联通
City	string	No	The name or ID of the city where the carrier detection point is located.	北京市
Ipv4	boolean	No	Specifies whether to return only IPv4 detection points.	false
Ipv6	boolean	No	Specifies whether to return only IPv6 detection points.	false
ViewAll	boolean	No	Specifies whether to return all detection points. Valid values: false (default): Returns the detection points that are available to you. true: Returns all detection points.	true
MbProbe	boolean	No	Specifies whether to return only mobile detection points.	false
LmProbe	boolean	No	Specifies whether to return only last-mile detection points.	false
IdcProbe	boolean	No	Specifies whether to return only detection points in data centers.	false

Response elements

Element	Type	Description	Example
	object	The response schema.
Code	string	The status code.	200
IspCityList	array<object>	The list of detection points.
	object	The details of a detection point.
AreaCn	string	The name of the area in Chinese.	华北
AreaEn	string	The name of the area in English.	Huabei
City	string	The city ID.	738
CityCn	string	The name of the city in Chinese.	北京
CityEn	string	The name of the city in English.	Beijing
Country	string	The country code.	629
CountryCn	string	The name of the country in Chinese.	中国
CountryEn	string	The name of the country or region in English.	China
IpPool	array	The list of node IP addresses.
	string	The node IP address.	1.1.1.1
Isp	string	The carrier ID.	232
IspCn	string	The name of the carrier in Chinese.	联通
IspEn	string	The name of the carrier in English.	China-Unicom
LmProbeCount	integer	The number of last-mile detection points.	1
MbProbeCount	integer	The number of mobile detection points.	1
Region	string	The province code.	264
RegionCn	string	The name of the province in Chinese.	江西省
RegionEn	string	The name of the province in English.	Jiangxi
IdcV4ProbeCount	integer	The number of IPv4 detection points in data centers.	1
IdcV6ProbeCount	integer	The number of IDC IPv6 nodes.	1
Message	string	The error message.	The specified resource is not found.
RequestId	string	The request ID.	87170bc7-e28a-4c93-b9bf-90a1dbe84736
Success	string	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue	Illegal parameters.	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.	No permission, please use RAM to authorize
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
429	ThrottlingException	The request was denied due to request throttling.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.