All Products
Search
Document Center

Application Real-Time Monitoring Service:GetSyntheticMonitors

Last Updated:Nov 05, 2024

Obtains detection points.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetSyntheticMonitorsnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
FilterobjectYes

The query conditions.

TaskTypeintegerYes

The type of the monitoring task. Valid values:

1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.

1
MonitorCategoryintegerYes

The type of the monitoring point. Valid values: 1: PC. 2: mobile device.

1
NetworkintegerYes

The network type. Valid values: 1: private network. 2: Internet.

1

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

2FD473FF-5398-5A85-9BF6-7AB45561522F
Codelong

The HTTP status code. The status code 200 indicates that the request was successful.

200
Messagestring

The returned message.

success
Dataarray<object>

The list of monitoring points.

dataobject
Countrystring

The country.

China
Regionstring

The region.

Beijing
Citystring

The city.

Beijing
CityCodestring

The city code.

1100101
Operatorstring

The carrier.

Alibaba Cloud
OperatorCodestring

The carrier code.

1
ClientTypeinteger

The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.

1
CanBeSelectedboolean

Indicates whether the monitoring point is selected. Valid values: true and false.

true
Availablestring

Indicates whether the monitoring point is available. Valid values: true and false.

true
Ipv6integer

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 codeError codeError message
400ParameterMissing%s
400ParameterIllegal%s
400TaskQuotaLimit%s
400ParameterRegionIllegal%s
400DuplicateTagKeyParam tagKey is duplicate.
400TagNumOUTthe number of tag is out .
400NoPermissionUSERuser no permission
403RAMNotAuthorize%s
403STSNotAuthorize%s
403IllegalUserAccess%s
403APINotAuthorize%s
403CommercialStatusException%s
403SyntheticTrailExpired%s
403SyntheticInDebt%s
403SyntheticDailyTimesExhausted%s
403SyntheticDailyLimit%s

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

Change history

Change timeSummary of changesOperation
2023-12-06The Error code has changedView Change Details