DescribeHybridCloudClusters - Web Application Firewall - Alibaba Cloud Documentation Center

Queries a list of hybrid cloud clusters.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstanceInfo to query the ID of the WAF instance.	waf_v2_public_cn-uqm35****02
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.
RequestId	string	The request ID.	66A98669-ER12-WE34-23PO-301469*****E
ClusterInfos	array<object>	The list of clusters.
	object	The cluster information.
HttpsPorts	string	The ports that use the HTTPS protocol. The value is a string. If multiple ports are returned, they are separated by commas in the port1,port2,port3 format.	443,8443
ProtectionServerCount	integer	The number of protection nodes that you can add to the cluster.	1
ProxyStatus	string	The status of the proxy. Valid values: on: enabled off: disabled	off
RuleType	string	The type of the rule. Valid values: bypass: WAF does not perform security checks and allows traffic to pass through.	bypass
AccessRegion	string	The region where the leased line is connected. Valid values: cn-hangzhou: Hangzhou cn-beijing: Beijing cn-shanghai: Shanghai	cn-hangzhou
Remark	string	The remarks.	测试集群备注
ClusterResourceId	string	The resource ID of the hybrid cloud cluster.	hdbc-cluster-t1****a
ClusterName	string	The name of the cluster.	混合云**集群
RuleStatus	string	The status of the manual bypass setting. Valid values: on: enabled. off: disabled.	off
Id	integer	The cluster ID.	524**8
AccessMode	string	The network access mode. Valid values: internet: Internet access. vpc: leased line-based private network access.	internet
ProxyType	string	The type of the cluster. Valid values: cname: reverse proxy cluster service: service cluster	cname
RuleConfig	string	The rule configuration.	{"enable":true,"param":{"breaker":{"duration":1,"failed":1,"recent_failed":1},"disable_protect":false,"max_request_body_len":1,"timeout":1}}
HttpPorts	string	The ports that use the HTTP protocol. The value is a string. If multiple ports are returned, they are separated by commas in the port1,port2,port3 format.	80,8080

Examples

Success response

JSON format

{
  "RequestId": "66A98669-ER12-WE34-23PO-301469*****E",
  "ClusterInfos": [
    {
      "HttpsPorts": "443,8443",
      "ProtectionServerCount": 1,
      "ProxyStatus": "off",
      "RuleType": "bypass",
      "AccessRegion": "cn-hangzhou",
      "Remark": "测试集群备注",
      "ClusterResourceId": "hdbc-cluster-t1****a",
      "ClusterName": "混合云**集群",
      "RuleStatus": "off",
      "Id": 0,
      "AccessMode": "internet",
      "ProxyType": "cname",
      "RuleConfig": "{\"enable\":true,\"param\":{\"breaker\":{\"duration\":1,\"failed\":1,\"recent_failed\":1},\"disable_protect\":false,\"max_request_body_len\":1,\"timeout\":1}}",
      "HttpPorts": "80,8080"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.