文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 实例管理/ 获取实例分片带宽
更新时间：2024-12-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取实例分片带宽

功能介绍

获取实例各个分片带宽。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/instances/{instance_id}/bandwidths

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

bandwidth

Integer

实例当前带宽(Mbit/s)。

max_bandwidth

Integer

实例最大带宽(Mbit/s)。

allow_modify

Boolean

是否支持调带宽。

group_bandwidths

Array of GroupBandwidthInfo objects

分片带宽列表。
表3 GroupBandwidthInfo

参数

参数类型

描述

group_id

String

分片ID。

updated_at

String

更新时间，UTC时间。

bandwidth

Integer

当前带宽(Mbit/s)。

max_bandwidth

Integer

最大带宽(Mbit/s)。

assured_bandwidth

Integer

基准带宽(Mbit/s)。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/bandwidths

响应示例

状态码： 200

实例分片带宽。

{
  "bandwidth" : 900,
  "max_bandwidth" : 6000,
  "allow_modify" : true,
  "group_bandwidths" : [ {
    "group_id" : "6e19e25d-44fb-4a0b-bd46-3046baa30027",
    "updated_at" : null,
    "bandwidth" : 300,
    "max_bandwidth" : 2000,
    "assured_bandwidth" : 200
  }, {
    "group_id" : "1a64e15b-b4a4-4de8-8f35-5fb4faae2460",
    "updated_at" : null,
    "bandwidth" : 300,
    "max_bandwidth" : 2000,
    "assured_bandwidth" : 200
  }, {
    "group_id" : "e407d2bf-893a-4e8e-8b83-3ab3c0f7d755",
    "updated_at" : null,
    "bandwidth" : 300,
    "max_bandwidth" : 2000,
    "assured_bandwidth" : 200
  } ]
}

状态码

状态码

描述

200

实例分片带宽。

400

非法请求。

401

认证非法。

403

请求被拒绝。

404

路径不存在。

500

内部错误。

错误码

请参见错误码。

父主题： 实例管理

相关文档