doc-exports/docs/vpc/api-ref/AttachBatchPublicIp.html

Adding EIPs to a Shared Bandwidth in Batches

Function

This API is used to add multiple EIPs to a shared bandwidth.

URI

POST /v3/{project_id}/eip/publicips/attach-share-bandwidth

Table 1 Path parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum length: 32 Maximum length: 32

Request Parameters

Table 2 Request body parameters

Parameter	Mandatory	Type	Description
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

Table 3 BatchAttachSharebwDict

Parameter	Mandatory	Type	Description
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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
publicips	Array of BatchPublicipResp objects	EIPs.
request_id	String	Request ID.

Table 5 BatchPublicipResp

Parameter	Type	Description
statusCode	Integer	Status code
publicip	PublicipResp object	EIP.

Table 6 PublicipResp

Parameter	Type	Description
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.

Table 7 VnicResp

Parameter	Type	Description
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

Table 8 BandwidthResp

Parameter	Type	Description
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.

Example Request

If multiple EIPs are added to the same shared bandwidth, the bandwidth ID of these EIPs must be the same.

POST /v3/{project_id}/eip/publicips/attach-share-bandwidth

{
  "publicips" : [ {
    "bandwidth_id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
    "publicip_id" : "99c8a2df-9e90-48df-9132-e2216e659459"
  }, {
    "bandwidth_id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
    "publicip_id" : "7b484d78-550a-4e92-8363-a34b5194ddcb"
  } ]
}

Example Response

Status code: 200

Normal response to POST requests

{
  "publicips" : [ {
    "statusCode" : 200,
    "publicip" : {
      "alias" : "test",
      "associate_instance_id" : null,
      "associate_instance_type" : null,
      "bandwidth" : {
        "id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
        "size" : 5,
        "share_type" : "WHOLE",
        "charge_mode" : "traffic",
        "name" : "bandwidth-b8ff",
        "billing_info" : ""
      },
      "billing_info" : null,
      "created_at" : "2020-07-10T10:10:18Z",
      "description" : "",
      "enterprise_project_id" : "0",
      "id" : "99c8a2df-9e90-48df-9132-e2216e659459",
      "ip_version" : 4,
      "lock_status" : null,
      "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
      "public_border_group" : "center",
      "public_ip_address" : "10.246.165.44",
      "public_ipv6_address" : null,
      "publicip_pool_id" : "ece62314-858c-4793-a768-346efca42131",
      "publicip_pool_name" : "5_bgp",
      "status" : "ACTIVE",
      "type" : "EIP",
      "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}"
      }
    }
  }, {
    "statusCode" : 200,
    "publicip" : {
      "alias" : "test",
      "associate_instance_id" : null,
      "associate_instance_type" : null,
      "bandwidth" : {
        "id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
        "size" : 5,
        "share_type" : "WHOLE",
        "charge_mode" : "traffic",
        "name" : "bandwidth-b8ff",
        "billing_info" : ""
      },
      "billing_info" : null,
      "created_at" : "2020-07-10T10:10:18Z",
      "description" : "",
      "enterprise_project_id" : "0",
      "id" : "7b484d78-550a-4e92-8363-a34b5194ddcb",
      "ip_version" : 4,
      "lock_status" : null,
      "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
      "public_border_group" : "center",
      "public_ip_address" : "10.246.165.45",
      "public_ipv6_address" : null,
      "publicip_pool_id" : "ece62314-858c-4793-a768-346efca42131",
      "publicip_pool_name" : "5_bgp",
      "status" : "ACTIVE",
      "type" : "EIP",
      "updated_at" : "2020-07-11T05:03:25Z",
      "vnic" : {
        "device_id" : "cc03e7f7-b820-4a2e-b243-8022daabf0dd",
        "device_owner" : "compute:br-iaas-odin1a",
        "instance_id" : "",
        "instance_type" : "",
        "mac" : "fa:16:3e:7a:5f:cc",
        "port_id" : "fb68a8e1-b93e-4100-8735-6d6b0a6a0eb6",
        "port_profile" : "",
        "private_ip_address" : "192.168.3.221",
        "vni" : "435405",
        "vpc_id" : "ac17491b-0769-4d96-b883-6d6295f6afad",
        "vtep" : "18.8.152.158",
        "port_vif_details" : "{\"primary_interface\": true}"
      }
    }
  } ],
  "request_id" : "db4b975a79d1da86dda3d02054f11e16"
}

Status Codes

Status Code	Description
200	Normal response to POST requests

Error Codes

See Error Codes.

Parent topic: EIPs