All Products
Search
Document Center

Web Application Firewall:DescribeHybridCloudGroups

Last Updated:Sep 13, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeHybridCloudGroupslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the WAF instance.

Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.
waf_v3prepaid_public_cn-********w0b
ClusterIdlongNo

The ID of the hybrid cloud cluster.

428
GroupNameintegerNo

The name of the node group that you want to query.

groupName1
GroupTypestringNo

The type of the node group. Valid values:

  • protect
  • control
  • storage
  • controlStorage
protect
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10.

10
ClusterProxyTypestringNo

The type of proxy cluster that is used. Valid values:

  • service: service-based traffic mirroring.
  • cname: reverse proxy.
cname
ResourceManagerResourceGroupIdstringNo

The ID of the resource group.

rg-acfm***q
RegionIdstringNo

The region ID of the WAF instance. Valid values:

  • cn-hangzhou: the Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

045660E7-C4C6-5CD7-8182-7B337D95****
Groupsarray<object>

The node groups.

object

The information about the node group.

GroupIdinteger

The ID of the node group.

123
GroupNamestring

The name of the node group.

StorageGroup
GroupTypestring

The type of the node group. Valid values:

  • protect
  • control
  • storage
  • controlStorage
protect
LoadBalanceIpstring

The IP address of the server used for load balancing.

1.1.XX.XX
Portsstring

The port that is used by the hybrid cloud cluster. The value of this parameter is a string. If multiple ports are returned, the value is in the port1,port2,port3 format.

80,9200,20018
Remarkstring

The description of the node group.

test
LocationIdlong

The ID of the protection node.

1312
OperatorValueinteger

The ISP code of the protected cluster.

Note For more information about ISP codes, see ISP codes in this topic.
0
ContinentsValueinteger

The continent code of the protected cluster.

Note For more information about continent codes, see Continent codes in this topic.
410
RegionCodeValueinteger

The city code of the protected cluster.

Note For more information about city codes, see City codes in this topic.
0
BackSourceMarkstring

The back-to-origin mark of the protected cluster. The value is in the {ISP name}-{Continent name}-{City name}-{Back-to-origin identifier} format. The back-to-origin identifier is optional.

Note For more information about ISP names, continent names, city names, and back-to-origin identifiers, see the following sections.
aliyun-asiapacific-beijing-12345678
TotalCountinteger

The total number of entries returned.

146

ISP codes

ISP codeISP tagISP description
0aliyunAlibaba Cloud
3tencentTencent Cloud
100googleGoogle Cloud
200IDCIDC

Continent codes

Continent codeContinent tagContinent description
410asiapacificasiapacific
411euroeuro

City codes

Continent codeCity codeCity tagCity description
4110frankfurtFrankfurt
4111siliconvallerySilicon Valley
4112VirginiaVirginia
4100beijingBeijing
4101shanghaiShanghai
4102hongkongHong Kong, China
4103jakartaJakarta
4104hangzhouHangzhou
4105zhangjiakouZhangjiakou
4106shenzhenShenzhen
4107singaporeSingapore
4108TokyoTokyo
4109changshaChangsha
41010public_cloudPublic cloud
41011nanjingNanjing

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-29The request parameters of the API has changedView Change Details
2023-10-18The internal configuration of the API is changed, but the call is not affectedView Change Details