DescribeHybridCloudBasicMonitor API Reference for WAF Node Health - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Operation description

Before calling this operation, make sure that the hybrid cloud feature is enabled for your WAF instance. You can call the DescribeInstance operation to query instance details. If the Details.HybridCloud response parameter is true, the hybrid cloud feature is enabled. If the feature is not enabled, log on to the WAF console and upgrade the instance to enable the hybrid cloud feature.

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

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 obtain the ID of the current WAF instance.	waf-cn-7mz****hw0u
Mid	string	Yes	The machine identifier (MID).	f451e90fcb068905ab379468****db42
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
RequestId	string	The request ID.	0B8AF42B-16A9-5762-AEF3-D148****FE5D
BasicMonitors	array<object>	The list of basic monitoring items.
	object	The basic monitoring item.
MonitorName	string	The monitoring item. Valid values: basic_monitor_cpu_usage: CPU. basic_monitor_memory_usage: memory. basic_monitor_disk_usage: disk.	basic_monitor_cpu_usage
UseRatio	integer	The usage ratio.	20
Levle	string	The status. Valid values: normal: Normal. `****`: abnormal (four asterisk characters are returned).	normal
TotalCount `deprecated`	integer	Note This parameter is deprecated and no longer returns meaningful data.	3

Examples

Success response

JSON format

{
  "RequestId": "0B8AF42B-16A9-5762-AEF3-D148****FE5D",
  "BasicMonitors": [
    {
      "MonitorName": "basic_monitor_cpu_usage",
      "UseRatio": 20,
      "Levle": "normal"
    }
  ],
  "TotalCount": 3
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.