GetSyntheticMonitors - 获取拨测点 - 应用实时监控服务ARMS

获取拨测点。

接口说明

云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:GetSyntheticMonitors	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
Filter	object	是	查询条件。
TaskType	integer	是	任务类型： 1：ICMP 2：TCP 3：DNS 4：HTTP 5：网站测速 6：文件下载	1
MonitorCategory	integer	是	监测点类型。 1：PC 端 2：移动端	1
Network	integer	是	网络类型。 1：内网 2：公网	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	2FD473FF-5398-5A85-9BF6-7AB45561522F
Code	long	状态码。200 表示成功。	200
Message	string	返回结果的提示信息。	success
Data	array<object>	监测点列表。
data	object
Country	string	国家。	中国
Region	string	地域。	浙江
City	string	城市。	北京市
CityCode	string	城市编码	1100101
Operator	string	运营商。	阿里云
OperatorCode	string	运营商编码。	1
ClientType	integer	拨测点客户端类型。 1：IDC 2：网民 3：移动端 4：云主机	1
CanBeSelected	boolean	是否选中。 true：选中 false：未选中	true
Available	string	是否可用。 true：可用 false：不可用	true
Ipv6	integer	是否支持 IPv6。 0：不支持 1：支持	0

示例

正常返回示例

JSON格式

{
  "RequestId": "2FD473FF-5398-5A85-9BF6-7AB45561522F",
  "Code": 200,
  "Message": "success",
  "Data": [
    {
      "Country": "中国",
      "Region": "浙江",
      "City": "北京市",
      "CityCode": "1100101",
      "Operator": "阿里云",
      "OperatorCode": "1",
      "ClientType": 1,
      "CanBeSelected": true,
      "Available": "true",
      "Ipv6": 0
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
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

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-12-06	OpenAPI 错误码发生变更	查看变更详情