获取定时拨测任务列表。
接口说明
云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
730E90FE-996A-5638-99F3-4F0F9038CC6C |
| Code |
integer |
状态码。200 表示成功。 |
200 |
| Message |
string |
返回信息。 |
success |
| Data |
object |
返回结构体。 |
|
| Items |
array<object> |
任务信息列表。 |
|
|
array<object> |
任务信息。 |
||
| TaskId |
string |
云拨测任务 ID。 |
5308a2691f59422c8c3b7aeccec9cd3b |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| Name |
string |
任务名称。 |
拨测任务 |
| TaskType |
integer |
任务类型： 1：ICMP 2：TCP 3：DNS 4：HTTP 5：网站测速 6：文件下载。 |
1 |
| Url |
string |
拨测地址。 |
https://www.example.com |
| MonitorCategory |
integer |
监测点类型，PC 端 1，移动端 2。 |
1 |
| Frequency |
string |
拨测频率，可选范围：1m,5m,10m,15m,20m,30m,1h,2h,3h,4h,6h,8h,12h,24h。 |
1m |
| MonitorNum |
string |
拨测点个数。 |
10 |
| Status |
string |
CREATING：任务创建中， RUNNING：任务运行中， PARTIAL_RUNNING：任务部分运行中， STOP：任务停止， LIMIT_STOP：任务由于限额停止， EXCEPTION：任务异常， DELETE：任务删除， DELETE_EXCEPTION： 删除异常。 |
RUNNING |
| GmtCreate |
string |
创建时间。 |
1671454758000 |
| GmtModified |
string |
修改时间。 |
1673085633000 |
| ResourceGroupId |
string |
资源组 ID。 |
rg-aekzgwtq5vxxxxx |
| CommonSetting |
object |
通用设置。 |
|
| CustomHost |
object |
自定义 host |
|
| Hosts |
array<object> |
自定义 host。 |
|
|
object |
自定义 host。 |
||
| Domain |
string |
域名。 |
www.aliyun.com |
| IpType |
integer |
IP 类型：
|
0 |
| Ips |
array |
IP 地址。 |
|
|
string |
IP。 |
39.104.85.210 |
|
| SelectType |
integer |
选择方式：
|
0 |
| IpType |
integer |
IP 类型：
|
0 |
| MonitorSamples |
integer |
是否均匀分配监测样本 ：
|
0 |
| IsOpenTrace |
boolean |
是否开启链路追踪。 |
false |
| TraceClientType |
integer |
链路追踪客户端类型：
|
1 |
| XtraceRegion |
string |
链路数据上报 region。 |
cn-hangzhou |
| CustomVPCSetting |
object |
用户 VPC 信息，如果拨测的是阿里云内网地址，需要配置 VPC 信息。 |
|
| RegionId |
string |
地域 ID。 |
cn-zhangjiakou |
| VpcId |
string |
VPC ID. |
vpc-2zehbd4dfzahxxxxxxx |
| VSwitchId |
string |
交换机 ID。 |
vsw-bp1bcmj81kxxxxxxx |
| SecureGroupId |
string |
安全组 ID，此安全组是拨测客户端所在的安全组，安全组限定了拨测客户端在 VPC 中的出入站规则。需要设置您的 VPC 所在安全组的入站规则为允许拨测客户端所在的安全组访问。否则，拨测客户端无法顺畅地访问您的 VPC 内资源。 |
sg-xxxxxxxxxxxxxx |
| CustomPrometheusSetting |
object |
保留字段。 |
|
| PrometheusLabels |
object |
保留字段。 |
|
|
string |
保留字段。 |
保留字段。 |
|
| PrometheusClusterId |
string |
保留字段。 |
保留字段。 |
| PrometheusClusterRegion |
string |
保留字段。 |
保留字段。 |
| Tags |
array<object> |
标签。 |
|
|
object |
标签。 |
||
| Key |
string |
标签键。 |
key |
| Value |
string |
标签的值。 |
value |
| Total |
integer |
返回结果的总任务数量。 |
100 |
| Page |
integer |
当前页数。 |
1 |
| PageSize |
integer |
每页数量。 |
10 |
示例
正常返回示例
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 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。