All Products
Search
Document Center

Container Registry:CreateScanRule

Last Updated:Dec 17, 2025

Creates a scan or content analysis rule.

Operation description

Creates a scan or content analysis rule.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cr:CreateScanRulecreate
*ScanRule
acs:cr:{#regionId}:{#accountId}:instance/{#instanceId}/scanrule/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID

cri-dqwc**********
RuleNamestringYes

The rule name

default
ScanScopestringYes

The scan scope

Valid values:

  • NAMESPACE: namespace.
  • REPO: repository.
Enumeration Value:
  • INSTANCE
  • NAMESPACE
  • REPO
NAMESPACE
TriggerTypestringYes

Trigger type

Valid values:

  • AUTO: automatically trigger.
  • MANUAL: manually trigger.
AUTO
NamespacesarrayNo

The list of namespaces.

  • When the scan scope is NAMESPACE, this parameter cannot be empty.
  • If the scan scope is REPO, you must specify a unique Namespace for this parameter.
stringNo

Namespace

ns1
RepoNamesarrayNo

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.
stringNo

The repository name

reppo1
RepoTagFilterPatternstringYes

The tag that triggers the scan matches the regular expression

.*
ScanTypestringNo

The scan type. Valid values:

  • VUL: Products Cloud Security Scanner
  • SBOM: Product Content Analysis

Default value: VUL

VUL

Response parameters

ParameterTypeDescriptionExample
object

The response struct

RequestIdstring

Request Id

EAEAB520-2456-5BF2-BCB5-AC998DFA3A51
Codelong

The returned HTTP or HTTPS status code.

success
ScanRuleIdstring

The rule ID.

crscnr-k3gdm5vrn2nzf5hw

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2025-11-28Add OperationView Change Details