• Elastic IP

eip
  1. Help Center
  2. Elastic IP
  3. API Reference
  4. APIs
  5. Bandwidth
  6. Updating a Bandwidth

Updating a Bandwidth

Function

This interface is used to update information about a bandwidth.

URI

PUT /v1/{project_id}/bandwidths/{bandwidth_id}
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Specifies the project ID.

bandwidth_id

Yes

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

Request Message

  • Request parameter
    Table 2 Request parameter

    Name

    Mandatory

    Type

    Description

    bandwidth

    Yes

    Dictionary data structure

    Specifies the bandwidth object.

    Table 3 Description of the bandwidth field

    Name

    Mandatory

    Type

    Description

    name

    No

    String

    • Specifies the bandwidth name.
    • The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.). If the value is left blank, the name of the bandwidth is not changed.
    • Either parameter name or size must be specified.

    size

    No

    int

    • Specifies the bandwidth size.
    • The value ranges from 1 Mbit/s to 1000 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.) If the parameter is not included, the bandwidth size is not changed.
    • Either parameter name or size must be specified.
    • If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer.
    • The minimum unit for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
      • The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).
      • The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
      • The minimum unit is 500 Mbit/s if the allowed bandwidth size is greater than 1000 Mbit/s.
  • Example request
    {
        "bandwidth":
            {"name": "bandwidth123",
             "size": 10
            }
    }

Response Message

  • Response parameter

    Name

    Type

    Description

    bandwidth

    Dictionary data structure

    Specifies the bandwidth object.

    Table 4 Description of the bandwidth field

    Name

    Type

    Description

    name

    String

    Specifies the bandwidth name.

    size

    int

    Specifies the bandwidth size.

    id

    String

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    share_type

    String

    • The value is PER, indicating that the bandwidth is dedicated.

    publicip_info

    Dictionary data structure

    • Specifies information about the EIP that uses the bandwidth.

    tenant_id

    String

    Specifies the project ID.

    bandwidth_type

    String

    Specifies the bandwidth type.

    The value is bgp.

    charge_mode

    String

    • Specifies whether the bandwidth is billed by traffic or by bandwidth size.
    • The value can be bandwidth or traffic. If the value is an empty character string or no value is specified, value bandwidth is used.
    Table 5 publicip_info object

    Name

    Type

    Description

    publicip_id

    String

    Specifies the ID of the EIP that uses the bandwidth.

    publicip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available.

    publicip_type

    String

    • Specifies the EIP type.
    • The value is 5_bgp.
  • Example response
    {
        "bandwidth": {
            "id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
            "name": "bandwidth123",
            "size": 10,
            "share_type": "PER",
            "publicip_info": [
                {
                    "publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                    "publicip_address": "161.xx.xx.9",
                    "publicip_type": "5_bgp"
                }
            ],
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "bandwidth_type": "bgp"
            "charge_mode": "bandwidth",
            
        }
    }

Status Codes

For details, see section Status Codes.

Error Codes

For details, see section Error Codes.