调用DescribeAsyncTasks查询异步导出任务的详细信息。

使用说明

本接口用于查询异步导出任务的详细信息,例如,任务ID、任务开始和结束时间、任务状态、任务参数、任务结果等。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAsyncTasks

要执行的操作。取值:DescribeAsyncTasks

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。
ResourceGroupId String rg-acfm2pz25js****

DDoS高防实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

PageNumber Integer 1

分页查询时,设置当前页面的页码。

PageSize Integer 10

分页查询时,设置每页包含异步导出任务的数量。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

查询到的异步导出任务的总数量。

RequestId String 6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1

本次请求的ID。

AsyncTasks Array of AsyncTask

异步导出任务的详细信息。

EndTime Long 157927362000

任务结束时间。使用时间戳表示,单位:毫秒。

TaskType Integer 5

任务类型。取值:

  • 1:四层导出任务,表示导出DDoS高防实例的端口转发规则。
  • 2:七层导出任务,表示导出网站业务转发规则。
  • 3:会话、健康检查导出任务,表示导出DDoS高防实例的会话、健康检查配置。
  • 4:DDoS防护策略导出任务,表示导出DDoS高防实例的DDoS防护策略配置。
  • 5:黑名单(针对目的IP)下载任务,表示导出针对DDoS高防实例的黑名单IP。
  • 6:白名单(针对目的IP)下载任务,表示导出针对DDoS高防实例的白名单IP。
StartTime Long 156927362000

任务开始时间。使用时间戳表示,单位:毫秒。

TaskParams String {"instanceId": "ddoscoo-cn-mp91j1ao****"}

任务参数。使用JSON格式的字符串表达。不同TaskType的任务参数不完全相同。

TaskType13456时,任务参数的结构如下:

  • instanceId:String类型,DDoS高防实例的ID。

TaskType2时,任务参数的结构如下:

  • domain:String类型,网站业务的域名。
TaskStatus Integer 2

任务状态。取值:

  • 0:表示任务初始化。
  • 1:表示任务进行中。
  • 2:表示任务成功。
  • 3:表示任务失败。
TaskResult String {"instanceId": "ddoscoo-cn-mp91j1ao****","url": "https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****"}

任务结果。使用JSON格式的字符串表达。不同TaskType的任务参数不完全相同。

TaskType13456时,任务参数的结构如下:

  • instanceId:String类型,DDoS高防实例的ID。
  • url:String类型,导出文件的OSS下载地址。

TaskType2时,任务参数的结构如下:

  • domain:String类型,网站业务的域名。
  • url:String类型,导出文件的OSS下载地址。
TaskId Long 1

任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAsyncTasks
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAsyncTasksResponse>
    <TotalCount>1</TotalCount>
    <RequestId>6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1</RequestId>
    <AsyncTasks>
        <EndTime>157927362000</EndTime>
        <TaskType>5</TaskType>
        <StartTime>156927362000</StartTime>
        <TaskParams>{"instanceId": "ddoscoo-cn-mp91j1ao****"}</TaskParams>
        <TaskStatus>2</TaskStatus>
        <TaskResult>{"instanceId": "ddoscoo-cn-mp91j1ao****","url": "https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&amp;OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&amp;Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****"}</TaskResult>
        <TaskId>1</TaskId>
    </AsyncTasks>
</DescribeAsyncTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1",
  "AsyncTasks" : [ {
    "EndTime" : 157927362000,
    "TaskType" : 5,
    "StartTime" : 156927362000,
    "TaskParams" : "{\"instanceId\": \"ddoscoo-cn-mp91j1ao****\"}",
    "TaskStatus" : 2,
    "TaskResult" : "{\"instanceId\": \"ddoscoo-cn-mp91j1ao****\",\"url\": \"https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****\"}",
    "TaskId" : 1
  } ]
}

错误码

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