Updated on 2024-09-04 GMT+08:00

Configuring the Billing Option

Function

  • This API is used to configure the billing option.

  • The service area can only be mainland_china (Chinese mainland).

  • The billing option can be flux (traffic-based billing) or bw (bandwidth-based billing, only for V2 and higher customers).

  • The acceleration type can only be base (basic acceleration).

  • A single tenant can call this API 10 times per minute.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/cdn/charge/charge-modes

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

charge_mode

Yes

String

Billing option. The value can be flux (traffic-based billing) or bw (bandwidth-based billing, only for V2 and higher customers).

product_type

Yes

String

Product mode. Only base (basic acceleration) is supported.

service_area

Yes

String

Service area. Only mainland_china (Chinese mainland) is supported.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

charge_mode

String

Billing option of the account.

product_type

String

Service type.

effective_time

Long

Effective time of the option.

create_time

Long

Creation time.

service_area

String

Area of this option.

status

String

Status. The status is active when the option is enabled for the first time and is changed to upcoming when the option is enabled again.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error

ErrMsg object

Error code and error message.

Table 4 ErrMsg

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Configuring the billing option

POST https://cdn.myhuaweicloud.com/v1.0/cdn/charge/charge-modes

{
  "charge_mode" : "flux",
  "product_type" : "base",
  "service_area" : "mainland_china"
}

Example Responses

Status code: 200

Success response

  • Configuring the billing option

    {
      "charge_mode" : "flux",
      "effective_time" : 1666238400000,
      "create_time" : 1664596800000,
      "service_area" : "mainland_china",
      "status" : "active",
      "product_type" : "base"
    }

SDK Sample Code

The SDK sample code is as follows.

Configuring the billing option

 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.GlobalCredentials;
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.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;


public class SetChargeModesSolution {

    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");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        SetChargeModesRequest request = new SetChargeModesRequest();
        SetChargeModesBody body = new SetChargeModesBody();
        body.withServiceArea("mainland_china");
        body.withProductType("base");
        body.withChargeMode("flux");
        request.withBody(body);
        try {
            SetChargeModesResponse response = client.setChargeModes(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());
        }
    }
}

Configuring the billing option

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.v2 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"]

    credentials = GlobalCredentials(ak, sk)

    client = CdnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CdnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SetChargeModesRequest()
        request.body = SetChargeModesBody(
            service_area="mainland_china",
            product_type="base",
            charge_mode="flux"
        )
        response = client.set_charge_modes(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Configuring the billing option

 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/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetChargeModesRequest{}
	request.Body = &model.SetChargeModesBody{
		ServiceArea: "mainland_china",
		ProductType: "base",
		ChargeMode: "flux",
	}
	response, err := client.SetChargeModes(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

Success response

400

Error response

Error Codes

See Error Codes.