调用DescribeInstancesOverview查询一个或多个Redis实例的信息概览。

若您未指定请求参数,将返回所有实例的信息概览。

说明 该接口返回结果均无分页。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值:DescribeInstancesOverview

RegionId String cn-hangzhou

实例所属的地域ID,可调用DescribeRegions接口获取。

InstanceIds String r-bp1zxszhcgatnx****

需要查询的实例ID。

说明 默认查询该账号下所有实例。如需传入多个实例ID时,使用英文逗号(,)分隔实例ID。
InstanceStatus String Normal

实例状态,取值:

  • Normal:正常。
  • Creating:创建中。
  • Changing:修改中。
  • Inactive:被禁用。
  • Flushing:清除中。
  • Released:已释放。
  • Transforming:转换中。
  • Unavailable:服务停止。
  • Error:创建失败。
  • Migrating:迁移中。
  • BackupRecovering:备份恢复中。
  • MinorVersionUpgrading:小版本升级中。
  • NetworkModifying:网络变更中。
  • SSLModifying:SSL变更中。
  • MajorVersionUpgrading:大版本升级中,可正常访问。
ChargeType String PostPaid

付费类型,取值:

  • PrePaid:预付费,即包年包月。
  • PostPaid:后付费,即按量付费。
NetworkType String CLASSIC

网络类型,取值:

  • CLASSIC:经典网络。
  • VPC:专有网络。
EngineVersion String 4.0

Redis实例的引擎版本,取值:2.84.05.0

InstanceClass String redis.master.small.default

实例规格,请参见实例规格表

VpcId String vpc-bp1nme44gek34slfc****

专有网络ID。

VSwitchId String vsw-bp1e7clcw529l773d****

虚拟交换机ID。

InstanceType String Redis

实例类型,取值:

  • Tair
  • Redis
  • Memcache
SearchKey String apitest

基于实例ID或者实例备注模糊搜索时使用的关键字。

ArchitectureType String standard

架构类型,取值:

  • cluster:集群版。
  • standard:标准版。
  • rwsplit:读写分离版。
ZoneId String cn-hangzhou-b

可用区ID。

ResourceGroupId String rg-acfmyiu4ekp****

资源组ID。

说明 您可以通过调用ListResourceGroups接口或通过控制台获取资源组ID列表。相关操作,请参见查看资源组基本信息
EditionType String Enterprise

实例类型,取值:

  • Community:社区版。
  • Enterprise:企业版。
PrivateIp String 172.16.49.***

专有网络IP地址。

返回数据

名称 类型 示例值 描述
RequestId String 1E83311F-0EE4-4922-A3BF-730B312B****

请求ID。

TotalCount Integer 1

实例总个数。

Instances Array of KVStoreInstance

由Instance(实例)组成的数组。

VpcId String vpc-bp1nme44gek34slfc****

专有网络ID。

PrivateIp String 172.16.49.***

专有网络IP地址。

说明 实例的网络类型为经典网络时,不会返回本参数。
Capacity Long 4096

实例容量, 单位:MB。

CreateTime String 2018-11-07T08:49:00Z

实例的创建时间。

ConnectionDomain String r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

实例的内网连接地址。

ChargeType String PostPaid

付费类型,取值:

  • PrePaid:预付费,即包年包月。
  • PostPaid:后付费,即按量付费。
ArchitectureType String cluster

架构类型,取值:

  • cluster:集群版。
  • standard:标准版。
  • rwsplit:读写分离版。
NetworkType String CLASSIC

网络类型,取值:

  • CLASSIC:经典网络。
  • VPC:专有网络。
ConnectionMode String Standard

实例的访问模式,返回值:

  • Standard:标准访问模式。
  • Safe:数据库代理模式。
Port Long 6379

Redis服务端口。

EngineVersion String 4.0

Redis实例的引擎版本,返回值:2.84.05.0

InstanceName String apitest

实例的名称。

GlobalInstanceId String gr-bp14rkqrhac****

分布式实例ID。

