GetSyntheticMonitors - Application Real-Time Monitoring Service

Obtains detection points.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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
arms:GetSyntheticMonitors	Write	acs:arms:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Filter	object	Yes	The query conditions.
TaskType	integer	Yes	The type of the monitoring task. Valid values: 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.	1
MonitorCategory	integer	Yes	The type of the monitoring point. Valid values: 1: PC. 2: mobile device.	1
Network	integer	Yes	The network type. Valid values: 1: private network. 2: Internet.	1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	2FD473FF-5398-5A85-9BF6-7AB45561522F
Code	long	The HTTP status code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	success
Data	object []	The list of monitoring points.
Country	string	The country.	China
Region	string	The region.	Beijing
City	string	The city.	Beijing
CityCode	string	The city code.	1100101
Operator	string	The carrier.	Alibaba Cloud
OperatorCode	string	The carrier code.	1
ClientType	integer	The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.	1
CanBeSelected	boolean	Indicates whether the monitoring point is selected. Valid values: true and false.	true
Available	string	Indicates whether the monitoring point is available. Valid values: true and false.	true
Ipv6	integer	Indicates whether IPv6 is supported. Valid values: 0: IPv6 is not supported. 1: IPv6 is supported.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "2FD473FF-5398-5A85-9BF6-7AB45561522F",
  "Code": 200,
  "Message": "success",
  "Data": [
    {
      "Country": "China",
      "Region": "Beijing",
      "City": "Beijing",
      "CityCode": "1100101",
      "Operator": "Alibaba Cloud",
      "OperatorCode": "1",
      "ClientType": 1,
      "CanBeSelected": true,
      "Available": "true",
      "Ipv6": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	ParameterMissing	%s
400	ParameterIllegal	%s
400	TaskQuotaLimit	%s
400	ParameterRegionIllegal	%s
400	DuplicateTagKey	Param tagKey is duplicate.
400	TagNumOUT	the number of tag is out .
400	NoPermissionUSER	user no permission
403	RAMNotAuthorize	%s
403	STSNotAuthorize	%s
403	IllegalUserAccess	%s
403	APINotAuthorize	%s
403	CommercialStatusException	%s
403	SyntheticTrailExpired	%s
403	SyntheticInDebt	%s
403	SyntheticDailyTimesExhausted	%s
403	SyntheticDailyLimit	%s

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

Change history

Change time

Summary of changes

Operation

2023-12-06

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403