文档

DescribeHybridCloudGroups - 查询混合云集群下节点组列表

更新时间:

查询添加到Web应用防火墙的混合云节点组列表。

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
waf_v3prepaid_public_cn-********w0b
ClusterIdlong

混合云集群 ID

428
GroupNameinteger

要查询的节点组名称

groupName1
GroupTypestring

混合云节点组类型。取值:

  • protect:防护。

  • control:管控。

  • storage:存储。

  • controlStorage:管控&存储。

protect
PageNumberinteger

分页查询时,返回第几页数据。默认值为 1,表示返回第 1 页数据。

1
PageSizeinteger

分页查询时,每页的行数。默认值为 10

10
ClusterProxyTypestring

集群代理类型。取值:

  • service:服务化代理。

  • cname:反向代理。

cname
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID,阿里云为该请求生成的标识符。

045660E7-C4C6-5CD7-8182-7B337D95ADF4
Groupsobject []

混合云节点组集合。

GroupIdinteger

混合云节点组 ID。

123
GroupNamestring

混合云节点组名称。

StorageGroup
GroupTypestring

混合云节点组类型。取值:

  • protect:防护。

  • control:管控。

  • storage:存储。

  • controlStorage:管控&存储。

protect
LoadBalanceIpstring

负载均衡(服务器)IP。

1.1.XX.XX
Portsstring

混合云集群使用的端口。 取值为字符串, 多个端口时,使用port1,port2,port3的格式返回。

80,9200,20018
Remarkstring

备注。

备注
LocationIdlong

防护节点 ID。

1312
OperatorValueinteger

防护集群运营商 Code。

说明 Code 的取值列表,见返回参数补充说明。
0
ContinentsValueinteger

防护集群大洲 Code。

说明 Code 的取值列表,见返回参数补充说明。
410
RegionCodeValueinteger

防护集群城市 Code。

说明 Code 的取值列表,见返回参数补充说明。
0
BackSourceMarkstring

防护集群回源标记,格式为 {防护集群运营商 Name}-{防护集群大洲 Name}-{防护集群城市 Name}-{防护集群回源标识}(可选)

说明 防护集群运营商 Name、防护集群大洲 Name、防护集群城市 Name、防护集群回源标识的取值列表,见返回参数补充说明。
aliyun-asiapacific-beijing-56477821
TotalCountinteger

返回结果的总数。

146

防护集群运营商 Code

运营商 Code运营商 Tag运营商 Desc
0aliyun阿里云
3tencent腾讯
100google谷歌
200IDCIDC

防护集群大洲 Code

防护大洲 Code防护大洲 Tag防护大洲 Desc
410asiapacificasiapacific
411euroeuro

防护集群城市 Code

防护大洲 Code防护城市 Code防护城市 Tag防护城市 Desc
4110frankfurt法兰克福
4111siliconvallery硅谷
4112Virginia弗吉尼亚
4100beijing北京
4101shanghai上海
4102hongkong中国香港
4103jakarta雅加达
4104hangzhou杭州
4105zhangjiakou张家口
4106shenzhen深圳
4107singapore新加坡
4108Tokyo东京
4109changsha长沙
41010public_cloud共有云
41011nanjing南京

示例

正常返回示例

JSON格式

{
  "RequestId": "045660E7-C4C6-5CD7-8182-7B337D95ADF4",
  "Groups": [
    {
      "GroupId": 123,
      "GroupName": "StorageGroup",
      "GroupType": "protect",
      "LoadBalanceIp": "1.1.XX.XX",
      "Ports": "80,9200,20018",
      "Remark": "备注",
      "LocationId": 1312,
      "OperatorValue": 0,
      "ContinentsValue": 410,
      "RegionCodeValue": 0,
      "BackSourceMark": "aliyun-asiapacific-beijing-56477821"
    }
  ],
  "TotalCount": 146
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)