Querying a Bandwidth

Function

This API is used to query details about a bandwidth.

URI

GET /v1/{project_id}/bandwidths/{bandwidth_id}

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
bandwidth_id	Yes	Specifies the bandwidth ID, which uniquely identifies the bandwidth.

Request Message

Request parameter
None

Example request

Get https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id}

Response Message

Response parameter

**Table 2** Response parameter
Name	Type	Description
bandwidth	bandwidth object	Specifies the bandwidth object.

**Table 3** Description of the **bandwidth** field
Name	Type	Description
name	String	Specifies the bandwidth name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
size	Integer	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 bandwidth range of each region on the management console.)
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	Array of publicip_info objects	Specifies information about the EIP that uses the bandwidth. For details, see Table 4.
tenant_id	String	Specifies the project ID.
bandwidth_type	String	Specifies the bandwidth type. The value is bgp.
charge_mode	String	Specifies whether the billing is based on traffic or bandwidth. 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 traffic is used.
status	String	Specifies the bandwidth status. Possible values are as follows: FREEZED (Frozen) NORMAL (Normal)

**Table 4** **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. Constraints: The configured value must be supported by the system. publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

Example response

{
  "bandwidth": {
    "id": "3cbd5ae9-368f-4bc8-8841-f2ecc322c64a",
    "name": "EIPResourceSetup_1553594229",
    "size": 5,
    "share_type": "PER",
    "publicip_info": [
      {
        "publicip_id": "22b02f40-b95f-465a-ae9b-7c8b0f042a41",
        "publicip_address": "10.xx.xx.62",
        "ip_version": 4,
        "publicip_type": "5_bgp",
      }
    ],
    "tenant_id": "26ae5181a416420998eb2093aaed84d9",
    "bandwidth_type": "bgp",
    "charge_mode": "bandwidth",
    "status": "NORMAL",
    "created_at": "2020-04-21T07:58:02Z",
    "updated_at": "2020-04-21T07:58:02Z"
  }
}