Updated on 2024-04-08 GMT+08:00

Enabling or Disabling WTP

Function

This API is used to enable or disable WTP.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant ID

Minimum: 0

Maximum: 64

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project

Minimum: 0

Maximum: 64

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token

Minimum: 1

Maximum: 32768

region

Yes

String

Region Id

Minimum: 0

Maximum: 32

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

status

Yes

Boolean

Status (enabled or disabled)

host_id_list

Yes

Array of strings

HostId list

Minimum: 0

Maximum: 128

Array Length: 0 - 20000

resource_id

No

String

Resource ID

Minimum: 0

Maximum: 64

charging_mode

No

String

Billing mode.

  • packet_cycle: yearly/monthly

Minimum: 0

Maximum: 32

Response Parameters

None

Example Requests

Enable WTP, set the target server IDs to a and b, and pay for the yearly/monthly billing mode.

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

{
  "status" : true,
  "host_id_list" : [ "a", "b" ],
  "resource_id" : "aaxxx",
  "charging_mode" : "packet_cycle"
}

Example Responses

None

Status Codes

Status Code

Description

200

successful response

Error Codes

See Error Codes.