全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 更多
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 智能硬件
云数据库 Redis 版

DescribeInstances

更新时间:2017-10-26 15:39:24

描述

查询账户下的某一个或多个实例信息。

请求参数

名称 类型 是否必须 描述
<公共请求参数> - - 参见公共请求参数
Action String 操作接口名,取值:DescribeInstances。
InstanceIds String 实例 ID(全局唯一)。
指定实例 ID 时需输入。若查询多个实例 ID 时,使用英文半角(“,”)分隔各 ID;置空时默认为查询该用户名下所有实例。
InstanceStatus String 按状态过滤所需返回的实例:
- Normal:正常
- Creating:创建中
- Changing:修改中
- Inactive: 被禁用
ChargeType String 按付费类型过滤所需返回的实例:
- PrePaid:预付费
- PostPaid:后付费
RegionId String 调用 DescribeRegions 查询 RegionId。
InstanceType String 引擎类型的过滤。
- Memcache:Memcache 类型的实例
- Redis:Redis 类型的实例
PageNumber Integer 实例状态列表的页码,起始值为1,默认值为1。
PageSize Integer 分页查询时设置的每页行数,最大值50行,默认值为10。
NetworkType String 按网络类型过滤:
- CLASSIC:经典网络类型
- VPC:VPC 网络类型

返回参数

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

Instance 的参数构成

名称 类型 描述
InstanceId String 实例 ID (全局唯一)
InstanceName String 实例名称
Capacity Long 申请到的存储实例容量; 单位:Mbyte。
InstanceClass String 实例规格信息
Bandwidth Long 实例带宽限制;单位:Mbps。
Connections Long 实例连接数限制;单位:个。
ConnectionDomain String 实例连接域名(仅支持内网访问。)
Port Int 连接端口
UserName String 连接用户名
RegionId String 申请的存储实例所在区域
ZoneId String RegionId 下级可用区编码
InstanceStatus String 实例状态:
- Normal:正常
- Creating:创建中
- Changing:修改中
- Inactive: 被禁用
- Transforming : 转换中
- BackupRecovering: 备份恢复中
- MinorVersionUpgrading: 实例小版本升级中
ChargeType String 付费类型:PrePaid 或 PostPaid
CreateTime String 实例创建时间。
ISO8601 表示法,并使用 UTC 时间。格式为: YYYY-MM-DDThh:mm:ssZ
EndTime String 预付费实例到期时间。
ISO8601 表示法,并使用 UTC 时间。格式为: YYYY-MM-DDThh:mm:ssZ
NetworkType String 网络类型:CLASSIC 或 VPC
VpcId String VPC 的 ID
VSwitchId String 虚拟交换机 ID
PrivateIpAddr String 私有 IP 地址

注意:出于历史兼容性考虑,该函数会有些返回结构在文档中并未提及(如 Config),后续阿里云将逐步把这些字段删除,请您在调用 API 时不要依赖这些在文档中没有涉及的返回字段。

示例

请求示例

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

返回示例

  1. {
  2. "Instances" : {
  3. "Instance" : [{
  4. "Bandwidth" : 128,
  5. "Capacity" : 512,
  6. "ConnectionDomain" : "de5d88e34d004211.m.cnhzalicm10pub001.r-kvstore.aliyuncs.com.com",
  7. "Connections" : 300,
  8. "ZoneId" : "cn-qingdao-b",
  9. "InstanceId" : "de5d88e34d004211",
  10. "InstanceName" : "wl123456",
  11. "InstanceStatus" : "Available",
  12. "InstanceClass" : "redis.master.mid.default",
  13. "Port" : 11211,
  14. "RegionId" : "cn-qingdao",
  15. "UserName" : "de5d88e34d004211"
  16. NetworkType”:”CLASSSIC
  17. ChargeType”:” PostPaid
  18. }
  19. ]
  20. },
  21. "PageNumber" : 1,
  22. "PageSize" : 10,
  23. "TotalCount" : 1,
  24. "RequestId" : "969D0A1D-C91A-4837-9F70-49785DF9BDCE"
  25. }
本文导读目录