Viewing Web Tamper Protection Policies
Function
This API is used to view web tamper protection policies.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/webtamper/{host_id}/policy
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 |
host_id |
Yes |
String |
Server ID. |
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. |
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 |
---|---|---|
protect_dir_num |
Integer |
Number of protected directories. |
protect_dir_info |
WtpProtectDirResponseInfo object |
Protected directory information. |
enable_timing_off |
Boolean |
Scheduled switch status. |
timing_off_config_info |
Unprotected Time Range. |
|
enable_rasp_protect |
Boolean |
Enable status of dynamic WTP. |
rasp_path |
String |
rasp path |
enable_privileged_process |
Boolean |
Privileged process status. |
privileged_child_status |
Boolean |
Trustworthy status of a privileged process and its subprocesses. |
privileged_process_path_list |
Array of strings |
Privileged process path list. |
privileged_process_info |
Privileged process. |
Parameter |
Type |
Description |
---|---|---|
protect_dir_list |
Array of WtpProtectHostDirResponseInfo objects |
List of protected directories. |
exclue_file_type |
String |
Excluded file types |
exclude_file_type |
String |
Excluded file types |
protect_mode |
String |
Protection mode. The options are as follows: |
Parameter |
Type |
Description |
---|---|---|
protect_dir |
String |
Protected directory |
exclude_child_dir |
String |
Excluded subdirectory |
exclude_file_path |
String |
Excluded file path |
exclue_file_path |
String |
Excluded file path |
local_backup_dir |
String |
Local backup path |
protect_status |
String |
Protection status. It can be closed (disabled), opened (being protected), opening (being enabled), closing (being disabled), or open_failed (failed). |
error |
String |
Failure cause |
Parameter |
Type |
Description |
---|---|---|
week_off_list |
Array of integers |
Period for disabling protection |
timing_range_list |
Array of TimingRangeConfigInfo objects |
Time range |
total_num |
Integer |
Definition Total number. Range The value range is 0 to 2,147,483,647. |
Parameter |
Type |
Description |
---|---|---|
time_range |
String |
Time range |
description |
String |
Description |
Parameter |
Type |
Description |
---|---|---|
data_list |
Array of PrivilegedProcessResponseInfo objects |
data list |
total_num |
Integer |
total number |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "protect_dir_num" : 10, "protect_dir_info" : { "protect_dir_list" : [ "/test" ], "exclude_file_type" : "log", "protect_mode" : "alarm" }, "enable_timing_off" : true, "timing_off_config_info" : { "week_off_list" : [ 1 ], "timing_range_list" : [ { "time_range" : "15:00-15:30", "description" : "Unprotected time range." } ] }, "enable_rasp_protect" : true, "rasp_path" : "/test", "enable_privileged_process" : true, "privileged_child_status" : true, "privileged_process_path_list" : [ "test" ] }
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 |
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 ShowWebTamperHostPolicySolution { 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(); ShowWebTamperHostPolicyRequest request = new ShowWebTamperHostPolicyRequest(); request.withHostId("{host_id}"); try { ShowWebTamperHostPolicyResponse response = client.showWebTamperHostPolicy(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 = ShowWebTamperHostPolicyRequest() request.host_id = "{host_id}" response = client.show_web_tamper_host_policy(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.ShowWebTamperHostPolicyRequest{} request.HostId = "{host_id}" response, err := client.ShowWebTamperHostPolicy(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