文档

GetSyntheticMonitors - 获取拨测点

更新时间:

获取拨测点。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
Filterobject

查询条件。

TaskTypeinteger

任务类型:

  • 1:ICMP
  • 2:TCP
  • 3:DNS
  • 4:HTTP
  • 5:网站测速
  • 6:文件下载
1
MonitorCategoryinteger

监测点类型。

  • 1:PC 端
  • 2:移动端
1
Networkinteger

网络类型。

  • 1:内网
  • 2:公网
1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

状态码。200 表示成功。

200
Messagestring

返回结果的提示信息。

success
Dataobject []

监测点列表。

Countrystring

国家。

中国
Regionstring

地域。

浙江
Citystring

城市。

北京市
CityCodestring

城市编码

1100101
Operatorstring

运营商。

阿里云
OperatorCodestring

运营商编码。

1
ClientTypeinteger

拨测点客户端类型。

  • 1:IDC
  • 2:网民
  • 3:移动端
  • 4:云主机
1
CanBeSelectedboolean

是否选中。

  • true:选中
  • false:未选中
true
Availablestring

是否可用。

  • true:可用
  • false:不可用
true
Ipv6integer

是否支持 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错误码错误信息
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

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

变更历史

变更时间变更内容概要操作
2023-12-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
  • 本页导读 (1)
文档反馈