查询镜像的敏感信息 - ListImageSensitive
功能介绍
查询镜像的敏感信息,若镜像类型为cicd镜像,则需传参镜像类型和镜像id唯一确定一条cicd镜像信息;若镜像类型为其他镜像仓类型,需要传参镜像类型、组织名称、镜像名称、镜像版本名称唯一确定一条其他镜像信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/{image_id}/sensitive
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
image_id |
是 |
String |
参数解释: 镜像id 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
image_type |
是 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
namespace |
否 |
String |
参数解释: 组织名称 约束限制: 不涉及 取值范围: 字符长度0-65535位 默认取值: 不涉及 |
|
image_name |
否 |
String |
参数解释: 镜像名称 约束限制: 不涉及 取值范围: 字符长度0-65535位 默认取值: 不涉及 |
|
image_version |
否 |
String |
参数解释: 镜像版本名称 约束限制: 不涉及 取值范围: 字符长度0-65535位 默认取值: 不涉及 |
|
file_path |
否 |
String |
参数解释: 文件路径 约束限制: 不涉及 取值范围: 字符长度0-65535位 默认取值: 不涉及 |
|
severity |
否 |
String |
参数解释: 威胁等级 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
handle_status |
否 |
String |
参数解释: 是否已处理 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0,最大值2147483547 |
|
data_list |
Array of ImageSensitiveInfo objects |
参数解释: 镜像的敏感信息 取值范围: 最小值0,最大值10241 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sensitive_info_id |
String |
参数解释: 敏感事件编号 取值范围: 字符长度0-128位 |
|
severity |
String |
参数解释: 威胁等级 取值范围:
|
|
name |
String |
参数解释: 规则名称 取值范围: 字符长度0-128位 |
|
description |
String |
参数解释: 规则描述 取值范围: 字符长度0-128位 |
|
position |
String |
参数解释: 漏洞所在镜像层 取值范围: 字符长度0-128位 |
|
file_path |
String |
参数解释: 文件路径 取值范围: 字符长度0-128位 |
|
content |
String |
参数解释: 敏感信息内容 取值范围: 字符长度0-128位 |
|
latest_scan_time |
Long |
参数解释: 最后一次检测时间,时间单位 毫秒(ms) 取值范围: 最小值0,最大值2147483647 |
|
handle_status |
String |
参数解释: 是否已处理 取值范围:
|
|
operate_accept |
String |
参数解释: 操作类型 取值范围:
|
请求示例
-
查询私有镜像的敏感信息
GET https://{endpoint}/v5/{project_id}/image/{image_id}/sensitive?limit=10&offset=0&image_type=private_image&namespace=scc_hss_container&image_name=proxy-agent&image_version=24.5.0-x86_64&enterprise_project_id=all_granted_eps -
查询cicd镜像中镜像id为111的镜像敏感信息
GET https://{endpoint}/v5/{project_id}/image/{image_id}/sensitive?limit=10&offset=0&image_type=cicd&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"content" : "--****--",
"description" : "PKCS8私钥",
"file_path" : "/home/sensitivecontent.txt",
"handle_status" : "unhandled",
"name" : "PKCS8私钥",
"operate_accept" : "ignore",
"position" : "sha256:2c07d7001e7b2afbe4a270883dfd2c7281f8cfdbe7a43592bae662badd39dfd2",
"sensitive_info_id" : "ee02b282-1cf4-4a6a-ac7f-78b42164bb99",
"severity" : "high"
} ]
}
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 |
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 ListImageSensitiveSolution { 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(); ListImageSensitiveRequest request = new ListImageSensitiveRequest(); request.withImageId("{image_id}"); try { ListImageSensitiveResponse response = client.listImageSensitive(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 |
# 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 = ListImageSensitiveRequest() request.image_id = "{image_id}" response = client.list_image_sensitive(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 |
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.ListImageSensitiveRequest{} request.ImageId = "{image_id}" response, err := client.ListImageSensitive(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。