All Products
Search
Document Center

Container Registry:ListRepoTagScanResult

Last Updated:Mar 01, 2024

Queries the results of a security scan that is created for an image tag.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:GetScanRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

cri-2j88dtld8yel****
RepoIdstringYes

The ID of the image repository.

crr-uf082u9dg8do****
TagstringYes

The name of the image tag.

1
ScanTaskIdstringNo

The ID of the security scan task.

6b0b094f-8a90-4f8f-b660-2427aed0****
PageNointegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

30
SeveritystringNo

The severity of the vulnerability. Valid values:

  • High
  • Medium
  • Low
  • Unknown
High
DigeststringNo

The digest of the image.

sha256:6b0b094f8a904f8fb6602427aed0d1fa
ScanTypestringNo

The type of the vulnerability. Valid values:

  • cve: image system vulnerability
  • sca: image application vulnerability
sca
VulQueryKeystringNo

The keyword for fuzzy search used in scanning. The value can be a CVE name.

CVE-2021
FilterValuestringNo

The parameter whose value that you want to query. Fox example, if the value is FixCmd, only the FixCmd parameter is returned.

FixCmd

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

56B5C92F-F5D9-46E0-823F-EC71D1892DAA
Codestring

The return value.

success
PageNointeger

The number of the returned page.

1
IsSuccessboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request failed.
true
PageSizeinteger

The number of entries returned per page.

30
TotalCountinteger

The total number of vulnerabilities detected on images.

196
Vulnerabilitiesobject []

The details about the detected vulnerabilities.

Severitystring

The severity of the vulnerability.

Medium
AddedBystring

The ID of the image layer where the vulnerability was detected.

sha256:123456717b8e40b6480979b739010d8d549989602bcdd07922119aec6f9dbe57
CveNamestring

The name of the vulnerability.

CVE-2009-5155
Descriptionstring

The description of the vulnerability.

description.
Featurestring

The cause of the vulnerability.

eglibc
Versionstring

The version of the vulnerability.

2.19-6.9
VersionFormatstring

The format of the vulnerability.

dpkg
VersionFixedstring

The version where the vulnerability was fixed.

2.19-18+deb8u5
FixCmdstring

The command used to fix the vulnerability.

yum install -y xxx
CveLocationstring

The directory of the vulnerability.

/test.txt
ScanTypestring

The type of the vulnerability. Valid values:

  • cve: image system vulnerability
  • sca: image application vulnerability
cve
AliasNamestring

The name of the vulnerability.

Vulnerability

Examples

Sample success responses

JSONformat

{
  "RequestId": "56B5C92F-F5D9-46E0-823F-EC71D1892DAA",
  "Code": "success",
  "PageNo": 1,
  "IsSuccess": true,
  "PageSize": 30,
  "TotalCount": 196,
  "Vulnerabilities": [
    {
      "Severity": "Medium",
      "AddedBy": "sha256:123456717b8e40b6480979b739010d8d549989602bcdd07922119aec6f9dbe57",
      "CveName": "CVE-2009-5155",
      "Description": "description.",
      "Feature": "eglibc",
      "Version": "2.19-6.9",
      "VersionFormat": "dpkg",
      "CveLink": "https://security-tracker.debian.org/tracker/CVE-2009-5155",
      "VersionFixed": "2.19-18+deb8u5",
      "FixCmd": "yum install -y xxx",
      "CveLocation": "/test.txt",
      "ScanType": "cve",
      "AliasName": "Vulnerability\n"
    }
  ]
}

Error codes

HTTP status codeError codeError message
403NoPrivilegeAccess denied for this user.
500SystemErrorUnknown error.

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

Change history

Change timeSummary of changesOperation
2021-06-18Add Operationsee changesets