AI 助理
备案控制台
文档
输入文档关键字查找
首页 云数据库 Tair（兼容 Redis®） 开发参考 OpenAPI集成 API参考 API目录 实例管理 DescribeInstancesOverview - 查询实例概览

DescribeInstancesOverview - 查询实例概览

更新时间：
产品详情
我的收藏

查询一个或多个云数据库 Tair（兼容 Redis）实例的信息概览。

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeInstancesOverviewget
*全部资源
*
    无
无

请求参数

名称类型必填描述示例值
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.8、4.0、5.0、6.0或7.0。

6.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<object>

由 Instance（实例）组成的数组。

KVStoreInstanceobject

对象。

VpcIdstring

专有网络 ID。

vpc-bp1nme44gek34slfc****
PrivateIpstring

专有网络 IP 地址，IP 地址可能会发生变化，请通过 ConnectionDomain（内网连接地址）进行连接。

说明
  • 实例的网络类型为经典网络时，不会返回本参数。
  • 云原生版实例不会返回该参数。
    •
    		172.16.49.***
    Capacitylong

    实例容量， 单位：MB。

    		4096
    CreateTimestring

    实例的创建时间。

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

    实例的内网连接地址。

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

    付费类型，取值：

    • PrePaid：预付费，即包年包月。
    • PostPaid：后付费，即按量付费。
    		PrePaid
    ArchitectureTypestring

    架构类型，取值：

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

    网络类型，取值：

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

    实例兼容的 Redis 版本，返回值：2.8、4.0、5.0、6.0或7.0。

    		6.0
    InstanceNamestring

    实例的名称。

    		apitest
    GlobalInstanceIdstring

    分布式实例 ID。

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

    实例的规格。

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

    实例 ID。

    		r-bp1zxszhcgatnx****
    InstanceTypestring

    实例类型，取值：

    • Tair：Tair（企业版）
    • Redis：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
    SecondaryZoneIdstring

    备可用区 ID。

    说明 当实例存在备可用区 ID 时，才会返回该参数。
    		cn-hangzhou-g

    示例

    正常返回示例

    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": "PrePaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "6.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",
      "SecondaryZoneId": "cn-hangzhou-g"
    }
  ]
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-06-12OpenAPI 错误码发生变更查看变更详情
    2023-03-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2021-11-23新增 OpenAPI查看变更详情
    上一篇：ModifyDBInstanceAutoUpgrade - 修改小版本自动升级开关下一篇：DescribeInstances - 查询实例的列表信息
    文档推荐