Adding EIPs to a Shared Bandwidth in Batches

project_id

Yes

String

Project ID.

Minimum length: 32

Maximum length: 32

publicips

Yes

Array of BatchAttachSharebwDict objects

• Definition: EIPs in a shared bandwidth.

• Constraints: If multiple EIPs are added to a shared bandwidth, the value of bandwidth_id of these EIPs must be the same.

Array length: 1 to 50

bandwidth_id

Yes

String

• Definition: Shared bandwidth ID.

Minimum length: 36

Maximum length: 36

publicip_id

Yes

String

• Definition: EIP ID.

Minimum length: 36

Maximum length: 36

publicips

Array of BatchPublicipResp objects

EIPs.

request_id

String

Request ID.

statusCode

Integer

Status code

publicip

PublicipResp object

EIP.

id

String

• Definition: EIP ID, which uniquely identifies the EIP.

project_id

String

• Definition: Project ID.

ip_version

Integer

• Definition: EIP version.

• Range: The value can be 4 or 6. 6 indicates that the NAT64 capability is enabled.

  • 4: IPv4 EIP

  • 6: IPv6 EIP

public_ip_address

String

• Definition: IPv4 EIP.

public_ipv6_address

String

• Definition: IPv6 EIP.

status

String

• Definition: EIP status

• Range: The value can be FREEZED, DOWN, ACTIVE, or ERROR.

  • FREEZED: The EIP is frozen.

  • DOWN: The EIP is not bound to any instance.

  • ACTIVE: The EIP is bound to an instance and is in use.

  • ERROR: The EIP status is abnormal.

description

String

• Definition: Supplementary information about the EIP

• Constraints: You can customize this value to identify your EIP, which is not perceived by the system.

created_at

String

• Definition: Time when an EIP was assigned.

• Constraints: The value is in UTC format, for example, 2018-12-25T10:07:24Z.

updated_at

String

• Definition: Time when an EIP was last updated.

• Constraints: The value is in UTC format, for example, 2018-12-25T10:09:20Z.

type

String

• Definition: EIP type.

• Range: The value can be EIP or DUALSTACK.

vnic

VnicResp object

• Definition: Port information of the instance that an EIP is bound to

• Constraints: If the instance has no port, the value is null.

bandwidth

BandwidthResp object

• Definition: Bandwidth of the EIP.

enterprise_project_id

String

• Definition: Enterprise project ID of the EIP.

billing_info

String

• Definition: Order information of an EIP.

• Constraints: Order information is available only for yearly/monthly resources. This parameter is left empty for pay-per-use resources.

lock_status

String

• Definition: Frozen status of an EIP.

• Constraints: The metadata type indicates that the EIP is frozen due to arrears or security reasons.

associate_instance_type

String

• Definition: Type of the instance that an EIP is bound to.

• Range:

  • PORT (Instance type, including ECS, BMS, and CCE)

  • NATGW (NAT gateway type)

  • ELB (Load balancer type)

  • VPN (VPN instance type)

associate_instance_id

String

• Definition: ID of the instance that an EIP is bound to.

publicip_pool_id

String

• Definition: ID of the network that an EIP belongs to. It is the network ID corresponding to publicip_pool_name.

publicip_pool_name

String

• Definition: Network type of an EIP,

including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool. For details about the dedicated EIP pool, see the APIs about publcip_pool.

alias

String

• Definition: EIP alias.

public_border_group

String

• Definition: Whether it is a central or an edge EIP. The value is CENTER for a central EIP and an edge AZ name for an edge EIP.

private_ip_address

String

• Definition: Private IP address of a port.

device_id

String

• Definition: ID of the device that the port belongs to. The device ID indicates the ID of the cloud service resource that uses the private IP address in the subnet, for example, the cloud server ID or load balancer ID.

• Constraints: If there is a port, the value of this parameter is the same as that of associate_instance_id.

device_owner

String

• Definition: Device that the port belongs to, that is, a cloud service resource that uses a private IP address in the subnet.

• Constraints: If there is a port, this parameter and associate_instance_type can be used to identify the instance type.

vtep

String

• Definition: VTEP IP address.

vni

String

• Definition: VXLAN ID.

vpc_id

String

• Definition: ID of the VPC that the port belongs to.

port_id

String

• Definition: Port ID, which uniquely identifies a port.

port_profile

String

• Definition: Port profile.

mac

String

• Definition: MAC address of a port.

instance_id

String

• Definition: User of a port, which is different from the owner of device_id. For example, the device_owner of a virtual IP address port is a virtual IP address, but the actual user of the port may be a VM or others.

instance_type

String

• Definition: Instance type. This parameter is used together with instance_id.

port_vif_details

String

• Definition: Details about the virtual interface of the network interface

id

String

• Definition: Bandwidth ID.

size

Integer

• Definition: Bandwidth size.

share_type

String

• Definition: Bandwidth type.

WHOLE indicates a shared bandwidth, and PER indicates a dedicated bandwidth.

charge_mode

String

• Definition: Bandwidth billing mode.

name

String

• Definition: Bandwidth name

billing_info

String

• Definition: Bandwidth order information.

200

Normal response to POST requests