Querying the Mirror Configuration Check Report
Function
This API is used to query the mirror configuration check report.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/image/baseline/check-rule/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256 |
image_type |
Yes |
String |
Image type. The options are as follows:
Minimum: 1 Maximum: 32 |
namespace |
No |
String |
Specifies the organization name. If no image information is available, all images are queried. Minimum: 0 Maximum: 64 |
image_name |
No |
String |
Image name Minimum: 0 Maximum: 128 |
image_version |
No |
String |
Image tag name Minimum: 0 Maximum: 64 |
check_name |
Yes |
String |
Baseline name Minimum: 0 Maximum: 255 |
check_type |
Yes |
String |
Baseline Type Minimum: 0 Maximum: 255 |
check_rule_id |
Yes |
String |
Check item ID Minimum: 0 Maximum: 255 |
standard |
Yes |
String |
Standard type. Its value can be:
Minimum: 0 Maximum: 32 |
instance_id |
No |
String |
Enterprise repository instance ID. This API is not required for SWR shared edition. Minimum: 0 Maximum: 128 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768 |
region |
No |
String |
Region ID Minimum: 0 Maximum: 128 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
description |
String |
Check item description Minimum: 0 Maximum: 2048 |
reference |
String |
Reference Minimum: 0 Maximum: 255 |
audit |
String |
Audit description Minimum: 0 Maximum: 65534 |
remediation |
String |
Suggestion Minimum: 0 Maximum: 65534 |
check_info_list |
Array of ImageCheckRuleCheckCaseResponseInfo objects |
Test case Array Length: 0 - 2147483647 |
Example Requests
Query the check report of the configuration item whose organization is aaa, image name is centos7, image version is common, baseline name is SSH, check item ID is 1.12, and standard type is Huawei standard.
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
Example Responses
Status code: 200
The check report of configuration check items is returned.
{ "audit" : "Check the configuration file: /etc/pam.d/system", "check_info_list" : [ { "check_description" : "Check the configuration file: /etc/pam.d/system-auth" }, { "current_value" : "" }, { "suggest_value" : "auth required is configured for each file." } ], "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 Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The check report of configuration check items is returned. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot