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 |
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 |
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:
|
scan_status |
No |
String |
Scan status. Its value can be:
|
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
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
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 |
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:
|
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 |
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" : "" } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListSwrImageRepositorySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListSwrImageRepositoryRequest request = new ListSwrImageRepositoryRequest(); try { ListSwrImageRepositoryResponse response = client.listSwrImageRepository(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSwrImageRepositoryRequest() response = client.list_swr_image_repository(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSwrImageRepositoryRequest{} response, err := client.ListSwrImageRepository(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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