文档

ListContainerDefenseRule - 获取非镜像程序防御规则列表

更新时间:

获取非镜像程序防御规则列表。

调试

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

授权信息

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

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

请求参数

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

规则类型。取值:

  • 1: 系统规则
  • 2: 用户规则
1
Conditionsarray<object>

条件列表。

Conditionobject

条件列表。

Typestring

条件类型。支持以下类型:

  • ruleName:规则名称。
ruleName
Valuestring

条件内容。

auto-test-rule-**
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
Langstring

请求和接收消息的语言类型,默认值 zh。取值:

  • zh:中文
  • en:英文
zh
IsDefaultRuleinteger

是否系统默认规则。

注意 此参数已废弃。

1

返回参数

名称类型描述示例值
object

PageResult

Listarray<object>

规则列表。

Listobject

规则列表对象。

RuleIdlong

规则 ID。

181
RuleTypeinteger

规则类型,取值:

  • 1: 系统规则。
  • 2: 用户自定义规则。
1
RuleNamestring

规则名称。

test-rule-01
Descriptionstring

规则描述。

defense rule.
RuleActioninteger

规则动作,取值:

  • 1:告警。

  • 2:拦截。

1
RuleSwitchinteger

规则的开关状态。取值:

  • 1:表示开启。
  • 0:表示关闭。
0
ClusterCountinteger

总集群数。

1
ClusterIdListstring

规则内的集群列表。

cfb41a8**8a106
PageInfoobject

查询结果的分页信息。

CurrentPageinteger

分页查询时,显示的当前页的页码。

1
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

查询结果的总记录数。

45
Countinteger

返回结果的当前页显示数据条数。

9
LastRowKeystring

最后一条数据的键。

CAESGgo***jE2NDc4NjE=
NextTokenstring

使用 NextToken 方式下返回的 NextToken 值。

B60***
Successboolean

接口调用是否成功。取值:

  • true:成功
  • false:失败
true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

请求结果返回信息。

successful
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

5E3A63BA-***843
HttpStatusCodeinteger

请求数据结果的 HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "List": [
    {
      "RuleId": 181,
      "RuleType": 1,
      "RuleName": "test-rule-01",
      "Description": "defense rule.",
      "RuleAction": 1,
      "RuleSwitch": 0,
      "ClusterCount": 1,
      "ClusterIdList": "cfb41a8**8a106"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 45,
    "Count": 9,
    "LastRowKey": "CAESGgo***jE2NDc4NjE=",
    "NextToken": "B60***"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5E3A63BA-***843",
  "HttpStatusCode": 200
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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