You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

DescribeDBInstances

最近更新时间：2024.01.09 20:04:37

首次发布时间：2021.11.15 16:07:16

我的收藏

调用 DescribeDBInstances 接口查询一个或多个 Redis 实例的基本信息。

请求类型

同步请求。

请求参数

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

RegionId

String

是

cn-beijing

实例所属的地域 ID。

说明

您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。

PageNumberInteger是1实例信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSizeInteger是10每页记录数。取值为 1~100 间的整数。

ZoneId

String

否

cn-beijing-a

实例所属的可用区 ID，支持模糊查询。

说明

您可以调用 DescribeZones 接口查询 Redis 实例在指定地域下的可用区资源信息，包括可用区 ID。

InstanceId

String

否

redis-cn0212gzmh2xs****

实例ID，支持模糊查询。

说明

若该参数留空，表示不使用实例 ID 条件进行筛选。

InstanceName

String

否

api_test

实例名称，支持模糊查询。

说明

若该参数留空，表示不使用实例名称条件进行筛选。

ShardedCluster

Integer

否

1

实例是否启用分片集群。取值范围如下：

  • 0：不启用。
  • 1：启用。

说明

若该参数留空，表示不使用实例是否启用分片集群条件进行筛选。

Status

String

否

Running

实例状态。关于实例状态的更多详情，请参见实例状态说明。
若该参数留空，表示不使用实例状态条件进行筛选。

EngineVersion

String

否

6.0

实例的数据库版本号。取值范围如下：

  • 4.0
  • 5.0
  • 6.0

说明

若该参数留空，表示不使用实例的数据库版本号条件进行筛选。

VpcId

String

否

vpc-2743n1ihbxla87fap8tap****

实例所属的私有网络（VPC）ID。支持模糊查询。

说明

  • 若该参数留空，表示不使用实例的私有网络 ID 条件进行筛选。
  • 您可以调用 DescribeVpcs 接口查询当前账号下的所有私有网络列表信息，包括私有网络 ID。

ChargeType

String

否

PostPaid

实例的计费类型。取值范围如下：

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

说明

若该参数留空，表示不使用实例的计费类型条件进行筛选。关于计费类型的更多信息，请参见按量计费和包年包月。

TagFilters

Array of TagFilterInfo

否

[
{
"Key": "department",
"Value": "game"
},
{
"Key": "owner",
"Value": "Alice"
}
]

用于查询筛选的标签键值对数组。关于 Tags 的更多说明，请参见数据结构。

说明

  • 当需要使用标签对查询结果进行筛选时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示不对标签值作限制，会搜索所有绑定了指定标签键的实例。
  • 单次最多支持同时传入 10 组标签键值对进行查询筛选。

ProjectName

String

否

default

指定实例所属的项目名称。

说明

若该参数留空，表示不使用实例的项目名称条件进行筛选。

返回数据

名称类型示例值描述
InstancesArray of InstanceInfo请参见返回示例。实例基本信息列表。 关于 Instances 的详细说明，请参见数据结构。
TotalInstancesNumInteger1符合查询条件的实例数量。

请求示例

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

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151542080102120420191760****",
          "Action": "DescribeDBInstances",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": {
          "Instances": [
               { 
                  "Capacity": {
                      "Total": 2048,
                      "Used":57 
                      }, 
                  "ChargeType": "PostPaid", 
                  "CreateTime": "2021-11-08T07:04:56Z",
                  "DeletionProtection": "disabled", 
                  "EngineVersion": "5.0",
                  "ExpiredTime": "",
                  "InstanceClass": "PrimarySecondary",
                  "InstanceId": "redis-cn0212gzmh2xs****", 
                  "InstanceName": "test", 
                  "NodeNumber": 2,
                  "ProjectName": "default",
                  "MultiAZ": "disabled",
                  "RegionId": "cn-beijing",
                  "ShardCapacity": 1, 
                  "ShardNumber": 2, 
                  "ShardedCluster": 1, 
                  "Status": "Running",
                  "Tags": [
                    {
                        "Key": "owner",
                        "Value": "Alice"
                    },
                    {
                        "Key": "department",
                        "Value": "game"
                    }
                  ],      
                  "VpcId" :"vpc-rs5811nceqyov0x58x4****",
                  "ZoneIds": [ 
											"cn-beijing-a" 
									]
               }
           ],
           "TotalInstancesNum": 1
      }
}

错误码

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