文档中心

缓存数据库 Redis 版

实例管理

DescribeDBInstanceDetail

调用 DescribeDBInstanceDetail 接口查询目标 Redis 实例的详细信息。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cnlfkmh6uiii87hla	实例 ID。说明您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
RegionId	String	cn-beijing	地域 ID。
ZoneIds	Array of String	["cn-beijing-a"]	可用区 ID 列表。
ConfigureNodes	Array of ConfigureNode	请参见返回示例。	实例中所有节点的可用区列表。
InstanceName	String	test	实例名称。
InstanceId	String	redis-cnlfkmh6uiii87hla	实例 ID。
Status	String	Running	实例的当前状态。说明关于实例状态的更多信息，请参见实例状态列表。
EngineVersion	String	5.0	Redis 实例的数据库版本。
ShardedCluster	Integer	1	当前实例是否已启用分片集群，取值范围如下： 0：未启用。 1：已启用。
NodeNumber	Integer	2	节点数。
ShardNumber	Integer	2	实例中的分片数量。
ShardCapacityV2	Long	1024	实例中每个分片的内存容量。单位：MiB。
Capacity	Object of InstanceCapacity	请参见返回示例。	实例的容量信息。单位：MiB。
VpcId	String	vpc-rs5811nceqyov0x58x458x4	私有网络的 ID。
SubnetId	String	subnet-rrz4zdgdv20wv0x58hx58h	实例所属子网的子网 ID。
CreateTime	String	2021-11-09T14:02:14Z	实例的创建时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
VisitAddrs	Array of VisitAddress	请参见返回示例。	连接地址信息。
MaintenanceTime	String	02:00-02:59	实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
ExpiredTime	String	2021-02-28 23:59:59	实例到期时间，格式为 yyyy-MM-dd HH:mm:ss（UTC+8）。说明仅包年包月实例（即 ChargeType 为 PrePaid），会返回该参数。
ProjectName	String	default	实例所属的项目名称。
DeletionProtection	String	enabled	实例删除保护功能开关状态。取值范围如下： enabled：已开启。 disabled：已关闭。说明关于实例删除保护的更多信息，请参见实例删除保护。
VpcAuthMode	String	close	免密访问开关是否打开。取值范围如下： open：免密访问已开启。 close：免密访问已关闭。说明关于免密访问的更多信息，请参见免密访问。
InstanceClass	String	PrimarySecondary	实例类型。取值范围如下： PrimarySecondary：主备实例。 Standalone：单节点实例。说明关于实例类型的更多说明，请参见产品架构。
Tags	Array of Tag	请参见返回示例。	实例已绑定的标签信息。
MultiAZ	String	disabled	设置实例的可用区部署方案。取值范围如下： enabled：多可用区部署方案。 disabled：单可用区部署方案。说明关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。
ChargeType	String	PostPaid	计费类型。取值范围如下： PostPaid：按量计费。 PrePaid：包年包月。说明关于计费类型的更多信息，请参见按量计费和包年包月。
AutoRenew	Boolean	false	实例是否已开启自动续费，取值范围如下： false：不开启自动续费。 true：开启自动续费。说明仅包年包月实例（即 ChargeType 为 PrePaid），会返回该参数。
MaxConnections	Integer	10000	实例当前单分片最大连接数。说明每分片的默认连接数为 10000，您也可以根据业务需要调用 ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
DataLayout	String	RAM	实例的数据存储形态。说明社区版（即 ServiceType 为 Basic）实例不涉及数据存储形态，DataLayout 取值固定为 RAM。
Modules	Array of String	[ "exbloom", "exstring", "exts", "valkey_json", "valkey_search" ]	实例加载的扩展模块列表。取值： exbloom：ExBloomFilter 模块。 exstring：ExString 模块。 exts：ExTimeSeries 模块。 valkey_json：Valkey-JSON 模块。 valkey_search：Valkey-Search 模块。说明如实例未开启扩展模块，则不返回该字段。
BlueGreenRole	String	Blue	实例的蓝绿部署角色。取值范围如下： Blue：蓝色实例。 Green：绿色实例。说明仅使用过蓝绿部署功能的 Redis 实例会返回该参数。更多详情，请参见通过蓝绿部署升级大版本。
ShardCapacity	Double	1	该字段作为保留字段，后续不再使用。

