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