# 按需转包年/包月EIP - ChangePublicipToPeriod #### 功能介绍 该接口用于将按需计费模式的EIP转为包年/包月计费模式的EIP。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ChangePublicipToPeriod&version=v2)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:publicIps:update | Write | publicip \* | - g:EnterpriseProjectId - g:ResourceTag/\ | vpc:publicIps:update | bss:renewal:update | #### URI POST /v2.0/{project_id}/publicips/change-to-period 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID [参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | publicip_ids | 是 | Array of strings | **参数解释：** 待按需转包IP列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | extendParam | 是 | [CreatePrePaidPublicipExtendParamOption] object | **参数解释：** 按需转包周期参数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3CreatePrePaidPublicipExtendParamOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | charge_mode | 否 | String | **参数解释：** 付费方式（预付费、按需付费；预付费，即包周期付费）。 **约束限制：** 后付费的场景下，extendParam的其他字段都会被忽略。 **取值范围：** - prePaid：预付费，即包年/包月。 - postPaid：后付费，即按需付费。 **默认取值：** postPaid。 | | period_type | 否 | String | **参数解释：** 订购资源的周期类型（包年、包月等）。 **约束限制：** 如果用包周期共享带宽创建时（即携带共享带宽id创建弹性公网IP）此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时，该字段必选。使用共享带宽创建IP时，带宽资源到期时间与IP的到期时间相同。 **取值范围：** - month：月。 - year：年。 **默认取值：** 不涉及。 | | period_num | 否 | Integer | **参数解释：** 订购周期数，和period_type组合使用。举例需订购3个月时，period_type取值month，period_num取值3。 **约束限制：** 同period_type约束限制。 **取值范围：** - period_type为month时，为\[1,9\]的整数。 - period_type为year时，为\[1,3\]的整数。 **默认取值：** 不涉及。 | | is_auto_renew | 否 | Boolean | **参数解释：** 是否自动续订。 **约束限制：** 到期后，默认自动续订1个月（自动续订时间后续可能会变化），详情可联系客服咨询。 **取值范围：** - true：自动续订。 - false：不自动续订。 **默认取值：** false。 | | is_auto_pay | 否 | Boolean | **参数解释：** 下单订购后，是否自动从客户的账户中支付。 **约束限制：** 自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 **取值范围：** - true：自动支付，从账户余额自动扣费。 - false：只提交订单不支付，需要客户手动去支付。 **默认取值：** false。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip_ids | Array of strings | **参数解释：** 转包IP的ID列表。 **取值范围：** 不涉及。 | | order_id | String | **参数解释：** 订单ID。 **取值范围：** 不涉及。 | | request_id | String | **参数解释：** 请求ID。 **取值范围：** 不涉及。 | #### 请求示例 将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需EIP转为包周期EIP，订购周期为1个月，不自动续费。 ``` { "publicip_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** ``` { "publicip_ids" : [ "2c3b404b-d595-4ab5-a333-69f3ff937dc2" ], "order_id" : "CS2212141730K2FGR", "request_id" : "9d5bc34c-810f-48f2-95c4-9c48d02f2a33" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需EIP转为包周期EIP，订购周期为1个月，不自动续费。 ``` 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 ChangePublicipToPeriodSolution { 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("")) .build(); ChangePublicipToPeriodRequest request = new ChangePublicipToPeriodRequest(); ChangeToPeriodReq body = new ChangeToPeriodReq(); CreatePrePaidPublicipExtendParamOption extendParambody = new CreatePrePaidPublicipExtendParamOption(); extendParambody.withChargeMode(CreatePrePaidPublicipExtendParamOption.ChargeModeEnum.fromValue("prePaid")) .withPeriodType(CreatePrePaidPublicipExtendParamOption.PeriodTypeEnum.fromValue("month")) .withPeriodNum(1) .withIsAutoRenew(false) .withIsAutoPay(true); List listbodyPublicipIds = new ArrayList<>(); listbodyPublicipIds.add("fe2a11c7-c880-49f7-b1e0-e151df2cc836"); body.withExtendParam(extendParambody); body.withPublicipIds(listbodyPublicipIds); request.withBody(body); try { ChangePublicipToPeriodResponse response = client.changePublicipToPeriod(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()); } } } ``` - [Python] 将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需EIP转为包周期EIP，订购周期为1个月，不自动续费。 ``` # 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("")) \ .build() try: request = ChangePublicipToPeriodRequest() extendParambody = CreatePrePaidPublicipExtendParamOption( charge_mode="prePaid", period_type="month", period_num=1, is_auto_renew=False, is_auto_pay=True ) listPublicipIdsbody = [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ] request.body = ChangeToPeriodReq( extend_param=extendParambody, publicip_ids=listPublicipIdsbody ) response = client.change_publicip_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) ``` - [Go] 将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需EIP转为包周期EIP，订购周期为1个月，不自动续费。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ChangePublicipToPeriodRequest{} 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 listPublicipIdsbody = []string{ "fe2a11c7-c880-49f7-b1e0-e151df2cc836", } request.Body = &model.ChangeToPeriodReq{ ExtendParam: extendParambody, PublicipIds: listPublicipIdsbody, } response, err := client.ChangePublicipToPeriod(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=ChangePublicipToPeriod&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。