DescribeHybridCloudClusterServers - Web Application Firewall

Cluster Machines

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 Web Application Firewall (WAF) instance. Note To query the ID of your WAF instance, call the DescribeInstance operation.	waf_v3prepaid_public_cn-******nd07
ClusterId	integer	Yes	The ID of the cluster.	1
Ip	string	No	The IP address of the server.	1.X.X.1
HostName	string	No	The hostname.	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 resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	3
RequestId	string	The ID of the request.	C3B0FDD2-11CE-59A5-BEB5-*****1A969
ClusterServers	array<object>	The list of servers.
	object
GroupName	string	The name of the node group.	测试组。
Operator	string	The cloud service provider.	aliyun。
Status	string	The status of the server.	ok
RegionCodeValue	integer	The code of the region.	0
RegionCode	string	The name of the region.	beijing
Memory	integer	The memory size.	33547386880
Ip	string	The IP address.	1..1。
Cpu	integer	The number of CPU cores.	4
Mid	string	The machine ID (MID).	28ab688cd403563e8e173*****79600
ContinentsValue	integer	The code for the continent where the protection cluster is deployed. Note For a list of valid values, see the supplementary description of the response parameters.	410
Mac	string	The MAC address.	::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 name of the node group.	测试组
UpdateTimestamp	integer	The timestamp of the last update.	1711953897000
Continents	string	The continent.	asiapacific
CreateTimestamp	integer	The timestamp that indicates when the server was created. Unit: milliseconds.	1665987186000
HostName	string	The hostname.	qsh5-sec-waf-*****-6
OperatorValue	integer	The operation value.	0

Examples

Success response

JSON format

{
  "TotalCount": 3,
  "RequestId": "C3B0FDD2-11CE-59A5-BEB5-*****1A969",
  "ClusterServers": [
    {
      "GroupName": "测试组。",
      "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": "测试组",
      "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.