操作WAF独享引擎
功能介绍
操作WAF独享引擎
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/premium-waf/instance/{instance_id}/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户Project ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
instance_id |
是 |
String |
参数解释: 独享引擎ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数解释: 租户token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
独享引擎操作名称 |
params |
否 |
Array of strings |
具体的请求体 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
securityGroupId |
Array of strings |
参数解释: 独享引擎ECS绑定的安全组 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
mgr_security_group_id |
String |
参数解释: 独享引擎ECS绑定的用于WAF服务的安全组 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
status |
Integer |
参数解释: 独享引擎计费状态(0:正常计费,1:冻结(资源和数据会保留,但租户无法再正常使用云服务),2:终止(资源和数据将清除),3:受限(UDS控制用户桶访问权限)) 约束限制: 不涉及 取值范围: 0:正常计费,1:冻结,2:终止 默认取值: 不涉及 |
run_status |
Integer |
参数解释: '独享引擎运行状态(0:创建中,1:运行中,2:删除中,3:已删除,4:创建失败,5:已冻结,6:异常,7:更新中,8:更新失败)' 约束限制: 不涉及 取值范围: 0:创建中,1:运行中,2:删除中,3:已删除,4:创建失败,5:已冻结,6:异常,7:更新中,8:更新失败 默认取值: 不涉及 |
access_status |
Integer |
参数解释: 独享引擎接入状态(0:未接入,1:已接入) 约束限制: 不涉及 取值范围: 0:未接入,1:已接入 默认取值: 不涉及 |
upgradable |
Integer |
参数解释: 独享引擎是否可升级(0:不可升级,1:可升级) 约束限制: 不涉及 取值范围: 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:按需' 约束限制: 不涉及 取值范围: 0: 包周期;1:按需 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
无
响应示例
无
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 48 49 50 |
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}"); UpdatePremiumInstanceRequestBody body = new UpdatePremiumInstanceRequestBody(); request.withBody(body); 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()); } } } |
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 |
# 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}" request.body = UpdatePremiumInstanceRequestBody( ) 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) |
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 |
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.UpdatePremiumInstanceRequest{} request.InstanceId = "{instance_id}" request.Body = &model.UpdatePremiumInstanceRequestBody{ } response, err := client.UpdatePremiumInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
独享引擎信息 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。