Viewing Web Tamper Protection Policies

Function

This API is used to view web tamper protection policies.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/webtamper/{host_id}/policy

**Table 1** Path Parameters
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	Definition Server ID. For this parameter to be valid, the server must have WTP enabled, or the WTP policy is not deleted after WTP is disabled. Constraints You need to use the ListWtpProtectHost API to query the WTP server protection status list. The host_id in the response body of the ListWtpProtectHost API is the server ID that meets the query conditions. Range Length: 1 to 256 characters Default Value** N/A

**Table 2** Query Parameters
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

**Table 3** Request header 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

**Table 4** Response body parameters
Parameter	Type	Description
protect_dir_num	Integer	Definition Number of protected directories. Range Minimum value: 0; maximum value: 50.
protect_dir_info	WtpProtectDirResponseInfo object	Protected directory information.
enable_timing_off	Boolean	Definition Scheduled protection switch status. Range True: Scheduled protection is enabled. False: Scheduled protection is not enabled.
timing_off_config_info	ListTimingOffConfigInfoResponseInfo object	Configuration details of scheduled protection.
enable_rasp_protect	Boolean	Definition Status of dynamic WTP. Only Linux servers are supported. Range True: Dynamic WTP is enabled. False: Dynamic WTP is not enabled.
rasp_path	String	Definition Tomcat bin directory for dynamic WTP. Range Length**: 0 to 512 characters
enable_privileged_process	Boolean	Definition Privileged process status. Range True: Privileged processes are enabled. False: Privileged processes are not enabled.
privileged_child_status	Boolean	Definition The trust status of the sub-processes of privileged processes. To configure this parameter, enable the privileged process first. Range True: The sub-processes of privileged processes are trusted. False: The sub-processes of privileged processes are not trusted.
privileged_process_path_list	Array of strings	Definition List of privileged process file paths. Range Minimum: 0 item; maximum: 10 items

**Table 5** WtpProtectDirResponseInfo
Parameter	Type	Description
protect_dir_list	Array of WtpProtectHostDirResponseInfo objects	Definition List of protected directories. Range Minimum: 0 item; maximum: 50 items
exclude_file_type	String	Definition Excluded file types. Range Length: 0 to 512 characters
protect_mode	String	Definition Protection mode. Range recovery: Interception mode alarm: Alarm mode. Only Linux servers are supported.

**Table 6** WtpProtectHostDirResponseInfo
Parameter	Type	Description
protect_dir	String	Definition Protected directory. Range Length: 0 to 512 characters
exclude_child_dir	String	Definition Excluded subdirectory. Range Length: 0 to 512 characters
exclude_file_path	String	Definition Excluded file path. Range Length: 0 to 512 characters
exclue_file_path	String	Definition Excluded file path. This field has been deprecated. Use exclude_file_path instead. Range The value can contain 0 to 512 characters.
local_backup_dir	String	Definition Local backup path. Only Linux servers are supported. Range Length**: 0 to 512 characters
protect_status	String	Definition Protection status. Range closed: disabled opened: The protection is in progress. opening: The function is being enabled. closing: disabling open_failed: Protection failed.
error	String	Definition Failure cause. If protection status is open_failed, there is a failure cause. Range Length: 0 to 512 characters

**Table 7** ListTimingOffConfigInfoResponseInfo
Parameter	Type	Description
week_off_list	Array of integers	Definition List of automatic protection periods. 1 indicates Monday. 2 indicates Tuesday. 3 indicates Wednesday. 4 indicates Thursday. 5 indicates Friday. 6 indicates Saturday. 7 indicates Sunday. Range 0 to 7 items are allowed.
timing_range_list	Array of TimingRangeConfigInfo objects	Definition Automatic unprotection period. Range Minimum: 0 item; maximum: 5 items

**Table 8** TimingRangeConfigInfo
Parameter	Type	Description
time_range	String	Definition Automatic unprotection period. Range Length: 0 to 512 characters
description	String	Definition Description of the automatic unprotection period. Range Length: 0 to 512 characters

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "protect_dir_info" : {
    "protect_dir_list" : [ {
      "protect_dir" : "/root/test1",
      "local_backup_dir" : "/root/test2",
      "protect_status" : "open_failed",
      "error" : "The protected directory or backup directory was not found."
    }, {
      "protect_dir" : "/root/test3",
      "exclude_child_dir" : "pro",
      "exclude_file_path" : "path",
      "local_backup_dir" : "/root/test4",
      "protect_status" : "open_failed",
      "error" : "The protected directory or backup directory was not found."
    } ],
    "exclude_file_type" : "log;pid;text",
    "protect_mode" : "recovery"
  },
  "enable_timing_off" : true,
  "timing_off_config_info" : {
    "week_off_list" : [ 1, 2, 4, 6 ],
    "timing_range_list" : [ {
      "time_range" : "02:00-04:00",
      "description" : "close"
    }, {
      "time_range" : "12:05-14:00"
    } ]
  },
  "enable_rasp_protect" : true,
  "rasp_path" : "/usr/bin/tomcat/bin",
  "enable_privileged_process" : true,
  "privileged_child_status" : true,
  "privileged_process_path_list" : [ "/usr/bin/echo" ]
}