All Products
Search
Document Center

:CreateApiExport

Last Updated:Nov 15, 2024

Creates a data export task 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:CreateApiExportcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the WAF instance.

Note You can call the DescribeInstance operation to query the ID of the WAF instance.
waf-cn-zxu3***
RegionstringNo

Language type. Valid values:

  • cn: Chinese.
  • en: English.
cn
ZoneIdstringNo

The ID of the time zone.

Asia/Shanghai
TypestringNo

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
ParamstringNo

The extended parameters of the data export task. The parameter value is in the JSON format. The following keys are supported:

  • instanceId: the instance ID
  • clusterId: the ID of the hybrid cloud cluster
  • orderKey: the name of the field used to sort exported data
  • orderWay: the sorting method of the exported data
{ "orderWay": "asc", "orderKey": "endTs", "instanceId": "waf_v3prepaid_public_cn-****" }
ClusterIdintegerNo

The ID of the hybrid cloud cluster.

Note For hybrid cloud scenarios only, you can call the DescribeHybridCloudClusters operation to query the hybrid cloud clusters.
993
RegionIdstringNo

The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland
  • ap-southeast-1: outside the Chinese mainland
cn-hangzhou
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

62382992-F9AA-52B2-9147-66B3B9E51D74

Examples

Sample success responses

JSONformat

{
  "RequestId": "62382992-F9AA-52B2-9147-66B3B9E51D74"
}

Error codes

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