All Products
Search
Document Center

:DescribeHybridCloudClusters

Last Updated:Nov 15, 2024

Queries a list of hybrid cloud clusters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeHybridCloudClustersget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the Web Application Firewall (WAF) instance.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.
waf_v2_public_cn-uqm35****02
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q
RegionIdstringNo

The region where the WAF instance is deployed. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

66A98669-ER12-WE34-23PO-301469*****E
ClusterInfosarray<object>

The information about the clusters.

ClusterInfoobject
Idlong

The ID of the cluster.

524**8
ClusterNamestring

The name of the cluster.

AccessModestring

The network access mode. Valid values:

  • internet: Internet access.
  • vpc: internal network access by using Express Connect circuits.
internet
AccessRegionstring

The region where the virtual private cloud (VPC) resides. Valid values:

  • cn-hangzhou: China (Hangzhou).
  • cn-beiijng: China (Beijing).
  • cn-shanghai: China (Shanghai).
cn-hangzhou
ProtectionServerCountinteger

The number of protection nodes that can be added to the cluster.

1
HttpPortsstring

The HTTP ports. The value is a string. If multiple ports are returned, the value is in the port1,port2,port3 format.

80,8080
HttpsPortsstring

The HTTPS ports. The value is a string. If multiple ports are returned, the value is in the port1,port2,port3 format.

443,8443
Remarkstring

The remarks about the cluster.

ProxyTypestring

The type of the cluster. Valid values:

  • cname: reverse proxy cluster.
  • service: SDK-based traffic mirroring cluster.
cname
RuleConfigstring

The configurations of the rule.

{"enable":true,"param":{"breaker":{"duration":1,"failed":1,"recent_failed":1},"disable_protect":false,"max_request_body_len":1,"timeout":1}}
RuleStatusstring

The status of manual bypass. Valid values:

  • on: enabled.
  • off: disabled.
off
ClusterResourceIdstring

The ID of the hybrid cloud cluster resource.

hdbc-cluster-t1****a
ProxyStatusstring

The status of the proxy gateway. Valid values:

  • on: enabled.
  • off: disabled.
off
RuleTypestring

The type of the rule. Valid value:

  • bypass: Requests are allowed without security checks.
bypass

Examples

Sample success responses

JSONformat

{
  "RequestId": "66A98669-ER12-WE34-23PO-301469*****E",
  "ClusterInfos": [
    {
      "Id": 0,
      "ClusterName": "",
      "AccessMode": "internet",
      "AccessRegion": "cn-hangzhou",
      "ProtectionServerCount": 1,
      "HttpPorts": "80,8080",
      "HttpsPorts": "443,8443",
      "Remark": "",
      "ProxyType": "cname",
      "RuleConfig": "{\"enable\":true,\"param\":{\"breaker\":{\"duration\":1,\"failed\":1,\"recent_failed\":1},\"disable_protect\":false,\"max_request_body_len\":1,\"timeout\":1}}",
      "RuleStatus": "off",
      "ClusterResourceId": "hdbc-cluster-t1****a",
      "ProxyStatus": "off",
      "RuleType": "bypass"
    }
  ]
}

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