文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 弹性公网IP/ 更新弹性公网IP - UpdatePublicip

更新时间：2025-12-31 GMT+08:00

在线调试

CLI示例

查看PDF

更新弹性公网IP - UpdatePublicip

功能介绍

更新弹性公网IP。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

PUT /v3/{project_id}/eip/publicips/{publicip_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取项目ID请参见获取项目ID 最大长度：32
publicip_id	是	String	弹性公网IP的ID 最小长度：36 最大长度：36

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
publicip	是	UpdatePublicipOption object	弹性公网IP对象

表3 UpdatePublicipOption
参数	是否必选	参数类型	描述
alias	否	String	功能说明：公网IP的名称。最小长度：0 最大长度：64
description	否	String	功能说明：公网IP的描述信息取值范围：0-255长度的字符串，不支持特殊字符<> 最小长度：0 最大长度：255
associate_instance_type	否	String	功能说明：EIP绑定的实例类型取值范围： PORT（云服务器实例类型，云服务器通常包括ECS、BMS、CCE等） NATGW（NAT网关实例类型） ELB（弹性负载均衡ELB实例类型） ELBV1（弹性负载均衡ELBV1实例类型） VPN（虚拟专用网络VPN实例类型）约束与限制： associate_instance_type和associate_instance_id都不为空时表示绑定实例 associate_instance_type和associate_instance_id都为null时表示解绑实例，通过APIE调用需要切换为文本输入方式输入null值，可参考解绑请求实例双栈公网IP不允许修改绑定的实例最小长度：0 最大长度：36
associate_instance_id	否	String	功能说明：绑定的实例ID，例如ELB的实例ID，ECS的网卡ID 约束与限制： associate_instance_type和associate_instance_id都不为空时表示绑定实例 associate_instance_type和associate_instance_id都为null时表示解绑实例，通过APIE调用需要切换为文本输入方式输入null值，可参考解绑请求实例双栈公网IP不允许修改绑定的实例最小长度：0 最大长度：36

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
request_id	String	本次请求的编号
publicip	PublicipUpdateResp object	更新弹性公网IP的返回对象

表5 PublicipUpdateResp
参数	参数类型	描述
id	String	功能说明：弹性公网IP唯一标识
project_id	String	功能说明：项目ID
ip_version	Integer	功能说明：IP版本信息取值范围： 4：公网IP地址为public_ip_address地址 6：公网IP地址为public_ipv6_address地址
public_ip_address	String	功能说明：弹性公网IP或者IPv6端口的地址
public_ipv6_address	String	功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址
status	String	功能说明：弹性公网IP的状态取值范围： FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 NOTIFYING：创建中 NOTIFY_DELETE：释放中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB VPN：绑定VPN ERROR：失败
description	String	功能说明：弹性公网IP描述信息约束与限制：用户以自定义方式标识资源，系统不感知
public_border_group	String	功能说明：表示中心站点资源或者边缘站点资源取值范围： center、边缘站点名称约束与限制：publicip只能绑定该字段相同的资源
created_at	String	功能说明：资源创建UTC时间格式：yyyy-MM-ddTHH:mm:ssZ
updated_at	String	功能说明：资源更新UTC时间格式：yyyy-MM-ddTHH:mm:ssZ
type	String	功能说明：弹性公网IP类型
vnic	VnicInfo object	功能说明：公网IP绑定实例有PORT时，PORT的相关信息约束与限制：如果绑定的实例不依赖PORT，该对象为null
bandwidth	PublicipBandwidthInfo object	功能说明：公网IP绑定带宽信息
enterprise_project_id	String	功能说明：企业项目ID。最大长度36字节,带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID
billing_info	String	功能说明：公网IP的订单信息约束与限制：包周期才会有订单信息，按需资源此字段为空
lock_status	String	功能说明：记录公网IP当前的冻结状态约束与限制：metadata类型，标识欠费冻结、公安冻结取值范围： police locked
associate_instance_type	String	功能说明：公网IP绑定的实例类型取值范围： PORT（云服务器实例类型，云服务器通常包括ECS、BMS、CCE等） NATGW（NAT网关实例类型） ELB（弹性负载均衡ELB实例类型） VPN（虚拟专用网络VPN实例类型）
associate_instance_id	String	功能说明：公网IP绑定的实例ID
publicip_pool_id	String	功能说明：公网IP所属网络的ID。publicip_pool_name对应的网络ID
publicip_pool_name	String	功能说明：弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户购买的专属池。专属池见publcip_pool相关接口
alias	String	功能说明：弹性公网IP名称
associate_mode	String	功能说明：开启支持直通模式后展示，表示直通模式的标识。（默认不显示）

表6 VnicInfo
参数	参数类型	描述
private_ip_address	String	功能说明：私网IP地址
device_id	String	功能说明：端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。约束与限制：不支持设置和更新，由系统自动维护
device_owner	String	功能说明：端口所属的设备，表示使用子网内私有IP地址的云服务资源。取值范围：合法设备所属 network:dhcp（表示DHCP服务） network:VIP_PORT（表示创建的是虚拟IP） network:router_interface_distributed（表示子网网关地址） network:router_centralized_snat（表示SNAT网关地址）约束与限制：不支持设置和更新，由系统自动维护
vpc_id	String	功能说明：虚拟私有云ID
port_id	String	功能说明：端口ID
port_profile	String	功能说明：端口profile信息
mac	String	功能说明：端口MAC地址约束与限制：由系统分配，不支持指定
vtep	String	功能说明：VTEP IP
vni	String	功能说明：VXLAN ID
instance_id	String	功能说明：端口所属实例ID，例如RDS实例ID 约束与限制：不支持设置和更新，由系统自动维护
instance_type	String	功能说明：端口所属实例类型，例如“RDS” 约束与限制：不支持设置和更新，由系统自动维护
port_vif_details	String	功能说明：网卡虚拟接口的详细信息

表7 PublicipBandwidthInfo
参数	参数类型	描述
id	String	功能描述：带宽ID
size	Integer	功能描述：带宽大小取值范围：默认5Mbit/s~2000Mbit/s
share_type	String	功能说明：带宽类型，标识是否是共享带宽取值范围： PER：独享带宽 WHOLE：共享带宽约束与限制：其中IPv6暂不支持WHOLE类型带宽。
charge_mode	String	功能说明：按流量计费还是按带宽计费取值范围： bandwidth：按带宽计费 traffic：按流量计费 95peak_plus：按增强型95计费
name	String	功能说明：带宽名称取值范围：1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点）
billing_info	String	功能说明：账单信息。如果billinginfo不为空，说明是包周期的带宽

请求示例

更新弹性公网IP别名及描述示例

{
  "publicip" : {
    "alias" : "abcd",
    "description" : "test!!!!"
  }
}

弹性公网IP解绑实例请求示例

{
  "publicip" : {
    "associate_instance_type" : null,
    "associate_instance_id" : null
  }
}

响应示例

状态码：200

PUT操作正常返回

{
  "publicip" : {
    "alias" : "abcd",
    "associate_instance_id" : null,
    "associate_instance_type" : null,
    "bandwidth" : {
      "billing_info" : "xxxx:xxxx:xxxx",
      "charge_mode" : "bandwidth",
      "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4",
      "name" : "bandwidth-bd25-test",
      "share_type" : "WHOLE",
      "size" : 7
    },
    "billing_info" : null,
    "created_at" : "2020-06-18T14:05:32Z",
    "description" : "test!!!!",
    "enterprise_project_id" : "0",
    "public_border_group" : "center",
    "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7",
    "ip_version" : 4,
    "lock_status" : null,
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "public_ip_address" : "xx.xx.xx.xx",
    "public_ipv6_address" : null,
    "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148",
    "publicip_pool_name" : "5_mobile",
    "status" : "DOWN",
    "type" : "弹性公网IP",
    "updated_at" : "2020-06-18T14:05:32Z",
    "vnic" : null
  },
  "request_id" : "ead9f912bd1191e3d5f0037141098d91"
}

SDK代码示例

SDK代码示例如下。

更新弹性公网IP别名及描述示例

        
         
           
           
             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.v3.region.EipRegion;
import com.huaweicloud.sdk.eip.v3.*;
import com.huaweicloud.sdk.eip.v3.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");
        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();
        UpdatePublicipRequest request = new UpdatePublicipRequest();
        request.withPublicipId("{publicip_id}");
        UpdatePublicipsRequestBody body = new UpdatePublicipsRequestBody();
        UpdatePublicipOption publicipbody = new UpdatePublicipOption();
        publicipbody.withAlias("abcd")
            .withDescription("test!!!!");
        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());
        }
    }
}

            

          

        
       

