首页 云原生内存数据库Tair API参考 API目录 实例管理 DescribeInstancesOverview - 查询实例概览

DescribeInstancesOverview - 查询实例概览

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

接口说明

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

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
InstanceIdsstring

需要查询的实例ID。

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

实例状态,取值:

  • Normal:正常。
  • Creating:创建中。
  • Changing:修改中。
  • Inactive:被禁用。
  • Flushing:清除中。
  • Released:已释放。
  • Transforming:转换中。
  • Unavailable:服务停止。
  • Error:创建失败。
  • Migrating:迁移中。
  • BackupRecovering:备份恢复中。
  • MinorVersionUpgrading:小版本升级中。
  • NetworkModifying:网络变更中。
  • SSLModifying:SSL变更中。
  • MajorVersionUpgrading:大版本升级中,可正常访问。
说明更多实例状态及详细信息,请参见实例状态与影响
Normal
ChargeTypestring

付费类型,取值:

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

网络类型,取值:

  • CLASSIC:经典网络。
  • VPC:专有网络。
CLASSIC
EngineVersionstring

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

4.0
InstanceClassstring

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

redis.master.small.default
VpcIdstring

专有网络ID。

vpc-bp1nme44gek34slfc****
VSwitchIdstring

虚拟交换机ID。

vsw-bp1e7clcw529l773d****
InstanceTypestring

实例类型,取值:

  • Tair
  • Redis
  • Memcache
Redis
SearchKeystring

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

apitest
ArchitectureTypestring

架构类型,取值:

  • cluster:集群版。
  • standard:标准版。
  • rwsplit:读写分离版。
standard
ZoneIdstring

可用区ID。

cn-hangzhou-b
ResourceGroupIdstring

资源组ID。

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

实例类型,取值:

  • Community:社区版。
  • Enterprise:企业版。
Enterprise
PrivateIpstring

专有网络IP地址。

172.16.49.***

返回参数

名称类型描述示例值
object

对象。

RequestIdstring

请求ID。

1E83311F-0EE4-4922-A3BF-730B312B****
TotalCountinteger

实例总个数。

1
Instancesarray

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

object

对象。

VpcIdstring

专有网络ID。

vpc-bp1nme44gek34slfc****
PrivateIpstring

专有网络IP地址。

说明实例的网络类型为经典网络时,不会返回本参数。
172.16.49.***
Capacitylong

实例容量, 单位:MB。

4096
CreateTimestring

实例的创建时间。

2018-11-07T08:49:00Z
ConnectionDomainstring

实例的内网连接地址。

r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ChargeTypestring

付费类型,取值:

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

架构类型,取值:

  • cluster:集群版。
  • standard:标准版。
  • rwsplit:读写分离版。
cluster
NetworkTypestring

网络类型,取值:

  • CLASSIC:经典网络。
  • VPC:专有网络。
CLASSIC
EngineVersionstring

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

4.0
InstanceNamestring

实例的名称。

apitest
GlobalInstanceIdstring

分布式实例ID。

说明当实例为分布式实例中的子实例时,才会返回该参数。
gr-bp14rkqrhac****
InstanceClassstring

实例的规格。

redis.logic.sharding.2g.2db.0rodb.4proxy.default
InstanceIdstring

实例ID。

r-bp1zxszhcgatnx****
InstanceTypestring

实例类型,取值:

  • Tair
  • Redis
  • Memcache
Redis
RegionIdstring

地域ID。

cn-hangzhou
EndTimestring

包年包月实例到期时间。

2022-06-13T16:00:00Z
VSwitchIdstring

虚拟交换机的ID。

vsw-bp1e7clcw529l773d****
ResourceGroupIdstring

实例所属的资源组ID。

rg-acfmyiu4ekp****
ZoneIdstring

可用区ID。

cn-hangzhou-b
InstanceStatusstring

实例状态,取值:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "PrivateIp": "172.16.49.***",
      "Capacity": 4096,
      "CreateTime": "2018-11-07T08:49:00Z",
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PostPaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "4.0",
      "InstanceName": "apitest",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceType": "Redis",
      "RegionId": "cn-hangzhou",
      "EndTime": "2022-06-13T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "ResourceGroupId": "rg-acfmyiu4ekp****",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Normal"
    }
  ]
}

错误码

Http code错误码错误信息
400InvalidInstanceIds.MalformedThe Specified parameter InstanceIds is not valid.

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

变更历史

变更时间变更内容概要操作
2021-11-23新增 OpenAPI
阿里云首页 云原生内存数据库Tair 相关技术圈