按需转包年/包月带宽 - ChangeBandwidthToPeriod
功能介绍
该接口用于将带宽的计费模式从按需转为包年/包月。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
eip:bandwidths:update
Write
bandwidth *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
vpc:bandwidths:update
bss:renewal:update
-
URI
POST /v2.0/{project_id}/bandwidths/change-to-period
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
bandwidth_ids |
是 |
Array of strings |
待按需转包带宽列表 |
|
extendParam |
是 |
按需转包周期参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
charge_mode |
是 |
String |
|
|
period_type |
是 |
String |
|
|
period_num |
是 |
Integer |
最小值:1 最大值:9 |
|
is_auto_renew |
否 |
Boolean |
false:不自动续订 true:自动续订 缺省值:false |
|
is_auto_pay |
否 |
Boolean |
缺省值:false |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bandwidth_ids |
Array of strings |
转包带宽列表 |
|
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 60 61 |
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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .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 44 45 |
# coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) 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 55 56 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). 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 |
按需转包正常返回 |
错误码
请参见错误码。