All Products
Search
Document Center

Security Center:GetContainerDefenseRuleDetail

Last Updated:Nov 13, 2024

Queries the details of a rule for non-image program defense.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RuleIdlongNo

The rule ID.

Note You can call the ListContainerDefenseRule operation to query the rule ID.
156

Response parameters

ParameterTypeDescriptionExample
object

PlainResult

Dataobject

The details of the rule.

Idlong

The ID of the rule.

1948
AliUidlong

The user ID.

1766185894104***
EventTypestring

The alert type. Valid values:

  • Proactive Defense for Containers
EventType
EventNamestring

The alert name. Valid values:

  • Non-image Program Startup
EventName
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
RuleTypestring

The type of the rule. Valid values:

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

The name of the rule.

test-000
Descriptionstring

The description of the rule.

Custom defense configuration
Whitelistobject

The whitelist.

Hasharray

The hash values of the files that are added to the whitelist.

Note This parameter is not supported.
Hashstring

The hash value of the file that is added to the whitelist.

Note This parameter is not supported.
0
Patharray

The paths to the files that are added to the whitelist.

Pathstring

The path to the file that is added to the whitelist.

/home/workdir/
Imagearray

An array consisting of images that are added to the whitelist.

Imagestring

The image that is added to the whitelist.

sdf:sdf
Scopearray<object>

The effective scope of the rule.

Scopeobject
ClusterIdstring

The ID of the container cluster.

c9bea04*2b25**
AllNamespaceinteger

Indicates whether all namespaces are included. Valid values:

  • 0: no
  • 1: yes
1
Namespacesarray

An array that consists of queried namespaces.

Namespacestring

The ID of the namespace.

kube-system
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.

77546BF4-CCE8-5F8D-B42B-5FD3306B43B4
HttpStatusCodeinteger

The HTTP status code. The status code 200 indicates that the request was successful.

200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Id": 1948,
    "AliUid": 0,
    "EventType": "EventType",
    "EventName": "EventName",
    "RuleAction": 1,
    "RuleSwitch": 0,
    "RuleType": "1",
    "RuleName": "test-000",
    "Description": "Custom defense configuration",
    "Whitelist": {
      "Hash": [
        "0"
      ],
      "Path": [
        "/home/workdir/"
      ],
      "Image": [
        "sdf:sdf"
      ]
    },
    "Scope": [
      {
        "ClusterId": "c9bea04*2b25**",
        "AllNamespace": 1,
        "Namespaces": [
          "kube-system"
        ]
      }
    ]
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "77546BF4-CCE8-5F8D-B42B-5FD3306B43B4",
  "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.