全部产品
Search
文档中心

Web 应用防火墙:DescribeHybridCloudClusterRule - 获取混合云集群规则信息

更新时间:Sep 13, 2024

获取混合云集群规则信息。

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。
waf-cn-uqm33n***02
ClusterIdlong

混合云集群 ID

1
RuleTypestring

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

  • pullin:集群引流
pullin
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 id。

1F29A6D2-9EB6-526D-A997-36888**99CB
ClusterRuleobject

规则信息。

RuleTypestring

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

  • pullin:集群引流
pullin
RuleConfigstring

规则配置信息。

{\"check_mode\":\"all\",\"exclude\":{\"exact\":[],\"regex\":[]}}
RuleStatusstring

规则状态,取值范围如下:

  • on:开启。

  • off:关闭。

on

示例

正常返回示例

JSON格式

{
  "RequestId": "1F29A6D2-9EB6-526D-A997-36888**99CB",
  "ClusterRule": {
    "RuleType": "pullin",
    "RuleConfig": "{\\\"check_mode\\\":\\\"all\\\",\\\"exclude\\\":{\\\"exact\\\":[],\\\"regex\\\":[]}}",
    "RuleStatus": "on"
  }
}

错误码

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