Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Creating Workspace Bandwidth
Updated on 2025-07-14 GMT+08:00
View PDF
Share

Creating Workspace Bandwidth

Function

Creates pay-per-use Workspace bandwidth.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/bandwidths

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

MIME type of the request body.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

bandwidth_name

No

String

Workspace bandwidth name.

subnet_id

Yes

String

Subnet ID.

charge_mode

Yes

String

Billing mode.

  • wks_bandwidth: billed by bandwidth. This mode is supported only for yearly/monthly billing.

  • free: free of charge. This mode is supported only for pay-per-use billing.

  • wks_traffic: billed by traffic. This mode is supported only for pay-per-use billing.

bandwidth_size

No

Integer

Workspace bandwidth size.

enterprise_project_id

No

String

Enterprise project ID, which is 0 by default.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: default

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

/v2/0e69423d4400f4a82f67c0059a1e4cc8/bandwidths

{
  "subnet_id" : "2fe2cebf-fb0c-40a6-8daa-f60bef147583",
  "charge_mode" : "wks_bandwidth",
  "bandwidth_size" : 1
}

Example Responses

Status code: 200

Response to the request for creating Workspace bandwidth.

{
  "job_id" : "fa9e41e1-1221-47c3-a43c-67a1271e2093"
}

Status Codes

Status Code

Description

200

Response to the request for creating Workspace bandwidth.

default

Default response.

Error Codes

See Error Codes.

Parent topic: Network