All Products
Search
Document Center

:ListAegisContainerPluginRule

Last Updated:Nov 13, 2024

Queries defense rules against container escapes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListAegisContainerPluginRulelist
  • All Resources
    *
    none
none

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
RuleListarray<object>

The rules.

Ruleobject
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.

policystring

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.

whiteImagestring

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

nginx:latest
Policiesarray<object>

An array that consists of policies.

policyobject

The information about the policy.

PolicyKeystring

The policy key.

system_auto_****
PolicyNamestring

The name of the policy.

System self-starting task\*\*\*\*

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"
      ],
      "Policies": [
        {
          "PolicyKey": "system_auto_****",
          "PolicyName": "System self-starting task\\*\\*\\*\\*"
        }
      ]
    }
  ]
}

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.

Change history

Change timeSummary of changesOperation
2024-09-02The response structure of the API has changedView Change Details