All Products
Search
Document Center

:DescribeApisecLogDeliveries

Last Updated:Sep 13, 2024

Queries the configurations of API security log subscription.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeApisecLogDeliveriesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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_v3_public_cn-uqm2z****0a
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q
RegionIdstringNo

The region where the WAF instance is deployed. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

2EFCFE18-78F8-5079-B312-07***48B
DeliveryConfigsarray<object>

The configurations of API security log subscription.

object
AssertKeystring

The type of the log subscription. Valid values:

  • risk: risk information.
  • event: attack event information.
  • asset: asset information.
risk
LogRegionIdstring

The ID of the region where logs are stored.

cn-hangzhou
ProjectNamestring

The name of the project in Simple Log Service.

apisec-project-14316572********
LogStoreNamestring

The name of the Logstore in Simple Log Service.

apisec-logstore***
Statusboolean

The status of API security log subscription. Valid values:

  • true: enabled.
  • false: disabled.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "DeliveryConfigs": [
    {
      "AssertKey": "risk",
      "LogRegionId": "cn-hangzhou",
      "ProjectName": "apisec-project-14316572********",
      "LogStoreName": "apisec-logstore***\n",
      "Status": true
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-27The request parameters of the API has changedView Change Details