调用DescribeAsyncTasks查询异步导出任务详细信息_DDoS防护(Anti-DDoS)-阿里云帮助中心

例如任务ID、任务开始和结束时间、任务状态、任务参数、任务结果等。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-ddoscoo:DescribeAsyncTasks	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	否	DDoS 高防实例在资源管理服务中所属的资源组 ID。不设置该参数表示默认资源组。	rg-acfm2pz25js****
PageNumber	integer	是	分页查询时，设置当前页面的页码。	1
PageSize	integer	是	分页查询时，设置每页包含异步导出任务的数量。	10

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

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

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	查询到的异步导出任务的总数量。	1
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1
AsyncTasks	array<object>	异步导出任务的详细信息。
AsyncTask	object
EndTime	long	任务结束时间。使用时间戳表示，单位：毫秒。	157927362000
TaskType	integer	任务类型。取值： 1：四层导出任务，表示导出 DDoS 高防实例的端口转发规则。 2：七层导出任务，表示导出网站业务转发规则。 3：会话、健康检查导出任务，表示导出 DDoS 高防实例的会话、健康检查配置。 4：DDoS 防护策略导出任务，表示导出 DDoS 高防实例的 DDoS 防护策略配置。 5：黑名单（针对目的 IP）下载任务，表示导出针对 DDoS 高防实例的黑名单 IP。 6：白名单（针对目的 IP）下载任务，表示导出针对 DDoS 高防实例的白名单 IP。	5
StartTime	long	任务开始时间。使用时间戳表示，单位：毫秒。	156927362000
TaskParams	string	任务参数。使用 JSON 格式的字符串表达。不同 TaskType 的任务参数不完全相同。 TaskType 为 1、3、4、5、6 时，任务参数的结构如下： instanceId：String 类型，DDoS 高防实例的 ID。 TaskType 为 2 时，任务参数的结构如下： domain：String 类型，网站业务的域名。	{"instanceId": "ddoscoo-cn-mp91j1ao****"}
TaskStatus	integer	任务状态。取值： 0：表示任务初始化。 1：表示任务进行中。 2：表示任务成功。 3：表示任务失败。	2
TaskResult	string	任务结果。使用 JSON 格式的字符串表达。不同 TaskType 的任务结果不完全相同。 TaskType 为 1、3、4、5、6 时，任务结果的结构如下： instanceId：String 类型，DDoS 高防实例的 ID。 url：String 类型，导出文件的 OSS 下载地址。 TaskType 为 2 时，任务结果的结构如下： domain：String 类型，网站业务的域名。 url：String 类型，导出文件的 OSS 下载地址。	{"instanceId": "ddoscoo-cn-mp91j1ao**","url": "https://.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3r&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv**"}
TaskId	long	任务 ID。	1

示例

正常返回示例

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.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3r****&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****\"}",
      "TaskId": 1
    }
  ]
}

错误码

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