Removing an EIP from a Shared Bandwidth

Function

This API is used to remove an EIP from a shared bandwidth.

URI

POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove

Request Message

• Request parameter

  Table 2 Request header parameter

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

  Table 3 Request parameter

  Name	Mandatory	Type	Description
  bandwidth	Yes	bandwidth object	Specifies the bandwidth objects. For details, see Table 4.

  Table 4 Description of the bandwidth field

  Name	Mandatory	Type	Description
  publicip_info	Yes	Array of publicip_info objects	Specifies information about the EIP to be removed from the bandwidth. For details, see Table 5. The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The number of EIPs varies depending on the tenant quota. By default, a shared bandwidth can be used by up to 20 EIPs.
  charge_mode	Yes	String	After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth. Specifies whether the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth is billed by traffic or by bandwidth. The value can be bandwidth or traffic.
  size	Yes	Integer	After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth. Specifies the size (Mbit/s) of the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth. The value ranges from 1 Mbit/s to 300 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)

  Table 5 publicip_info object

  Name	Mandatory	Type	Description
  publicip_id	Yes	String	Specifies the ID of the EIP that uses the bandwidth.
  publicip_type	No	String	If the publicip_id value is the EIP ID, this parameter will be ignored. If publicip_id is the ID of the IPv6 port, this parameter must be set to 5_dualStack. This only applies to the CN North-Beijing4 region.

• Example request

  POST https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/remove
  
  {
      "bandwidth": {
          "publicip_info": [
              {
                  "publicip_id": "d91b0028-6f6b-4478-808a-297b75b6812a"
   
              },
              {
                  "publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
              }
          ],
          "charge_mode": "traffic",
          "size": 22
      }
  }

Response Message

• Response parameter

  None

• Example response

  None

  Or

  {
         "code":"xxx",
         "message":"xxxxx"
  }

Status Code

See Status Codes.

Error Code

See Error Codes.