# 共享带宽移出弹性公网IP - DetachShareBandwidth #### 功能介绍 共享带宽移出弹性公网IP，当前接口仅支持移出单个弹性公网IP。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=DetachShareBandwidth&version=v3)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:publicIps:detachBandwidth | Write | publicip \* | - g:EnterpriseProjectId - g:ResourceTag/\ | vpc:publicIps:update | - | | eip:publicIps:detachBandwidth | Write | bandwidth \* | - g:EnterpriseProjectId - g:ResourceTag/\ | vpc:publicIps:update | - | #### URI POST /v3/{project_id}/eip/publicips/{publicip_id}/detach-share-bandwidth 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 最小长度：**32** 最大长度：**32** | | publicip_id | 是 | String | 弹性公网ID 最小长度：**36** 最大长度：**36** | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | publicip | 是 | [publicip] object | 共享带宽移出弹性公网IP请求对象 数组长度：**0 - 2000** | 表3publicip | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bandwidth | 否 | [DetachSharedbwDict] object | 功能说明：弹性公网IP移出共享带宽后带宽的参数 | 表4DetachSharedbwDict | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 功能说明：弹性公网IP移出共享带宽后的带宽名称 最小长度：**1** 最大长度：**64** | | size | 是 | Integer | 功能说明：弹性公网IP移出共享带宽后的带宽大小 最小值：**1** 最大值：**2000** | | charge_mode | 是 | String | 功能说明：弹性公网IP移出共享带宽后的带宽计费模式 最小长度：**1** 最大长度：**36** | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip | [PublicipResp] object | 弹性公网IP对象 | | request_id | String | 本次请求编号 | 表6PublicipResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：弹性公网IP的唯一标识 | | project_id | String | - 功能说明：项目ID | | ip_version | Integer | - 功能说明: 弹性公网IP版本号 - 取值范围: 4、6，6为开启NAT64能力 - 4表示公网IP地址为public_ip_address地址 - 6表示公网IP地址为public_ipv6_address地址 | | public_ip_address | String | - 功能说明: 弹性公网IPv4地址 | | public_ipv6_address | String | - 功能说明: 弹性公网IPv6地址 | | status | String | - 功能说明：弹性公网IP的状态 - 取值范围：FREEZED，DOWN，ACTIVE，ERROR。 - FREEZED表示弹性公网IP处于冻结状态 - DOWN表示弹性公网IP未绑定实例 - ACTIVE表示弹性公网IP绑定实例，正在使用中 - ERROR表示弹性公网IP状态异常 | | description | String | - 功能说明：弹性公网IP的描述信息 - 约束与限制：用户以自定义方式标识资源，系统不感知 | | created_at | String | - 功能说明：弹性公网IP的创建时间 - 约束与限制：UTC时间格式（2018-12-25T10:07:24Z） | | updated_at | String | - 功能说明：弹性公网IP最近的更新时间 - 约束与限制：UTC时间格式（2018-12-25T10:09:20Z） | | type | String | - 参数解释：弹性公网IP类型。 - 约束限制：不涉及 - 取值范围： - EIP：IPV4类型的弹性公网IP。 - DUALSTACK：IPV6类型的弹性公网IP。 - 默认取值：不涉及 | | vnic | [VnicResp] object | - 功能说明：弹性公网IP绑定实例有PORT时，PORT的相关信息 - 约束与限制：如果绑定的实例不依赖PORT，该对象为null | | bandwidth | [BandwidthResp] object | - 功能说明：弹性公网IP绑定的带宽信息 | | enterprise_project_id | String | - 功能说明：弹性公网IP的企业项目ID | | billing_info | String | - 功能说明：弹性公网IP的订单信息 - 约束与限制：包周期才会有订单信息，按需资源此字段为空 | | lock_status | String | - 参数解释：弹性公网IP当前的冻结状态。 - 约束限制：metadata类型 - 取值范围： - POLICE：公安冻结。 - LOCKED：普通冻结。 - ARREAR：普通冻结中的欠费冻结。 - DELABLE：普通冻结中的可删除冻结。 - 默认取值：不涉及 | | 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...，和用户购买的专属池。专属池见publicip_pool相关接口 | | alias | String | - 功能说明：弹性公网IP别名 | | public_border_group | String | - 功能说明：中心还是边缘。中心CENTER，边缘为各边缘区域名称 | 表7VnicResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | private_ip_address | String | - 功能说明：PORT的内网地址 | | device_id | String | - 功能说明：端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。 - 约束与限制：存在PORT时，此字段associate_instance_id相同，都为实例ID | | device_owner | String | - 功能说明：端口所属的设备，表示使用子网内私有IP地址的云服务资源。 - 约束与限制：存在PORT时，此字段和associate_instance_type都可区分实例类型 | | vtep | String | - 功能说明：VTEP IP | | vni | String | - 功能说明：VXLAN ID | | vpc_id | String | - 功能说明：PORT所在VPC的ID | | port_id | String | - 功能说明：PORT的唯一标识 | | port_profile | String | - 功能说明：端口profile信息 | | mac | String | - 功能说明：PORT的MAC信息 | | instance_id | String | - 功能说明：PORT的使用者，不同于device_id的归属者。举例：vip port的device_owner为vip，但是这个port实际使用者可能是虚机或其他 | | instance_type | String | - 功能说明：port的使用者。 - 约束限制：不涉及 - 取值范围： - PORT：弹性网卡。 - PEP_PORT：PEP弹性网卡。 - EVPN：以太网虚拟私有网络。 - NATGW：NAT网关。 - P2CVPN：P2C虚拟专用网络。 - 默认取值：不涉及 | | port_vif_details | String | - 功能说明：网卡虚拟接口的详细信息 | 表8BandwidthResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：带宽ID | | size | Integer | - 功能说明：带宽大小 | | share_type | String | - 功能说明：类型 "WHOLE"为共享带宽，"PER"为独占带宽 | | charge_mode | String | - 功能说明：带宽计费模式 | | name | String | - 功能说明：带宽名称 | | billing_info | String | - 功能说明：带宽的订单信息 | #### 请求示例 弹性公网IP移出共享带宽，弹性公网IP通过url中的publicip_id传入，移出后弹性公网IP的宽带信息通过bandwidth参数传入 ``` POST /v3/{project_id}/eip/publicips/{publicip_id}/detach-share-bandwidth { "publicip" : { "bandwidth" : { "name" : "bandwidth-test", "size" : 5, "charge_mode" : "bandwidth" } } } ``` #### 响应示例 **状态码：200** ``` { "publicip" : { "alias" : null, "associate_instance_id" : null, "associate_instance_type" : null, "bandwidth" : { "id" : "c7cd5c85-491f-4423-a691-7c74d28c4fc1", "size" : 5, "share_type" : "PER", "charge_mode" : "bandwidth", "name" : "bandwidth-test", "billing_info" : "" }, "billing_info" : null, "created_at" : "2020-07-10T10:10:18Z", "description" : "", "enterprise_project_id" : "0", "id" : "1175ec9b-852d-4769-bf33-35c5be432cfe", "ip_version" : 4, "lock_status" : null, "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee", "public_border_group" : null, "public_ip_address" : "10.246.165.44", "public_ipv6_address" : null, "publicip_pool_id" : null, "publicip_pool_name" : "5_bgp", "status" : "ACTIVE", "type" : "弹性公网IP", "updated_at" : "2020-07-11T05:03:25Z", "vnic" : { "device_id" : "cc03e7f7-b820-4a2e-b243-8022daabf0cf", "device_owner" : "compute:br-iaas-odin1a", "instance_id" : "", "instance_type" : "", "mac" : "fa:16:3e:7a:5f:db", "port_id" : "fb68a8e1-b93e-4100-8735-6d6b0a6a0eb5", "port_profile" : "", "private_ip_address" : "192.168.3.222", "vni" : "435405", "vpc_id" : "ac17491b-0769-4d96-b883-6d6295f6afad", "vtep" : "18.8.152.158", "port_vif_details" : "{\"primary_interface\": true}" } }, "request_id" : "db4b975a79d1da86dda3d02054f11e16" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 弹性公网IP移出共享带宽，弹性公网IP通过url中的publicip_id传入，移出后弹性公网IP的宽带信息通过bandwidth参数传入 ``` 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 DetachShareBandwidthSolution { 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(); DetachShareBandwidthRequest request = new DetachShareBandwidthRequest(); request.withPublicipId("{publicip_id}"); DetachSharedbwReq body = new DetachSharedbwReq(); DetachSharedbwDict bandwidthPublicip = new DetachSharedbwDict(); bandwidthPublicip.withName("bandwidth-test") .withSize(5) .withChargeMode("bandwidth"); DetachSharedbwReqPublicip publicipbody = new DetachSharedbwReqPublicip(); publicipbody.withBandwidth(bandwidthPublicip); body.withPublicip(publicipbody); request.withBody(body); try { DetachShareBandwidthResponse response = client.detachShareBandwidth(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] 弹性公网IP移出共享带宽，弹性公网IP通过url中的publicip_id传入，移出后弹性公网IP的宽带信息通过bandwidth参数传入 ``` # 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("")) \ .build() try: request = DetachShareBandwidthRequest() request.publicip_id = "{publicip_id}" bandwidthPublicip = DetachSharedbwDict( name="bandwidth-test", size=5, charge_mode="bandwidth" ) publicipbody = DetachSharedbwReqPublicip( bandwidth=bandwidthPublicip ) request.body = DetachSharedbwReq( publicip=publicipbody ) response = client.detach_share_bandwidth(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] 弹性公网IP移出共享带宽，弹性公网IP通过url中的publicip_id传入，移出后弹性公网IP的宽带信息通过bandwidth参数传入 ``` 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, 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.DetachShareBandwidthRequest{} request.PublicipId = "{publicip_id}" nameBandwidth:= "bandwidth-test" bandwidthPublicip := &model.DetachSharedbwDict{ Name: &nameBandwidth, Size: int32(5), ChargeMode: "bandwidth", } publicipbody := &model.DetachSharedbwReqPublicip{ Bandwidth: bandwidthPublicip, } request.Body = &model.DetachSharedbwReq{ Publicip: publicipbody, } response, err := client.DetachShareBandwidth(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=DetachShareBandwidth&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | POST操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。