调用该API可以查询账户下的某一个或多个实例信息。

请求参数

表 1. 请求参数
名称 类型 是否必须 描述
<公共请求参数> - - 参见公共请求参数
Action String 操作接口名,取值:DescribeInstances。
InstanceIds String 实例 ID(全局唯一)。指定实例 ID 时需输入。若查询多个实例 ID 时,使用英文半角逗号(“,”)分隔各 ID;置空时默认为查询该用户名下所有实例。
InstanceStatus String

按状态过滤所需返回的实例:

  • Normal:正常
  • Creating:创建中
  • Changing:修改中
  • Inactive:被禁用
  • Flushing:清除中
  • Released:已释放
  • Transforming:转换中
  • Available:使用中
  • Unavailable:服务停止
  • Error:创建失败
  • Migrating:迁移中
  • BackupRecovering:备份恢复中
  • MinorVersionUpgrading:小版本升级中
  • NetworkModifying:网络变更中
  • SSLModifying:SSL变更中
  • MajorVersionUpgrading :大版本升级中,可正常访问
ChargeType String 按付费类型过滤所需返回的实例:
  • PrePaid:预付费
  • PostPaid:后付费
RegionId String 调用 DescribeRegions 查询 RegionId。
InstanceType String 引擎类型的过滤。
  • Memcache:Memcache 类型的实例
  • Redis:Redis 类型的实例
PageNumber Integer 实例状态列表的页码,起始值为1,默认值为1。
PageSize Integer 分页查询时设置的每页行数,最大值50行,默认值为10。
EngineVersion String 按数据库版本过滤:2.8或4.0。
InstanceClass String 按实例规格过滤。请参见实例规格表
ArchitectureType String 指定架构类型返回实例列表,standard:标准,cluster:集群,SplitRW:读写分离,非必须,默认为空,返回所有实例列表
VpcId String 按VPC的ID过滤。
VSwitchId String 按路由器的ID过滤。
SearchKey String 按实例名称查询。
Expired String 按即将到期的实例查询。
ZoneId String 按可用区过滤。例如:cn-hangzhou-b
NetworkType String 按网络类型过滤:
  • CLASSIC:经典网络类型
  • VPC:VPC 网络类型

返回参数

表 2. 返回参数
名称 类型 描述
<公共返回参数> - 参见公共返回参数
Instances List 由 Instance 组成的数组
TotalCount Integer 实例总个数
PageNumber Integer 实例列表的页码
PageSize Integer 输入时设置的每页行数

Instance 的参数构成

名称 类型 描述
InstanceId String 实例 ID (全局唯一)
SearchKey String 实例名称
ConnectionDomain String 实例连接域名(仅支持内网访问)
Port Long 连接端口
UserName String 连接用户名
RegionId String 区域ID
Capacity Long 申请到的存储实例容量; 单位:MB。
InstanceClass String 实例的规格
InstanceStatus String 实例的状态
QPS Long QPS(Query per Second)
Bandwidth Long 带宽
Connections Long 连接数
ZoneId String 区域的可用区ID
Config String 配置
ChargeType String 交易类型
NetworkType String 网络类型:
  • CLASSIC:经典网络
  • VPC:VPC 网络
VpcId String VPC 的 ID
VSwitchId String 虚拟交换机或路由器 ID
PrivateIp String 私有 IP 地址
CreateTime String 创建时间
EndTime String 结束时间
HasRenewChangeOrder String 是否有续费订单
IsRds Boolean 是否属于RDS
InstanceType String

实例引擎类型:

  • Memcache类型的实例
  • Redis 类型的实例
ArchitectureType String

架构类型:

  • cluster:集群版
  • standard:标准版
  • SplitRW:读写分离版
  • 为空即显示所有架构类型,默认为NULL
NodeType String 节点类型
PackageType String

套餐类型:

  • standard:标准套餐
  • customized:定制套餐
EngineVersion String 数据库版本:2.8或4.0
DestroyTime String 销毁实例的时间
ConnectionMode String 网络连接模式
注意 出于历史兼容性考虑,该函数会有些返回结构在文档中并未提及(如 Config),后续阿里云将逐步把这些字段删除,请您在调用 API 时不要依赖这些在文档中没有涉及的返回字段。

请求示例

https://r-kvstore.aliyuncs.com.com/
?<公共请求参数>
&Action=DescribeInstances
&PageNumber=1
&PageSize=10
&InstanceId=de5d88e34d004211

返回示例

{
    "Instances" : {
        "Instance" : [{
                "Bandwidth" : 128,
                "Capacity" : 512,
                "ConnectionDomain" : "de5d88e34d004211.m.cnhzalicm10pub001.r-kvstore.aliyuncs.com.com",
                "Connections" : 300,
                "ZoneId" : "cn-qingdao-b",
                "InstanceId" : "de5d88e34d004211",
                "InstanceName" : "wl123456",
                "InstanceStatus" : "Available",
                 "InstanceClass" : "redis.master.mid.default",
                "Port" : 11211,
                "RegionId" : "cn-qingdao",
                "UserName" : "de5d88e34d004211"
                “NetworkType”:”CLASSSIC”
“ChargeType”:” PostPaid”
            }
        ]
    },
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 1,
    "RequestId" : "969D0A1D-C91A-4837-9F70-49785DF9BDCE"
}