All Products
Search

This Product

    Security Center:GetAegisContainerPluginRule

    Document Center

    Security Center:GetAegisContainerPluginRule

    Last Updated:Mar 24, 2026

    Retrieves the details of a defense rule against container escapes.

    Operation description

    Only the Ultimate edition of Security Center supports this operation.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

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

    • zh: Chinese

    • en: English

    zh
    RuleType

    integer

    No

    The type of the rule. Valid values:

    • 0: custom rule

    • 1: system rule

    0
    Id

    string

    No

    The ID of the defense rule against container escapes.

    Note

    You can call the ListAegisContainerPluginRule operation to obtain the ID.

    1141****

    Response elements

    Element

    Type

    Description

    Example

    object

    Data

    object

    The returned data.

    GmtCreate

    integer

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

    1671607025000
    GmtModified

    integer

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

    1671607025000
    RuleId

    integer

    The ID of the rule.

    21**
    RuleName

    string

    The name of the rule.

    auto_test_rule-EmzIXZ
    RuleDescription

    string

    The description of the rule.

    autoTest
    RuleTemplateId

    string

    The template ID of the rule.

    100**
    RuleTemplateName

    string

    The template name of the rule.

    template01
    Mode

    integer

    The action mode of the rule. Valid values:

    • 0: allows escape behavior.

    • 1: triggers alerts.

    • 2: blocks escape behavior.

    1
    SelectedPolicy

    array

    The rule items.

    string

    The rule item.

    notify_on_release_2
    SwitchId

    string

    The ID of the switch.

    USER-CONTAINER-RULE-SWITCH-TYPE_***
    WhiteImages

    array

    The images that are added to the whitelist.

    string

    The image that is added to the whitelist.

    centos
    RequestId

    string

    The request ID.

    09969D2C-***0DEF8BF6F

    Examples

    Success response

    JSON format

    {
  "Data": {
    "GmtCreate": 1671607025000,
    "GmtModified": 1671607025000,
    "RuleId": 0,
    "RuleName": "auto_test_rule-EmzIXZ",
    "RuleDescription": "autoTest",
    "RuleTemplateId": "100**",
    "RuleTemplateName": "template01",
    "Mode": 1,
    "SelectedPolicy": [
      "notify_on_release_2"
    ],
    "SwitchId": "USER-CONTAINER-RULE-SWITCH-TYPE_***",
    "WhiteImages": [
      "centos"
    ]
  },
  "RequestId": "09969D2C-***0DEF8BF6F"
}

    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.