更新时间:2025-08-19 GMT+08:00

购买包周期云模式waf

功能介绍

购买包周期云模式waf。入门版waf不支持购买扩展包

接口约束

如果付款方式无法完成支付,系统会自动生成一个待支付订单,您可以手动在控制台上选择支付方式进行支付。(仅在北京四、北京一、上海二、上海一、广州以及广州-友好用户环境支持入门版)

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/subscription/purchase/prepaid-cloud-waf

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。

约束限制:

不涉及

取值范围:

  • 0:代表default企业项目

  • all_granted_eps:代表所有企业项目

  • 其它企业项目ID:长度为36个字符

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表4 请求Body参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及

is_auto_pay

Boolean

参数解释:

是否自动支付

约束限制:

不涉及

取值范围:

  • false: 否(需要客户手动去支付)

  • true:是(自动支付)

默认取值:

不涉及

is_auto_renew

Boolean

参数解释:

是否自动续订

约束限制:

不涉及

取值范围:

  • true:自动续订

  • false:不自动续订

默认取值:

不涉及

region_id

String

参数解释:

region Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

waf_product_info

WafProductInfo object

购买waf信息

domain_expack_product_info

ExpackProductInfo object

购买域名扩展包信息

bandwidth_expack_product_info

ExpackProductInfo object

购买带宽扩展包信息

rule_expack_product_info

ExpackProductInfo object

购买规则扩展包信息

表5 WafProductInfo

参数

是否必选

参数类型

描述

resource_spec_code

String

参数解释:

waf规格

约束限制:

不涉及

取值范围:

  • detection: 入门 (仅在北京四、北京一、上海二、上海一、广州以及广州-友好用户环境支持入门版)

  • professional:标准

  • enterprise:专业

  • ultimate:企业版

默认取值:

不涉及

period_type

String

参数解释:

订购周期类型,month: 月;year: 年

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

period_num

Integer

参数解释:

订购周期数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 ExpackProductInfo

参数

是否必选

参数类型

描述

resource_size

Integer

参数解释:

扩展包数量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

orderId

String

参数解释:

订单id

取值范围:

不涉及

状态码:400

表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

下游服务报错信息

状态码:401

表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

下游服务报错信息

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表13 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

在项目id为“550500b49078408682d0d4f7d923f3e1”的项目中购买包周期云模式waf,waf不自动续订,不自动支付,region Id为"cn-north-7",带宽扩展包的扩展包数量为“1”。

POST https://{Endpoint}/v1/{project_id}/waf/subscription/purchase/prepaid-cloud-waf?enterprise_project_id=0

{
  "project_id" : "550500b49078408682d0d4f7d923f3e1",
  "is_auto_renew" : false,
  "is_auto_pay" : false,
  "region_id" : "cn-north-7",
  "bandwidth_expack_product_info" : {
    "resource_size" : 1
  }
}

响应示例

状态码:200

请求成功

{
  "orderId" : "38ff0cb9a10e4d5293c642bc0350fa6d"
}

SDK代码示例

SDK代码示例如下。

在项目id为“550500b49078408682d0d4f7d923f3e1”的项目中购买包周期云模式waf,waf不自动续订,不自动支付,region Id为"cn-north-7",带宽扩展包的扩展包数量为“1”。

 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
51
52
53
54
55
56
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 CreatePrepaidCloudWafSolution {

    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();
        CreatePrepaidCloudWafRequest request = new CreatePrepaidCloudWafRequest();
        CreatePrepaidCloudWafRequestBody body = new CreatePrepaidCloudWafRequestBody();
        ExpackProductInfo bandwidthExpackProductInfobody = new ExpackProductInfo();
        bandwidthExpackProductInfobody.withResourceSize(1);
        body.withBandwidthExpackProductInfo(bandwidthExpackProductInfobody);
        body.withRegionId("cn-north-7");
        body.withIsAutoRenew(false);
        body.withIsAutoPay(false);
        body.withProjectId("550500b49078408682d0d4f7d923f3e1");
        request.withBody(body);
        try {
            CreatePrepaidCloudWafResponse response = client.createPrepaidCloudWaf(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());
        }
    }
}

在项目id为“550500b49078408682d0d4f7d923f3e1”的项目中购买包周期云模式waf,waf不自动续订,不自动支付,region Id为"cn-north-7",带宽扩展包的扩展包数量为“1”。

 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
# 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 = CreatePrepaidCloudWafRequest()
        bandwidthExpackProductInfobody = ExpackProductInfo(
            resource_size=1
        )
        request.body = CreatePrepaidCloudWafRequestBody(
            bandwidth_expack_product_info=bandwidthExpackProductInfobody,
            region_id="cn-north-7",
            is_auto_renew=False,
            is_auto_pay=False,
            project_id="550500b49078408682d0d4f7d923f3e1"
        )
        response = client.create_prepaid_cloud_waf(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

在项目id为“550500b49078408682d0d4f7d923f3e1”的项目中购买包周期云模式waf,waf不自动续订,不自动支付,region Id为"cn-north-7",带宽扩展包的扩展包数量为“1”。

 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
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.CreatePrepaidCloudWafRequest{}
	resourceSizeBandwidthExpackProductInfo:= int32(1)
	bandwidthExpackProductInfobody := &model.ExpackProductInfo{
		ResourceSize: &resourceSizeBandwidthExpackProductInfo,
	}
	request.Body = &model.CreatePrepaidCloudWafRequestBody{
		BandwidthExpackProductInfo: bandwidthExpackProductInfobody,
		RegionId: "cn-north-7",
		IsAutoRenew: false,
		IsAutoPay: false,
		ProjectId: "550500b49078408682d0d4f7d923f3e1",
	}
	response, err := client.CreatePrepaidCloudWaf(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码