Hybrid Cloud Cluster Servers Overview in WAF - Web Application Firewall

Queries the servers in 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:DescribeHybridCloudClusterServers

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 the DescribeInstance operation to query the ID of the WAF instance.	waf_v3prepaid_public_cn-******nd07
ClusterId	integer	Yes	The ID of the hybrid cloud cluster.	1
Ip	string	No	The IP address of the server that you want to query.	1.X.X.1
HostName	string	No	The hostname of the server that you want to query.	online-***wwq
GroupType	string	No	The type of the hybrid cloud node group. Valid values: protect: protection. control: control. storage: storage. controlStorage: control and storage.	protect
GroupName	string	No	The name of the node group.	test
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
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.	3
RequestId	string	The request ID.	C3B0FDD2-11CE-59A5-BEB5-*****1A969
ClusterServers	array<object>	The servers in the hybrid cloud cluster.
	object
GroupName	string	The name of the node group.	Test group.
Operator	string	The cloud service provider where the server resides.	aliyun
Status	string	The health status of the server in the hybrid cloud cluster.	ok
RegionCodeValue	integer	The numeric code of the region where the server resides.	0
RegionCode	string	The region identifier of the server, such as `beijing`.	beijing
Memory	integer	The memory size of the server. Unit: bytes.	33547386880
Ip	string	The IP address of the server.	1..1
Cpu	integer	The number of CPU cores of the server.	4
Mid	string	The machine ID (MID) of the server.	28ab688cd403563e8e173*****79600
ContinentsValue	integer	The continent code of the protection cluster. Note For a list of valid codes, see the supplementary description of response parameters.	410
Mac	string	The MAC address of the server.	::00:02:eb:c7
GroupId	integer	The ID of the node group.	1
JobStatus	string	The running status of the server.	running
GroupType	string	The type of the hybrid cloud node group. Valid values: protect: protection. control: control. storage: storage. controlStorage: control and storage.	protect
CustomName	string	The custom name of the server.	Test group
UpdateTimestamp	integer	The time when the server was last updated. This value is a UNIX timestamp. Unit: milliseconds.	1711953897000
Continents	string	The continent identifier of the server, such as `asiapacific`.	asiapacific
CreateTimestamp	integer	The time when the server was created. This value is a UNIX timestamp. Unit: milliseconds.	1665987186000
HostName	string	The hostname of the server.	qsh5-sec-waf-*****-6
OperatorValue	integer	The carrier code of the server.	0

Examples

Success response

JSON format

{
  "TotalCount": 3,
  "RequestId": "C3B0FDD2-11CE-59A5-BEB5-*****1A969",
  "ClusterServers": [
    {
      "GroupName": "Test group.",
      "Operator": "aliyun",
      "Status": "ok",
      "RegionCodeValue": 0,
      "RegionCode": "beijing",
      "Memory": 33547386880,
      "Ip": "1.*.*1",
      "Cpu": 4,
      "Mid": "28ab688cd403563e8e173*****79600",
      "ContinentsValue": 410,
      "Mac": "**:**:00:02:eb:c7",
      "GroupId": 1,
      "JobStatus": "running",
      "GroupType": "protect",
      "CustomName": "Test group",
      "UpdateTimestamp": 1711953897000,
      "Continents": "asiapacific",
      "CreateTimestamp": 1665987186000,
      "HostName": "qsh5-sec-waf-*****-6",
      "OperatorValue": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.