全部产品
Search
文档中心

Web 应用防火墙:DescribeHybridCloudClusters - 查询混合云集群列表

更新时间:Nov 15, 2024

查询混合云集群列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:DescribeHybridCloudClustersget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

要操作的 WAF 实例 ID。

说明 您可以调用 DescribeInstanceInfo 查询 WAF 实例的 ID。
waf_v2_public_cn-uqm35****02
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

返回参数

名称类型描述示例值
object

响应结果。

RequestIdstring

请求 ID。

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

集群列表。

ClusterInfoobject

集群信息。

HttpsPortsstring

HTTPS 协议的端口列表。 取值为字符串, 多个端口时,使用port1,port2,port3的格式返回。

443,8443
ProtectionServerCountinteger

集群可添加的防护节点数量。

1
ProxyStatusstring

代理网关模式。取值范围如下:

  • on:开启
  • off:关闭
off
RuleTypestring

规则类型。取值范围如下:

  • bypass:不做安全检查,直接放行
bypass
AccessRegionstring

专线接入区域。取值范围如下:

  • cn-hangzhou : 杭州
  • cn-beiijng : 北京
  • cn-shanghai : 上海
cn-hangzhou
Remarkstring

备注。

测试集群备注
ClusterResourceIdstring

混合云集群资源 ID。

hdbc-cluster-t1****a
ClusterNamestring

集群名称。

混合云**集群
RuleStatusstring

手动 Bypass 状态,取值范围如下:

  • on:开启。

  • off:关闭。

off
Idlong

集群 ID。

524**8
AccessModestring

网络接入模式。取值范围如下:

  • internet:公网接入。
  • vpc:专线私网接入。
internet
ProxyTypestring

集群类型。取值范围如下:

  • cname:反代集群
  • service:服务化集群
cname
RuleConfigstring

规则配置。

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

HTTP 协议的端口列表。 取值为字符串, 多个端口时,使用port1,port2,port3的格式返回。

80,8080

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-29OpenAPI 入参发生变更查看变更详情