Operations on a Dedicated WAF Instance

Function

This API is used to perform 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	Definition Name of operation you want to perform for the dedicated engine. Currently, upgrade (upgrade), rollback (rollback after upgrade), and security_groups (security group change) are supported. Constraints N/A Range upgrade rollback security_groups Default Value N/A
params	No	Array of strings	Definition Request parameters. You do not need to set this parameter when the operation is upgrade or rollback. When the operation is security_groups, the parameter is the security group ID. Constraints N/A Range N/A Default Value N/A

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
security_group_ids	Array of strings	Definition The security group bound to the exclusive engine ECS Constraints N/A Range N/A Default Value N/A
status	Integer	Definition Billing status of the dedicated engine instance. Constraints N/A Range 0: normal 1: frozen. Resources and data are retained, but you cannot use the cloud service. 2: terminated. Resources and data will be cleared. Default Value N/A
run_status	Integer	Definition Running status of the dedicated engine instance. Constraints N/A Range 0: creating 1: running 2: deleting 3: deleted 4: creation failed 5: frozen 6: abnormal 7: being updated 8: update failed Default Value N/A
access_status	Integer	Definition Dedicated engine access status. Constraints N/A Range 0: Inaccessible 1: Accessible Default Value N/A
upgradable	Integer	Definition Whether the dedicated engine can be upgraded (0: Non-upgradable. 1: Upgradable). Constraints N/A Range 0: not upgradeable 1: upgradeable 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	Protected domain name ID.
hostname	String	Protected domain name.

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

{
  "action" : "upgrade"
}

Example Responses

Status code: 200

Dedicated WAF Engine Details

{
  "id" : "9ea89e662ba940af932258f510c3cfaf",
  "region" : "cn-north-7",
  "zone" : "cn-north-7c",
  "specification" : "2vCPUs | 8GB",
  "arch" : "x86",
  "upgradable" : 1,
  "status" : 0,
  "serverId" : "e10ceb6a-c59d-4671-88b1-f2ceaccf28da",
  "cloudServiceType" : "hws.service.type.waf",
  "resourceType" : "hws.resource.type.waf.instance",
  "resourceSpecCode" : "waf.instance.professional",
  "charge_mode" : 30,
  "vpc_id" : "0c32b303-70fc-4afa-bb4e-ec3de412103f",
  "subnet_id" : "66d467e1-8826-43e1-8236-62383f0fe4b3",
  "service_ip" : "10.0.1.14",
  "security_group_ids" : [ "06294861-8747-42d2-a770-0a6a5dc0df58" ],
  "cpu_flavor" : "c6.large.4",
  "run_status" : 1,
  "access_status" : 0,
  "instancename" : "60102527-SVqO"
}

SDK Sample Code

The SDK sample code is as follows.

     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}");
        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());
        }
    }
}
 
 
  

     # 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}"
        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)
 
 
  

     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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

    request := &model.UpdatePremiumInstanceRequest{}
	request.InstanceId = "{instance_id}"
	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.

Parent Topic: Managing Dedicated Instances

Previous topic: Querying Tags of a Dedicated WAF Instance

Next topic: Creating a Proxy

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot