Enabling or Disabling WTP

Function

This API is used to turn on or off web tamper protection.

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

POST /v5/{project_id}/webtamper/static/status

**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

**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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	Boolean	Definition Protection status. Constraints N/A Range True: Enable protection. charging_mode must be specified. False: Disable protection. charging_mode does not need to be specified. Default Value False
host_id_list	Yes	Array of strings	Definition IDs of servers where protection needs to be enabled or disabled. Constraints When enabling protection, you need to use the ListWtpProtectHost API to query the server WTP protection status list. The host_id in the response body of the ListWtpProtectHost API is the server ID that meets the query conditions. Range 1 to 20,000 items Default Value N/A
charging_mode	No	String	Definition Billing mode. Constraints N/A Range packet_cycle: Yearly/monthly. You can specify resource_id. on_demand: Pay-per-use. You do not need to specify resource_id. Default Value on_demand
resource_id	No	String	Definition Resource ID, that is, the WTP quota ID. This parameter can be specified when charging_mode is set to packet_cycle. You can also leave this parameter blank, indicating that a quota is randomly selected. Constraints N/A Range Length: 0 to 64 characters Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable WTP. The ID of the target server is 96ae7317-b5c4-4bc8-aa90-eda53f23e99e and the billing mode is Yearly/Monthly.

POST https://{endpoint}/v5/{project_id}/webtamper/static/status

{
  "status" : true,
  "host_id_list" : [ "96ae7317-b5c4-4bc8-aa90-eda53f23e99e" ],
  "resource_id" : "",
  "charging_mode" : "packet_cycle"
}