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

Changing the Protection Status

Function

This API is used to change the protection status.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 1

Maximum: 256

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.

Default: 0

Minimum: 1

Maximum: 256

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Minimum: 1

Maximum: 32768

region

Yes

String

Region ID

Minimum: 0

Maximum: 128

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

version

Yes

String

HSS edition. Its value can be:

  • hss.version.null: protection disabled

  • 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

Minimum: 1

Maximum: 128

charging_mode

No

String

Payment mode. This parameter is mandatory when version is not set to hss.version.null.

  • packet_cycle: yearly/monthly

  • on_demand: on-demand

Minimum: 1

Maximum: 64

resource_id

No

String

HSS quota ID. If this parameter is not specified, the quota of the corresponding version is randomly selected.

Minimum: 1

Maximum: 128

host_id_list

Yes

Array of strings

Server list

Minimum: 1

Maximum: 128

Array Length: 0 - 2097152

tags

No

Array of TagInfo objects

Resource tag list

Array Length: 0 - 2097152

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.

Minimum: 1

Maximum: 128

value

No

String

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

Minimum: 1

Maximum: 255

Response Parameters

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"
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;

import java.util.List;
import java.util.ArrayList;

public class SwitchHostsProtectStatusSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        SwitchHostsProtectStatusRequest request = new SwitchHostsProtectStatusRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        SwitchHostsProtectStatusRequestInfo body = new SwitchHostsProtectStatusRequestInfo();
        List<TagInfo> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new TagInfo()
                .withKey("Service")
                .withValue("hss")
        );
        List<String> listbodyHostIdList = new ArrayList<>();
        listbodyHostIdList.add("71a15ecc-049f-4cca-bd28-5e90aca1817f");
        body.withTags(listbodyTags);
        body.withHostIdList(listbodyHostIdList);
        body.withResourceId("af4d08ad-2b60-4916-a5cf-8d6a23956dda");
        body.withChargingMode("packet_cycle");
        body.withVersion("hss.version.enterprise");
        request.withBody(body);
        try {
            SwitchHostsProtectStatusResponse response = client.switchHostsProtectStatus(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SwitchHostsProtectStatusRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        listTagsbody = [
            TagInfo(
                key="Service",
                value="hss"
            )
        ]
        listHostIdListbody = [
            "71a15ecc-049f-4cca-bd28-5e90aca1817f"
        ]
        request.body = SwitchHostsProtectStatusRequestInfo(
            tags=listTagsbody,
            host_id_list=listHostIdListbody,
            resource_id="af4d08ad-2b60-4916-a5cf-8d6a23956dda",
            charging_mode="packet_cycle",
            version="hss.version.enterprise"
        )
        response = client.switch_hosts_protect_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SwitchHostsProtectStatusRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	keyTags:= "Service"
	valueTags:= "hss"
	var listTagsbody = []model.TagInfo{
        {
            Key: &keyTags,
            Value: &valueTags,
        },
    }
	var listHostIdListbody = []string{
        "71a15ecc-049f-4cca-bd28-5e90aca1817f",
    }
	resourceIdSwitchHostsProtectStatusRequestInfo:= "af4d08ad-2b60-4916-a5cf-8d6a23956dda"
	chargingModeSwitchHostsProtectStatusRequestInfo:= "packet_cycle"
	request.Body = &model.SwitchHostsProtectStatusRequestInfo{
		Tags: &listTagsbody,
		HostIdList: listHostIdListbody,
		ResourceId: &resourceIdSwitchHostsProtectStatusRequestInfo,
		ChargingMode: &chargingModeSwitchHostsProtectStatusRequestInfo,
		Version: "hss.version.enterprise",
	}
	response, err := client.SwitchHostsProtectStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

successful response

Error Codes

See Error Codes.