DescribeApiExports - - Alibaba Cloud Documentation Center

Queries the list of data export tasks in the API security module.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeApiExports	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	Language type. Valid values: cn: Chinese. en: English.	zh
PageNumber	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries to return on each page. Default value: 10.	10
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_v3prepaid_public_cn-p****
RegionId	string	No	The region ID of the Web Application Firewall (WAF) instance. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D9532525-E885-54E7-A178-D5554D563AFB
ApiExports	array<object>	The returned data export tasks.
ApiExports	object	The returned data export task.
Status	string	The status of the data export task. Valid values: expired: The file is expired. exporting: Data is being exported. completed: Data is exported.	completed
FileUrl	string	The download URL of the exported file.	https://waf-api-sec-cn.*.aliyuncs.com/file_1610954145*.csv
Type	string	The type of the data export task. Valid values: apisec_api: API tasks apisec_abnormal: API risk tasks apisec_event: API security event tasks	apisec_api
Format	string	The format of the exported file.	CSV
FileName	string	The name of the file.	file_16109541456445334c0f01d9a7444e0e908***.csv
CreateTime	long	The time when the data export task was created. The value is a UNIX timestamp displayed in UTC. Unit: seconds.	1725604852
Total	long	The status of the data export task. Valid values: expired: The file is expired. exporting: Data is being exported. completed: Data is exported.	7

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.