Querying the Image List in the SWR Image Repository

Function

This API is used to query the image list in the SWR image repository. To synchronize the latest images from SWR, call the API for synchronizing images from SWR first.

URI

GET /v5/{project_id}/image/swr-repository

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Table 2 Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
namespace	No	String	Organization name
image_name	No	String	Image name
image_version	No	String	Image tag
latest_version	No	Boolean	Display latest image versions only
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
limit	No	Integer	Number of records on each page
image_type	Yes	String	Image type. The options are as follows: private_image: private image repository shared_image: shared image repository local_image instance_image: enterprise image
scan_status	No	String	Scan status. Its value can be: unscan success scanning failed waiting_for_scan
instance_name	No	String	Enterprise image instance name
image_size	No	Long	Image size
start_latest_update_time	No	Long	Creation start date, in ms.
end_latest_update_time	No	Long	Creation end date, in ms.
start_latest_scan_time	No	Long	The start time of latest scan completion, in ms.
end_latest_scan_time	No	Long	The end time of latest scan completion, in ms.
has_malicious_file	No	Boolean	Whether there are malicious files
has_unsafe_setting	No	Boolean	Whether baseline check exists
has_vul	No	Boolean	Whether there are software vulnerabilities
instance_id	No	String	Enterprise repository instance ID. This API is not required for SWR shared edition.

Request Parameters

Table 3 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
region	Yes	String	Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
total_num	Integer	Total number
data_list	Array of PrivateImageRepositoryInfo objects	Querying the image list in the SWR image repository

Table 5 PrivateImageRepositoryInfo
Parameter	Type	Description
id	Long	id
namespace	String	Namespace
image_name	String	Image name
image_id	String	Image ID
image_digest	String	Image digest
image_version	String	Image tag
image_type	String	Image type. The options are as follows: private_image shared_image
latest_version	Boolean	Check whether the version is the latest.
scan_status	String	Scan status. The options are as follows: unscan success scanning failed download_failed image_oversized waiting_for_scan
scan_failed_desc	String	Cause of the scanning failure. The options are as follows: "unknown_error" "authentication_failed" "download_failed": Failed to download the image. "image_over_sized": The size of the image exceeds the maximum. "image_oversized" "failed_to_scan_vulnerability" "failed_to_scan_file" "failed_to_scan_software" "failed_to_check_sensitive_information" "failed_to_check_baseline" "failed_to_check_software_compliance" "failed_to_query_basic_image_information" "response_timed_out" "database_error" "failed_to_send_the_scan_request"
image_size	Long	Image size
latest_update_time	Long	Last update time of the image version, in ms.
latest_scan_time	Long	Last scanned, in ms.
vul_num	Integer	Vulnerabilities
unsafe_setting_num	Integer	Number of failed baseline scans
malicious_file_num	Integer	Number of malicious files
domain_name	String	Owner (shared image parameter)
shared_status	String	The status of a shared image. The value can be: expired effective
scannable	Boolean	Scannable or not
instance_name	String	Enterprise image instance name
instance_id	String	Enterprise image instance ID
instance_url	String	Enterprise image instance URL
association_images	Array of AssociateImages objects	Multi-architecture associated image information

Table 6 AssociateImages
Parameter	Type	Description
image_name	String	Image name
image_version	String	Image tag
image_type	String	Image type
namespace	String	Namespace
image_digest	String	Image digest
scan_status	String	Scan status. The options are as follows: unscan success scanning failed download_failed image_oversized waiting_for_scan

Example Requests

Query the image list in the SWR image repository whose image type is private image.

GET https://{endpoint}/v5/{project_id}/image/swr-repository?offset=0&limit=50&image_type=private_image&latest_version=false&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 3,
  "data_list" : [ {
    "id" : "111 (example for private images)",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "centos7",
    "image_size" : "1000 (Bytes)",
    "image_type" : "private_image",
    "image_version" : "common",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "222 (example for shared image)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 (Bytes)",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "333 (example of an enterprise image)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 (Bytes)",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "Enterprise instance name",
    "instance_id" : "",
    "instance_url" : ""
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Container Image

Предыдущая статья

Container Image

Следующая статья

Scanning Images in the Image Repository in Batches

Была ли эта статья полезна?

Поддержка Юридические документы