查询镜像配置检查项检测报告
功能介绍
查询镜像配置检查项检测报告
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/image/baseline/check-rule/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256 |
image_type |
是 |
String |
镜像类型,包含如下:
最小长度:1 最大长度:32 |
namespace |
否 |
String |
组织名称(没有镜像相关信息时,表示查询所有镜像) 最小长度:0 最大长度:64 |
image_name |
否 |
String |
镜像名称 最小长度:0 最大长度:128 |
image_version |
否 |
String |
镜像版本名称 最小长度:0 最大长度:64 |
check_name |
是 |
String |
基线名称 最小长度:0 最大长度:255 |
check_type |
是 |
String |
基线类型 最小长度:0 最大长度:255 |
check_rule_id |
是 |
String |
检查项id 最小长度:0 最大长度:255 |
standard |
是 |
String |
标准类型,包含如下:
最小长度:0 最大长度:32 |
instance_id |
否 |
String |
企业仓库实例ID,swr共享版无需使用该参数 最小长度:0 最大长度:128 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 |
region |
否 |
String |
Region ID 最小长度:0 最大长度:128 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
检查项描述 最小长度:0 最大长度:2048 |
reference |
String |
参考 最小长度:0 最大长度:255 |
audit |
String |
审计描述 最小长度:0 最大长度:65534 |
remediation |
String |
修改建议 最小长度:0 最大长度:65534 |
check_info_list |
Array of ImageCheckRuleCheckCaseResponseInfo objects |
检测用例信息 数组长度:0 - 2147483647 |
请求示例
查询所属组织为aaa,镜像名称为centos7,镜像版本为common的私有镜像、基线名称为SSH、检测项id为1.12并且标准类型为华为规范的配置检查项检测报告。
GET https://{endpoint}/v5/{project_id}/image/baseline/check-rule/detail?image_type=private_image&namespace=aaa&image_name=centos7&image_version=common&check_rule_id=1.12&standard=hw_standard&check_type=SSH&check_name=SSH&enterprise_project_id=all_granted_eps
响应示例
状态码: 200
配置检查项检测报告
{ "audit" : "检查配置文件/etc/pam.d/system", "check_info_list" : [ { "check_description" : "检查配置文件/etc/pam.d/system-auth" }, { "current_value" : "" }, { "suggest_value" : "每个文件都配置auth required " } ], "description" : "The two options ClientAliveInterval and ClientAliveCountMax control the timeout of SSH sessions. The ClientAliveInterval parameter sets a timeout interval in seconds after which if no data has been received from the client, sshd will send a message through the encrypted channel to request a response from the client. The ClientAliveCountMax parameter sets the number of client alive messages which may be sent without sshd receiving any messages back from the client. For example, if the ClientAliveInterval is set to 15s and the ClientAliveCountMax is set to 3, unresponsive SSH clients will be disconnected after approximately 45s.", "reference" : "", "remediation" : "Edit the /etc/ssh/sshd_config file to set the parameter as follows: \nClientAliveInterval 300 \nClientAliveCountMax 0" }
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 |
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 ShowImageCheckRuleDetailSolution { 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(); ShowImageCheckRuleDetailRequest request = new ShowImageCheckRuleDetailRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withImageType("<image_type>"); request.withNamespace("<namespace>"); request.withImageName("<image_name>"); request.withImageVersion("<image_version>"); request.withCheckName("<check_name>"); request.withCheckType("<check_type>"); request.withCheckRuleId("<check_rule_id>"); request.withStandard("<standard>"); request.withInstanceId("<instance_id>"); try { ShowImageCheckRuleDetailResponse response = client.showImageCheckRuleDetail(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 |
# 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 = ShowImageCheckRuleDetailRequest() request.enterprise_project_id = "<enterprise_project_id>" request.image_type = "<image_type>" request.namespace = "<namespace>" request.image_name = "<image_name>" request.image_version = "<image_version>" request.check_name = "<check_name>" request.check_type = "<check_type>" request.check_rule_id = "<check_rule_id>" request.standard = "<standard>" request.instance_id = "<instance_id>" response = client.show_image_check_rule_detail(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 |
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.ShowImageCheckRuleDetailRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.ImageType = "<image_type>" namespaceRequest:= "<namespace>" request.Namespace = &namespaceRequest imageNameRequest:= "<image_name>" request.ImageName = &imageNameRequest imageVersionRequest:= "<image_version>" request.ImageVersion = &imageVersionRequest request.CheckName = "<check_name>" request.CheckType = "<check_type>" request.CheckRuleId = "<check_rule_id>" request.Standard = "<standard>" instanceIdRequest:= "<instance_id>" request.InstanceId = &instanceIdRequest response, err := client.ShowImageCheckRuleDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
配置检查项检测报告 |
错误码
请参见错误码。