Help Center/ Host Security Service/ API Reference/ API Description/ Server Management/ Changing the Protection Status
Updated on 2025-09-22 GMT+08:00
View PDF

Changing the Protection Status

Function

This API is used to change the protection status.

URI

POST /v5/{project_id}/host-management/protection

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token.

It can be obtained by calling the IAM API used to obtain an IAM token. The value of X-Subject-Token in the response header is a token.

region

Yes

String

Region ID
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

version

No

String

Edition to be enabled. Its value can be:

  • hss.version.null : VERSION_NULL

  • hss.version.enterprise : VERSION_ENTERPRISE

  • hss.version.premium : VERSION_PREMIUM

  • hss.version.wtp : VERSION_WTP

charging_mode

No

String

on_demand: pay-per-use

resource_id

No

String

Instance ID

host_id_list

No

Array of strings

Server list

tags

No

Array of TagInfo objects

Resource tag
Table 5 TagInfo

Parameter

Mandatory

Type

Description

key

No

String

Key. It can contain up to 128 Unicode characters. The key cannot be left blank.

value

No

String

Value. Each tag value can contain a maximum of 255 Unicode characters.

Response Parameters

Status code: 200

successful response

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" : "on_demand",
  "resource_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
  "tags" : [ {
    "key" : "Service",
    "value" : "hss"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

successful response

Error Codes

See Error Codes.

Parent Topic: Server Management