弹性公网IP解绑实例请求示例

        
         
           
           
             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.v3.region.EipRegion;
import com.huaweicloud.sdk.eip.v3.*;
import com.huaweicloud.sdk.eip.v3.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");
        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();
        UpdatePublicipRequest request = new UpdatePublicipRequest();
        request.withPublicipId("{publicip_id}");
        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());
        }
    }
}

            

          

        
       

更新弹性公网IP别名及描述示例

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.v3 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 = UpdatePublicipRequest()
        request.publicip_id = "{publicip_id}"
        publicipbody = UpdatePublicipOption(
            alias="abcd",
            description="test!!!!"
        )
        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)

            

          

        
       

弹性公网IP解绑实例请求示例

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.v3 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 = UpdatePublicipRequest()
        request.publicip_id = "{publicip_id}"
        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)

            

          

        
       

更新弹性公网IP别名及描述示例

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/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.UpdatePublicipRequest{}
	request.PublicipId = "{publicip_id}"
	aliasPublicip:= "abcd"
	descriptionPublicip:= "test!!!!"
	publicipbody := &model.UpdatePublicipOption{
		Alias: &aliasPublicip,
		Description: &descriptionPublicip,
	}
	request.Body = &model.UpdatePublicipsRequestBody{
		Publicip: publicipbody,
	}
	response, err := client.UpdatePublicip(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

弹性公网IP解绑实例请求示例

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/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.UpdatePublicipRequest{}
	request.PublicipId = "{publicip_id}"
	response, err := client.UpdatePublicip(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

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

状态码

状态码	描述
200	PUT操作正常返回

错误码

请参见错误码。

父主题：弹性公网IP

上一篇：查询弹性公网IP详情 - ShowPublicip

下一篇：解绑弹性公网IP - DisassociatePublicips

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

更新弹性公网IP - UpdatePublicip

功能介绍

调试

授权信息

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？