Help Center/ Cloud Phone Host/ API Reference/ Cloud Phone Server APIs/ Bandwidth/ Modifying a Shared Bandwidth
Updated on 2025-10-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Shared Bandwidth

Function

This API is used to modify the bandwidth used by a cloud phone. This API applies only to cloud phone servers that use system-defined networks.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

band_width_id

Yes

String

Specifies the bandwidth ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

band_width_size

Yes

Integer

Specifies the increment step of a bandwidth.

  • ≤ 300 Mbit/s: The default minimum increment step is 1 Mbit/s.

  • 300 Mbit/s to 1,000 Mbit/s: The default minimum increment step is 50 Mbit/s.

  • NOTE:
    1,000 Mbit/s: The default minimum increment step is 500 Mbit/s.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

error_msg

String

Specifies the error message returned for the task.

error_code

String

Specifies the task error code.

Example Requests

Changing the bandwidth size to 350 Mbit/s

PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/bandwidths/{band_width_id}

{
  "band_width_size" : 350
}

Example Responses

Status code: 200

OK

{
  "request_id" : "70bb40bef50e4a14b116a5a527fd7432"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Bandwidth