查询镜像指定安全配置项的检查项列表
功能介绍
查询镜像指定安全配置项的检查项列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/image/baseline/risk-configs/{check_name}/rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
check_name |
是 |
String |
基线名称 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps |
image_type |
是 |
String |
镜像类型,包含如下:
|
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 |
limit |
否 |
Integer |
每页显示数量 |
namespace |
否 |
String |
组织名称(没有镜像相关信息时,表示查询所有镜像) |
image_name |
否 |
String |
镜像名称 |
image_version |
否 |
String |
镜像版本名称 |
standard |
是 |
String |
标准类型,包含如下:
|
result_type |
否 |
String |
结果类型,包含如下:
|
check_rule_name |
否 |
String |
检查项名称,支持模糊匹配 |
severity |
否 |
String |
风险等级,包含如下:
|
instance_id |
否 |
String |
企业仓库实例ID,swr共享版无需使用该参数 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
region |
否 |
String |
Region ID |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
风险总数 |
data_list |
Array of ImageRiskConfigsCheckRulesResponseInfo objects |
数据列表 |
参数 |
参数类型 |
描述 |
---|---|---|
severity |
String |
风险等级,包含如下:
|
check_name |
String |
基线名称 |
check_type |
String |
基线类型 |
standard |
String |
标准类型,包含如下:
|
check_rule_name |
String |
检查项 |
check_rule_id |
String |
检查项ID |
scan_result |
String |
检测结果,包含如下:
|
请求示例
查询所属组织为aaa,镜像名称为centos7,镜像版本为common的私有镜像并且标准类型为华为规范的指定安全配置项的检查项列表。
GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs/{check_name}/rules?offset=0&limit=200&image_type=private_image&namespace=aaa&image_name=centos7/test&image_version=common&standard=hw_standard&enterprise_project_id=all_granted_eps
响应示例
状态码: 200
指定安全配置项的检查项列表
{ "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "规则:口令锁定策略.", "check_name" : "CentOS 7", "check_type" : "CentOS 7", "standard" : "hw_standard", "scan_result" : "failed", "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 ListImageRiskConfigRulesSolution { 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(); ListImageRiskConfigRulesRequest request = new ListImageRiskConfigRulesRequest(); request.withCheckName("{check_name}"); try { ListImageRiskConfigRulesResponse response = client.listImageRiskConfigRules(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 = ListImageRiskConfigRulesRequest() request.check_name = "{check_name}" response = client.list_image_risk_config_rules(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.ListImageRiskConfigRulesRequest{} request.CheckName = "{check_name}" response, err := client.ListImageRiskConfigRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
指定安全配置项的检查项列表 |
错误码
请参见错误码。