DescribeApiExports - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the list of export tasks for API security.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeApiExports

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English.	zh
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the WAF instance.	waf_v3prepaid_public_cn-p****
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	D9532525-E885-54E7-A178-D5554D563AFB
ApiExports	array<object>	The list of export tasks.
	object	The information about the export task.
Status	string	The status of the export task. Valid values: expired: The file has expired. exporting: The file is being exported. completed: The export is successful.	completed
FileUrl	string	The download URL of the file.	https://waf-api-sec-cn.*.aliyuncs.com/file_1610954145*.csv
Type	string	The type of the export task. Valid values: apisec_api: API asset task. apisec_abnormal: API threat task. apisec_event: API security event task.	apisec_api
Format	string	The format of the exported file.	CSV
FileName	string	The name of the file.	file_16109541456445334c0f01d9a7444e0e908***.csv
CreateTime	integer	The time when the export task was created. This value is a UNIX timestamp. Unit: seconds.	1725604852
Total	integer	The total number of returned entries.	7

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.