查询Redis实例列表

最近更新时间:2018-12-20 19:20:51

1. 接口描述

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

查询Redis实例列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:redis.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances
Version String 公共参数,本接口取值:2018-04-12
Region String 公共参数,详见产品支持的地域列表
Limit Integer 实例列表的大小,参数默认值20
Offset Integer 偏移量,取Limit整数倍
InstanceId String 实例Id,如:crs-6ubhgouj
OrderBy String 枚举范围: projectId,createtime,instancename,type,curDeadline
OrderType Integer 1倒序,0顺序,默认倒序
VpcIds.N Array of String 私有网络ID数组,数组下标从0开始,如果不传则默认选择基础网络,如:47525
SubnetIds.N Array of String 子网ID数组,数组下标从0开始,如:56854
ProjectIds.N Array of Integer 项目ID 组成的数组,数组下标从0开始
SearchKey String 查找实例的ID。
InstanceName String 实例名称
UniqVpcIds.N Array of String 私有网络ID数组,数组下标从0开始,如果不传则默认选择基础网络,如:vpc-sad23jfdfk
UniqSubnetIds.N Array of String 子网ID数组,数组下标从0开始,如:subnet-fdj24n34j2
RegionIds.N Array of Integer 地域ID,已经弃用,可通过公共参数Region查询对应地域

3. 输出参数

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

4. 示例

示例1 请求示例

输入示例

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

输出示例

{
  "Response": {
    "InstanceSet": [
      {
        "AutoRenewFlag": 0,
        "ProductType": "Redis2.8集群版",
        "Type": 1,
        "Status": 2,
        "VpcId": 0,
        "InstanceId": "crs-6ubhgouj",
        "RegionId": 1,
        "SubnetId": 0,
        "Engine": "社区版Redis",
        "SizeUsed": 0,
        "ProjectId": 0,
        "DeadlineTime": "2020-09-08 16:21:05",
        "ZoneId": 100002,
        "Appid": 251005863,
        "WanIp": "10.66.126.126",
        "InstanceName": "crs-6ubhgouj",
        "Createtime": "2015-06-11 16:54:21",
        "UniqVpcId": "",
        "BillingMode": 1,
        "UniqSubnetId": "",
        "Port": 6379,
        "Size": 2048
      }
    ],
    "TotalCount": 1,
    "RequestId": "03f6c2f8-cd3f-41aa-82b8-3bce0c605da5"
  }
}

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 权限。