All Products
Search

This Product

    Web Application Firewall:CreateHybridCloudCluster

    Document Center

    Web Application Firewall:CreateHybridCloudCluster

    Last Updated:Mar 17, 2026

    Creates a hybrid cloud Web Application Firewall (WAF) cluster.

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

    create

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the WAF instance.

    Note

    Call the DescribeInstance operation to query the ID of the WAF instance.

    waf_cdnsdf3****
    ClusterName

    string

    Yes

    The name of the hybrid cloud cluster.

    test
    HttpPorts

    string

    Yes

    The listening ports for the HTTP protocol. Separate multiple ports with commas (,), such as port1,port2,port3.

    80,8080
    HttpsPorts

    string

    Yes

    The listening ports for the HTTPS protocol. Separate multiple ports with commas (,), such as port1,port2,port3.

    443,8443
    AccessMode

    string

    Yes

    The network access mode of the cluster. Valid values:

    • internet: access over the Internet.

    • vpc: access over an Express Connect circuit.

    internet
    AccessRegion

    string

    No

    The region for Express Connect circuit access. Valid values:

    • cn-hangzhou: Hangzhou.

    • cn-beijing: Beijing.

    • cn-shanghai: Shanghai.

    cn-hangzhou
    LogFieldsNotReturned deprecated

    string

    No

    Note

    This parameter is deprecated. It no longer returns meaningful data.

    deprecated
    ProtectionServerCount

    integer

    Yes

    The maximum number of protection nodes that can be added to the hybrid cloud cluster.

    1
    Remark

    string

    No

    The description of the hybrid cloud cluster.

    test
    ProxyType

    string

    No

    The type of the hybrid cloud cluster. Valid values:

    • cname: reverse proxy cluster. Traffic is forwarded through CNAME resolution.

    • service: transparent proxy cluster. Traffic is forwarded at the service level.

    cname
    RuleStatus

    string

    No

    Indicates whether manual bypass is enabled for the cluster. Valid values:

    • on: Manual bypass is enabled.

    • off: Manual bypass is disabled.

    on
    RuleType

    string

    No

    The type of the bypass rule. Valid values:

    • bypass: skips WAF security checks and allows traffic to pass through directly.

    bypass
    RuleConfig

    string

    No

    The configuration of the bypass rule, in JSON format. This includes settings such as circuit breaker thresholds, request body size limits, and timeout values.

    { "enable": true, "param": { "breaker": { "duration": 1, "failed": 1, "recent_failed": 1 }, "disable_protect": false, "max_request_body_len": 1, "timeout": 1 } }
    ProxyStatus

    string

    No

    Indicates whether the proxy gateway is enabled for the cluster. Valid values:

    • on: The proxy gateway is enabled.

    • off: The proxy gateway is disabled.

    off
    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 ID of the request.

    66A98669-ER12-WE34-23PO-301469*****E
    Data

    integer

    The ID of the hybrid cloud cluster.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "66A98669-ER12-WE34-23PO-301469*****E",
  "Data": 1
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.