ListContainerDefenseRule API Reference for Container Defense Rules - Security Center - Alibaba Cloud - Security Center

Retrieves the list of defense rules for non-image programs.

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:ListContainerDefenseRule

get

*ContainerDefenseRule

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

None

Request parameters

Parameter	Type	Required	Description	Example
RuleType	integer	No	The rule type. Valid values: 1: system rule 2: user rule.	1
Conditions	array<object>	No	The list of conditions.
	object	No	The list of conditions.
Type	string	No	The condition type. The following type is supported: ruleName: rule name.	ruleName
Value	string	No	The condition content.	auto-test-rule-**
CurrentPage	integer	No	The page number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paging query. Default value: 20. If you leave this parameter empty, 20 entries are returned per page. Note Do not leave PageSize empty.	20
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh
IsDefaultRule	integer	No	Specifies whether the rule is a system default rule. Important This parameter is deprecated. .	1

Response elements

Element	Type	Description	Example
	object	PageResult
List	array<object>	The list of rules.
	object	The rule object.
RuleId	integer	The rule ID.	181
RuleType	integer	The rule type. Valid values: 1: system rule. 2: user-defined rule.	1
RuleName	string	The rule name.	test-rule-01
Description	string	The rule description.	defense rule.
RuleAction	integer	The rule action. Valid values: 1: Alert. 2: Block.	1
RuleSwitch	integer	The switch status of the rule. Valid values: 1: enabled. 0: disabled.	0
ClusterCount	integer	The total number of clusters.	1
ClusterIdList	string	The list of clusters associated with the rule.	cfb41a8**8a106
PageInfo	object	The pagination information of the query result.
CurrentPage	integer	The page number of the current page in a paging query.	1
PageSize	integer	The maximum number of entries per page in a paging query.	20
TotalCount	integer	The total number of entries returned.	45
Count	integer	The number of entries on the current page.	9
LastRowKey	string	The key of the last entry.	CAESGgo***jE2NDc4NjE=
NextToken	string	The value of NextToken returned when the NextToken-based pagination method is used.	B60***
Success	boolean	Indicates whether the call was successful. Valid values: true: successful. false: failed.	true
Code	string	The result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of a failure.	200
Message	string	The returned message.	successful
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	5E3A63BA-***843
HttpStatusCode	integer	The HTTP status code of the request.	200

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.