查询Redis实例列表

最近更新时间:2018-09-21 11:33:30

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

查询Redis实例列表

默认接口请求频率限制:20次/每秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances
Version String 公共参数,本接口取值:2018-04-12
Region String 公共参数,本接口不需要传递此参数。
Limit Integer 实例列表大小
Offset Integer 偏移量,取Limit整数倍
InstanceId String 实例Id
OrderBy String 枚举范围: projectId,createtime,instancename,type,curDeadline
OrderType Integer 1倒序,0顺序,默认倒序
VpcIds.N Array of String 私有网络ID数组,数组下标从0开始,如果不传则默认选择基础网络
SubnetIds.N Array of String 子网ID数组,数组下标从0开始
ProjectIds.N Array of Integer 项目ID 组成的数组,数组下标从0开始
SearchKey String 查找实例的ID。
RegionIds.N Array of Integer 查询的Region的列表。
InstanceName String 实例名称

3. 输出参数

参数名称 类型 描述
TotalCount Integer 实例数
InstanceSet Array of InstanceSet 实例详细信息列表
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeInstances
&Limit=5
&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RedisSets": [
      {
        "Appid": 251005863,
        "AutoRenewFlag": 0,
        "Createtime": "2018-05-21 14:08:13",
        "DeadlineTime": "2019-01-21 14:08:13",
        "Port": 6380,
        "ProjectId": 0,
        "RedisId": "crs-inha6znn",
        "RedisName": "crs-inha6znn",
        "RegionId": 1,
        "Size": 2048,
        "SizeUsed": 0,
        "Status": 2,
        "SubnetId": 43513,
        "Type": 2,
        "UnSubnetId": "",
        "UnVpcId": "",
        "VpcId": 74187,
        "WanIp": "172.16.0.30",
        "ZoneId": 100002
      },
      {
        "Appid": 251005863,
        "AutoRenewFlag": 0,
        "Createtime": "2018-05-31 15:10:37",
        "DeadlineTime": "2018-07-31 15:10:37",
        "Port": 6378,
        "ProjectId": 0,
        "RedisId": "crs-isoxewbz",
        "RedisName": "crs-api-测试专用实例",
        "RegionId": 1,
        "Size": 1024,
        "SizeUsed": 0,
        "Status": 2,
        "SubnetId": 43513,
        "Type": 2,
        "UnSubnetId": "",
        "UnVpcId": "",
        "VpcId": 74187,
        "WanIp": "172.16.0.41",
        "ZoneId": 100002
      },
      {
        "Appid": 251005863,
        "AutoRenewFlag": 0,
        "Createtime": "2018-07-23 18:37:57",
        "DeadlineTime": "2018-08-23 18:37:57",
        "Port": 6379,
        "ProjectId": 0,
        "RedisId": "crs-jflhdhs3",
        "RedisName": "crs-jflhdhs3",
        "RegionId": 1,
        "Size": 4096,
        "SizeUsed": 0,
        "Status": 2,
        "SubnetId": 44142,
        "Type": 3,
        "UnSubnetId": "",
        "UnVpcId": "",
        "VpcId": 75101,
        "WanIp": "10.0.0.7",
        "ZoneId": 100002
      },
      {
        "Appid": 251005863,
        "AutoRenewFlag": 1,
        "Createtime": "2018-08-06 10:09:15",
        "DeadlineTime": "2018-12-06 10:09:15",
        "Port": 6379,
        "ProjectId": 0,
        "RedisId": "crs-a8m3x6x5",
        "RedisName": "crs-a8m3x6x5-回归实例",
        "RegionId": 1,
        "Size": 1024,
        "SizeUsed": 0,
        "Status": 2,
        "SubnetId": 44142,
        "Type": 5,
        "UnSubnetId": "",
        "UnVpcId": "",
        "VpcId": 75101,
        "WanIp": "10.0.0.68",
        "ZoneId": 100002
      },
      {
        "Appid": 251005863,
        "AutoRenewFlag": 2,
        "Createtime": "2018-08-06 14:41:29",
        "DeadlineTime": "2018-10-06 18:16:40",
        "Port": 6379,
        "ProjectId": 0,
        "RedisId": "crs-leew5zfx",
        "RedisName": "crs-leew5zfx",
        "RegionId": 1,
        "Size": 1024,
        "SizeUsed": 0,
        "Status": 2,
        "SubnetId": 44142,
        "Type": 2,
        "UnSubnetId": "",
        "UnVpcId": "",
        "VpcId": 75101,
        "WanIp": "10.0.0.126",
        "ZoneId": 100002
      }
    ],
    "RequestId": "60f4bc65-85c0-4325-818c-f15fc3de5fc3",
    "TotalCount": 48
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError.DbOperationFailed 统的 DB 操作错误,可以是 update insert select..。
InvalidParameter 参数错误
InvalidParameter.EmptyParam 参数为空。
InvalidParameter.InvalidParameter 业务参数错误。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。