Querying the Baseline Directory Information of a Baseline Detection Policy
Function
This API is used to query the baseline directory information of a baseline detection policy.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/baseline/security-checks/directory
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
support_os |
Yes |
String |
Details: OSs that support baseline check Constraints: N/A Options:
Default value: Linux |
select_type |
Yes |
String |
Details: Determines the order of the directory structure. Constraints: N/A Options:
Default value: N/A |
group_id |
No |
String |
Details: Displays the check items selected for the policy group. Constraints: N/A Options: The value contains 0 to 64 characters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_condition |
SecurityCheckTaskCondition object |
Scheduled check configuration |
baseline_directory_list |
Array of ShowBaselineDirectoryInfo objects |
Details: Baseline check policy directory |
pwd_directory_list |
Array of ShowPwdDirectoryInfo objects |
Details: Baseline check policy directory |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Scheduled task, including:
|
day_of_week |
Array of strings |
Weekday when the rule is triggered. The value can be 0 or multiple values. |
hour |
Integer |
Hour in which a scheduled task is triggered. |
minute |
Integer |
The scheduled task is triggered at the minute specified by this parameter. |
random_offset |
Integer |
Random offset time |
Parameter |
Type |
Description |
---|---|---|
type |
String |
The meaning varies according to the value of select_type.
|
standard |
String |
Standard type. Its value can be:
|
data_list |
Array of data_list objects |
Level-3 directory information of the baseline check policy |
Parameter |
Type |
Description |
---|---|---|
name |
String |
The meaning varies according to the value of select_type.
|
enable |
Boolean |
Whether the item is selected |
Parameter |
Type |
Description |
---|---|---|
tag |
String |
Level-1 label of weak passwords and password complexity, including:
|
sub_tag |
String |
The password check contains the following sub-labels. The options are as follows:
|
checked |
Boolean |
Details: Whether this item is selected Value Range
|
key |
String |
Unique value in the directory:
|
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "task_condition" : { "type" : "fixed_weekday", "day_of_week" : [ "mon", "sun" ], "hour" : 4, "minute" : 0, "random_offset" : 3600 }, "baseline_directory_list" : [ { "type" : "SSH", "standard" : "cn_standard", "data_list" : [ { "name" : "Access control", "checked" : true, "key" : "SSH-cn_standard-access control" }, { "name" : "Service deployment", "checked" : true, "key" : "SSH-cn_standard-Service deployment" } ] }, { "type" : "Apache", "standard" : "hw_standard", "data_list" : [ { "name" : "Access control", "checked" : false, "key" : "Apache-hw_standard-Access Control" }, { "name" : "Service deployment", "checked" : true, "key" : "Apache-hw_standard-service deployment" } ] } ], "pwd_directory_list" : [ { "tag" : "weakpwd_pwdcomplexity", "sub_tag" : "weakpwd", "checked" : true, "key" : "weakpwd" }, { "tag" : "weakpwd_pwdcomplexity", "sub_tag" : "pwdcomplexity", "checked" : true, "key" : "pwdcomplexity" } ] }
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 |
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 ShowBaselineDirectorySolution { 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(); ShowBaselineDirectoryRequest request = new ShowBaselineDirectoryRequest(); try { ShowBaselineDirectoryResponse response = client.showBaselineDirectory(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 |
# 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 = ShowBaselineDirectoryRequest() response = client.show_baseline_directory(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 |
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.ShowBaselineDirectoryRequest{} response, err := client.ShowBaselineDirectory(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 |
Request succeeded. |
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