云数据库 Redis®
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>云数据库 Redis®>API 文档>实例相关接口>查询Redis实例列表

查询Redis实例列表

最近更新时间：2024-09-27 01:25:14

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeInstances）用于查询Redis实例列表。

默认接口请求频率限制：35次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeInstances。
Version 是 String 公共参数，本接口取值：2018-04-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 否 Integer 每页输出实例的数量，参数默认值20，最大值为1000。
示例值：20
Offset 否 Integer 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。
示例值：0
InstanceId 否 String 指定实例 ID。例如：crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。


示例值：crs-dagpcalj
OrderBy 否 String 实例列表排序依据，枚举值如下所示：
- projectId：依据项目ID排序。
- createtime：依据实例创建时间排序。
- instancename：依据实例名称排序。
- type：依据实例类型排序。
- curDeadline：依据实例到期时间排序。
示例值：instancename
OrderType 否 Integer 实例排序方式，默认为倒序排序。
- 1：倒序。
- 0：顺序。
示例值：0
VpcIds.N 否 Array of String 私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留，可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。
示例值：47525
SubnetIds.N 否 Array of String 私有网络所属子网 ID 数组，例如：56854。该参数暂时保留，可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。
示例值：56854
SearchKey 否 String 设置模糊查询关键字段，仅实例名称支持模糊查询。
示例值：test
ProjectIds.N 否 Array of Integer 项目 ID 组成的数组。
示例值：[1289900]
InstanceName 否 String 实例名称。
示例值：test
UniqVpcIds.N 否 Array of String 私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络，如：vpc-sad23jfdfk。
示例值：vpc-b6fsjaxt
UniqSubnetIds.N 否 Array of String 私有网络所属子网 ID 数组，如：subnet-fdj24n34j2。
示例值：subnet-gqj66zh0
RegionIds.N 否 Array of Integer 地域 ID 数组，该参数已经弃用，可通过公共参数Region查询对应地域。
示例值：1
Status.N 否 Array of Integer 实例状态。
- 0：待初始化。
- 1：流程中。
- 2：运行中。
- -2：已隔离。
- -3：待删除。
示例值：1
TypeVersion 否 Integer 实例架构版本。
- 1：单机版。
- 2：主从版。
- 3：集群版。
示例值：2
EngineName 否 String 存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。
示例值：Redis-4.0
AutoRenew.N 否 Array of Integer 续费模式。
- 0：手动续费。
- 1：自动续费。
- 2：到期不再续费。
示例值：1
BillingMode 否 String 计费模式。
- postpaid：按量计费。
- prepaid：包年包月。
示例值：prepaid
Type 否 Integer 实例类型。
- 2：Redis 2.8 内存版（标准架构）。
- 3：CKV 3.2 内存版（标准架构）。
- 4：CKV 3.2 内存版（集群架构）。
- 5：Redis 2.8 内存版（单机）。
- 6：Redis 4.0 内存版（标准架构）。
- 7：Redis 4.0 内存版（集群架构）。
- 8：Redis 5.0 内存版（标准架构）。
- 9：Redis 5.0 内存版（集群架构）。
- 15：Redis 6.2 内存版（标准架构）。
- 16：Redis 6.2 内存版（集群架构）。
- 17：Redis 7.0 内存版（标准架构）。
- 18：Redis 7.0 内存版（集群架构）。
示例值：8
SearchKeys.N 否 Array of String 该参数为数组类型，支持配置实例名称、实例 ID、IP地址，其中实例名称为模糊匹配，实例 ID 和 IP 地址精确匹配。

- 数组中每一个元素取并集进行匹配查询。
- InstanceId 与 SearchKeys 同时配置，则取二者交集进行匹配查询。
示例值：["crs-dagpcalj"]
TypeList.N 否 Array of Integer 内部参数，用户可忽略。
示例值：1
MonitorVersion 否 String 内部参数，用户可忽略。
示例值：1
InstanceTags.N 否 Array of InstanceTagInfo 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。
TagKeys.N 否 Array of String 根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。
示例值：test
ProductVersions.N 否 Array of String 实例的产品版本。如果该参数不配置或者数组设置为空值，则默认不依据此参数过滤实例。
- local：本地盘版。
- cdc：独享集群版。
示例值：["cdc"]
InstanceIds.N 否 Array of String 批量查询指定的实例 ID，返回结果已 Limit 限制为主。
示例值：["crs-fljrtizn","crs-0tbmwtop","crs-i0n3dutj"]
AzMode 否 String 可用区模式。
- singleaz：单可用区。
- multiaz：多可用区。
示例值：multiaz

3. 输出参数

参数名称 类型 描述
TotalCount Integer 实例总数量。
示例值：1
InstanceSet Array of InstanceSet 实例详细信息列表。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

查询Redis实例列表

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>