ConfigureNode

参数	类型	示例值	描述
AZ	String	cn-beijing-a	每个节点所属的可用区。实例的可用区部署方案不同，返回的信息不同。其中：当实例为单可用区部署（即 MultiAZ 取值为 disabled）时，所有节点的 AZ 返回值一致。当实例为多可用区部署（即 MultiAZ 取值为 enabled）时，表示的是单个分片中每个节点所在的可用区。

InstanceCapacity

参数	类型	示例值	描述
Used	Long	57	当前实例已用容量。单位：MiB。
Total	Long	2048	当前实例的内存总容量。单位：MiB。

VisitAddress

参数	类型	示例值	描述
Port	String	6379	端口号。
EipId	String	eip-2fef2qcfbfw8w5oxruw3w****	实例公网地址所绑定的 EIP ID。说明仅当连接地址类型（即 AddrType）为 Public公网连接地址时，返回该参数。
Address	String	redis-redis-cnlfkmh6uiii8****.redis.volcs.com	IP 地址或者域名。
AddrType	String	Public	连接地址类型，取值范围如下： Private：私网连接地址。 Public：公网连接地址。 DirectLink：直连地址。说明仅启用分片集群的 Redis 实例申请了直连地址后，才会返回直连地址信息。关于连接地址的更多信息，请参见连接地址类型。
VIP	String	172.16.1.15	连接地址所对应的 IPv4 地址。
VIPv6	String	2408:4003:2027:ff0d:a86c:2529:8352:****	连接地址所对应的 IPv6 地址。说明仅当实例使用了 IPv6 地址时才会返回该参数。仅私网地址和直连地址支持 IPv6 地址，公网地址不支持，因此当连接地址类型为公网地址（即 AddrType 为 Public）时，该参数值固定为空。

Tag

参数	类型	示例值	描述
Key	String	department	当前实例所绑定标签的标签键。
Value	String	game	当前实例所绑定标签的标签值。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceDetail&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "InstanceId":"redis-cnlfkmh6uiii87hla"​
}​

返回示例

{​
     "ResponseMetadata": {​
          "RequestId": "2022041515423001021204401912651265",​
          "Action": "DescribeDBInstanceDetail",​
          "Version": "2020-12-07",​
          "Service": "Redis",​
          "Region": "cn-beijing"​
     },​
     "Result": {​
          "Capacity": {​
               "Total": 2048,​
               "Used": 57​
          },​
          "ChargeType": "PostPaid",​
          "CreateTime": "2021-11-09T14:02:14Z",​
          "DeletionProtection": "enabled",​
          "EngineVersion": "5.0",​
          "ExpiredTime": "",​
          "InstanceClass": "PrimarySecondary",​
          "InstanceId": "redis-cnlfkmh6uiii87hla",​
          "InstanceName": "test",​
          "MaintenanceTime": "02:00-02:59",​
          "MultiAZ": "disabled",​
          "NodeNumber": 2,​
          "ProjectName": "default",​
          "RegionId": "cn-beijing",​
          "ShardCapacity": 1,​
          "ShardCapacityV2": 1024,​
          "ShardNumber": 2,​
          "ShardedCluster": 1,​
          "Status": "Running",​
          "SubnetId": "subnet-rrz4zdgdv20wv0x58hx58h",​
          "VisitAddrs": [​
               {​
                   "AddrType": "Public",​
                   "Address": "redis-redis-cnlfkmh6uiii8****.redis.volcs.com",​
                   "EipId": "eip-2fef2qcfbfw8w5oxruw3wuw3w",​
                   "Port": "6379",​
                   "VIP": "172.16.1.15",​
                   "VIPv6": ""​
               }​
          ],​
          "VpcAuthMode": "close",​
          "VpcId": "vpc-rs5811nceqyov0x58x458x4",​
          "ZoneIds": [​
               "cn-beijing-a"​
          ],​
          "Tags": [​
            {​
                "Key": "owner",​
                "Value": "Alice"​
            },​
            {​
                "Key": "department",​
                "Value": "game"​
            }​
          ],​
          "MaxConnections":10000,​
          "DataLayout": "RAM",​
           "BlueGreenRole": "Blue"​
     }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.21 14:23:30

这个页面对您有帮助吗？

有用

无用