文档首页/ 云手机服务器 CPH/ API参考/ 云手机服务器API/ 带宽管理/ 查询带宽信息
更新时间：2024-11-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询带宽信息

功能介绍

查询云手机使用的带宽信息，本接口只适用于使用系统定义网络的服务器。

调试

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

URI

GET /v1/{project_id}/cloud-phone/bandwidths

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。

limit

否

Integer

每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

band_widths

Array of Bandwidth objects

带宽信息。
表5 Bandwidth

参数

参数类型

描述

band_width_name

String

云手机服务器的带宽名称。

band_width_id

String

云手机服务器的带宽唯一标识。

band_width_size

Integer

云手机服务器的带宽大小。

band_width_charge_mode

Integer

云手机服务器带宽的计费方式。

  • 0：bandwidth, 按带宽计费

  • 1：traffic, 按流量计费

band_width_share_type

Integer

云手机服务器的带宽类型。

  • 0：per，独享带宽

  • 1：whole，共享带宽

create_time

String

带宽创建时间，

时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。

update_time

String

带宽更新时间，

时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。

请求示例

查询使用的带宽信息

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

响应示例

状态码： 200

OK

{
  "request_id" : "70bb40bef50e4a14b116a5a527fd7432",
  "band_widths" : [ {
    "band_width_id" : "70bb40-bef5-0e4a-14b116-a5a527fd7432",
    "band_width_name" : "BANDWIDTH_70bb40bef50e4a14b116a5a527fd7432",
    "band_width_size" : 300,
    "band_width_share_type" : 1,
    "create_time" : "2017-10-10T00:00:00Z",
    "update_time" : "2018-11-12T00:00:00Z"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 带宽管理

相关文档