You need to enable JavaScript to run this app.
导航
DescribeDBInstances
最近更新时间:2024.06.17 10:22:58首次发布时间:2021.11.15 16:07:16

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

请求类型

同步请求。

请求参数

参数
类型
是否必选
示例值
描述
RegionId
String
cn-beijing

实例所属的地域 ID。

说明

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

PageNumber
Integer
1
实例信息列表的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。
PageSize
Integer
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
5.0

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

  • 5.0
  • 6.0
  • 7.0

说明

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

VpcId
String
vpc-2743n1ihbxla87fap8tap****

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

说明

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

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

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

说明

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

TagFilters
Object[]
用于查询筛选的标签键值对数组。
ProjectName
String
default

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

说明

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

ServiceType
String
Basic

实例的服务类型。当前仅支持 Basic 社区版服务类型。

说明

若该参数留空,表示不使用实例的服务类型条件进行筛选。

返回参数

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

示例

请求示例

查询社区版实例详情。

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,
	"ServiceType":"Basic"
}

返回示例

社区版实例返回详情。

{
     "ResponseMetadata": {
          "RequestId": "202204151542080102120420191760****",
          "Action": "DescribeDBInstances",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": {
          "Instances": [
               { 
                  "Capacity": {
                      "Total": 2048,
                      "Used":57 
                      }, 
                  "ChargeType": "PostPaid", 
                  "CreateTime": "2024-04-30T14:24:32Z",
                  "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
      }
}

错误码

更多详情,请参见错误码