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

文档中心

立即注册

缓存数据库 Redis 企业版

实例管理

DescribeDBInstances

调用 DescribeDBInstances 接口查询 Redis 企业版实例的基本信息。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	否	cn-beijing	实例所属的地域 ID。说明若该参数留空，默认使用签名中设置的地域进行筛选。关于签名机制的更多信息，请参见签名机制。您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。
PageNumber	Integer	否	1	实例信息列表的页码。取值为不超过 Integer 数据类型的最大值，起始值与默认值均为 1。
PageSize	Integer	否	10	每页记录数。取值为 1~1000 间的整数，默认值为 10。
ZoneId	String	否	cn-beijing-a	实例所属的可用区 ID，支持模糊查询。说明您可以调用 DescribeEnterpriseZones 接口查询 Redis 实例在指定地域下的可用区资源信息，包括可用区 ID。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID，精确查询。说明若该参数留空，表示不使用实例 ID 条件进行筛选。
InstanceName	String	否	api_test	实例名称，支持模糊查询。说明若该参数留空，表示不使用实例名称条件进行筛选。
ShardedCluster	Integer	否	1	实例是否启用分片集群。取值范围如下： `0`：不启用。 `1`：启用。说明若该参数留空，表示不使用实例是否启用分片集群条件进行筛选。
Status	String	否	Running	实例状态。关于实例状态的更多详情，请参见实例状态。说明若该参数留空，表示不使用实例状态条件进行筛选。
EngineVersion	String	否	7.4	实例的数据库版本。企业版实例当前仅支持 `7.4` 版本。说明若该参数留空，表示不使用实例的数据库版本号条件进行筛选。
VpcId	String	否	vpc-rs5811nceqyov0x****	实例所属的私有网络（VPC）ID。支持模糊查询。说明若该参数留空，表示不使用实例的私有网络 ID 条件进行筛选。您可以调用 DescribeVpcs 接口查询当前账号下的所有私有网络列表信息，包括私有网络 ID。
ChargeType	String	否	PostPaid	实例的计费类型。取值范围如下： `PostPaid`：按量计费。 `PrePaid`：包年包月。说明若该参数留空，表示不使用实例的计费类型条件进行筛选。关于计费类型的更多信息，请参见计费类型。
TagFilters	Object[]	否		用于查询筛选的标签键值对数组。说明若该参数留空，表示不使用标签条件进行筛选。
ProjectName	String	否	default	实例所属的项目名称。说明若该参数留空，表示不使用实例的项目名称条件进行筛选。
ServiceType	String	否	Enterprise	实例的服务类型，取值范围如下： `Basic`（默认值）：社区版。 `Enterprise`：企业版。说明如需查询企业版实例，需要将 `ServiceType` 设置为 `Enterprise`。
DataLayout	String	否	RAM	企业版实例的数据存储形态，取值范围如下： `RAM`：内存型。 `Hybrid`：混存型。说明该参数仅对企业版（即`ServiceType`为`Enterprise`）实例有意义；社区版（即`ServiceType`为`Basic`）实例不涉及数据存储形态，`DataLayout`取值固定为`RAM`。若该参数留空，表示不使用数据存储形态进行筛选。关于企业版实例数据存储形态的更多信息，请参见数据存储形态。

返回参数

参数	类型	示例值	描述
TotalInstancesNum	Integer	1	符合查询条件的实例数量。
Instances	Object[]		实例基本信息列表。

示例

请求示例

查询企业版实例详情。

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeDBInstances&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=****
{
    "RegionId": "cn-beijing",
    "PageNumber": 1,
    "PageSize": 10,
    "ServiceType": "Enterprise"
}

返回示例

企业版实例返回详情。

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "DescribeDBInstances",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalInstancesNum": 1,
        "Instances": [
            {
                "InstanceId": "redis-cnlfexqnf6f48****",
                "ProjectName": "default",
                "ShardedCluster": 0,
                "NodeNumber": 2,
                "EngineVersion": "7.4",
                "Tags": [
                    {
                        "Key": "department",
                        "Value": "game"
                    },
                    {
                        "Key": "owner",
                        "Value": "Alice"
                    }
                ],
                "CreateTime": "2024-04-18T14:24:32Z",
                "RegionId": "cn-beijing",
                "ChargeType": "PrePaid",
                "Status": "Running",
                "ExpiredTime": "2024-05-18 00:00:00",
                "InstanceName": "test",
                "MultiAZ": "disabled",
                "ShardNumber": 2,
                "Capacity": {
                    "Total": 36864,
                    "Used": 57
                },
                "DeletionProtection": "disabled",
                "ZoneIds": [
                    "cn-beijing-a"
                ],
                "ServiceType": "Enterprise",
                "ShardCapacity": 36,
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "DataLayout": "RAM",
                "PrivateAddress": "redis-cnlfexqnf6f48****.redis.ivolces.com",
                "PrivatePort": "6379",
                "VIP": "192.168.***.***",
                "VIPv6": ""
            }
        ]
    }
}

错误码

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

最近更新时间：2025.09.25 14:31:44

这个页面对您有帮助吗？

有用

无用

缓存数据库 Redis 企业版

请求类型 #

调试 #

请求参数 #

返回参数 #

示例 #

请求示例 #

返回示例 #

错误码 #

请求类型

调试

请求参数

返回参数

示例

请求示例

返回示例

错误码