Scan Rule Overview for Vulnerability & SBOM Detection - Container Registry - Alibaba Cloud - Container Registry

Lists scan rules.

Operation description

Lists scan rules.

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

get

*ScanRule

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	cri-upoulewerx*****
PageNo	integer	No	The page number.	1
PageSize	integer	No	The page size.	30
ScanType	string	No	The vulnerability type. Valid values: `VUL`: artifact vulnerability scanning. `SBOM`: artifact content analysis. Default value: `VUL`. Valid values: SBOM : Artifact content analysis. VUL : Artifact vulnerability scanning.	SBOM

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	Request Id	2CB62B5E-605B-5A23-9110-728B8207A25C
Code	string	The return code.	success
PageNo	integer	The page number.	1
IsSuccess	boolean	Indicates whether the request was successful.	True
PageSize	integer	The page size.	30
TotalCount	integer	The total number of entries.	1
ScanRules	array<object>	The list of scan rules.
	object	The list of scan rules.
ScanRuleId	string	The scan rule ID.	crscnr-2sdveqjhpzd****
RuleName	string	The rule name.	cicd-prod
ScanScope	string	The scan scope.	REPO
TriggerType	string	The trigger type.	AUTO
Namespaces	array	The list of namespaces.
	string	The list of namespaces.	platform
RepoNames	array	The repository name.
	string	The repository name.	cloud-function-agent
RepoTagFilterPattern	string	The regular expression used to match tags that trigger a scan.	.*
CreateTime	integer	The creation time. The value is a UNIX timestamp in milliseconds.	1702361810000
UpdateTime	integer	The update time. The value is a UNIX timestamp in milliseconds.	1764122725000
ScanType	string	The scan type. Valid values: `VUL`: artifact vulnerability scanning. `SBOM`: artifact content analysis.	SBOM

Examples

Success response

JSON format

{
  "RequestId": "2CB62B5E-605B-5A23-9110-728B8207A25C",
  "Code": "success",
  "PageNo": 1,
  "IsSuccess": true,
  "PageSize": 30,
  "TotalCount": 1,
  "ScanRules": [
    {
      "ScanRuleId": "crscnr-2sdveqjhpzd****",
      "RuleName": "cicd-prod",
      "ScanScope": "REPO",
      "TriggerType": "AUTO",
      "Namespaces": [
        "platform"
      ],
      "RepoNames": [
        "cloud-function-agent"
      ],
      "RepoTagFilterPattern": ".*",
      "CreateTime": 1702361810000,
      "UpdateTime": 1764122725000,
      "ScanType": "SBOM"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.