Updated on 2025-08-19 GMT+08:00

Operations on a Dedicated WAF Instance

Function

Operations on a Dedicated WAF Instance

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/premium-waf/instance/{instance_id}/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

ID of the dedicated WAF engine.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition

User token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Operation name.

params

No

Array of strings

Request body.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition

ID of the dedicated WAF engine.

Constraints

N/A

Range

N/A

Default Value

N/A

instancename

String

Definition

Name of the dedicated WAF engine.

Constraints

N/A

Range

N/A

Default Value

N/A

serverId

String

Definition

ID of the ECS hosting the dedicated engine.

Constraints

N/A

Range

N/A

Default Value

N/A

region

String

Definition

Region code.

Constraints

N/A

Range

N/A

Default Value

N/A

zone

String

Definition

AZ code.

Constraints

N/A

Range

N/A

Default Value

N/A

arch

String

Definition

CPU architecture code.

Constraints

N/A

Range

N/A

Default Value

N/A

cpu_flavor

String

Definition

ECS flavor code.

Constraints

N/A

Range

N/A

Default Value

N/A

vpc_id

String

Definition

ID of the VPC where the dedicated engine is located.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_id

String

Definition

Subnet ID of the VPC where the dedicated engine is located.

Constraints

N/A

Range

N/A

Default Value

N/A

service_ip

String

Definition

Service plane IP address of the dedicated engine.

Constraints

N/A

Range

N/A

Default Value

N/A

service_ipv6

String

Definition

IPv6 address of the service plane of the dedicated engine.

Constraints

N/A

Range

N/A

Default Value

N/A

floatIp

String

Definition

Management plane IP address of the dedicated engine.

Constraints

N/A

Range

N/A

Default Value

N/A

securityGroupId

Array of strings

Definition

Security group bound to the dedicated engine ECS.

Constraints

N/A

Range

N/A

Default Value

N/A

mgrSecurityGroupId

String

Definition

Security group configured for the dedicated WAF engine ECSs.

Constraints

N/A

Range

N/A

Default Value

N/A

status

Integer

Definition

Billing status of the dedicated WAF engine. 0: The billing is normal. 1: The billing account is frozen. Resources and data will be retained, but the cloud services cannot be used by the account. 2: The billing is terminated. Resources and data will be cleared. 3: Access to buckets is controlled by the UDS.

Constraints

N/A

Range

N/A

Default Value

N/A

run_status

Integer

Definition

Running status of the dedicated WAF engine. 0: Creating. 1: Running. 2: Deleting. 3: Deleted. 4: Creation failed. 5: Frozen. 6: Abnormal. 7: Updating. 8: Update failed.

Constraints

N/A

Range

N/A

Default Value

N/A

access_status

Integer

Definition

Access status of the dedicated engine (0: Not connected. 1: Connected.)

Constraints

N/A

Range

N/A

Default Value

N/A

upgradable

Integer

Definition

Whether the dedicated engine can be upgraded (0: No. 1: Yes).

Constraints

N/A

Range

N/A

Default Value

N/A

cloudServiceType

String

Definition

Cloud service code.

Constraints

N/A

Range

N/A

Default Value

N/A

resourceType

String

Definition

Cloud service resource type.

Constraints

N/A

Range

N/A

Default Value

N/A

resourceSpecCode

String

Definition

Cloud service resource code.

Constraints

N/A

Range

N/A

Default Value

N/A

specification

String

Definition

Dedicated engine ECS flavor, for example, 8 vCPUs | 16 GB.

Constraints

N/A

Range

N/A

Default Value

N/A

hosts

Array of IdHostnameEntry objects

Definition

Domain name protected by the dedicated engine.

Constraints

N/A

Range

N/A

Default Value

N/A

volume_type

String

Definition

Storage type (optional).

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

String

Definition

ID of the storage resource pool. This parameter is optional.

Constraints

N/A

Range

N/A

Default Value

N/A

pool_id

String

Definition

ID of the WAF group to which the dedicated engine belongs (applicable only to the dedicated mode).

Constraints

N/A

Range

N/A

Default Value

N/A

charge_mode

Integer

Definition

Billing mode. 0: yearly/monthly; 1: pay-per-use.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 IdHostnameEntry

Parameter

Type

Description

id

String

Definition

Domain ID

Range

N/A

hostname

String

Definition

Protected domain dame.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 7 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 9 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 11 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

None

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

 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
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class UpdatePremiumInstanceSolution {

    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");
        String projectId = "{project_id}";

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

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePremiumInstanceRequest request = new UpdatePremiumInstanceRequest();
        request.withInstanceId("{instance_id}");
        UpdatePremiumInstanceRequestBody body = new UpdatePremiumInstanceRequestBody();
        request.withBody(body);
        try {
            UpdatePremiumInstanceResponse response = client.updatePremiumInstance(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = UpdatePremiumInstanceRequest()
        request.instance_id = "{instance_id}"
        request.body = UpdatePremiumInstanceRequestBody(
        )
        response = client.update_premium_instance(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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")
    projectId := "{project_id}"

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

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePremiumInstanceRequest{}
	request.InstanceId = "{instance_id}"
	request.Body = &model.UpdatePremiumInstanceRequestBody{
	}
	response, err := client.UpdatePremiumInstance(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

Dedicated WAF Engine Details

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.