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

调试

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

请求参数

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

要执行的操作。取值:DescribeAsyncTasks

PageNumber Integer 1

分页查询请求时返回的页码。例如,查询第一页的返回结果,则填写1

PageSize Integer 10

页面显示的记录数量。最大值:20

RegionId String cn-hangzhou

DDoS高防服务地域ID。取值:

  • cn-hangzhou:表示DDoS高防(新BGP)服务
  • ap-southeast-1:表示DDoS高防(国际)服务
ResourceGroupId String default

DDoS高防实例在资源管理产品中所属的资源组ID。默认为空,即属于默认资源组。

返回数据

名称 类型 示例值 描述
AsyncTasks Array

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

EndTime Long 157927362000

任务结束时间。时间戳格式,单位:毫秒。

StartTime Long 156927362000

任务开始时间。时间戳格式,单位:毫秒。

TaskId Long 1

任务ID。

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

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

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

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

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

  • domain:String类型,网站业务的域名。
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下载地址。
TaskStatus Integer 2

任务状态。取值:

  • 0:任务初始化
  • 1:任务进行中
  • 2:任务成功
  • 3:任务失败
TaskType Integer 5

任务类型。取值:

  • 1:四层导出任务,导出DDoS高防实例的端口转发规则
  • 2:七层导出任务,导出网站业务转发规则
  • 3:会话、健康检查导出任务,导出DDoS高防实例的会话、健康检查配置
  • 4:DDoS防护策略导出任务,导出DDoS高防实例的DDoS防护策略配置
  • 5:黑名单(针对目的IP)下载任务,导出针对DDoS高防实例的黑名单IP
  • 6:白名单(针对目的IP)下载任务,导出针对DDoS高防实例的白名单IP
RequestId String 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

本次请求的ID。

TotalCount Integer 1

异步导出任务的总数。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeAsyncTasksResponse>
	  <TotalCount>1</TotalCount>
	  <RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
	  <AsyncTasks>
		    <TaskId>1</TaskId>
		    <TaskType>5</TaskType>
		    <TaskStatus>2</TaskStatus>
		    <StartTime>156927362</StartTime>
		    <EndTime>157927362</EndTime>
		    <TaskParams>
			      <instanceId>ddoscoo-cn-mp91j1ao****</instanceId>
		    </TaskParams>
		    <TaskResult>
			      <instanceId>ddoscoo-cn-mp91j1ao****</instanceId>
			      <url>https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&amp;OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&amp;Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****</url>
		    </TaskResult>
	  </AsyncTasks>
</DescribeAsyncTasksResponse>

JSON 格式

{
    "TotalCount": 1,
    "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
    "AsyncTasks": [
        {
            "TaskId": 1,
            "TaskType": 5,
            "TaskStatus": 2,
            "StartTime": 156927362,
            "EndTime": 157927362,
            "TaskParams": {
                "instanceId": "ddoscoo-cn-mp91j1ao****"
            },
            "TaskResult": {
                "instanceId": "ddoscoo-cn-mp91j1ao****",
                "url": "https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3rDu3v&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****"
            }
        }
    ]
}

错误码

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