All Products
Search
Document Center

Security Center:ListAegisContainerPluginRule

Last Updated:Feb 20, 2024

Queries defense rules against container escapes.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh: Chinese
  • en: English
zh
CriteriastringNo

The query condition.

[{\"name\": \"name\", \"value\": \"test-1818\"}]
CurrentPageintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page.

20
RuleTypeintegerNo

The type of the rule. Valid values:

  • 0: custom
  • 1: system
0

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CE500770-42D3-442E-9DDD-156E0F9F3B45
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

69
RuleListobject []

The rules.

GmtCreatelong

The time when the rule was created. Unit: milliseconds.

1676355025000
GmtModifiedlong

The time when the rule was modified. Unit: milliseconds.

1681985833000
RuleIdlong

The ID of the rule.

30****
RuleNamestring

The name of the rule.

test-18****
RuleDescriptionstring

The description of the rule.

system_call
RuleTemplateIdstring

The ID of the rule template. The ListSystemClientRules operation returns the ID of a rule template.

868**
RuleTemplateNamestring

The name of the rule template.

system_call
Modeinteger

The action of the rule. Valid values:

  • 1: Alert
  • 2: Block
1
SelectedPolicyarray

The fields in the value of the rule subtype.

string

The field in the value of the rule subtype.

system_schedule_task
SwitchIdstring

The switch ID of the rule.

USER-ENABLE-SWITCH-TYPE_****
WhiteImagesarray

The images that are added to the whitelist of the rule.

string

The image that is added to the whitelist of the rule.

nginx:latest

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE500770-42D3-442E-9DDD-156E0F9F3B45",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69
  },
  "RuleList": [
    {
      "GmtCreate": 1676355025000,
      "GmtModified": 1681985833000,
      "RuleId": 0,
      "RuleName": "test-18****",
      "RuleDescription": "system_call",
      "RuleTemplateId": "868**",
      "RuleTemplateName": "system_call",
      "Mode": 1,
      "SelectedPolicy": [
        "system_schedule_task"
      ],
      "SwitchId": "USER-ENABLE-SWITCH-TYPE_****",
      "WhiteImages": [
        "nginx:latest"
      ]
    }
  ]
}

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.