文档首页/ Web应用防火墙 WAF/ API参考/ API/ 独享实例管理/ 操作WAF独享引擎 - UpdatePremiumInstance
更新时间:2025-11-21 GMT+08:00
分享

操作WAF独享引擎 - UpdatePremiumInstance

功能介绍

操作WAF独享引擎

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户Project ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

instance_id

String

参数解释:

独享引擎ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释:

独享引擎操作名称,目前支持 upgrade(升级) ,rollback(升级后回滚),security_groups(切换安全组)

取值范围:

  • upgrade

  • rollback

  • security_groups

params

Array of strings

参数解释:

具体的请求参数,操作为upgrade(升级) ,rollback(升级后回滚)时无需填写,操作为 security_groups(切换安全组)时,参数为安全组的ip数组

取值范围:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

独享引擎ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

instancename

String

参数解释:

独享引擎名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

serverId

String

参数解释:

独享引擎ECS ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

region

String

参数解释:

Region代码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

zone

String

参数解释:

可用区代码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

arch

String

参数解释:

CPU架构代码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cpu_flavor

String

参数解释:

ECS规格代码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

vpc_id

String

参数解释:

独享引擎所在VPC ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

subnet_id

String

参数解释:

独享引擎所在VPC的子网ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

service_ip

String

参数解释:

独享引擎的业务面IP

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

service_ipv6

String

参数解释:

独享引擎的业务面IPV6地址

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

floatIp

String

参数解释:

独享引擎的管理面IP

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

security_group_ids

Array of strings

参数解释:

独享引擎ECS绑定的安全组

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

status

Integer

参数解释:

独享引擎计费状态(0:正常计费,1:冻结(资源和数据会保留,但租户无法再正常使用云服务),2:终止(资源和数据将清除),3:受限(UDS控制用户桶访问权限))

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

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

参数解释:

独享引擎防护的域名

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

volume_type

String

参数解释:

存储类型(可选)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cluster_id

String

参数解释:

存储资源池ID(可选)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

pool_id

String

参数解释:

独享引擎所在WAF组的ID(仅适用特殊独享模式)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

charge_mode

Integer

参数解释:

'计费模式。0: 包周期;1:按需'

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 IdHostnameEntry

参数

参数类型

描述

id

String

防护域名ID

hostname

String

防护域名

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表7 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

{
  "action" : "upgrade"
}

响应示例

状态码:200

独享引擎信息

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

状态码

状态码

描述

200

独享引擎信息

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

相关文档