All Products
Search

This Product

    Web Application Firewall:CreateHybridCloudClusterRule

    Document Center

    Web Application Firewall:CreateHybridCloudClusterRule

    Last Updated:Aug 12, 2026

    Creates cluster rule information.

    Operation description

    Before calling this operation, make sure that the hybrid cloud feature is enabled for the WAF instance. You can call the DescribeInstance operation to query instance details. If the Details.HybridCloud parameter in the response is true, the hybrid cloud feature is enabled. If the feature is not enabled, log on to the WAF console and upgrade the instance to enable the hybrid cloud feature.

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

    create

    *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 current WAF instance.

    waf_elasticity-cn-0xldbqt****
    ClusterId

    integer

    Yes

    The ID of the hybrid cloud cluster.

    Note

    This parameter applies only to hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to obtain hybrid cloud cluster information.

    428
    RuleType

    string

    Yes

    The rule type. Valid values:

    • pullin: cluster traffic redirection.

    pullin
    RuleStatus

    string

    Yes

    The rule status. Valid values:

    • on: enabled.

    • off: disabled.

    on
    RuleConfig

    string

    No

    The traffic redirection rule configuration.

    Note

    The mode options are mutually exclusive. You can select only one. If you change the mode, all traffic redirection rules under the original mode are cleared.

    • check_mode: the mode. Valid values:

      • all: full traffic redirection.

      • part: partial traffic redirection.

    • type: the rule matching type. Valid values:

      • exact: exact match.

      • regex: regular expression.

    • substance: the rule value.

    full volume drainage:{\"check_mode\": \"all\", \"type\": \"exact\", \"substance\": \"122\"} Specified partial drainage：{\"check_mode\": \"part\", \"type\": \"exact\", \"substance\": \"12222\"}
    RegionId

    string

    No

    The region where the WAF instance is deployed. 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.

    66A98669-CC6E-4F3E-*****-3014697B11AE
    ClusterRuleResourceId

    string

    The cluster rule resource ID.

    hdbc-clusterrule-*******m0w

    Examples

    Success response

    JSON format

    {
  "RequestId": "66A98669-CC6E-4F3E-*****-3014697B11AE",
  "ClusterRuleResourceId": "hdbc-clusterrule-*******m0w"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.