Query rule template details for proactive defense for containers using GetStrategyTemplateDetail - Security Center - Alibaba Cloud - Security Center

Queries the details of a rule template for container proactive defense.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StrategyId	integer	No	The ID of the rule template. Note You can call the GetOpaStrategyTemplateSummary operation to obtain this parameter.	2

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The template details.
StrategyId	integer	The ID of the rule.	1005
StrategyTemplateId	integer	The ID of the template used by the rule.	1204
ClusterId	string	The ID of the cluster.	c8ca91e0907d94efaba7fb0827eb9****
StrategyName	string	The name of the rule.	Blank template
Description	string	The description of the rule.	Custom defense configuration
ClusterName	string	The name of the cluster.	hhht-cluster-02
UnScanedImage	boolean	Specifies whether the rule supports unscanned images. Valid values: true: Supported. false: Not supported.	false
MaliciousImage	boolean	Specifies whether the rule supports Internet malicious images. Valid values: true: Supported. false: Not supported.	false
Namespace	array	The list of namespaces.
	string	The namespace.	default
ImageName	array	The list of image names.
	string	The image name.	test
Label	array	The list of container labels.
	string	The container label.	test
RuleAction	integer	The rule action. Valid values: 1: alert 2: block 3: allow.	1
WhiteList	array	The list of image tag whitelists.
	string	The image tag whitelist.	test-tag
AlarmDetail	object	The rule configuration information.
Baseline	object	The configuration of the baseline.
RiskLevel	array	The severities of the baselines. Valid values: high medium low
	string	The severity of the baseline. Valid values: high medium low	low
Item	array<object>	The baseline items.
	object
Id	string	The unique identifier of the baseline check item.	ak_leak
Name	string	The name of the baseline check item.	Access Key plaintext storage
Vul	object	The configuration of the vulnerability detection rule.
RiskLevel	array	The severities of the vulnerabilities.
	string	The severity of the vulnerability. Valid values: high medium low	low
Item	array<object>	The items on which vulnerabilities are detected.
	object
Id	string	The ID of the vulnerability.	AVD-2023-1680169
Name	string	The alias of the vulnerability.	ezOffice evoInterfaceServlet Info Leak
MaliciousFile	object	The configuration of the alert rule for the malicious sample.
RiskLevel	array	The severities of the malicious samples.
	string	The severity of the malicious sample. Valid values: high medium low	low
Item	array<object>	The items on which malicious samples are detected.
	object
Id	string	The unique identifier of the malicious sample.	test
Name	string	The name of the malicious sample.	test
Success	boolean	Indicates whether the call was successful. Valid values: true: Successful. false: Failed.	true
Code	string	The result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.	200
Message	string	The detailed information about the error code.	successful
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	1E36BEEA-0B27-58CC-8319-50279203B048

Examples

Success response

JSON format

{
  "Data": {
    "StrategyId": 1005,
    "StrategyTemplateId": 1204,
    "ClusterId": "c8ca91e0907d94efaba7fb0827eb9****",
    "StrategyName": "Blank template",
    "Description": "Custom defense configuration",
    "ClusterName": "hhht-cluster-02",
    "UnScanedImage": false,
    "MaliciousImage": false,
    "Namespace": [
      "default"
    ],
    "ImageName": [
      "test"
    ],
    "Label": [
      "test"
    ],
    "RuleAction": 1,
    "WhiteList": [
      "test-tag"
    ],
    "AlarmDetail": {
      "Baseline": {
        "RiskLevel": [
          "low"
        ],
        "Item": [
          {
            "Id": "ak_leak",
            "Name": "Access Key plaintext storage"
          }
        ]
      },
      "Vul": {
        "RiskLevel": [
          "low"
        ],
        "Item": [
          {
            "Id": "AVD-2023-1680169",
            "Name": "ezOffice evoInterfaceServlet Info Leak"
          }
        ]
      },
      "MaliciousFile": {
        "RiskLevel": [
          "low"
        ],
        "Item": [
          {
            "Id": "test",
            "Name": "test"
          }
        ]
      }
    }
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "1E36BEEA-0B27-58CC-8319-50279203B048"
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.