:original_name: vpc_bandwidth_0001.html

.. _vpc_bandwidth_0001:

Querying a Bandwidth
====================

Function
--------

This API is used to query details about a bandwidth.

URI
---

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

:ref:`Table 1 <vpc_bandwidth_0001__table40002310>` describes the parameters.

.. _vpc_bandwidth_0001__table40002310:

.. table:: **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

   None

-  Example request

   .. code-block::

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

Response Message
----------------

-  Response parameter

   .. table:: **Table 2** Response parameter

      +-----------+-------------------------------------------------------------+---------------------------------+
      | Name      | Type                                                        | Description                     |
      +===========+=============================================================+=================================+
      | bandwidth | :ref:`bandwidth <vpc_bandwidth_0001__table60972066>` object | Specifies the bandwidth object. |
      +-----------+-------------------------------------------------------------+---------------------------------+

   .. _vpc_bandwidth_0001__table60972066:

   .. table:: **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                                                                    | -  Possible values are as follows:                                                                                                                                                                                  |
      |                       |                                                                           |                                                                                                                                                                                                                     |
      |                       |                                                                           |    -  **PER**: Dedicated bandwidth                                                                                                                                                                                  |
      |                       |                                                                           |    -  **WHOLE**: Shared bandwidth                                                                                                                                                                                   |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | publicip_info         | Array of :ref:`publicip_info <vpc_bandwidth_0001__table30936422>` objects | -  Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 <vpc_bandwidth_0001__table30936422>`.                                                                                |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | tenant_id             | String                                                                    | Specifies the project ID.                                                                                                                                                                                           |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | bandwidth_type        | String                                                                    | -  Specifies the bandwidth type.                                                                                                                                                                                    |
      |                       |                                                                           | -  The value can be:                                                                                                                                                                                                |
      |                       |                                                                           |                                                                                                                                                                                                                     |
      |                       |                                                                           |    -  **share**: Shared bandwidth                                                                                                                                                                                   |
      |                       |                                                                           |    -  **gray**: Dedicated load balancer                                                                                                                                                                             |
      |                       |                                                                           |    -  **bgp**: Dynamic BGP                                                                                                                                                                                          |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | charge_mode           | String                                                                    | If the value is **traffic**, the billing is based on traffic.                                                                                                                                                       |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | billing_info          | String                                                                    | Specifies the bill information.                                                                                                                                                                                     |
      |                       |                                                                           |                                                                                                                                                                                                                     |
      |                       |                                                                           | If **billing_info** is specified, the bandwidth is in yearly/monthly billing mode.                                                                                                                                  |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | enterprise_project_id | String                                                                    | -  Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-).                                                                    |
      |                       |                                                                           | -  When creating a bandwidth, associate the enterprise project ID with the bandwidth.                                                                                                                               |
      |                       |                                                                           | -  If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used.                                                                                     |
      |                       |                                                                           |                                                                                                                                                                                                                     |
      |                       |                                                                           | .. note::                                                                                                                                                                                                           |
      |                       |                                                                           |                                                                                                                                                                                                                     |
      |                       |                                                                           |    This parameter is unsupported. Do not use it.                                                                                                                                                                    |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | status                | String                                                                    | -  Specifies the bandwidth status.                                                                                                                                                                                  |
      |                       |                                                                           | -  Possible values are as follows:                                                                                                                                                                                  |
      |                       |                                                                           |                                                                                                                                                                                                                     |
      |                       |                                                                           |    -  **FREEZED** (Frozen)                                                                                                                                                                                          |
      |                       |                                                                           |    -  **NORMAL** (Normal)                                                                                                                                                                                           |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | created_at            | String                                                                    | -  Specifies the time (UTC) when the bandwidth is created.                                                                                                                                                          |
      |                       |                                                                           | -  Format: *yyyy-MM-ddTHH:mm:ss*                                                                                                                                                                                    |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | updated_at            | String                                                                    | -  Specifies the time (UTC) when the bandwidth is updated.                                                                                                                                                          |
      |                       |                                                                           | -  Format: *yyyy-MM-ddTHH:mm:ss*                                                                                                                                                                                    |
      +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

   .. _vpc_bandwidth_0001__table30936422:

   .. table:: **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.                                                                           |
      +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
      | ip_version            | Integer               | -  Specifies the IP address version.                                                                                                  |
      |                       |                       | -  Possible values are as follows:                                                                                                    |
      |                       |                       |                                                                                                                                       |
      |                       |                       |    -  **4**: IPv4                                                                                                                     |
      |                       |                       |    -  **6**: IPv6 (IPv6 is not supported currently.)                                                                                  |
      +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
      | publicip_type         | String                | -  Specifies the EIP type.                                                                                                            |
      |                       |                       | -  The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). |
      |                       |                       | -  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

   .. code-block::

      {
        "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": "traffic",
          "enterprise_project_id": "0",
          "status": "NORMAL",
          "created_at": "2020-04-21T07:58:02Z",
          "updated_at": "2020-04-21T07:58:02Z"
        }
      }

Status Code
-----------

See :ref:`Status Codes <vpc_api_0002>`.

Error Code
----------

See :ref:`Error Codes <vpc_api_0003>`.