查询WAF独享引擎列表
功能介绍
查询WAF独享引擎列表。独享模式只在部分局点支持,包括:华北-北京四、华东-上海一、华南-广州、华南-深圳 、中国-香港、亚太-曼谷、 亚太-新加坡。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/premium-waf/instance
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
page |
否 |
Integer |
分页查询参数,第page页,默认值为1 |
pagesize |
否 |
Integer |
分页查询参数,每页pagesize条记录,默认值为10 |
instancename |
否 |
String |
模糊查询,独享引擎名称 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
独享引擎实例数量 |
purchased |
Boolean |
是否曾经购买过独享引擎 |
items |
Array of ListInstance objects |
详细的独享引擎信息列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
独享引擎实例ID |
instancename |
String |
独享引擎实例名称 |
region |
String |
独享引擎实例Region ID |
zone |
String |
可用区ID |
arch |
String |
CPU架构 |
cpu_flavor |
String |
ECS规格 |
vpc_id |
String |
独享引擎实例所在VPC ID |
subnet_id |
String |
独享引擎实例所在VPC的子网ID |
service_ip |
String |
独享引擎实例的业务面IP |
security_group_ids |
Array of strings |
独享引擎绑定的安全组 |
status |
Integer |
独享引擎计费状态
|
run_status |
Integer |
独享引擎运行状态
|
access_status |
Integer |
独享引擎接入状态(0:未接入,1:已接入) |
upgradable |
Integer |
独享引擎是否可升级(0:不可升级,1:可升级) |
cloudServiceType |
String |
云服务代码。 仅作为标记,用户可忽略。 |
resourceType |
String |
云服务资源类型,仅作为标记,用户可忽略。 |
resourceSpecCode |
String |
云服务资源代码。仅作为标记,用户可忽略。 |
specification |
String |
独享引擎ECS规格,如"8vCPUs | 16GB" |
hosts |
Array of IdHostnameEntry objects |
独享引擎防护的域名 |
serverId |
String |
独享引擎ECS ID |
create_time |
Long |
引擎实例创建时间 |
instance_name |
String |
独享引擎实例名称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询项目id为project_id的WAF独享引擎列表。
GET https://{endpoint}/v1/{project_id}/premium-waf/instance
响应示例
状态码: 200
独享引擎信息列表
{ "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代码示例
SDK代码示例如下。
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 |
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()); } } } |
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 |
# 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) |
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 |
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.ListInstanceRequest{} response, err := client.ListInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
独享引擎信息列表 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。