Automate Image Scanning via CreateScanRule API - Container Registry - Alibaba Cloud - Container Registry

Creates a scan or content analysis rule.

Operation description

Creates a scan or content analysis rule.

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

cr:CreateScanRule

create

*ScanRule

acs:cr:{#regionId}:{#accountId}:instance/{#instanceId}/scanrule/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	cri-dqwc**********
RuleName	string	Yes	The rule name.	default
ScanScope	string	Yes	The scan scope. Valid values: NAMESPACE : namespace. REPO : repository.	NAMESPACE
TriggerType	string	Yes	The trigger type. Valid values: AUTO : Automatically triggered upon push. MANUAL : Manually triggered.	AUTO
Namespaces	array	No	The collection of namespaces. If the scan scope is NAMESPACE, this parameter cannot be empty. If the scan scope is REPO, specify exactly one namespace for this parameter.
	string	No	The namespace.	ns1
RepoNames	array	No	The list of repositories. If the scan scope is NAMESPACE, this parameter must be empty. If the scan scope is REPO, this parameter cannot be empty.
	string	No	The repository name.	reppo1
RepoTagFilterPattern	string	Yes	The regular expression used to match tags that trigger a scan.	.*
ScanType	string	No	The scan type. Valid values: `VUL`: Artifact vulnerability scanning. `SBOM`: Artifact content analysis. Default value: `VUL`. Valid values: SBOM : Artifact content analysis. VUL : Artifact vulnerability scanning.	VUL

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	Request Id	EAEAB520-2456-5BF2-BCB5-AC998DFA3A51
Code	integer	The status code.	success
ScanRuleId	string	The rule ID.	crscnr-k3gdm5vrn2nzf5hw

Examples

Success response

JSON format

{
  "RequestId": "EAEAB520-2456-5BF2-BCB5-AC998DFA3A51",
  "Code": 0,
  "ScanRuleId": "crscnr-k3gdm5vrn2nzf5hw"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.