文档

GetContainerDefenseRuleDetail - 获取非镜像程序防御规则详情

更新时间:

获取非镜像程序防御规则详情。

调试

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

授权信息

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

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

请求参数

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

规则 ID。

说明 您可以调用 ListContainerDefenseRule 接口获取该参数。
156

返回参数

名称类型描述示例值
object

PlainResult

Dataobject

规则详情。

Idlong

规则 ID。

1948
AliUidlong

用户 ID。

1766185894104***
EventTypestring

告警类型。取值:

  • 容器主动防御
EventType
EventNamestring

告警名称,取值:

  • 非镜像程序启动
EventName
RuleActioninteger

规则动作,取值:

  • 1:告警。

  • 2:拦截。

1
RuleSwitchinteger

规则的开关状态。取值:

  • 1:表示开启
  • 0:表示关闭
0
RuleTypestring

规则类型。取值:

  • 1:系统规则。

  • 2:自定义规则。

1
RuleNamestring

规则名称。

test-000
Descriptionstring

描述。

防御规则。
Whitelistobject

白名单

Hasharray

文件 hash 列表。

注意 暂不支持此参数

Hashstring

文件 hash。

注意 暂不支持此参数

0
Patharray

加入白名单的文件路径列表。

Pathstring

加入白名单的文件路径。

/home/workdir/
Imagearray

加入白名单的镜像列表。

Imagestring

加入白名单的镜像。

sdf:sdf
Scopearray<object>

规则生效范围。

Scopeobject

规则生效范围。

ClusterIdstring

容器集群的 ID。

c9bea04*2b25**
AllNamespaceinteger

是否包含所有命名空间,取值:

  • 0:否。
  • 1:是。
1
Namespacesarray

命名空间列表。

Namespacestring

命名空间 ID。

kube-system
Successboolean

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

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

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

200
Messagestring

请求结果返回信息。

successful
RequestIdstring

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

77546BF4-CCE8-5F8D-B42B-5FD3306B43B4
HttpStatusCodeinteger

请求状态码,返回 200 代表请求成功。

200

示例

正常返回示例

JSON格式

{
  "Data": {
    "Id": 1948,
    "AliUid": 0,
    "EventType": "EventType",
    "EventName": "EventName",
    "RuleAction": 1,
    "RuleSwitch": 0,
    "RuleType": "1",
    "RuleName": "test-000",
    "Description": "防御规则。",
    "Whitelist": {
      "Hash": [
        "0"
      ],
      "Path": [
        "/home/workdir/"
      ],
      "Image": [
        "sdf:sdf"
      ]
    },
    "Scope": [
      {
        "ClusterId": "c9bea04*2b25**",
        "AllNamespace": 1,
        "Namespaces": [
          "kube-system"
        ]
      }
    ]
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "77546BF4-CCE8-5F8D-B42B-5FD3306B43B4",
  "HttpStatusCode": 200
}

错误码

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

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