Help Center> Cloud Phone Host> API Reference> Cloud Phone APIs> Bandwidth Management> Querying Bandwidth Information
View PDF

Querying Bandwidth Information

Function Description

  • API Name

    QueryBandwidth

  • Function

    Query the bandwidth used by a cloud phone.

URI

GET /v1/{project_id}/cloud-phone/bandwidths

For details, see Table 1.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

Request

  • Request parameters

    None

  • Example request 
    1
    		 
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/bandwidths

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Specifies the request ID, which is unique.

    band_widths

    Array of objects

    Specifies the bandwidth information. For details, see Table 2.
    Table 2 band_width field description

    Parameter

    Type

    Description

    band_width_id

    String

    Specifies the bandwidth ID. The value can contain a maximum of 32 bytes.

    band_width_name

    String

    Specifies the bandwidth name. The value can contain a maximum of 64 bytes.

    band_width_size

    Integer

    Specifies the bandwidth size in Mbit/s.

    band_width_share_type

    Integer

    Specifies the bandwidth type.

    • 0: dedicated bandwidth
    • 1: shared bandwidth

    create_time

    String

    Specifies the time when the bandwidth is created.

    The time format is UTC, YYYY-MM-DDTHH:MM:SSZ.

    update_time

    String

    Specifies the time when the bandwidth is updated.

    The time format is UTC, YYYY-MM-DDTHH:MM:SSZ.
  • Example response 
    {
    "request_id": "70bb40bef50e4a14b116a5a527fd7432",
    "band_widths": [
        {
            "band_width_id": "70bb40-bef5-0e4a-14b116-a5a527fd7432",
            "band_width_name": "BANDWIDTH_70bb40bef50e4a14b116a5a527fd7432",
            "band_width_size": 300,
            "band_width_share_type": 1,
            "create_time": "2017-10-10T00:00:00Z",
            "update_time": "2018-11-12T00:00:00Z"
        }
    ]
}

Returned Values

See Returned Values.

Error Codes

See Error Codes.

Parent topic: Bandwidth Management