文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 网络/ 查询云办公带宽列表
更新时间:2025-01-03 GMT+08:00

查询云办公带宽列表

功能介绍

查询云办公带宽列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/bandwidths

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID。

offset

Integer

用于分页查询,查询的起始记录序号,从0开始。

limit

Integer

用于分页查询,返回桌面数量限制。如果不指定,则返回所有符合条件的记录。

vpc_id

String

vpc id。

subnet_id

String

子网id。

bandwidth_id

String

云办公带宽id。

bandwidth_name

String

云办公带宽名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

bandwidths

Array of SubnetBandwidthDetail objects

云办公带宽信息。

total_count

Integer

总数。

表5 SubnetBandwidthDetail

参数

参数类型

描述

bandwidth_id

String

云办公带宽id。

bandwidth_name

String

云办公带宽名称。

charge_mode

String

云办公带宽计费方式。

size

Integer

云办公带宽大小。

vpc_id

String

VPC ID。

vpc_name

String

VPC名称。

subnet_id

String

子网 ID。

subnet_name

String

子网名称。

enterprise_project_id

String

企业项目ID。

created_at

String

创建时间。

order_id

String

订单id。

status

String

状态。

  • CREATING:创建中。

  • ACTIVE:使用中。

  • INACTIVE:已停用。

  • UPDATING:更新中。

  • DELETING:删除中。

control_mode

String

状态。

  • BLACK:黑名单管控模式。

  • WHITE:白名单管控模式。

状态码: default

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

响应示例

状态码: 200

查询云办公带宽列表响应。

{
  "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
}

状态码

状态码

描述

200

查询云办公带宽列表响应。

default

默认响应。

错误码

请参见错误码