说明 当实例为分布式实例中的子实例时,才会返回该参数。
InstanceClass String redis.logic.sharding.2g.2db.0rodb.4proxy.default

实例的规格。

InstanceId String r-bp1zxszhcgatnx****

实例ID。

InstanceType String Redis

实例类型,取值:

  • Tair
  • Redis
  • Memcache
RegionId String cn-hangzhou

地域ID。

EndTime String 2022-06-13T16:00:00Z

包年包月实例到期时间。

VSwitchId String vsw-bp1e7clcw529l773d****

虚拟交换机的ID。

ResourceGroupId String rg-acfmyiu4ekp****

实例所属的资源组ID。

ZoneId String cn-hangzhou-b

可用区ID。

InstanceStatus String Normal

实例状态,取值:

  • Normal:正常。
  • Creating:创建中。
  • Changing:修改中。
  • Inactive:被禁用。
  • Flushing:清除中。
  • Released:已释放。
  • Transforming:转换中。
  • Unavailable:服务停止。
  • Error:创建失败。
  • Migrating:迁移中。
  • BackupRecovering:备份恢复中。
  • MinorVersionUpgrading:小版本升级中。
  • NetworkModifying:网络变更中。
  • SSLModifying:SSL变更中。
  • MajorVersionUpgrading:大版本升级中,可正常访问。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstancesOverviewResponse>
    <Instances>
        <ArchitectureType>cluster</ArchitectureType>
        <Capacity>32768</Capacity>
        <ChargeType>PrePaid</ChargeType>
        <ConnectionDomain>r-bp1d****letsgv****.tairpena.rds.aliyuncs.com</ConnectionDomain>
        <CreateTime>2021-11-11T06:52:52Z</CreateTime>
        <EndTime>2021-12-11T16:00:00Z</EndTime>
        <EngineVersion>1.0</EngineVersion>
        <InstanceClass>tair.scm.cluster.sharding.common.ce</InstanceClass>
        <InstanceId>r-bp1d****letsgv****</InstanceId>
        <InstanceName>aep***-pull-cluster</InstanceName>
        <InstanceStatus>Normal</InstanceStatus>
        <InstanceType>tair_scm</InstanceType>
        <NetworkType>VPC</NetworkType>
        <PrivateIp>172.16.*.*</PrivateIp>
        <RegionId>cn-hangzhou</RegionId>
        <ResourceGroupId>rg-acfm22c********</ResourceGroupId>
        <VSwitchId>vsw-bp1p9le7ibusm********</VSwitchId>
        <VpcId>vpc-bp1jk5vwkcri2********</VpcId>
        <ZoneId>cn-hangzhou-h</ZoneId>
    </Instances>
    <RequestId>E9848396-E363-5ECE-94D2-E0CF993*****</RequestId>
    <TotalCount>1</TotalCount>
</DescribeInstancesOverviewResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Instances" : [ {
    "ArchitectureType" : "cluster",
    "Capacity" : 32768,
    "ChargeType" : "PrePaid",
    "ConnectionDomain" : "r-bp1d****letsgv****.tairpena.rds.aliyuncs.com",
    "CreateTime" : "2021-11-11T06:52:52Z",
    "EndTime" : "2021-12-11T16:00:00Z",
    "EngineVersion" : "1.0",
    "InstanceClass" : "tair.scm.cluster.sharding.common.ce",
    "InstanceId" : "r-bp1d****letsgv****",
    "InstanceName" : "aep***-pull-cluster",
    "InstanceStatus" : "Normal",
    "InstanceType" : "tair_scm",
    "NetworkType" : "VPC",
    "PrivateIp" : "172.16.*.*",
    "RegionId" : "cn-hangzhou",
    "ResourceGroupId" : "rg-acfm22c********",
    "VSwitchId" : "vsw-bp1p9le7ibusm********",
    "VpcId" : "vpc-bp1jk5vwkcri2********",
    "ZoneId" : "cn-hangzhou-h"
  } ],
  "RequestId" : "E9848396-E363-5ECE-94D2-E0CF993*****",
  "TotalCount" : 1
}

错误码

访问错误中心查看更多错误码。