You need to enable JavaScript to run this app.
导航
DescribeDBInstanceDetail
最近更新时间:2024.04.12 13:02:04首次发布时间:2021.11.15 16:07:16

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

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

返回数据

名称类型示例值描述
CapacityStructure of CapacityInfo{
  "Used": 57,
  "Total": 2048
}
实例的容量信息。单位:MiB。关于 Capacity 的详细说明,请参见数据结构

ChargeType

String

PostPaid

计费类型。取值范围如下:

  • PostPaid:按量计费。
  • PrePaid:包年包月。

关于计费类型的更多信息,请参见按量计费包年包月

AutoRenew

Boolean

false

实例是否已开启自动续费,取值范围如下:

  • false:不开启自动续费。
  • true:开启自动续费。

说明

仅包年包月实例(即 ChargeTypePrePaid),会返回该参数。

CreateTimeString2021-11-09T14:02:14Z实例的创建时间(UTC 时间)。

DeletionProtection

String

enabled

实例删除保护功能开关状态。取值范围如下:

  • enabled:已开启。
  • disabled:已关闭。

关于实例删除保护的更多信息,请参见实例删除保护

EngineVersionString5.0Redis 版本。

ExpiredTime

String

2021-02-28T00:00:00Z

实例到期时间(UTC 时间)。

说明

仅当计费类型为 PrePaid 时返回该参数。

InstanceIdStringredis-cn0212gzmh2xs****实例 ID。
InstanceNameStringtest实例名称。
MaintenanceTimeString02:00-03:00可维护时间段(UTC 时间)。
NodeNumberInteger2节点数。
ProjectNameStringdefault实例所属的项目名称。
RegionIdStringcn-beijing地域 ID。
ShardCapacityV2Integer2048实例中每个分片的内存容量。单位:MiB。
ShardCapacityDouble2该字段作为保留字段,后续不再使用。
ShardNumberInteger2实例中的分片数量。

ShardedCluster

Integer

1

当前实例是否已启用分片集群,取值范围如下:

  • 0:未启用。
  • 1:已启用。
StatusStringRunning实例的当前状态。关于实例状态的更多信息,请参见实例状态列表
SubnetIdStringsubnet-rrz4zdgdv20wv0x58h****实例所属子网的子网 ID。
VisitAddrsArray of VisitAddressInfo请参见返回示例连接地址信息。关于 VisitAddrs 的详细说明,请参见数据结构

VpcAuthMode

String

open

免密访问开关是否打开。取值范围如下:

  • open:免密访问已开启。
  • close:免密访问已关闭。

关于免密访问的更多信息,请参见免密访问

VpcIdStringvpc-rs5811nceqyov0x58x4****私有网络的 ID。
ZoneIdsArray of String[
"cn-beijing-a"
]
可用区 ID 列表。
TagsArray of TagInfo[
{
"Key": "department",
"Value": "game"
},
{
"Key": "owner",
"Value": "Alice"
}
]
实例已绑定的标签信息。关于 Tags 的更多说明,请参见数据结构

InstanceClass

String

PrimarySecondary

实例类型。取值范围如下:

  • PrimarySecondary:主备实例。
  • Standalone:单节点实例。

关于实例类型的更多说明,请参见核心组件和产品架构

MultiAZ

String

disabled

设置实例的可用区部署方案。取值范围如下:

  • enabled:多可用区部署方案。
  • disabled:单可用区部署方案。

关于可用区部署方案的更多说明,请参见多可用区同城容灾解决方案

请求示例

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-cn0212gzmh2xs****"
}

返回示例

正常返回示例

{
     "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-cn0212gzmh2xs****",
          "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-cn0212gzmh2xs****.redis.volcs.com",
                   "EipId": "eip-2fef2qcfbfw8w5oxruw3w****",
                   "Port": "6379",
                   "VIP": "10.249.***.***"
               }
          ],
          "VpcAuthMode": "close",
          "VpcId": "vpc-rs5811nceqyov0x58x4****",
          "ZoneIds": [
               "cn-beijing-a"
          ],
          "Tags": [
            {
                "Key": "owner",
                "Value": "Alice"
            },
            {
                "Key": "department",
                "Value": "game"
            }
          ]
     }
}

错误码

更多详情,请参见错误码