Querying Bandwidths

Function

This API is used to query bandwidths using search criteria.

URI

GET /v1/{project_id}/bandwidths

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
marker	No	String	Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit. If parameters marker and limit are not passed, resource records on the first page will be returned. If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned. If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned. If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
limit	No	Integer	Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker.
share_type	No	String	Specifies the bandwidth type. Possible values are as follows: PER: Dedicated bandwidth WHOLE: Shared bandwidth If this parameter is not set, the list of all bandwidths will be returned by default.
enterprise_project_id	No	String	Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps. NOTE:

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.

Example request

GET https://{Endpoint}/v1/{project_id}/bandwidths?limit={limit}&marker={marker}

Response Message

Response parameter

**Table 3** Response parameter
Name	Type	Description
bandwidths	Array of bandwidths objects	Specifies the bandwidth objects. For details, see Table 4.

**Table 4** Description of the **bandwidths** 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 in Mbit/s. 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.)
id	String	Specifies the bandwidth ID, which uniquely identifies the bandwidth.
share_type	String	Specifies whether the bandwidth is shared or dedicated. Possible values are as follows: PER: Dedicated bandwidth WHOLE: Shared bandwidth If this parameter is not set, the list of all bandwidths will be returned by default.
publicip_info	Array of publicip_info objects	Specifies the information about the EIP that uses the bandwidth. For details, see Table 5. The bandwidth, whose type is WHOLE, can be used by multiple EIPs (up to 20 EIPs by default). 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 value can be: share: Shared bandwidth bgp: Dynamic BGP 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.
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 (-). Value 0 indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set all_granted_eps. When creating a bandwidth, associate the enterprise project ID with the bandwidth. NOTE:
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
enable_bandwidth_rules	boolean	Specifies whether to enable QoS. The value can be true or false.
rule_quota	integer	Specifies the maximum number of grouping rules supported by the bandwidth.
bandwidth_rules	Array of bandwidth_rules objects	Specifies the bandwidth rules.
public_border_group	String	Specifies whether it is in a central site or an edge site. Values: center Edge site name This resource can only be associated with an EIP of the same region.

**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.
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 6: IPv6
publicip_type	String	Specifies the EIP type. The value can be 5_bgp. 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.

**Table 6** **bandwidth_rules** object
Name	Type	Description
id	string	Specifies the bandwidth rule ID.
name	string	Specifies the name of the bandwidth rule.
admin_state_up	boolean	Specifies the configuration status. The value False indicates that the configuration does not take effect.
egress_size	integer	Specifies the maximum outbound bandwidth in Mbit/s. The value range ranges from 0 to n, where n indicates the shared bandwidth size. If the value is set to 0, the maximum bandwidth, that is the shared bandwidth size will be used.
egress_guarented_size	integer	Specifies the guaranteed outbound bandwidth in Mbit/s. The value ranges from 0 to x, where x indicates the remaining bandwidth.
publicip_info	Array of publicip_info objects	Specifies the EIP associated with the bandwidth. The bandwidth, whose type is set to WHOLE, can be used by multiple EIPs. The bandwidth, whose type is set to PER, can be used by only one EIP.

Example response

{
  "bandwidths": [
    {
      "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71",
      "name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977",
      "size": 200,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5",
          "publicip_address": "10.xx.xx.3",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    },
    {
      "id": "0a583ff1-b43e-4000-ade3-e7af0097f832",
      "name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d",
      "size": 300,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80",
          "publicip_address": "10.xx.xx.9",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    },
    {
      "id": "0a673f00-3640-4a13-949e-7049b2916baf",
      "name": "bandwidth123",
      "size": 10,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc",
          "publicip_address": "10.xx.xx.184",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    },
    {
      "id": "0dde1eae-1783-46dc-998c-930fbe261ff9",
      "name": "bandwidth123",
      "size": 100,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "24232038-e178-40ad-80e4-5abb75db84be",
          "publicip_address": "10.xx.xx.101",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    }
  ]
}