Подключиться
Yandex Container Registry

Method list

Статья создана

Retrieves the list of ScanResults for specified Image.

HTTP request

GET https://container-registry.api.cloud.yandex.net/container-registry/v1/scans

Query parameters

Parameter Description
imageId The maximum string length in characters is 50.
repositoryId The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter A filter expression that filters resources listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on status field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. Value or a list of values to compare against the values of the field. The maximum string length in characters is 1000.
orderBy An order expression that orders resources listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on status field. 2. Order selector. Currently you can use ordering only on ScanResult.status field (critical first). The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "scanResults": [
    {
      "id": "string",
      "imageId": "string",
      "scannedAt": "string",
      "status": "string",
      "vulnerabilities": {
        "critical": "string",
        "high": "string",
        "medium": "string",
        "low": "string",
        "negligible": "string",
        "undefined": "string"
      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
scanResults[] object

A ScanResult resource.
scanResults[].
id		 string

Output only. ID of the ScanResult.
scanResults[].
imageId		 string

Output only. ID of the Image that the ScanResult belongs to.
scanResults[].
scannedAt		 string (date-time)

Output only. The timestamp in RFC3339 text format when the scan been finished.

String in RFC3339 text format.
scanResults[].
status		 string

Output only. The status of the ScanResult.

  • RUNNING: Image scan is in progress.
  • READY: Image has been scanned and result is ready.
  • ERROR: Image scan is failed.
scanResults[].
vulnerabilities		 object

Output only. Summary information about vulnerabilities found.

A VulnerabilityStats resource.
scanResults[].
vulnerabilities.
critical		 string (int64)

Count of CRITICAL vulnerabilities.
scanResults[].
vulnerabilities.
high		 string (int64)

Count of HIGH vulnerabilities.
scanResults[].
vulnerabilities.
medium		 string (int64)

Count of MEDIUM vulnerabilities.
scanResults[].
vulnerabilities.
low		 string (int64)

Count of LOW vulnerabilities.
scanResults[].
vulnerabilities.
negligible		 string (int64)

Count of NEGLIGIBLE vulnerabilities.
scanResults[].
vulnerabilities.
undefined		 string (int64)

Count of other vulnerabilities.
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.
В этой статье: