Automate Container Scan Rules with API - Container Registry - Alibaba Cloud - Container Registry

Updates a scan rule.

Operation description

This API is available through a whitelist. Submit a ticket to request access.

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

update

*ScanRule

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	cri-4abntrj42twd****
ScanRuleId	string	Yes	The rule ID.	crscnr-3qmkeiuggfpjkfrq
RuleName	string	Yes	The rule name.	scan-test
ScanScope	string	Yes	The scan scope. Valid values: NAMESPACE : namespace. REPO : repository.	REPO
TriggerType	string	Yes	The trigger type. Valid values: AUTO : Automatically triggered upon push. MANUAL : Manually triggered.	AUTO
Namespaces	array	No	The collection of namespaces. When the scan scope is NAMESPACE, this parameter cannot be empty. When the scan scope is REPO, this parameter must contain exactly one namespace.
	string	No	The namespace.	prd
RepoNames	array	No	The list of repositories. When the scan scope is NAMESPACE, this parameter must be empty. When the scan scope is REPO, this parameter cannot be empty.
	string	No	The repository name.	prod
RepoTagFilterPattern	string	Yes	The tag filtering rule.	prod-.*

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	Request Id	33EF1695-E2B7-5D57-B4E1-3D655FE1EBD8
Code	integer	The return code.	success
ScanRuleId	string	The rule ID.	crscnr-3qmkeiuggfpjkfrq

Examples

Success response

JSON format

{
  "RequestId": "33EF1695-E2B7-5D57-B4E1-3D655FE1EBD8",
  "Code": 0,
  "ScanRuleId": "crscnr-3qmkeiuggfpjkfrq"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.