Querying Dedicated WAF Instances

Function

This API is used to query the list of dedicated WAF instances. Dedicated WAF instances are supported only in some regions, including: CN North-Beijing4, CN East-Shanghai1, CN South-Guangzhou, CN South-Shenzhen, CN-Hong Kong, AP-Bangkok, and AP-Singapore

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/premium-waf/instance

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range 0: the default enterprise project. all_granted_eps: all enterprise projects. A specific enterprise project ID: Enter a maximum of 36 characters. Default Value 0
page	No	Integer	Definition Page number of the data to be returned in a query. Constraints N/A Range The valid range of page depends on the total data volume and the value of pagesize. The value cannot be greater than the total number of pages. Default Value 1
pagesize	No	Integer	Definition Number of results per page in a query. Constraints N/A Range [0, Total data volume] Default Value 10
instancename	No	String	Definition Name of the dedicated WAF instance for fuzzy query. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of dedicated engine instances.
purchased	Boolean	Whether any dedicated engine has been purchased.
items	Array of Instance objects	Details about the dedicated WAF instance.

**Table 5** Instance
Parameter	Type	Description
id	String	ID of the dedicated engine instance.
instancename	String	Name of the dedicated engine instance.
region	String	Region ID of a dedicated engine instance.
zone	String	AZ ID.
arch	String	CPU architecture.
cpu_flavor	String	ECS specifications.
vpc_id	String	ID of the VPC where the dedicated engine instance is located.
subnet_id	String	Subnet ID of the VPC where the dedicated engine instance is located.
service_ip	String	Service plane IP address of the dedicated engine instance.
security_group_ids	Array of strings	Security group for the dedicated engine.
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	Whether the dedicated engine can be upgraded (0: Non-upgradable. 1: Upgradable).
cloudServiceType	String	Cloud service code. This field is used only as a tag. You can ignore it.
resourceType	String	Cloud service resource type. This field is used only as a tag. You can ignore it.
resourceSpecCode	String	Cloud service resource code. This field is used only as a tag. You can ignore it.
specification	String	Dedicated engine ECS flavor, for example, 8 vCPUs \| 16 GB.
hosts	Array of IdHostnameEntry objects	Domain name protected by the dedicated engine.
serverId	String	ID of the ECS hosting the dedicated engine.
create_time	Long	Time when an engine instance was created.
instance_name	String	Name of the dedicated engine instance.

**Table 6** IdHostnameEntry
Parameter	Type	Description
id	String	Protected domain name ID.
hostname	String	Protected domain name.

Status code: 400

**Table 7** 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 8** 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 9** 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 10** 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 11** 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 12** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Example Requests

The following example shows how to query the dedicated WAF instance list in a project. The project ID is specified by project_id.

GET https://{endpoint}/v1/{project_id}/premium-waf/instance

Example Responses

Status code: 200

Lists of dedicated WAF instances

{
  "purchased" : true,
  "total" : 1,
  "items" : [ {
    "id" : "0619871acb764d48a112695e8f7cbb10",
    "region" : "region-01-7",
    "zone" : "region-01-7a",
    "specification" : "8vCPUs | 16GB",
    "arch" : "x86",
    "upgradable" : 0,
    "status" : 0,
    "serverId" : "477353dc-8687-4bf4-b45b-1d7fee74fa63",
    "cloudServiceType" : "hws.service.type.waf",
    "resourceType" : "hws.resource.type.waf.instance",
    "resourceSpecCode" : "waf.instance.enterprise",
    "vpc_id" : "13718074-a3f9-408d-82aa-3c41ef55e589",
    "subnet_id" : "74d1b5a6-c7eb-4e9a-8372-181212552fcc",
    "service_ip" : "192.168.10.68",
    "security_group_ids" : [ "34287bdb-7aba-471a-b041-27427f1af76a" ],
    "cpu_flavor" : "Si2.2xlarge.2",
    "run_status" : 2,
    "access_status" : 1,
    "hosts" : [ {
      "id" : "c3be17bbe3a641c7a1ded6019c377402",
      "hostname" : "demo.www.com"
    } ],
    "instance_name" : "0412elb",
    "create_time" : 1649217360674
  } ]
}

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 ListInstanceSolution {

    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();
        ListInstanceRequest request = new ListInstanceRequest();
        try {
            ListInstanceResponse response = client.listInstance(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 = ListInstanceRequest()
        response = client.list_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.ListInstanceRequest{}
	response, err := client.ListInstance(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	Lists of dedicated WAF instances
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 the Proxy of a Dedicated Engine

Next topic: Creating a Dedicated WAF Instance

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