文档首页> 弹性公网IP EIP> API参考> API> 带宽(V2.0)> 按需转包年/包月带宽
更新时间:2024-02-06 GMT+08:00
分享

按需转包年/包月带宽

功能介绍

该接口用于将按需计费模式的带宽转为包年/包月计费模式的带宽。

调用方法

请参见如何调用API

URI

POST /v2.0/{project_id}/bandwidths/change-to-period

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth_ids

Array

待按需转包带宽列表

extendParam

CreatePrePaidPublicipExtendParamOption object

按需转包周期参数

表3 CreatePrePaidPublicipExtendParamOption

参数

是否必选

参数类型

描述

charge_mode

String

  • 功能说明:付费方式(预付费、按需付费;预付费,即包周期付费)

  • 取值范围:

    • prePaid -预付费,即包年包月;

    • postPaid-后付费,即按需付费;

  • 后付费的场景下,extendParam的其他字段都会被忽略。

缺省值:postPaid

枚举值:

  • prePaid

  • postPaid

period_type

String

  • 功能说明:订购资源的周期类型(包年、包月等)

  • 取值范围:

    • month-月

    • year-年

  • 约束:如果用包周期共享带宽创建时(即携带共享带宽id创建EIP)此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时,该字段必选; 使用共享带宽创建IP时,带宽资源到期时间与IP的到期时间相同。

枚举值:

  • month

  • year

period_num

Integer

  • 功能说明:订购周期数

  • 取值范围:(后续会随运营策略变化)

    • period_type为month时,为[1,9]

    • period_type为year时,为[1,3]

  • 约束:同period_type约束。

最小值:1

最大值:9

is_auto_renew

Boolean

  • 功能说明:是否自动续订

  • 取值范围: false:不自动续订 true:自动续订

  • 约束:到期后,默认自动续订1个月(自动续订时间后续可能会变化),详情可联系客服咨询。

缺省值:false

is_auto_pay

Boolean

  • 功能说明:下单订购后,是否自动从客户的账户中支付

  • 取值范围:

    • true:自动支付,从账户余额自动扣费

    • false:只提交订单不支付,需要客户手动去支付

  • 约束:自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。

缺省值:false

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

bandwidth_ids

Array

转包带宽列表

order_id

String

订单ID

request_id

String

请求ID

请求示例

将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需带宽转为包周期带宽,订购周期为1个月,不自动续费。

POST /v2.0/{project_id}/bandwidths/change-to-period

{
  "bandwidth_ids" : [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ],
  "extendParam" : {
    "charge_mode" : "prePaid",
    "period_type" : "month",
    "period_num" : 1,
    "is_auto_renew" : false,
    "is_auto_pay" : true
  }
}

响应示例

状态码: 200

按需转包正常返回

{
  "bandwidth_ids" : [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ],
  "order_id" : "CS2212141741L0QZG",
  "request_id" : "8bcadb5d-1bf4-42e8-909f-1606ecf781ce"
}

SDK代码示例

SDK代码示例如下。

将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需带宽转为包周期带宽,订购周期为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
57
58
59
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.eip.v2.region.EipRegion;
import com.huaweicloud.sdk.eip.v2.*;
import com.huaweicloud.sdk.eip.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ChangeBandwidthToPeriodSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        ChangeBandwidthToPeriodRequest request = new ChangeBandwidthToPeriodRequest();
        BwChangeToPeriodReq body = new BwChangeToPeriodReq();
        CreatePrePaidPublicipExtendParamOption extendParambody = new CreatePrePaidPublicipExtendParamOption();
        extendParambody.withChargeMode(CreatePrePaidPublicipExtendParamOption.ChargeModeEnum.fromValue("prePaid"))
            .withPeriodType(CreatePrePaidPublicipExtendParamOption.PeriodTypeEnum.fromValue("month"))
            .withPeriodNum(1)
            .withIsAutoRenew(false)
            .withIsAutoPay(true);
        List<String> listbodyBandwidthIds = new ArrayList<>();
        listbodyBandwidthIds.add("fe2a11c7-c880-49f7-b1e0-e151df2cc836");
        body.withExtendParam(extendParambody);
        body.withBandwidthIds(listbodyBandwidthIds);
        request.withBody(body);
        try {
            ChangeBandwidthToPeriodResponse response = client.changeBandwidthToPeriod(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为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需带宽转为包周期带宽,订购周期为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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v2.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ChangeBandwidthToPeriodRequest()
        extendParambody = CreatePrePaidPublicipExtendParamOption(
            charge_mode="prePaid",
            period_type="month",
            period_num=1,
            is_auto_renew=False,
            is_auto_pay=True
        )
        listBandwidthIdsbody = [
            "fe2a11c7-c880-49f7-b1e0-e151df2cc836"
        ]
        request.body = BwChangeToPeriodReq(
            extend_param=extendParambody,
            bandwidth_ids=listBandwidthIdsbody
        )
        response = client.change_bandwidth_to_period(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为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需带宽转为包周期带宽,订购周期为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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ChangeBandwidthToPeriodRequest{}
	chargeModeExtendParam:= model.GetCreatePrePaidPublicipExtendParamOptionChargeModeEnum().PRE_PAID
	periodTypeExtendParam:= model.GetCreatePrePaidPublicipExtendParamOptionPeriodTypeEnum().MONTH
	periodNumExtendParam:= int32(1)
	isAutoRenewExtendParam:= false
	isAutoPayExtendParam:= true
	extendParambody := &model.CreatePrePaidPublicipExtendParamOption{
		ChargeMode: &chargeModeExtendParam,
		PeriodType: &periodTypeExtendParam,
		PeriodNum: &periodNumExtendParam,
		IsAutoRenew: &isAutoRenewExtendParam,
		IsAutoPay: &isAutoPayExtendParam,
	}
	var listBandwidthIdsbody = []string{
        "fe2a11c7-c880-49f7-b1e0-e151df2cc836",
    }
	request.Body = &model.BwChangeToPeriodReq{
		ExtendParam: extendParambody,
		BandwidthIds: listBandwidthIdsbody,
	}
	response, err := client.ChangeBandwidthToPeriod(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

按需转包正常返回

错误码

请参见错误码

分享:

    相关文档

    相关产品