Hybrid Cloud Cluster Rules API Reference - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Operation description

Before calling this operation, make sure that the hybrid cloud feature is enabled for the WAF instance. Call the DescribeInstance operation to query instance details. If the returned parameter Details.HybridCloud is true, the hybrid cloud feature is enabled. If it 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:DescribeHybridCloudClusterRule

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to obtain the ID of the current WAF instance.	waf-cn-uqm33n***02
ClusterId `deprecated`	integer	No	[Deprecated] The hybrid cloud cluster ID.	1
RuleType `deprecated`	string	No	[Deprecated] The rule type. Valid values: pullin: cluster traffic redirection	pullin
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 Alibaba Cloud resource group ID.	rg-acfm***q
ClusterRuleResourceId	string	No	The cluster rule resource ID.	hdbc-clusterrule-*******m0w

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1F29A6D2-9EB6-526D-A997-36888**99CB
ClusterRule	object	The rule information.
RuleType	string	The rule type. Valid values: pullin: traffic redirection rule	pullin
RuleConfig	string	The traffic redirection rule configuration: check_mode: the mode selection. 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	{\"check_mode\":\"all\",\"exclude\":{\"exact\":[],\"regex\":[]}}
RuleStatus	string	The rule status. Valid values: on: enabled. off: disabled.	on
ClusterRuleResourceId	string	The cluster rule resource ID.	hdbc-clusterrule-2m*****m0w

Examples

Success response

JSON format

{
  "RequestId": "1F29A6D2-9EB6-526D-A997-36888**99CB",
  "ClusterRule": {
    "RuleType": "pullin",
    "RuleConfig": "{\\\"check_mode\\\":\\\"all\\\",\\\"exclude\\\":{\\\"exact\\\":[],\\\"regex\\\":[]}}",
    "RuleStatus": "on",
    "ClusterRuleResourceId": "hdbc-clusterrule-2m*****m0w"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.