全部产品
Search
文档中心

Web 应用防火墙:DescribeApiExports - 查询API安全导出任务列表

更新时间:Nov 15, 2024

查询API安全导出任务列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

语言类型。取值:

  • zh:中文。
  • en:英文。
zh
PageNumberlong

分页查询时,返回第几页数据。默认值为 1,表示返回第 1 页数据。

1
PageSizelong

分页查询时,每页包含多少条结果。默认值为 10,表示每页包含 10 条结果。

10
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstance ,查看当前 WAF 实例的 ID。
waf_v3prepaid_public_cn-p****
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

D9532525-E885-54E7-A178-D5554D563AFB
ApiExportsarray<object>

导出任务的列表。

ApiExportsobject

导出任务信息。

Statusstring

导出任务的状态。取值:

  • expired:表示文件过期。

  • exporting:表示正在导出。

  • completed:表示导出成功。

completed
FileUrlstring

文件下载地址。

https://waf-api-sec-cn.***.aliyuncs.com/file_1610954145***.csv
Typestring

导出任务类型。取值:

  • apisec_api:表示 API 资产任务。

  • apisec_abnormal:表示 API 风险任务。

  • apisec_event:表示 API 安全事件任务。

apisec_api
Formatstring

导出文件格式。

CSV
FileNamestring

文件名称。

file_16109541456445334c0f01d9a7444e0e908***.csv
CreateTimelong

导出任务的创建时间,格式为 Unix 时间戳(UTC 时间),单位为秒。

1725604852
Totallong

返回结果的总数。

7

示例

正常返回示例

JSON格式

{
  "RequestId": "D9532525-E885-54E7-A178-D5554D563AFB",
  "ApiExports": [
    {
      "Status": "completed",
      "FileUrl": "https://waf-api-sec-cn.***.aliyuncs.com/file_1610954145***.csv",
      "Type": "apisec_api",
      "Format": "CSV",
      "FileName": "file_16109541456445334c0f01d9a7444e0e908***.csv",
      "CreateTime": 1725604852
    }
  ],
  "Total": 7
}

错误码

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