DescribeHybridCloudGroups - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the hybrid cloud node groups that are added to Web Application Firewall (WAF).

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

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the current WAF instance.	waf_v3prepaid_public_cn-********w0b
ClusterId	integer	No	The ID of the hybrid cloud cluster.	428
GroupName	integer	No	The name of the node group to query.	groupName1
GroupType	string	No	The type of the hybrid cloud node group. Valid values: protect: protection. control: control. storage: storage. controlStorage: control and storage.	protect
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
ClusterProxyType	string	No	The proxy type of the cluster. Valid values: service: SDK integration. cname: reverse proxy.	cname
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
TotalCount	integer	The total number of entries returned.	146
RequestId	string	The ID of the request.	045660E7-C4C6-5CD7-8182-7B337D95ADF4
Groups	array<object>	The hybrid cloud node groups.
	object	The information about a hybrid cloud node group.
GroupName	string	The name of the hybrid cloud node group.	StorageGroup
RegionCodeValue	integer	The city code of the protection cluster. Note For a list of valid codes, see Additional information about response parameters.	0
LoadBalanceIp	string	The IP address of the Server Load Balancer instance.	1.1.XX.XX
BackSourceMark	string	The back-to-origin mark of the protection cluster. The value is a string in the {Carrier Name}-{Continent Name}-{City Name}-{Back-to-origin Identifier} format. The back-to-origin identifier is optional. Note For a list of valid values, see Additional information about response parameters.	aliyun-asiapacific-beijing-56477821
GroupType	string	The type of the hybrid cloud node group. Valid values: protect: protection. control: control. storage: storage. controlStorage: control and storage.	protect
LocationId	integer	The ID of the protection node.	1312
Ports	string	The ports that are used by the hybrid cloud cluster. This parameter is a string. Multiple ports are separated by commas (,), for example, port1,port2,port3.	80,9200,20018
ContinentsValue	integer	The continent code of the protection cluster. Note For a list of valid codes, see Additional information about response parameters.	410
GroupId	integer	The ID of the hybrid cloud node group.	123
Remark	string	The remarks.	备注
OperatorValue	integer	The carrier code of the protection cluster. Note For a list of valid codes, see Additional information about response parameters.	0

Carrier codes for protection clusters

Carrier Code	Carrier Tag	Carrier Description
0	aliyun	Alibaba Cloud
3	tencent	Tencent
100	google	Google
200	IDC	IDC

Continent codes for protection clusters

Continent Code	Continent Tag	Continent Description
410	asiapacific	asiapacific
411	euro	euro

City codes for protection clusters

Continent Code	City Code	City Tag	City Description
411	0	frankfurt	Frankfurt
411	1	siliconvallery	Silicon Valley
411	2	Virginia	Virginia
410	0	beijing	Beijing
410	1	shanghai	Shanghai
410	2	hongkong	Hong Kong (China)
410	3	Jakarta	Indonesia (Jakarta)
410	4	hangzhou	Hangzhou
410	5	zhangjiakou	Zhangjiakou
410	6	shenzhen	Shenzhen
410	7	singapore	Singapore
410	8	Tokyo	Tokyo
410	9	changsha	Changsha
410	10	public_cloud	Public cloud
410	11	nanjing	Nanjing

Examples

Success response

JSON format

{
  "TotalCount": 146,
  "RequestId": "045660E7-C4C6-5CD7-8182-7B337D95ADF4",
  "Groups": [
    {
      "GroupName": "StorageGroup",
      "RegionCodeValue": 0,
      "LoadBalanceIp": "1.1.XX.XX",
      "BackSourceMark": "aliyun-asiapacific-beijing-56477821",
      "GroupType": "protect",
      "LocationId": 1312,
      "Ports": "80,9200,20018",
      "ContinentsValue": 410,
      "GroupId": 123,
      "Remark": "备注",
      "OperatorValue": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.