At-Risk Image Blocking Rules API Reference - Security Center - Alibaba Cloud - Security Center

Retrieves the list of risky image blocking policies.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StrategyName	array	No	The policy name.
	string	No	The policy name.	default
ImageName	array	No	The list of image names.
	string	No	The image name.	repo:tag
Label	array	No	The list of labels.
	string	No	The container label.	testlabel
PageSize	integer	No	The number of entries per page in a paged query.	20
CurrentPage	integer	No	The page number of the current page in a paged query.	1

Response elements

Element	Type	Description	Example
	object	PageResult
List	array<object>	The list of policies.
	object	The policy object.
StrategyId	integer	The policy ID.	1
StrategyName	string	The policy name.	auto-strategy-vohuiq
Description	string	The description.	Config the Event Audit policys
UnScanedImage	boolean	Specifies whether the rule supports unscanned images. Valid values: true: Supported. false: Not supported.	true
MaliciousImage	boolean	Specifies whether the rule supports Internet malicious images. Valid values: true: Supported. false: Not supported.	true
Action	integer	The action performed by the policy. Valid values: 1: alert 2: block 3: allow.	1
ClusterCount	integer	The number of clusters to which the policy applies.	1
ClusterIdList	array	The list of clusters to which the policy applies.
	string	The cluster to which the policy applies.	cfb41a8**8a106
ImageName	array	The image name.
	string	The image name.	centos
Label	array	The container label.
	string	The container label.	alertmanager:main
PageInfo	object	The pagination information of the query result.
CurrentPage	integer	The page number of the current page in a paged query.	1
PageSize	integer	The maximum number of entries per page in a paged query.	20
TotalCount	integer	The total number of entries.	45
Count	integer	The number of entries on the current page.	20
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call 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 result message. Fixed value: success. This indicates that the export was successful.	success
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.	7DFD947C-9172-5129-B783-DD14C55191D2
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "List": [
    {
      "StrategyId": 1,
      "StrategyName": "auto-strategy-vohuiq",
      "Description": "Config the Event Audit policys",
      "UnScanedImage": true,
      "MaliciousImage": true,
      "Action": 1,
      "ClusterCount": 1,
      "ClusterIdList": [
        "cfb41a8**8a106"
      ],
      "ImageName": [
        "centos"
      ],
      "Label": [
        "alertmanager:main"
      ]
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 45,
    "Count": 20
  },
  "Success": true,
  "Code": "200",
  "Message": "success",
  "RequestId": "7DFD947C-9172-5129-B783-DD14C55191D2",
  "HttpStatusCode": 200
}

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.