All Products
Search

This Product

    Web Application Firewall:ModifyApisecLogDeliveryStatus

    Document Center

    Web Application Firewall:ModifyApisecLogDeliveryStatus

    Last Updated:Aug 12, 2026

    Modifies the subscription status of API security logs.

    Operation description

    Before you invoke this operation, make sure that you have created an API security log delivery configuration by invoking the ModifyApisecLogDelivery operation. If you have not created a delivery configuration, complete the following prerequisites:

    1. Confirm that the API security feature is enabled. Invoke the DescribeInstance operation to query the instance details. If the Details.AgenticApisec or Details.Apisec parameter in the response is true, the API security feature is enabled.

    2. Confirm that WAF is authorized to access cloud resources. Invoke the DescribeRoleAuthStatus operation to query the authorization status. If WAF is not authorized, invoke the InitializeWafOperationRole operation to grant the authorization.

    3. Invoke the DescribeApisecSlsProjects and DescribeApisecSlsLogStores operations to query active SLS projects and Logstores, and then invoke the ModifyApisecLogDelivery operation to create a delivery configuration.

    After you complete the preceding steps, invoke this operation to enable or disable the delivery status of API security logs.

    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:ModifyApisecLogDeliveryStatus

    update

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    Instance ID of the WAF instance.

    Note

    You can call the DescribeInstance operation to query instance ID of the WAF instance.

    waf_v3_public_cn-uqm2z****0a
    AssertKey

    string

    Yes

    The log subscription type. Valid values:

    • risk: risk information.

    • event: attack event information.

    • asset: asset information.

    risk
    Status

    boolean

    Yes

    The enabling status of API security log subscribe. Valid values:

    • true: subscribe is enabled.

    • false: subscribe is shutdown.

    true
    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 Alibaba Cloud resource group.

    rg-acfm***q

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    F35F45B0-5D6B-4238-BE02-A62D****E840

    Examples

    Success response

    JSON format

    {
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D****E840"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.