Query the details of a non-image program defense rule with GetContainerDefenseRuleDetail - Security Center

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:GetContainerDefenseRuleDetail

get

*ContainerDefenseRule

acs:yundun-sas:{#regionId}:{#accountId}:containerdefenserule/{#RuleId}

None

Request parameters

Parameter	Type	Required	Description	Example
RuleId	integer	No	The rule ID. Note You can call the ListContainerDefenseRule operation to query the rule ID.	156
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	PlainResult
Data	object	The details of the rule.
Id	integer	The ID of the rule.	1948
AliUid	integer	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.	Defense rule.
Whitelist	object	The whitelist.
Hash `deprecated`	array	The hash values of the files that are added to the whitelist. Note This parameter is not supported.
`deprecated`	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	array<object>	The effective scope of the rule.
	object
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

Success response

JSON format

{
  "Data": {
    "Id": 1948,
    "AliUid": 0,
    "EventType": "EventType",
    "EventName": "EventName",
    "RuleAction": 1,
    "RuleSwitch": 0,
    "RuleType": "1",
    "RuleName": "test-000",
    "Description": "Defense rule.",
    "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
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.