DescribeEnterpriseDBInstanceDetail--缓存数据库 Redis 企业版-火山引擎

文档中心

立即注册

缓存数据库 Redis 企业版

实例管理

DescribeEnterpriseDBInstanceDetail

调用 DescribeEnterpriseDBInstanceDetail 接口查询目标 Redis 企业版的实例详情。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

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

返回参数

参数	类型	示例值	描述
RegionId	String	cn-beijing	实例所属的地域 ID。
InstanceName	String	redis-enterprise	实例名称。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
Status	String	Running	实例的当前状态。关于实例状态的更多信息，请参见实例状态。
EngineVersion	String	7.4	实例的数据库版本。Redis 企业版实例当前仅支持 7.4 版本。
VpcId	String	vpc-2743n1ihbxla87fap8tap****	私有网络的 ID。
ChargeType	String	PrePaid	计费类型，取值范围如下： `PostPaid`：按量计费。 `PrePaid`：包年包月。说明关于计费类型的更多信息，请参见计费类型。
Capacity	Object		实例的容量信息。
CreateTime	String	2024-05-01T10:02:14Z	实例的创建时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。
VisitAddrs	Object[]		连接地址信息。
NodeNumber	Integer	2	每分片的节点数。每个企业版实例中默认包含 2 个节点，取值固定为 `2`。
MaintenanceTime	String	02:00-02:59	实例的可维护时间段，格式为 `HH:mm-HH:mm`（UTC+8）。
ExpiredTime	String	2024-08-01 23:59:59	实例到期时间，格式为 `yyyy-MM-dd HH:mm:ss`（UTC+8）。说明仅包年包月实例（即 `ChargeType` 为 `PrePaid`），会返回该参数。
ProjectName	String	default	实例所属的项目名称。
AutoRenew	Boolean	false	实例是否已开启自动续费，取值范围如下： `false`：不开启自动续费。 `true`：开启自动续费。说明仅包年包月实例（即 `ChargeType` 为 `PrePaid`），会返回该参数。
SubnetId	String	subnet-rrz4zdgdv20wv0x58h****	实例所属的子网 ID。
DeletionProtection	String	disabled	实例删除保护功能开关状态。取值范围如下： `enabled`：已开启。 `disabled`：已关闭。说明关于实例删除保护的更多信息，请参见实例删除保护。
Tags	Object[]		实例已绑定的标签列表。
MultiAZ	String	disabled	实例的可用区部署方案。取值范围如下： `enabled`：多可用区部署方案。 `disabled`：单可用区部署方案。说明关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。
ShardNumber	Integer	2	实例中的分片数量。
RamPerShard	Integer	8192	单分片的 RAM 容量，单位：MiB。
FlashPerShard	Integer	0	单分片的高速存储容量，单位：MiB。说明仅混存型（即 `DataLayout` 为 `Hybrid`）实例支持配置高速存储容量，内存型（即 `DataLayout` 为 `RAM`）实例的该参数值固定为 `0`。
Modules	String[]	["RedisJSON"]	企业版实例中已加载的 Module 列表。
ZoneIds	String[]	[ "cn-beijing-a" ]	实例所属的可用区信息列表。
DataLayout	String	RAM	实例的数据存储形态，取值范围如下： `RAM`：内存型。 `Hybrid`：混存型。关于企业版实例数据存储形态的更多信息，请参见数据存储形态。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeEnterpriseDBInstanceDetail&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-cn0212gzmh2xs****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240418215816DB2B3193A28DCA24D540-c5****",
        "Action": "DescribeEnterpriseDBInstanceDetail",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "AutoRenew": false,
        "Capacity": {
            "Total": 36864,
            "Used": 100
        },
        "ChargeType": "PrePaid",
        "ConfigureNodes": [
            {
                "AZ": "cn-beijing-a"
            },
            {
                "AZ": "cn-beijing-a"
            }
        ],
        "CreateTime": "2024-05-01T10:02:14Z",
        "DeletionProtection": "disabled",
        "EngineVersion": "7.4",
        "ExpiredTime": "2024-08-01 00:00:00",
        "FlashPerShard": 0,
        "InstanceId": "redis-cn0212gzmh2xs****",
        "InstanceName": "redis-enterprise",
        "InternetProtocol": "IPv4",
        "MaintenanceTime": "02:00-02:59",
        "Modules": [
            "RedisJSON",
            "RedisBloom"
        ],
        "MultiAZ": "disabled",
        "NodeNumber": 2,
        "ProjectName": "default",
        "RamPerShard": 8192,
        "RegionId": "cn-beijing",
        "ShardNumber": 2,
        "Status": "Running",
        "SubnetId": "subnet-rrz4zdgdv20wv0x58h****",
        "Tags": [
            {
                "Key": "servicetype",
                "Value": "enterprise"
            }
        ],
        "VisitAddrs": [
            {
                "AddrType": "Private",
                "IPAddress": "redis-cn0212gzmh2xs****.redis.ivolces.com",
                "Port": "6379",
                "VIP": "10.249.***.***"
            }
        ],
        "VpcId": "vpc-2743n1ihbxla87fap8tap****",
        "ZoneIds": [
            "cn-beijing-a"
        ],
        "DataLayout": "RAM"
    }
}

错误码

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

最近更新时间：2025.08.14 15:34:20

这个页面对您有帮助吗？

有用

无用

缓存数据库 Redis 企业版

请求类型 #

调试 #

请求参数 #

返回参数 #

示例 #

请求示例 #

返回示例 #

错误码 #

请求类型

调试

请求参数

返回参数

示例

请求示例

返回示例

错误码