GetContainerDefenseRuleDetail - Security Center - Alibaba Cloud Documentation Center

Queries the details of a rule for non-image program defense.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RuleId	long	No	The rule ID. Note You can call the ListContainerDefenseRule operation to query the rule ID.	156

Response parameters

Parameter	Type	Description	Example
	object	PlainResult
Data	object	The details of the rule.
Id	long	The ID of the rule.	1948
AliUid	long	The user ID.	1766185894104***
EventType	string	The alert type. Valid values: Proactive Defense for Containers	EventType
EventName	string	The alert name. Valid values: Non-image Program Startup	EventName
RuleAction	integer	The action specified in the rule. Valid values: 1: alert 2: block	1
RuleSwitch	integer	The status of the rule. Valid values: 1: enabled 0: disabled	0
RuleType	string	The type of the rule. Valid values: 1: system rule 2: custom rule	1
RuleName	string	The name of the rule.	test-000
Description	string	The description of the rule.	Custom defense configuration
Whitelist	object	The whitelist.
Hash	array	The hash values of the files that are added to the whitelist. Note This parameter is not supported.
	string	The hash value of the file that is added to the whitelist. Note This parameter is not supported.	0
Path	array	The paths to the files that are added to the whitelist.
	string	The path to the file that is added to the whitelist.	/home/workdir/
Image	array	An array consisting of images that are added to the whitelist.
	string	The image that is added to the whitelist.	sdf:sdf
Scope	object []	The effective scope of the rule.
ClusterId	string	The ID of the container cluster.	c9bea042b25*
AllNamespace	integer	Indicates whether all namespaces are included. Valid values: 0: no 1: yes	1
Namespaces	array	An array that consists of queried namespaces.
	string	The ID of the namespace.	kube-system
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.	200
Message	string	The returned message.	successful
RequestId	string	The request ID.	77546BF4-CCE8-5F8D-B42B-5FD3306B43B4
HttpStatusCode	integer	The HTTP status code. The status code 200 indicates that the request was successful.	200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Id": 1948,
    "AliUid": 0,
    "EventType": "EventType",
    "EventName": "EventName",
    "RuleAction": 1,
    "RuleSwitch": 0,
    "RuleType": "1",
    "RuleName": "test-000",
    "Description": "Custom defense configuration",
    "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
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.