Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Your Subscriptions/ Buying a Yearly/Monthly-Billed Cloud WAF Instance
Updated on 2024-11-08 GMT+08:00

Buying a Yearly/Monthly-Billed Cloud WAF Instance

Function

This API is used to buy a yearly/monthly-billed cloud WAF instance. Expansion packages are not supported by the starter edition.

Constraints

If the payment fails, the system automatically generates a pending payment order. You can select another payment method on the console. The Starter edition is available only in CN North-Beijing1, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, and CN South-Guangzhou-InvitationOnly regions.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain the value, go to the Huawei Cloud management console first. Then, click your username, select My Credentials, and view the Project ID column in the Projects area.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

is_auto_pay

Yes

Boolean

Whether automatic payment is enabled.

  • false: Automatic payment is not enabled. You need to complete payment manually.

  • **: Automatic payment is enabled.

is_auto_renew

Yes

Boolean

Whether auto-renewal is enabled.

  • true: Auto-renewal is enabled for the instance.

  • false: Auto-renewal is disabled for the instance.

region_id

Yes

String

region Id

waf_product_info

No

WafProductInfo object

Details about purchased WAF instances.

domain_expack_product_info

No

ExpackProductInfo object

Domain name expansion packages purchased.

bandwidth_expack_product_info

No

ExpackProductInfo object

Bandwidth expansion packages purchased.

rule_expack_product_info

No

ExpackProductInfo object

Rule expansion packages purchased.

Table 5 WafProductInfo

Parameter

Mandatory

Type

Description

resource_spec_code

No

String

WAF editions

  • detection: The Starter edition. (This edition is available only in CN North-Beijing1, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, and CN South-Guangzhou-InvitationOnly regions.)

  • professional: The Standard edition.

  • enterprise: The Professional edition.

  • ultimate: The Platinum edition.

period_type

No

String

Period type in yearly/monthly billing. month (2) is for monthly billing and year(3) for yearly billing.

period_num

No

Integer

Number of subscription periods.

Table 6 ExpackProductInfo

Parameter

Mandatory

Type

Description

resource_size

No

Integer

Number of expansion packages.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

orderId

String

Order ID.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 9 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 11 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 13 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

The following example shows how to purchase yearly/monthly billed cloud WAF. Project Id:550500b49078408682d0d4f7d923f3e1. Auto-renewal: Disabled. Region ID: cn-north-7. Quantity of bandwidth expansion packages: 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
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "orderId" : "38ff0cb9a10e4d5293c642bc0350fa6d"
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to purchase yearly/monthly billed cloud WAF. Project Id:550500b49078408682d0d4f7d923f3e1. Auto-renewal: Disabled. Region ID: cn-north-7. Quantity of bandwidth expansion packages: 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());
        }
    }
}

The following example shows how to purchase yearly/monthly billed cloud WAF. Project Id:550500b49078408682d0d4f7d923f3e1. Auto-renewal: Disabled. Region ID: cn-north-7. Quantity of bandwidth expansion packages: 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)

The following example shows how to purchase yearly/monthly billed cloud WAF. Project Id:550500b49078408682d0d4f7d923f3e1. Auto-renewal: Disabled. Region ID: cn-north-7. Quantity of bandwidth expansion packages: 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.