有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 Redis > API 文档 > 实例相关接口 > 查询Redis实例列表信息(已废弃)

1. 接口描述

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

查询Redis实例列表信息。该接口已废弃。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCommonDBInstances。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
VpcIds.N Array of Integer vpc网络ID信息列表
示例值:crs-deindi7de
SubnetIds.N Array of Integer 子网ID信息列表
示例值:null
PayMode Integer 计费类型过滤列表;0表示包年包月,1表示按量计费
示例值:0
InstanceIds.N Array of String 实例ID过滤信息列表
示例值:["crs-nh47ubwr\n"]
InstanceNames.N Array of String 实例名称过滤信息列表
示例值:null
Status.N Array of String 实例状态信息过滤列表
示例值:null
OrderBy String 排序字段
示例值:null
OrderByType String 排序方式
示例值:null
Vips.N Array of String 实例vip信息列表
示例值:null
UniqVpcIds.N Array of String vpc网络ID信息列表
示例值:null
UniqSubnetIds.N Array of String 子网统一ID列表
示例值:null
Limit Integer 数量限制,默认推荐100
示例值:20
Offset Integer 偏移量,默认0
示例值:0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 实例数
示例值:1
InstanceDetails Array of RedisCommonInstanceList 实例信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

废弃接口

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeCommonDBInstances
&PayMode=0
&InstanceIds.0=crs-nh47ubwr
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 0,
        "InstanceDetails": [
            {
                "InstanceName": "abc",
                "InstanceId": "abc",
                "AppId": 0,
                "ProjectId": 0,
                "Region": "abc",
                "Zone": "abc",
                "VpcId": "abc",
                "SubnetId": "abc",
                "Status": "abc",
                "Vips": [
                    "abc"
                ],
                "Vport": 0,
                "Createtime": "abc",
                "PayMode": 0,
                "NetType": 0
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.Unknown weekday输入无效数据。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InvalidParameter 参数错误。
InvalidParameter.EmptyParam 参数为空。
InvalidParameter.InvalidParameter 业务参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。