Changing Specifications of Yearly/Monthly-Billed Cloud WAF
Function
This API is used to change specifications of a cloud WAF instance that is billed yearly/monthly. Notes:
-
1: The cloud WAF instance must be billed yearly/monthly.
-
2: The edition for the WAF instance cannot be scaled down. The number of any type of expansion packages cannot be decreased to 0.
-
3: The number of each type of expansion packages can only be increased or decreased together.
Constraints
If the payment fails, the system automatically generates a pending payment order. You can select another payment method on the console.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/subscription/batchalter/prepaid-cloud-waf
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
is_auto_pay |
Yes |
Boolean |
Whether automatic payment is enabled.
|
waf_product_info |
No |
AlterWafProductInfo object |
Changing the WAF edition. |
domain_expack_product_info |
No |
ExpackProductInfo object |
Changing the quantity of domain expansion packages. |
bandwidth_expack_product_info |
No |
ExpackProductInfo object |
Changing the quantity of bandwidth expansion packages. |
rule_expack_product_info |
No |
ExpackProductInfo object |
Changing the quantity of rule expansion packages. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
orderId |
String |
Order ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
The following example shows how to change the yearly/monthly cloud WAF specifications. Project ID: 550500b49078408682d0d4f7d923f3e1. Auto-renewal: changed to enabled. Quantity of bandwidth expansion packages: changed to 2.
POST https://{Endpoint}/v1/{project_id}/waf/subscription/batchalter/prepaid-cloud-waf?enterprise_project_id=0 { "project_id" : "550500b49078408682d0d4f7d923f3e1", "is_auto_pay" : true, "domain_expack_product_info" : { "resource_size" : 2 } }
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 change the yearly/monthly cloud WAF specifications. Project ID: 550500b49078408682d0d4f7d923f3e1. Auto-renewal: changed to enabled. Quantity of bandwidth expansion packages: changed to 2.
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 |
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 ChangePrepaidCloudWafSolution { 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(); ChangePrepaidCloudWafRequest request = new ChangePrepaidCloudWafRequest(); ChangePrepaidCloudWafRequestBody body = new ChangePrepaidCloudWafRequestBody(); ExpackProductInfo domainExpackProductInfobody = new ExpackProductInfo(); domainExpackProductInfobody.withResourceSize(2); body.withDomainExpackProductInfo(domainExpackProductInfobody); body.withIsAutoPay(true); body.withProjectId("550500b49078408682d0d4f7d923f3e1"); request.withBody(body); try { ChangePrepaidCloudWafResponse response = client.changePrepaidCloudWaf(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 change the yearly/monthly cloud WAF specifications. Project ID: 550500b49078408682d0d4f7d923f3e1. Auto-renewal: changed to enabled. Quantity of bandwidth expansion packages: changed to 2.
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 |
# 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 = ChangePrepaidCloudWafRequest() domainExpackProductInfobody = ExpackProductInfo( resource_size=2 ) request.body = ChangePrepaidCloudWafRequestBody( domain_expack_product_info=domainExpackProductInfobody, is_auto_pay=True, project_id="550500b49078408682d0d4f7d923f3e1" ) response = client.change_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 change the yearly/monthly cloud WAF specifications. Project ID: 550500b49078408682d0d4f7d923f3e1. Auto-renewal: changed to enabled. Quantity of bandwidth expansion packages: changed to 2.
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 |
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.ChangePrepaidCloudWafRequest{} resourceSizeDomainExpackProductInfo:= int32(2) domainExpackProductInfobody := &model.ExpackProductInfo{ ResourceSize: &resourceSizeDomainExpackProductInfo, } request.Body = &model.ChangePrepaidCloudWafRequestBody{ DomainExpackProductInfo: domainExpackProductInfobody, IsAutoPay: true, ProjectId: "550500b49078408682d0d4f7d923f3e1", } response, err := client.ChangePrepaidCloudWaf(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot