更新时间:2024-02-06 GMT+08:00
分享

更新EIP

功能介绍

更新EIP,将EIP跟一个网卡绑定或者解绑定,转换IP地址版本类型。

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/publicips/{publicip_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

publicip_id

String

EIP唯一标识

最大长度:36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip

UpdatePublicipOption object

EIP对象

表3 UpdatePublicipOption

参数

是否必选

参数类型

描述

port_id

String

  • 功能说明:端口id

  • 约束:

    • 必须是存在的端口id,如果不带该参数或者值为空时为解除绑定EIP,如果该端口不存在或端口已绑定EIP则会提示出错。

    • 和ip_version字段互斥,不能同时更新。

    • 如果alias和port_id都携带,只有alias生效。

最大长度:36

ip_version

Integer

  • 功能说明:IP版本信息

  • 取值范围:4和6,IPv6为开启NAT64能力

    • 4:IPv4

    • 6:IPv6

  • 约束:

    • 必须是系统支持的IP版本类型

    • 和port_id互斥,不能同时更新。

枚举值:

  • 4

  • 6

alias

String

  • 功能说明:弹性公网IP名称

  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

  • 约束:如果alias和port_id都携带,只有alias生效。

最大长度:64

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

publicip

PublicipUpdateResp object

更新弹性公网IP的返回对象

表5 PublicipUpdateResp

参数

参数类型

描述

bandwidth_id

String

  • 功能说明:EIPIP对应带宽ID

最大长度:36

bandwidth_name

String

  • 功能说明:带宽名称

最小长度:1

最大长度:64

bandwidth_share_type

String

  • 功能说明:EIP的带宽类型

  • 取值范围:PER,WHOLE。

    • WHOLE表示共享带宽

    • PER表示独享带宽

  • 约束:其中IPv6暂不支持WHOLE类型带宽。

枚举值:

  • WHOLE

  • PER

bandwidth_size

Integer

  • 功能说明:带宽大小,单位为Mbit/s。

最小值:0

create_time

String

  • 功能说明:EIP申请时间(UTC)

enterprise_project_id

String

  • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

  • 创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

  • 不指定该参数时,默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

最大长度:36

id

String

  • 功能说明:EIP唯一标识

最大长度:36

port_id

String

  • 功能说明:端口id。

  • 约束:只有绑定了的EIP查询才会返回该参数

最大长度:36

private_ip_address

String

  • 功能说明:绑定EIP的私有IP地址

  • 约束:只有绑定了的EIP查询才会返回该参数

profile

ProfileResp object

  • 功能说明:额外参数,包括订单id、产品id等信息

  • 约束:如果profile不为空,说明是包周期的EIP

public_ip_address

String

  • 功能说明:IPv4时是申请到的EIP地址,IPv6时是IPv6地址对应的IPv4地址

最大长度:15

status

String

  • 功能说明:EIP的状态

  • 取值范围:

    • FREEZED:冻结

    • BIND_ERROR:绑定失败

    • BINDING:绑定中

    • PENDING_DELETE:释放中

    • PENDING_CREATE:创建中

    • NOTIFYING:创建中

    • NOTIFY_DELETE:释放中

    • PENDING_UPDATE:更新中

    • DOWN:未绑定

    • ACTIVE:绑定

    • ELB:绑定ELB

    • VPN:绑定VPN

    • ERROR:失败

枚举值:

  • FREEZED

  • BIND_ERROR

  • BINDING

  • PENDING_DELETE

  • PENDING_CREATE

  • NOTIFYING

  • NOTIFY_DELETE

  • PENDING_UPDATE

  • DOWN

  • ACTIVE

  • ELB

  • VPN

  • ERROR

tenant_id

String

  • 功能说明:项目ID

最大长度:36

type

String

  • 功能说明:EIP的类型

  • 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP),5_youxuanbgp(优选BGP)

    • 华南-广州:5_bgp、5_sbgp

    • 华东-上海一:5_bgp、5_sbgp

    • 华东-上海二:5_bgp、5_sbgp

    • 华北-北京一:5_bgp、5_sbgp

    • 中国-香港:5_bgp、5_youxuanbgp

    • 亚太-曼谷:5_bgp

    • 亚太-新加坡:5_bgp

    • 非洲-约翰内斯堡:5_bgp

    • 西南-贵阳一:5_sbgp

    • 华北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亚哥:5_bgp

    • 拉美-圣保罗一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜诺斯艾利一:5_bgp

    • 拉美-利马一:5_bgp

    • 拉美-圣地亚哥二: 5_bgp

  • 约束:

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口,所以"type"字段未给定时,默认为5_bgp。

最大长度:36

public_ipv6_address

String

  • 功能说明:IPv4时无此字段,IPv6时为申请到的EIP地址

最大长度:39

ip_version

Integer

  • 功能说明:IP版本信息

  • 取值范围是4和6,IPV6为开启NAT64能力

    • 4:IPv4

    • 6:IPv6

枚举值:

  • 4

  • 6

alias

String

  • 功能说明:弹性公网IP名称

  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最大长度:64

表6 ProfileResp

参数

参数类型

描述

order_id

String

订单的id

最大长度:36

product_id

String

产品的id

最大长度:36

region_id

String

region的id

最大长度:36

user_id

String

用户的id

最大长度:36

请求示例

  • 绑定id为f588ccfa-8750-4d7c-bf5d-2ede24414706的实例。

    {
      "publicip" : {
        "port_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706"
      }
    }
  • 将EIP的ip_version更新为ipv6。

    {
      "publicip" : {
        "ip_version" : 6
      }
    }

响应示例

状态码: 200

GET和PUT操作正常返回

{
  "publicip" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_size" : 6,
    "public_ip_address" : "161.xx.xx.7",
    "create_time" : "2015-07-16 04:10:52",
    "ip_version" : 4,
    "port_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "type" : "5_bgp",
    "status" : "PENDING_UPDATE"
  }
}

SDK代码示例

SDK代码示例如下。

  • 绑定id为f588ccfa-8750-4d7c-bf5d-2ede24414706的实例。

     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.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.*;
    
    
    public class UpdatePublicipSolution {
    
        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();
            UpdatePublicipRequest request = new UpdatePublicipRequest();
            UpdatePublicipsRequestBody body = new UpdatePublicipsRequestBody();
            UpdatePublicipOption publicipbody = new UpdatePublicipOption();
            publicipbody.withPortId("f588ccfa-8750-4d7c-bf5d-2ede24414706");
            body.withPublicip(publicipbody);
            request.withBody(body);
            try {
                UpdatePublicipResponse response = client.updatePublicip(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());
            }
        }
    }
    
  • 将EIP的ip_version更新为ipv6。

     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.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.*;
    
    
    public class UpdatePublicipSolution {
    
        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();
            UpdatePublicipRequest request = new UpdatePublicipRequest();
            UpdatePublicipsRequestBody body = new UpdatePublicipsRequestBody();
            UpdatePublicipOption publicipbody = new UpdatePublicipOption();
            publicipbody.withIpVersion(UpdatePublicipOption.IpVersionEnum.NUMBER_6);
            body.withPublicip(publicipbody);
            request.withBody(body);
            try {
                UpdatePublicipResponse response = client.updatePublicip(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为f588ccfa-8750-4d7c-bf5d-2ede24414706的实例。

     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
    
    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 = UpdatePublicipRequest()
            publicipbody = UpdatePublicipOption(
                port_id="f588ccfa-8750-4d7c-bf5d-2ede24414706"
            )
            request.body = UpdatePublicipsRequestBody(
                publicip=publicipbody
            )
            response = client.update_publicip(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 将EIP的ip_version更新为ipv6。

     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
    
    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 = UpdatePublicipRequest()
            publicipbody = UpdatePublicipOption(
                ip_version=6
            )
            request.body = UpdatePublicipsRequestBody(
                publicip=publicipbody
            )
            response = client.update_publicip(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为f588ccfa-8750-4d7c-bf5d-2ede24414706的实例。

     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
    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.UpdatePublicipRequest{}
    	portIdPublicip:= "f588ccfa-8750-4d7c-bf5d-2ede24414706"
    	publicipbody := &model.UpdatePublicipOption{
    		PortId: &portIdPublicip,
    	}
    	request.Body = &model.UpdatePublicipsRequestBody{
    		Publicip: publicipbody,
    	}
    	response, err := client.UpdatePublicip(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 将EIP的ip_version更新为ipv6。

     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
    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.UpdatePublicipRequest{}
    	ipVersionPublicip:= model.GetUpdatePublicipOptionIpVersionEnum().E_6
    	publicipbody := &model.UpdatePublicipOption{
    		IpVersion: &ipVersionPublicip,
    	}
    	request.Body = &model.UpdatePublicipsRequestBody{
    		Publicip: publicipbody,
    	}
    	response, err := client.UpdatePublicip(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

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

状态码

状态码

描述

200

GET和PUT操作正常返回

错误码

请参见错误码

分享:

    相关文档

    相关产品