Modifying a Shared Bandwidth

Function Description

  • API Name

    UpdateBandwidth

  • Function

    Change the shared bandwidth size used by the cloud phone.

URI

PUT /v1/{project_id}/cloud-phone/bandwidths/{band_width_id}

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.

band_width_id

Yes

String

Specifies the shared bandwidth ID, which can be obtained in Querying Bandwidth Information.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    band_width_size

    Yes

    Integer

    • ≤ 300 Mbit/s: The default minimum increment step is 1 Mbit/s.
    • 300 Mbit/s to 1000 Mbit/s: The default minimum increment step is 50 Mbit/s.
    • > 1000 Mbit/s: The default minimum increment step is 500 Mbit/s.
  • Example request
    PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/bandwidths/{band_width_id}
    {
        "band_width_size": 350
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Specifies the request ID, which is unique.

  • Example response
    {
        "request_id": "70bb40bef50e4a14b116a5a527fd7432"
    }

Returned Values

See Returned Values.

Error Codes

See Error Codes.