# 查询swr镜像仓库镜像列表-接口已废弃，不再推荐使用 - ListSwrImageRepository #### 功能介绍 查询swr镜像仓库镜像列表,如果需要从swr同步最新镜像，需要先调用"从swr同步镜像"接口。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/image/swr-repository 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为"0"，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参"all_granted_eps"。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 | | namespace | 否 | String | 组织名称 | | image_name | 否 | String | 镜像名称 | | image_version | 否 | String | 镜像版本 | | latest_version | 否 | Boolean | 仅关注最新版本镜像 | | offset | 否 | Integer | 偏移量：指定返回记录的开始位置 | | limit | 否 | Integer | 每页显示数量 | | image_type | 是 | String | 镜像类型，包含如下: - private_image : 私有镜像仓库 - shared_image : 共享镜像仓库 - local_image : 本地镜像 - instance_image : 企业镜像 | | scan_status | 否 | String | 扫描状态，包含如下: - unscan : 未扫描 - success : 扫描完成 - scanning : 扫描中 - failed : 扫描失败 - waiting_for_scan : 等待扫描 | | instance_name | 否 | String | 企业镜像实例名称 | | image_size | 否 | Long | 镜像大小 | | start_latest_update_time | 否 | Long | 创建时间开始日期，时间单位：毫秒（ms） | | end_latest_update_time | 否 | Long | 创建时间结束日期，时间单位：毫秒（ms） | | start_latest_scan_time | 否 | Long | 最近一次扫描完成时间开始日期，时间单位：毫秒（ms） | | end_latest_scan_time | 否 | Long | 最近一次扫描完成时间结束日期，时间单位：毫秒（ms） | | has_malicious_file | 否 | Boolean | 是否存在恶意文件 | | has_unsafe_setting | 否 | Boolean | 是否存在基线检查 | | has_vul | 否 | Boolean | 是否存在软件漏洞 | | instance_id | 否 | String | 企业仓库实例ID，swr共享版无需使用该参数 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） | | region | 否 | String | Region ID | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | 总数 | | data_list | Array of [PrivateImageRepositoryInfo] objects | 查询swr镜像仓库镜像列表 | 表5PrivateImageRepositoryInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | id | | namespace | String | 命名空间 | | image_name | String | 镜像名称 | | image_id | String | 镜像id | | image_digest | String | 镜像digest | | image_version | String | 镜像版本 | | image_type | String | 镜像类型，包含如下2种。 - private_image ：私有镜像。 - shared_image ：共享镜像。 | | latest_version | Boolean | 是否是最新版本 | | scan_status | String | 扫描状态，包含如下2种。 - unscan ：未扫描。 - success ：扫描完成。 - scanning ：正在扫描。 - failed ：扫描失败。 - download_failed ：下载失败。 - image_oversized ：镜像超大。 - waiting_for_scan ：等待扫描。 | | scan_failed_desc | String | 扫描失败原因，包含如下14种。 - "unknown_error" :未知错误 - "authentication_failed":认证失败 - "download_failed":镜像下载失败 - "image_over_sized":镜像大小超限 - "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 | 镜像大小 | | latest_update_time | Long | 镜像版本最后更新时间，时间单位：毫秒（ms） | | latest_scan_time | Long | 最近扫描时间，时间单位：毫秒（ms） | | vul_num | Integer | 漏洞个数 | | unsafe_setting_num | Integer | 基线扫描未通过数 | | malicious_file_num | Integer | 恶意文件数 | | domain_name | String | 拥有者（共享镜像参数） | | shared_status | String | 共享镜像状态，包含如下2种。 - expired ：已过期。 - effective ：有效。 | | scannable | Boolean | 是否可扫描 | | instance_name | String | 企业版镜像实例名称 | | instance_id | String | 企业版镜像实例ID | | instance_url | String | 企业版镜像实例URL | | association_images | Array of [AssociateImages] objects | 多架构关联镜像信息 | 表6AssociateImages | 参数 | 参数类型 | 描述 | |:---|:---|:---| | image_name | String | 镜像名称 | | image_version | String | 镜像版本 | | image_type | String | 镜像类型 | | namespace | String | 命名空间 | | image_digest | String | 镜像digest | | scan_status | String | 扫描状态，包含如下2种。 - unscan ：未扫描。 - success ：扫描完成。 - scanning ：正在扫描。 - failed ：扫描失败。 - download_failed ：下载失败。 - image_oversized ：镜像超大。 - waiting_for_scan ：等待扫描。 | #### 请求示例 查询镜像类型为私有镜像的swr镜像仓库镜像列表。 ``` 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 ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 3, "data_list" : [ { "id" : 111, "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX", "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX", "image_name" : "centos7", "image_size" : 1000, "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, "domain_name" : "scc_cgs_XXX", "shared_status" : "effective", "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX", "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX", "image_name" : "mysql", "image_size" : 1000, "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, "domain_name" : "scc_cgs_XXX", "shared_status" : "effective", "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX", "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX", "image_name" : "mysql", "image_size" : 1000, "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" : "" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListSwrImageRepositoryRequest{} response, err := client.ListSwrImageRepository(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListSwrImageRepository&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。