首页 云原生内存数据库Tair API参考 API目录 实例管理 DescribeInstances - 查询实例的列表信息

DescribeInstances - 查询实例的列表信息

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

调试

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

调试

授权信息

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

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

请求参数

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

实例所属的地域ID。

说明调用本接口时,如果传入了Tag参数,则本参数必须传入。
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****
PageNumberinteger

实例列表的页码,起始值为1,默认值为1

1
PageSizeinteger

每页最多可显示的行数,最大值为50,默认值为10

10
InstanceTypestring

实例类型,取值:

  • Tair
  • Redis
  • Memcache
Redis
SearchKeystring

支持模糊搜索实例名称或实例ID。

apitest
ArchitectureTypestring

架构类型,取值:

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

实例的过期状态,取值:

  • true:已过期。
  • false:未过期。
false
ZoneIdstring

可用区ID。

cn-hongkong-b
ResourceGroupIdstring

资源组ID。

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

返回的实例列表中,是否过滤分布式实例中的子实例,取值:

  • true:只返回子实例信息。
  • false:不返回子实例信息。
true
EditionTypestring

实例类型,取值:

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

专有网络IP地址。

172.16.49.***
Tagarray

实例的标签信息。

object

对象。

Keystring

标签的键,与Tag Value组成标签的键值对。

说明单次最多支持传入5组标签的键值对。
存储类型
Valuestring

标签键的值,与Tag Key组成标签的键值对。

本地盘

返回参数

名称类型描述示例值
object

对象。

RequestIdstring

请求ID。

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

实例列表的页码。

1
PageSizeinteger

输入时设置的每页行数。

30
TotalCountinteger

实例总个数。

1
Instancesarray

由Instance组成的集合。

object

对象。

VpcIdstring

专有网络(VPC)的ID。

vpc-bp1nme44gek34slfc****
PrivateIpstring

专有网络IP地址。

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

实例容量, 单位:MB。

4096
ReplacateIdstring

多活实例的逻辑ID。

grr-bp11381ebc16****
CreateTimestring

实例的创建时间。

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

实例的内网连接地址。

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

是否属RDS管控,返回值:

  • true:是。
  • false:否。
true
ChargeTypestring

付费类型,返回值:

  • PrePaid:预付费。
  • PostPaid:后付费。
PostPaid
ArchitectureTypestring

架构类型,返回值:

  • cluster:集群版。
  • standard:标准版。
  • rwsplit:读写分离版。
  • NULL:所有类型,默认值。
cluster
NetworkTypestring

网络类型,返回值:

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

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

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

Redis服务端口。

6379
SecondaryZoneIdstring

备可用区ID。

说明ZoneId参数已返回多可用区,例如"cn-hangzhou-MAZ10(h,i)",本参数将不返回备可用区ID。
cn-hangzhou-h
EngineVersionstring

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

4.0
PackageTypestring

套餐类型,返回值:

  • standard:标准套餐。
  • customized:定制套餐。
standard
Configstring

实例的参数设置情况,详情请参见参数设置

{\"maxmemory-policy\":\"volatile-lfu\",\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64,\"#no_loose_disabled-commands\":\"flushall,flushdb\",\"lazyfree-lazy-eviction\":\"yes\"}
Bandwidthlong

实例带宽,单位:MB/s。

96
InstanceNamestring

实例的名称。

apitest
ShardCountinteger

集群的数据节点数量。

说明当Redis实例为云盘版(集群架构)时才会返回本参数。
3
UserNamestring

连接使用的用户名,默认包含有一个以实例ID命名的用户名。

r-bp1zxszhcgatnx****
GlobalInstanceIdstring

分布式实例ID。

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

每秒请求数(Queries per Second)。

100000
InstanceClassstring

实例的规格。

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

销毁实例的时间。

2019-04-28T10:03:01Z
InstanceIdstring

实例的ID。

r-bp1zxszhcgatnx****
InstanceTypestring

实例类型,返回值:

  • Tair
  • Redis
  • Memcache
Redis
HasRenewChangeOrderboolean

是否有未生效的续费变配订单,返回值:

  • true:是。
  • false:否。
false
RegionIdstring

地域ID。

cn-hangzhou
EndTimestring

包年包月实例到期时间。

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

虚拟交换机的ID。

vsw-bp1e7clcw529l773d****
NodeTypestring

节点类型,返回值:

  • double:双副本。
  • single:单副本(已下线)。
double
Connectionslong

实例的连接数限制。

20000
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
CloudTypestring

仅云盒实例显示该参数。

cloudbox
EditionTypestring

实例类型,取值:

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

标签信息。

object

对象。

Keystring

Tag的Key。

key1
Valuestring

Tag的Value。

value1

示例

正常返回示例

JSON格式

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Instances": {
    "KVStoreInstance": [
      {
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "PrivateIp": "172.16.49.***",
        "Capacity": 4096,
        "ReplacateId": "grr-bp11381ebc16****",
        "CreateTime": "2018-11-07T08:49:00Z",
        "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "IsRds": true,
        "ChargeType": "PostPaid",
        "ArchitectureType": "cluster",
        "NetworkType": "CLASSIC",
        "ConnectionMode": "Standard",
        "Port": 6379,
        "SecondaryZoneId": "cn-hangzhou-h",
        "EngineVersion": "4.0",
        "PackageType": "standard",
        "Config": "{\\\"maxmemory-policy\\\":\\\"volatile-lfu\\\",\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64,\\\"#no_loose_disabled-commands\\\":\\\"flushall,flushdb\\\",\\\"lazyfree-lazy-eviction\\\":\\\"yes\\\"}",
        "Bandwidth": 96,
        "InstanceName": "apitest",
        "ShardCount": 3,
        "UserName": "r-bp1zxszhcgatnx****",
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "QPS": 100000,
        "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
        "DestroyTime": "2019-04-28T10:03:01Z",
        "InstanceId": "r-bp1zxszhcgatnx****",
        "InstanceType": "Redis",
        "HasRenewChangeOrder": true,
        "RegionId": "cn-hangzhou",
        "EndTime": "2019-06-13T16:00:00Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "NodeType": "double",
        "Connections": 20000,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "InstanceStatus": "Normal",
        "CloudType": "cloudbox",
        "EditionType": "Enterprise",
        "Tags": {
          "Tag": [
            {
              "Key": "key1",
              "Value": "value1"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2022-03-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-03-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
阿里云首页 云原生内存数据库Tair 相关技术圈