DescribeHybridCloudClusterRules - 查询混合云集群规则列表

集群规则列表

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeHybridCloudClusterRules

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

WAF 实例的 ID。

说明

您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。

waf_v3prepaid_public_cn-****

RuleType

string

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

  • pullin:集群引流

pullin

ClusterId

integer

混合云集群 ID。

说明

只针对混合云场景,您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。

428

PageSize

integer

分页查询时,每页包含多少条结果。默认值为 10,表示每页包含 10 条结果。

10

PageNumber

integer

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

1

RegionId

string

WAF 实例所属地域。取值:

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

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

cn-hangzhou

ResourceManagerResourceGroupId

string

阿里云资源组 ID。

rg-acfm***q

RuleContent

string

规则值前缀匹配。

1.1.1.1

RuleMatchType

string

匹配逻辑取值:

  • 精准:exact

  • 正则:regex

exact

返回参数

名称

类型

描述

示例值

object

响应数据

TotalCount

integer

查询到的云产品接入总数量。

10

RequestId

string

本次请求的 ID。

D7861F61-5B61-46CE-A47C-6B19160D5EB0

Data

array<object>

响应数据。

object

合规检测结果。

Status

string

规则的状态。取值:

  • 1:表示开启。

  • 0:表示关闭。

1

ClusterId

integer

混合云集群 ID

1099

Version

integer

版本号。

1

ClusterRuleResourceId

string

集群规则资源 ID

hdbc-clusterrule-*****khzre0ym0w

RuleType

string

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

  • pullin:集群引流

pullin

RuleConfig

string

引流规则配置:

  • check_mode 模式选择 取值:
    • all:全量引流

    • part:指定部分引流

  • type:规则匹配类型取值:
    • exact:精准

    • regex:正则

  • substance:规则值

{\"check_mode\": \"all\", \"type\": \"exact\", \"substance\": \"122\"}

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "Status": "1",
      "ClusterId": 1099,
      "Version": 1,
      "ClusterRuleResourceId": "hdbc-clusterrule-*****khzre0ym0w",
      "RuleType": "pullin",
      "RuleConfig": "{\\\"check_mode\\\": \\\"all\\\", \\\"type\\\": \\\"exact\\\", \\\"substance\\\": \\\"122\\\"}"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情