Container Registry API, gRPC: ScannerService.List

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

Yandex Cloud

Обновлена 26 ноября 2024 г.

gRPC request
ListScanResultsRequest
ListScanResultsResponse
ScanResult
VulnerabilityStats

Retrieves the list of ScanResults for specified Image.

gRPC request

rpc List (ListScanResultsRequest) returns (ListScanResultsResponse)

ListScanResultsRequest

{
  // Includes only one of the fields `image_id`, `repository_id`
  "image_id": "string",
  "repository_id": "string",
  // end of the list of possible fields
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

Field	Description
image_id	string Includes only one of the fields `image_id`, `repository_id`. ID of the Image or Repository to list ScanResults for. To get the image ID use a yandex.cloud.containerregistry.v1.ImageService.List request. To get the repository ID use a yandex.cloud.containerregistry.v1.RepositoryService.List request.
repository_id	string Includes only one of the fields `image_id`, `repository_id`. ID of the Image or Repository to list ScanResults for. To get the image ID use a yandex.cloud.containerregistry.v1.ImageService.List request. To get the repository ID use a yandex.cloud.containerregistry.v1.RepositoryService.List request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListRegistriesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.
page_token	string Page token. To get the next page of results, set `page_token` to the ListRegistriesResponse.next_page_token returned by a previous list request.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can use filtering only on ScanResult.status field. An `=` operator. The value in double quotes (`"`).
order_by	string An order expression that orders resources listed in the response. The expression must specify: The field name. Currently you can use filtering only on ScanResult.status field. Order selector. Currently you can use ordering only on `ScanResult.status` field (critical first).

ListScanResultsResponse

{
  "scan_results": [
    {
      "id": "string",
      "image_id": "string",
      "scanned_at": "google.protobuf.Timestamp",
      "status": "Status",
      "vulnerabilities": {
        "critical": "int64",
        "high": "int64",
        "medium": "int64",
        "low": "int64",
        "negligible": "int64",
        "undefined": "int64"
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

scan_results[]

ScanResult

List of ScanResult resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListImagesRequest.page_size, use
the next_page_token as the value
for the ListImagesRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

ScanResult

A ScanResult resource.

Field	Description
id	string Output only. ID of the ScanResult.
image_id	string Output only. ID of the Image that the ScanResult belongs to.
scanned_at	google.protobuf.Timestamp Output only. The timestamp in RFC3339 text format when the scan been finished.
status	enum Status Output only. The status of the ScanResult. `STATUS_UNSPECIFIED` `RUNNING`: Image scan is in progress. `READY`: Image has been scanned and result is ready. `ERROR`: Image scan is failed.
vulnerabilities	VulnerabilityStats Output only. Summary information about vulnerabilities found.

VulnerabilityStats

A VulnerabilityStats resource.

Field	Description
critical	int64 Count of CRITICAL vulnerabilities.
high	int64 Count of HIGH vulnerabilities.
medium	int64 Count of MEDIUM vulnerabilities.
low	int64 Count of LOW vulnerabilities.
negligible	int64 Count of NEGLIGIBLE vulnerabilities.
undefined	int64 Count of other vulnerabilities.