1. 接口描述
接口请求域名: redis.api3.fincloud.tencent.com。
查询Redis实例列表
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-11 11:59:23。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeInstances |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-04-12 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 否 | Uint64 | 实例列表的大小,参数默认值20 示例值: 20 |
| Offset | 否 | 否 | Uint64 | 偏移量,取Limit整数倍 示例值: 0 |
| InstanceId | 否 | 否 | String | 实例Id,如:crs-6ubhgouj 示例值: crs-dagpcalj |
| OrderBy | 否 | 否 | String | 枚举范围: projectId,createtime,instancename,type,curDeadline 示例值: instancename |
| OrderType | 否 | 否 | Int64 | 1倒序,0顺序,默认倒序 示例值: 0 |
| VpcIds | 否 | 否 | Array of String | 私有网络ID数组,数组下标从0开始,如果不传则默认选择基础网络,如:47525 示例值: 47525 |
| SubnetIds | 否 | 否 | Array of String | 子网ID数组,数组下标从0开始,如:56854 示例值: 56854 |
| ProjectIds | 否 | 否 | Array of Int64 | 项目ID 组成的数组,数组下标从0开始 示例值: [1289900] |
| SearchKey | 否 | 否 | String | 查找实例的ID。 示例值: 40a150c6N5GcWqm3z94Blr5D3ckRlpqi9mk5iW9clfRybobiPUft2wa_2GtkUfIUzN29y*k2pw== |
| InstanceName | 否 | 否 | String | 实例名称 示例值: crs-dagpcalj |
| UniqVpcIds | 否 | 否 | Array of String | 私有网络ID数组,数组下标从0开始,如果不传则默认选择基础网络,如:vpc-sad23jfdfk 示例值: vpc-b6fsjaxt |
| UniqSubnetIds | 否 | 否 | Array of String | 子网ID数组,数组下标从0开始,如:subnet-fdj24n34j2 示例值: subnet-gqj66zh0 |
| RegionIds | 否 | 否 | Array of Int64 | 地域ID,已经弃用,可通过公共参数Region查询对应地域 示例值: 1 |
| Status | 否 | 否 | Array of Int64 | 实例状态:0-待初始化,1-流程中,2-运行中,-2-已隔离,-3-待删除 示例值: 1 |
| TypeVersion | 否 | 否 | Int64 | 类型版本:1-单机版,2-主从版,3-集群版 示例值: 2 |
| EngineName | 否 | 否 | String | 引擎信息:Redis-2.8,Redis-4.0,CKV 示例值: Redis-4.0 |
| AutoRenew | 否 | 否 | Array of Int64 | 续费模式:0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费 示例值: 1 |
| BillingMode | 否 | 否 | String | 计费模式:postpaid-按量计费;prepaid-包年包月 示例值: prepaid |
| Type | 否 | 否 | Int64 | 实例类型:1-Redis老集群版;2-Redis 2.8主从版;3-CKV主从版;4-CKV集群版;5-Redis 2.8单机版;6-Redis 4.0主从版;7-Redis 4.0集群版;8 – Redis5.0主从版,9 – Redis5.0集群版, 示例值: 8 |
| SearchKeys | 否 | 否 | Array of String | 搜索关键词:支持实例Id、实例名称、完整IP 示例值: ["crs-dagpcalj"] |
| TypeList | 否 | 否 | Array of Int64 | 内部参数,用户可忽略 示例值: 1 |
| MonitorVersion | 否 | 否 | String | 秒级监控:1-1m,0-5s 示例值: 1 |
| InstanceTags | 否 | 否 | Array of TagInfo | 实例tag 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 实例数 示例值: 1 |
| InstanceSet | Array of InstanceSet | 实例详细信息列表 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidParameter | 业务参数错误。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误,可以是 update insert select..。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
| InvalidParameter.EmptyParam | 参数为空。 |
| InvalidParameter | 参数错误 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |