Querying the Workspace Bandwidth List
Function
Queries the Workspace bandwidth list.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/bandwidths
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. |
offset |
No |
Integer |
Where the pagination query starts. The value starts from 0. |
limit |
No |
Integer |
Limits the quantity of returned desktops in pagination query. If this parameter is not specified, all records that meet the search criteria are returned. |
vpc_id |
No |
String |
VPC ID. |
subnet_id |
No |
String |
Subnet ID. |
bandwidth_id |
No |
String |
Workspace bandwidth ID. |
bandwidth_name |
No |
String |
Workspace bandwidth name. |
Request 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
bandwidths |
Array of SubnetBandwidthDetail objects |
Workspace bandwidth information. |
total_count |
Integer |
Total number. |
Parameter |
Type |
Description |
---|---|---|
bandwidth_id |
String |
Workspace bandwidth ID. |
bandwidth_name |
String |
Workspace bandwidth name. |
charge_mode |
String |
Workspace bandwidth billing mode. |
size |
Integer |
Workspace bandwidth size. |
vpc_id |
String |
VPC ID. |
vpc_name |
String |
VPC name. |
subnet_id |
String |
Subnet ID. |
subnet_name |
String |
Subnet name. |
enterprise_project_id |
String |
Enterprise project ID. |
created_at |
String |
Creation time. |
order_id |
String |
Order ID. |
status |
String |
Status.
|
control_mode |
String |
Status.
|
Status code: default
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
None
Example Responses
Status code: 200
Response to the request for querying the Workspace bandwidth list.
{ "bandwidths" : [ { "bandwidth_id" : "string", "bandwidth_name" : "string", "charge_mode" : "string", "size" : 0, "vpc_id" : "string", "vpc_name" : "string", "subnet_id" : "string", "subnet_name" : "string", "enterprise_project_id" : "string", "created_at" : "string", "order_id" : "string", "status" : "string", "control_mode" : "string" } ], "total_count" : 0 }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying the Workspace bandwidth list. |
default |
Default response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot