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.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/image/swr-repository
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant project ID |
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 ID |
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. The value must be a number no less than 0. The default value is 0. |
limit |
No |
Integer |
Number of records displayed on each page. |
image_type |
Yes |
String |
Image type. The options are as follows:
|
scan_status |
No |
String |
Scanning status. The options are as follows:
|
instance_name |
No |
String |
Enterprise image instance name |
image_size |
No |
Long |
Image size |
start_latest_update_time |
No |
Long |
Creation start time. |
end_latest_update_time |
No |
Long |
Creation end time. |
start_latest_scan_time |
No |
Long |
Specify the start time based on the query condition of latest scan completion. |
end_latest_scan_time |
No |
Long |
Specify the end time based on the query condition of latest scan completion. |
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
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number |
data_list |
Array of PrivateImageRepositoryInfo objects |
Querying the image list in the SWR image repository |
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:
|
latest_version |
Boolean |
Check whether the version is the latest. |
scan_status |
String |
Scan status. The options are as follows:
|
scan_failed_desc |
String |
Cause of the scanning failure. The options are as follows:
|
image_size |
Long |
Image size |
latest_update_time |
Long |
Specifies the last update time of the image version. |
latest_scan_time |
Long |
Last scanned |
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:
|
scannable |
Boolean |
Scannable or not |
association_images |
Array of AssociateImages objects |
Multi-architecture associated image information |
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:
|
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
This API is used to query the image list in the SWR image repository, including the private image list and shared image list (controlled by the input parameter image_type).
{ "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 |
This API is used to query the image list in the SWR image repository, including the private image list and shared image list (controlled by the input parameter image_type). |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot