All Products
Search
Document Center

Security Center:ListContainerDefenseRule

Last Updated:Aug 28, 2024

Queries a list of rules 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListContainerDefenseRuleget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RuleTypeintegerNo

The rule type. Valid values:

  • 1: system rule
  • 2: user-defined rule
1
Conditionsarray<object>No

The details of the condition.

objectNo
TypestringNo

The condition type. Valid values:

  • ruleName: the rule name
ruleName
ValuestringNo

The rule content.

auto-test-rule-**
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh
IsDefaultRuleintegerNo

Specifies whether to query system rules.

Note This parameter is deprecated.
1

Response parameters

ParameterTypeDescriptionExample
object

PageResult

Listarray<object>

The rules.

object
RuleIdlong

The ID of the rule.

181
RuleTypeinteger

The type of the rule. Valid values:

  • 1: system rule
  • 2: custom rule
1
RuleNamestring

The name of the rule.

test-rule-01
Descriptionstring

The description of the rule.

defense rule.
RuleActioninteger

The action specified in the rule. Valid values:

  • 1: alert
  • 2: block
1
RuleSwitchinteger

The status of the rule. Valid values:

  • 1: enabled
  • 0: disabled
0
ClusterCountinteger

The total number of clusters.

1
ClusterIdListstring

The clusters specified in the rule.

cfb41a8**8a106
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

45
Countinteger

The number of entries returned on the current page.

9
LastRowKeystring

The key of the last data entry.

CAESGgo***jE2NDc4NjE=
NextTokenstring

The query credential.

B60***
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

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
Messagestring

The returned message.

successful
RequestIdstring

The request ID.

5E3A63BA-***843
HttpStatusCodeinteger

The HTTP status code that is returned.

200

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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