全部产品
Search
文档中心

云原生内存数据库Tair:DescribeIntranetAttribute - 查询实例内网带宽信息

更新时间:Feb 20, 2024

查询Redis实例当前的内网带宽。如果调整过带宽,您还可以查询到带宽的过期时间。

接口说明

您可以调用 EnableAdditionalBandwidth 接口为实例购买带宽。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeIntranetAttributeREAD
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
ResourceGroupIdstring

资源组 ID。

rg-acfmyiu4ekp****

返回参数

名称类型描述示例值
object
AutoRenewalboolean

购买的带宽是否开启了自动续订,取值:

  • true:已开启。
  • false:未开启。
说明 如果未购买带宽,则不返回本参数。
true
RequestIdstring

请求 ID。

25D42CC3-FBA1-4AEC-BCE2-B8DD3137****
ExpireTimestring

临时带宽的过期时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 如果实例未执行过临时调整带宽或临时带宽已过期,本参数返回 0
0
IntranetBandwidthinteger

实例当前的内网带宽,单位 MB/s。

102
HasPrePaidBandWidthOrderRunningboolean

实例是否有未到期的带宽包,取值:

  • true:存在未到期的带宽包。
  • false:不存在未到期的带宽包。
说明 如果实例未购买额外的带宽,则不返回本参数。
true
BandwidthExpireTimestring

购买带宽的过期时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 如果实例未购买额外的带宽,则不返回本参数。
2021-03-06T16:00:00Z
BandwidthPrePaidstring

带宽包付费类型,取值:

  • 0:按量付费。
  • 1:预付费。
0

示例

正常返回示例

JSON格式

{
  "AutoRenewal": true,
  "RequestId": "25D42CC3-FBA1-4AEC-BCE2-B8DD3137****",
  "ExpireTime": "0",
  "IntranetBandwidth": 102,
  "HasPrePaidBandWidthOrderRunning": true,
  "BandwidthExpireTime": "2021-03-06T16:00:00Z",
  "BandwidthPrePaid": "0"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更