Changing the Protection Status

Function

This API is used to change the protection status.

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}/host-management/protection

**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
version	Yes	String	Definition Enabled HSS edition. Constraints N/A Range The options are as follows: hss.version.null: none hss.version.basic: basic edition hss.version.advanced: professional edition hss.version.enterprise: enterprise edition hss.version.premium: premium edition hss.version.wtp: WTP edition hss.version.container.enterprise: container edition Default Value N/A
charging_mode	No	String	Definition Billing mode Constraints N/A Range packet_cycle: yearly/monthly on_demand: pay-per-use Default Value N/A
resource_id	No	String	Definition Resource ID Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
host_id_list	Yes	Array of strings	Definition Server ID list. Constraints N/A Range N/A Default Value N/A
tags	No	Array of TagInfo objects	Definition Resource tag list. Constraints N/A Range N/A Default Value N/A

**Table 5** TagInfo
Parameter	Mandatory	Type	Description
key	No	String	Definition Key. Range Each tag key can contain a maximum of 128 Unicode characters. The key cannot be left blank.
value	No	String	Definition Value. Range Each tag value can contain a maximum of 255 Unicode characters.

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Switch the protection edition of the server whose ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f to the enterprise edition.

{
  "version" : "hss.version.enterprise",
  "charging_mode" : "packet_cycle",
  "resource_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
  "tags" : [ {
    "key" : "Service",
    "value" : "hss"
  } ]
}