文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 独享模式/ 独享实例管理/ 查询WAF独享引擎列表
更新时间：2024-07-25 GMT+08:00
查看PDF
分享

查询WAF独享引擎列表

功能介绍

查询WAF独享引擎列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

page

否

Integer

分页查询参数，默认值为1

pagesize

否

Integer

分页查询参数，每页包含多少条记录，默认值为10

instancename

否

String

模糊查询，独享引擎名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

独享引擎实例数量

purchased

Boolean

是否曾经购买过独享引擎

items

Array of ListInstance objects

详细的独享引擎信息列表
表5 ListInstance

参数

参数类型

描述

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

独享引擎计费状态

  • 0：正常计费

  • 1：冻结,资源和数据会保留，但租户无法再正常使用云服务

  • 2：终止，资源和数据将清除

run_status

Integer

独享引擎运行状态

  • 0：创建中

  • 1：运行中

  • 2：删除中

  • 3：已删除

  • 4：创建失败

  • 5：已冻结

  • 6：异常

  • 7：更新中

  • 8：更新失败

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

独享引擎实例名称
表6 IdHostnameEntry

参数

参数类型

描述

id

String

防护域名ID

hostname

String

防护域名

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

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

状态码

状态码

描述

200

独享引擎信息列表

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 独享实例管理