获取任务详情。
接口说明
云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:GetTimingSyntheticTask | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
| TaskId | string | 否 | 云拨测任务 ID。 | 856566a9cb2a4cafa05aa95ed0******* |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E13430A6-57A9-56E9-9D8D-28FE8DEBCA40",
"Code": 200,
"Message": "success",
"Data": {
"TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
"RegionId": "cn-hangzhou",
"Name": "拨测任务",
"TaskType": 5,
"MonitorConf": {
"NetICMP": {
"TargetUrl": "www.aliyun.com",
"Interval": 200,
"PackageNum": 4,
"PackageSize": 1024,
"SplitPackage": true,
"Timeout": 2000,
"TracertEnable": true,
"TracertNumMax": 64,
"TracertTimeout": 60000
},
"NetTCP": {
"TargetUrl": "127.0.0.1:8888",
"ConnectTimes": 4,
"Interval": 200,
"Timeout": 20000,
"TracertEnable": true,
"TracertNumMax": 20,
"TracertTimeout": 60000
},
"NetDNS": {
"TargetUrl": "www.aliyun.com",
"DnsServerIpType": 0,
"NsServer": "114.114.114.114",
"QueryMethod": 0,
"Timeout": 5000
},
"ApiHTTP": {
"TargetUrl": "http://127.0.0.1:8090/api/list",
"Method": "POST",
"RequestHeaders": {
"key": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}"
},
"RequestBody": {
"Content": "text/plain",
"Type": "multipart/form-data"
},
"ConnectTimeout": 5000,
"Timeout": 10000,
"CheckCert": false,
"ProtocolAlpnProtocol": 1
},
"FileDownload": {
"TargetUrl": "https://********",
"DownloadKernel": 0,
"QuickProtocol": 1,
"ConnectionTimeout": 5000,
"CustomHeaderContent": {
"key": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}"
},
"IgnoreCertificateStatusError": 0,
"IgnoreCertificateUntrustworthyError": 0,
"IgnoreInvalidHostError": 0,
"MonitorTimeout": 6000,
"Redirection": 0,
"TransmissionSize": 2048,
"IgnoreCertificateCanceledError": 0,
"IgnoreCertificateAuthError": 0,
"IgnoreCertificateOutOfDateError": 0,
"IgnoreCertificateUsingError": 0,
"VerifyWay": 0,
"ValidateKeywords": "success",
"WhiteList": "www.aliyun.com:203.0.3.55|203.3.44.67"
},
"Website": {
"TargetUrl": "http://www.aliyun.com",
"AutomaticScrolling": 0,
"CustomHeader": 0,
"CustomHeaderContent": {
"key": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}\n"
},
"DisableCache": 1,
"DisableCompression": 0,
"FilterInvalidIP": 0,
"IgnoreCertificateError": 0,
"MonitorTimeout": 20000,
"Redirection": 1,
"SlowElementThreshold": 5000,
"WaitCompletionTime": 5000,
"VerifyStringBlacklist": "error",
"VerifyStringWhitelist": "success",
"ElementBlacklist": "www.example.com/a.jpg",
"DNSHijackWhitelist": "www.aliyun.com:203.0.3.55|203.3.44.67",
"PageTamper": "www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg",
"FlowHijackJumpTimes": 0,
"FlowHijackLogo": "aliyun"
},
"Stream": {
"TargetUrl": "http://www.aliyun.com/stream/test.mp4",
"StreamType": 0,
"StreamMonitorTimeout": 30,
"StreamAddressType": 0,
"PlayerType": 12,
"CustomHeaderContent": {
"key": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}"
},
"WhiteList": "www.aliyun.com:203.0.3.55|203.3.44.67"
}
},
"MonitorCategory": 1,
"Monitors": [
{
"CityCode": "110100",
"OperatorCode": "1",
"ClientType": 1
}
],
"Frequency": "5m",
"CustomPeriod": {
"EndHour": 22,
"StartHour": 14
},
"CommonSetting": {
"CustomHost": {
"Hosts": [
{
"Domain": "www.aliyun.com",
"IpType": 0,
"Ips": [
"10.0.114.17"
]
}
],
"SelectType": 0
},
"IpType": 0,
"MonitorSamples": 0,
"IsOpenTrace": true,
"TraceClientType": 1,
"XtraceRegion": "cn-hangzhou",
"CustomVPCSetting": {
"RegionId": "cn-hangzhou",
"VpcId": "vpc-2zexy5nae9q2otaxxxx",
"VSwitchId": "vsw-bp1i0xezblf1yrz4xxxxx",
"SecureGroupId": "sg-xxxxxxx"
},
"CustomPrometheusSetting": {
"PrometheusLabels": {
"key": "保留字段。"
},
"PrometheusClusterId": "保留字段。",
"PrometheusClusterRegion": "保留字段。"
}
},
"AvailableAssertions": [
{
"Type": "websiteTTLB",
"Target": "key\n",
"Operator": "gt",
"Expect": "100"
}
],
"Status": "RUNNING",
"ResourceGroupId": "default",
"Tags": [
{
"Key": "user1",
"Value": "p_运维"
}
]
}
}错误码
| 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 返回结构发生变更 | 查看变更详情 |
| 2024-03-14 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-03-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-23 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |