ListScanRule - Container Registry - Alibaba Cloud Documentation Center

Lists the scan rules.

Operation description

Lists the scan rules.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cr:ListScanRule	get	ScanRule `acs:cr:{#regionId}:{#accountId}:instance/{#instanceId}/scanrule/`	none	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 number of entries per page.	30
ScanType	string	No	The type of the vulnerability. Valid values: `VUL`: Products Cloud Security Scanner. `SBOM`: Product Content Analysis. Default value: `VUL`	SBOM

Response parameters

Parameter	Type	Description	Example
	object	The response struct.
RequestId	string	Request Id	2CB62B5E-605B-5A23-9110-728B8207A25C
Code	string	The HTTP status code	success
PageNo	integer	The page number.	1
IsSuccess	boolean	Indicates whether the request is successful.	True
PageSize	integer	The number of entries per page.	30
TotalCount	integer	The total number of entries returned.	1
ScanRules	array<object>	The list of scan rules.
ScanRules	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.
Namespaces	string	The list of namespaces.	platform
RepoNames	array	The repository name.
RepoNames	string	The repository name.	cloud-function-agent
RepoTagFilterPattern	string	The tag that triggers the scan matches the regular expression.	.*
CreateTime	long	The creation time.	1702361810000
UpdateTime	long	The update time.	1764122725000
ScanType	string	The scan type. Valid values: `VUL`: Products Cloud Security Scanner `SBOM`: Product Content Analysis	SBOM

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-11-28	Add Operation	View Change Details