DescribeDBInstanceDetail--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceDetail

最近更新时间：2024.09.26 17:00:06首次发布时间：2021.11.15 16:07:16

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

请求类型

同步请求。

请求参数

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

返回参数

参数	类型	示例值	描述
RegionId	String	cn-beijing	地域 ID。
ZoneIds	String[]	["cn-beijing-a"]	可用区 ID 列表。
InstanceName	String	test	实例名称。
InstanceId	String	redis-cnlfkmh6uiii8****	实例 ID。
Status	String	Running	实例的当前状态。关于实例状态的更多信息，请参见实例状态列表。
EngineVersion	String	5.0	Redis 版本。
ShardedCluster	Integer	1	当前实例是否已启用分片集群，取值范围如下： `0`：未启用。 `1`：已启用。
NodeNumber	Integer	2	节点数。
ShardNumber	Integer	2	实例中的分片数量。
ShardCapacityV2	Long	2048	实例中每个分片的内存容量。单位：MiB。
Capacity	Object		实例的容量信息。单位：MiB。
VpcId	String	vpc-rs5811nceqyov0x58x4****	私有网络的 ID。
SubnetId	String	subnet-rrz4zdgdv20wv0x58h****	实例所属子网的子网 ID。
CreateTime	String	2021-11-09T14:02:14Z	实例的创建时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。
VisitAddrs	Object[]		连接地址信息。
MaintenanceTime	String	02:00-03:00	可维护时间段，格式为 `HH:mm-HH:mm`（UTC）。
ExpiredTime	String	2021-02-28 00:00:00	实例到期时间，格式为 `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	Object[]		实例已绑定的标签信息。
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`。
ShardCapacity	Double	2	该字段作为保留字段，后续不再使用。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeDBInstanceDetail&Version=2020-12-07 HTTP/1.1
Host: redis.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-cnlfkmh6uiii8****"
}

返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151542300102120440191265****",
          "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-cnlfkmh6uiii8****",
          "InstanceName": "test",
          "MaintenanceTime": "02:00-03:00",
          "MultiAZ": "disabled",
          "NodeNumber": 2,
          "ProjectName": "default",
          "RegionId": "cn-beijing",
          "ShardCapacity": 2,
          "ShardCapacityV2": 2048,
          "ShardNumber": 2,
          "ShardedCluster": 1,
          "Status": "Running",
          "SubnetId": "subnet-rrz4zdgdv20wv0x58h****",
          "VisitAddrs": [
               {
                   "AddrType": "Public",
                   "Address": "redis-redis-cnlfkmh6uiii8****.redis.volcs.com",
                   "EipId": "eip-2fef2qcfbfw8w5oxruw3w****",
                   "Port": "6379",
                   "VIP": "172.16.\*\*\*.\*\*\*",
                   "VIPv6": ""
               }
          ],
          "VpcAuthMode": "close",
          "VpcId": "vpc-rs5811nceqyov0x58x4****",
          "ZoneIds": [
               "cn-beijing-a"
          ],
          "Tags": [
            {
                "Key": "owner",
                "Value": "Alice"
            },
            {
                "Key": "department",
                "Value": "game"
            }
          ],
          "MaxConnections": 10000,
          "DataLayout": "RAM"
     }
}

错误码

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