获取定时拨测任务列表。
接口说明
云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:ListTimingSyntheticTasks | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
| Search | object | 否 | 搜索关键字 | |
| TaskTypes | array | 否 | 查询的任务类型列表。 | |
| integer | 否 | 任务类型：1：ICMP 2：TCP 3：DNS 4：HTTP 5：网站测速 6：文件下载。 | 1 | |
| TaskIds | array | 否 | 任务 ID 列表。 | |
| string | 否 | 任务 ID。 | 181248 | |
| Name | string | 否 | 任务名称。 | 拨测 |
| Status | string | 否 | CREATING：任务创建中， RUNNING：任务运行中， PARTIAL_RUNNING：任务部分运行中， STOP：任务停止， LIMIT_STOP：任务由于限额停止， EXCEPTION：任务异常， DELETE：任务删除， DELETE_EXCEPTION： 删除异常。 | CREATING |
| OrderField | string | 否 | 排序字段，支持按照 gmtCreate、gmtModified、status 和 monitorCount 其中之一排序。 | status |
| Order | integer | 否 | 1:升序 -1:降序 | 1 |
| Page | integer | 否 | 页码，必填。 | 1 |
| PageSize | integer | 否 | 每页数量，必填。 | 10 |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmxyexli2**** |
| Tags | array<object> | 否 | 标签 | |
| object | 否 | 标签 | ||
| Key | string | 否 | 标签的键(key)。 | mark |
| Value | string | 否 | 标签的值（value）。 | value1111 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "730E90FE-996A-5638-99F3-4F0F9038CC6C",
"Code": 200,
"Message": "success",
"Data": {
"Items": [
{
"TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
"RegionId": "cn-hangzhou",
"Name": "拨测任务",
"TaskType": 1,
"Url": "https://www.example.com",
"MonitorCategory": 1,
"Frequency": "1m",
"MonitorNum": "10",
"Status": "RUNNING",
"GmtCreate": "1671454758000",
"GmtModified": "1673085633000",
"ResourceGroupId": "rg-aekzgwtq5vxxxxx",
"CommonSetting": {
"CustomHost": {
"Hosts": [
{
"Domain": "www.aliyun.com",
"IpType": 0,
"Ips": [
"39.104.85.210"
]
}
],
"SelectType": 0
},
"IpType": 0,
"MonitorSamples": 0,
"IsOpenTrace": false,
"TraceClientType": 1,
"XtraceRegion": "cn-hangzhou",
"CustomVPCSetting": {
"RegionId": "cn-zhangjiakou",
"VpcId": "vpc-2zehbd4dfzahxxxxxxx",
"VSwitchId": "vsw-bp1bcmj81kxxxxxxx",
"SecureGroupId": "sg-xxxxxxxxxxxxxx"
},
"CustomPrometheusSetting": {
"PrometheusLabels": {
"key": "保留字段。\n"
},
"PrometheusClusterId": "保留字段。\n",
"PrometheusClusterRegion": "保留字段。"
}
},
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
],
"Total": 100,
"Page": 1,
"PageSize": 10
}
}错误码
| 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 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-04-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |