本地镜像列表查询
功能介绍
本地镜像列表查询
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/image/local-repositories
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256 |
image_name |
否 |
String |
镜像名称 最小长度:1 最大长度:128 |
image_version |
否 |
String |
镜像版本 最小长度:1 最大长度:64 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:2000000 缺省值:0 |
limit |
否 |
Integer |
每页显示数量 最小值:10 最大值:200 缺省值:10 |
scan_status |
否 |
String |
扫描状态,包含如下:
最小长度:0 最大长度:32 |
local_image_type |
否 |
String |
镜像类型,包含如下:
最小长度:0 最大长度:64 |
image_size |
否 |
Long |
镜像大小,单位字节 最小值:0 最大值:2147483547 缺省值:0 |
start_latest_update_time |
否 |
Long |
最近更新时间搜索开始日期,时间单位 毫秒(ms) 最小值:0 最大值:2147483547 缺省值:0 |
end_latest_update_time |
否 |
Long |
最近更新时间搜索结束日期,时间单位 毫秒(ms) 最小值:0 最大值:2147483547 缺省值:0 |
start_latest_scan_time |
否 |
Long |
最近一次扫描完成时间搜索开始日期,时间单位 毫秒(ms) 最小值:0 最大值:2147483547 缺省值:0 |
end_latest_scan_time |
否 |
Long |
最近一次扫描完成时间搜索结束日期,时间单位 毫秒(ms) 最小值:0 最大值:2147483547 缺省值:0 |
has_vul |
否 |
Boolean |
是否存在软件漏洞 |
host_name |
否 |
String |
本地镜像所关联服务器的名称 最小长度:0 最大长度:128 |
host_id |
否 |
String |
本地镜像所关联服务器的ID 最小长度:0 最大长度:128 |
host_ip |
否 |
String |
本地镜像所关联服务器的IP(公网或私网) 最小长度:0 最大长度:128 |
container_id |
否 |
String |
本地镜像所关联容器的ID 最小长度:0 最大长度:128 |
container_name |
否 |
String |
本地镜像所关联容器的名称 最小长度:0 最大长度:128 |
pod_id |
否 |
String |
本地镜像所关联Pod的ID 最小长度:0 最大长度:128 |
pod_name |
否 |
String |
本地镜像所关联Pod的名称 最小长度:0 最大长度:128 |
app_name |
否 |
String |
本地镜像所关联软件的名称 最小长度:0 最大长度:128 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-auth-token |
是 |
String |
用户Token。 最小长度:1 最大长度:32768 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
本地镜像总数 最小值:0 最大值:2147483547 |
data_list |
Array of ImageLocalInfo objects |
本地镜像数据列表 数组长度:1 - 100000 |
参数 |
参数类型 |
描述 |
---|---|---|
image_name |
String |
镜像名称 最小长度:0 最大长度:256 |
image_id |
String |
镜像ID 最小长度:0 最大长度:64 |
image_digest |
String |
镜像digest 最小长度:0 最大长度:128 |
image_version |
String |
镜像版本 最小长度:0 最大长度:256 |
local_image_type |
String |
本地镜像类型 最小长度:0 最大长度:256 |
scan_status |
String |
扫描状态,包含如下:
最小长度:0 最大长度:256 |
image_size |
Long |
镜像大小,单位字节 最小值:0 最大值:9223372036854775807 |
latest_update_time |
Long |
镜像版本最后更新时间,时间单位毫秒(ms) 最小值:0 最大值:4070880000000 |
latest_scan_time |
Long |
最近扫描时间,时间单位毫秒(ms) 最小值:0 最大值:4070880000000 |
vul_num |
Long |
漏洞个数 最小值:0 最大值:9223372036854775807 |
unsafe_setting_num |
Long |
基线扫描未通过数 最小值:0 最大值:9223372036854775807 |
malicious_file_num |
Long |
恶意文件数 最小值:0 最大值:9223372036854775807 |
host_num |
Long |
关联主机数 最小值:0 最大值:9223372036854775807 |
container_num |
Long |
关联容器数 最小值:0 最大值:9223372036854775807 |
component_num |
Long |
关联组件数 最小值:0 最大值:9223372036854775807 |
scan_failed_desc |
String |
扫描失败原因,包含如下10种。
最小长度:0 最大长度:64 |
severity_level |
String |
镜像风险程度,在镜像扫描完成后展示,包含如下:
最小长度:0 最大长度:256 |
host_name |
String |
服务器名称 最小长度:0 最大长度:128 |
host_id |
String |
主机ID 最小长度:1 最大长度:128 |
agent_id |
String |
Agent ID 最小长度:1 最大长度:128 |
请求示例
查询前10条本地镜像信息列表
GET https://{endpoint}/v5/{project_id}/image/local-repositories?offset=0&limit=10
响应示例
状态码: 200
successful response
{ "data_list" : [ { "image_id" : "f757deea-781e-45ec-90ec-f199249890df", "image_name" : "webshell-ljx", "image_version" : "v1", "image_digest" : "sha256:ce0b5d91b072730d0bc9518f11efd07eb7fdb9f43251e11a96cab5b1918b7044", "local_image_type" : "swr_image", "scan_status" : "success", "image_size" : 215304488, "latest_update_time" : 1697509433000, "latest_scan_time" : 1709973506292, "host_num" : 0, "container_num" : 5, "component_num" : 146, "vul_num" : 77, "host_name" : "myhost", "host_id" : "9ad79426-992c-4be4-a2d1-dfd3a75b7c14", "agent_id" : "1c1d073c5fc403eb0d9c3088bc49da4e015586fd4864513a2fd81afedce282d4", "severity_level" : "High" } ], "total_num" : 1 }
SDK代码示例
SDK代码示例如下。
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
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 ListImageLocalSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListImageLocalRequest request = new ListImageLocalRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withImageName("<image_name>"); request.withImageVersion("<image_version>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withScanStatus("<scan_status>"); request.withLocalImageType("<local_image_type>"); request.withImageSize(<image_size>L); request.withStartLatestUpdateTime(<start_latest_update_time>L); request.withEndLatestUpdateTime(<end_latest_update_time>L); request.withStartLatestScanTime(<start_latest_scan_time>L); request.withEndLatestScanTime(<end_latest_scan_time>L); request.withHasVul(<has_vul>); request.withHostName("<host_name>"); request.withHostId("<host_id>"); request.withHostIp("<host_ip>"); request.withContainerId("<container_id>"); request.withContainerName("<container_name>"); request.withPodId("<pod_id>"); request.withPodName("<pod_name>"); request.withAppName("<app_name>"); try { ListImageLocalResponse response = client.listImageLocal(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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListImageLocalRequest() request.enterprise_project_id = "<enterprise_project_id>" request.image_name = "<image_name>" request.image_version = "<image_version>" request.offset = <offset> request.limit = <limit> request.scan_status = "<scan_status>" request.local_image_type = "<local_image_type>" request.image_size = <image_size> request.start_latest_update_time = <start_latest_update_time> request.end_latest_update_time = <end_latest_update_time> request.start_latest_scan_time = <start_latest_scan_time> request.end_latest_scan_time = <end_latest_scan_time> request.has_vul = <HasVul> request.host_name = "<host_name>" request.host_id = "<host_id>" request.host_ip = "<host_ip>" request.container_id = "<container_id>" request.container_name = "<container_name>" request.pod_id = "<pod_id>" request.pod_name = "<pod_name>" request.app_name = "<app_name>" response = client.list_image_local(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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListImageLocalRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest imageNameRequest:= "<image_name>" request.ImageName = &imageNameRequest imageVersionRequest:= "<image_version>" request.ImageVersion = &imageVersionRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest scanStatusRequest:= "<scan_status>" request.ScanStatus = &scanStatusRequest localImageTypeRequest:= "<local_image_type>" request.LocalImageType = &localImageTypeRequest imageSizeRequest:= int64(<image_size>) request.ImageSize = &imageSizeRequest startLatestUpdateTimeRequest:= int64(<start_latest_update_time>) request.StartLatestUpdateTime = &startLatestUpdateTimeRequest endLatestUpdateTimeRequest:= int64(<end_latest_update_time>) request.EndLatestUpdateTime = &endLatestUpdateTimeRequest startLatestScanTimeRequest:= int64(<start_latest_scan_time>) request.StartLatestScanTime = &startLatestScanTimeRequest endLatestScanTimeRequest:= int64(<end_latest_scan_time>) request.EndLatestScanTime = &endLatestScanTimeRequest hasVulRequest:= <has_vul> request.HasVul = &hasVulRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest hostIpRequest:= "<host_ip>" request.HostIp = &hostIpRequest containerIdRequest:= "<container_id>" request.ContainerId = &containerIdRequest containerNameRequest:= "<container_name>" request.ContainerName = &containerNameRequest podIdRequest:= "<pod_id>" request.PodId = &podIdRequest podNameRequest:= "<pod_name>" request.PodName = &podNameRequest appNameRequest:= "<app_name>" request.AppName = &appNameRequest response, err := client.ListImageLocal(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
successful response |
错误码
请参见错误码。