Function

This API is used to assign multiple shared bandwidths at a time.

URI

POST /v2.0/{project_id}/batch-bandwidths

Request Message

• Request parameter

  Table 2 Request parameter

  Name	Mandatory	Type	Description
  bandwidth	Yes	Object	Specifies the bandwidth objects. For details, see Table 3.

  Table 3 Description of the bandwidth field

  Name	Mandatory	Type	Description
  name	Yes	String	Specifies the bandwidth name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).
  size	Yes	Integer	Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s. The value ranges from 5 Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included). The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
  count	Yes	Integer	Specifies the number of shared bandwidths that can be assigned at a time. The value is a positive integer. If a decimal fraction (for example 2.2) or a character string (for example "2") is specified, the specified value will be automatically converted to an integer.

Response Message

• Response parameter

  Table 4 Response parameter

  Name	Type	Description
  bandwidths	List. The elements in the list are dictionaries.	Specifies the bandwidth objects. For details, see Table 5.

  Table 5 Description of the bandwidth field

  Name	Type	Description
  name	String	Specifies the bandwidth name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).
  size	Integer	Specifies the bandwidth size. The value ranges from 5 Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.)
  id	String	Specifies the bandwidth ID, which uniquely identifies the bandwidth.
  share_type	String	Specifies whether the bandwidth is shared or dedicated. The value can be PER or WHOLE. WHOLE: Shared bandwidth PER: Dedicated bandwidth
  publicip_info	Array of publicip_info objects	Specifies information about the EIP that uses the bandwidth. For details, see Table 6. The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The bandwidth, whose type is PER, can be used by only one EIP.
  tenant_id	String	Specifies the project ID.
  bandwidth_type	String	Specifies the bandwidth type. The default value for the shared bandwidth is share. The value can be share, bgp, telcom, or sbgp. share: Shared bandwidth bgp: Dynamic BGP telcom: China Unicom sbgp: Static BGP
  charge_mode	String	Specifies whether the bandwidth is billed by traffic or by bandwidth size. Possible values can be bandwidth (billed by bandwidth) and traffic (billed by traffic). If the value is an empty character string or no value is specified, value bandwidth is used. The shared bandwidth can be billed only by bandwidth.
  billing_info	String	Specifies the bill information. If billing_info is specified, the bandwidth is in yearly/monthly billing mode.
  status	String	Specifies the bandwidth status. Possible values are as follows: FREEZED (Frozen) NORMAL (Normal)

  Table 6 publicip_info object

  Name	Type	Description
  publicip_id	String	Specifies the ID of the EIP or IPv6 port that uses the bandwidth.
  publicip_address	String	Specifies the obtained EIP if only IPv4 EIPs are available. Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available.
  publicipv6_address	String	Specifies the obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available.
  ip_version	Integer	Specifies the IP address version. Possible values are as follows: 4: IPv4 address 6: IPv6 address
  publicip_type	String	Specifies the EIP type. Possible values are 5_telcom (China Telecom), 5_union (China Unicom), 5_bgp (dynamic BGP), and 5_sbgp (static BGP). CN Northeast-Dalian: 5_telcom and 5_union CN South-Guangzhou: 5_bgp and 5_sbgp CN East-Shanghai1: 5_bgp and 5_sbgp CN East-Shanghai2: 5_bgp and 5_sbgp CN North-Beijing1: 5_bgp and 5_sbgp AP-Hong Kong: 5_bgp AP-Bangkok: 5_bgp AP-Singapore: 5_bgp AF-Johannesburg: 5_bgp CN Southwest-Guiyang1: 5_sbgp CN North-Beijing4: 5_bgp and 5_sbgp LA-Santiago: 5_bgp LA-Sao Paulo1: 5_bgp LA-Mexico City1: 5_bgp LA-Buenos Aires1: 5_bgp LA-Lima1: 5_bgp LA-Santiago2: 5_bgp The configured value must be supported by the system.

• Example response

  {
    "bandwidths": [
      {
        "id": "7e5a1a30-6e88-4ce5-b5fa-1d6c6864e084",
        "name": "bandwidth123",
        "size": 10,
        "share_type": "WHOLE",
        "publicip_info": [],
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "bandwidth_type": "share",
        "charge_mode": "bandwidth",
        "billing_info": "",
        "status": "NORMAL"
      },
      {
        "id": "ed2da50a-3ce9-4d86-9f17-e8f3801299a5",
        "name": "bandwidth123",
        "size": 10,
        "share_type": "WHOLE",
        "publicip_info": [],
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "bandwidth_type": "share",
        "charge_mode": "bandwidth",
        "billing_info": "",
        "status": "NORMAL"
      }
    ]
  }

Status Code

See Status Codes.

Error Code

See Error Codes.