{
    "Limit": 2,
    "Offset": 0,
    "OrderBy": "createtime "
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "Appid": 251223628,
                "AutoRenewFlag": 0,
                "BillingMode": 1,
                "ClientLimit": 10000,
                "ClientLimitMax": 40000,
                "ClientLimitMin": 10000,
                "CloseTime": "0000-00-00 00:00:00",
                "Createtime": "2023-04-17 11:32:18",
                "CurrentProxyVersion": "5.8.0",
                "CurrentRedisVersion": "6.0.0",
                "DeadlineTime": "2023-05-17 11:32:18",
                "DedicatedClusterId": "",
                "DiskSize": 0,
                "DtsStatus": 0,
                "Engine": "Redis",
                "InstanceId": "crs-4nmzc0ul",
                "InstanceName": "Redis_automation_is_awesome",
                "InstanceNode": [],
                "InstanceTags": [],
                "InstanceTitle": "添加实例中",
                "MonitorVersion": "5s",
                "NetLimit": 24,
                "NoAuth": false,
                "NodeSet": [
                    {
                        "NodeId": 336948,
                        "NodeType": 0,
                        "ZoneId": 100002,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336946,
                        "NodeType": 1,
                        "ZoneId": 100003,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336947,
                        "NodeType": 1,
                        "ZoneId": 100004,
                        "ZoneName": ""
                    }
                ],
                "OfflineTime": "",
                "PasswordFree": 0,
                "PolarisServer": "",
                "Port": 6379,
                "PriceId": 1000848,
                "ProductType": "standalone",
                "ProductVersion": "local",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "ReadOnly": 0,
                "RedisClusterId": "",
                "RedisReplicasNum": 2,
                "RedisShardNum": 1,
                "RedisShardSize": 4096,
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "RemainBandwidthDuration": "",
                "Size": 4096,
                "SizeUsed": 0,
                "SlaveReadWeight": 0,
                "Status": 1,
                "SubStatus": 37,
                "SubnetId": 2282634,
                "Tags": [],
                "Type": 15,
                "UniqSubnetId": "subnet-1ed4w7to",
                "UniqVpcId": "vpc-mjwornzj",
                "UpgradeProxyVersion": "",
                "UpgradeRedisVersion": "",
                "Vip6": "",
                "VpcId": 11133673,
                "WanAddress": "",
                "WanIp": "10.0.1.61",
                "ZoneId": 100002
            },
            {
                "Appid": 251223628,
                "AutoRenewFlag": 0,
                "BillingMode": 1,
                "ClientLimit": 10000,
                "ClientLimitMax": 40000,
                "ClientLimitMin": 10000,
                "CloseTime": "0000-00-00 00:00:00",
                "Createtime": "2023-04-17 11:47:02",
                "CurrentProxyVersion": "5.5.0",
                "CurrentRedisVersion": "92.0.0",
                "DeadlineTime": "2023-05-17 11:47:01",
                "DedicatedClusterId": "",
                "DiskSize": 0,
                "DtsStatus": 0,
                "Engine": "Redis",
                "InstanceId": "crs-46njvft9",
                "InstanceName": "Redis_automation_is_awesome",
                "InstanceNode": [],
                "InstanceTags": [],
                "InstanceTitle": "运行中",
                "MonitorVersion": "5s",
                "NetLimit": 24,
                "NoAuth": false,
                "NodeSet": [
                    {
                        "NodeId": 336951,
                        "NodeType": 0,
                        "ZoneId": 100002,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336949,
                        "NodeType": 1,
                        "ZoneId": 100003,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336950,
                        "NodeType": 1,
                        "ZoneId": 100004,
                        "ZoneName": ""
                    }
                ],
                "OfflineTime": "",
                "PasswordFree": 0,
                "PolarisServer": "",
                "Port": 6379,
                "PriceId": 1000848,
                "ProductType": "standalone",
                "ProductVersion": "local",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "ReadOnly": 0,
                "RedisClusterId": "",
                "RedisReplicasNum": 2,
                "RedisShardNum": 1,
                "RedisShardSize": 4096,
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "RemainBandwidthDuration": "",
                "Size": 4096,
                "SizeUsed": 0,
                "SlaveReadWeight": 0,
                "Status": 2,
                "SubStatus": 19,
                "SubnetId": 2282634,
                "Tags": [],
                "Type": 6,
                "UniqSubnetId": "subnet-1ed4w7to",
                "UniqVpcId": "vpc-mjwornzj",
                "UpgradeProxyVersion": "",
                "UpgradeRedisVersion": "",
                "Vip6": "",
                "VpcId": 11133673,
                "WanAddress": "",
                "WanIp": "10.0.1.71",
                "ZoneId": 100002
            }
        ],
        "RequestId": "3fb5a4d2-680c-45a2-aa88-0213b76d1489",
        "TotalCount": 8
    }
}

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权限。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnsupportedOperation 操作不支持。
中国站
文档反馈
文档活动
message-icon联系我们
目录