操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

查询Redis实例列表接口请求域名: redis.tencentcloudapi.com 。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 每页输出实例的数量,参数默认值20,最大值为1000。
Offset Integer 分页偏移量,取Limit整数倍。
InstanceId String 实例 ID,如:crs-6ubhgouj。
OrderBy String 实例排序依据,枚举值如下所示:
  • projectId:项目ID。
  • createtime:实例创建时间。
  • instancename:实例名称。
  • type:实例类型。
  • curDeadline:实例到期时间。
OrderType Integer 实例排序方式,默认为倒序排序。
  • 1:倒序。
  • 0:顺序。
VpcIds.N Array of String 私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留,可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。
SubnetIds.N Array of String 私有网络所属子网 ID 数组,例如:56854。该参数暂时保留,可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。
SearchKey String 设置模糊查询关键字,支持根据实例名称或实例ID模糊查询实例。
ProjectIds.N Array of Integer 项目 ID 组成的数组。
InstanceName String 实例名称。
UniqVpcIds.N Array of String 私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络,如:vpc-sad23jfdfk。
UniqSubnetIds.N Array of String 私有网络所属子网 ID 数组,如:subnet-fdj24n34j2。
RegionIds.N Array of Integer 地域 ID 数组,该参数已经弃用,可通过公共参数Region查询对应地域。
Status.N Array of Integer 实例状态。
  • 0:待初始化。
  • 1:流程中。
  • 2:运行中。
  • -2:已隔离。
  • -3:待删除。
TypeVersion Integer 实例架构版本。
  • 1:单机版。
  • 2:主从版。
  • 3:集群版。
EngineName String 存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。
AutoRenew.N Array of Integer 续费模式。
  • 0:默认状态(手动续费)。
  • 1:自动续费。
  • 2:明确不自动续费。
BillingMode String 计费模式。
  • postpaid:按量计费。
  • prepaid:包年包月。
Type Integer 实例类型。
  • 1:Redis 老集群版。
  • 2:Redis 2.8 主从版。
  • 3:CKV 主从版。
  • 4:CKV 集群版。
  • 5:Redis 2.8 单机版。
  • 6:Redis 4.0主从版。
  • 7:Redis 4.0 集群版。
  • 8:Redis 5.0 主从版。
  • 9:Redis 5.0 集群版。
SearchKeys.N Array of String 设置搜索关键字数组,可根据实例ID、实例名称、完整IP地址查询实例。
TypeList.N Array of Integer 内部参数,用户可忽略。
MonitorVersion String 内部参数,用户可忽略。
InstanceTags.N Array of InstanceTagInfo 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。
TagKeys.N Array of String 根据标签的 Key 筛选资源,该参数不配置或者数组设置为空值,则不根据标签Key进行过滤。
ProductVersions.N Array of String 实例的产品版本。如果该参数不配置或者数组设置为空值,则默认不依据此参数过滤实例。
  • local:本地盘版。
  • cloud:云盘版。
  • cdc:独享集群版。
InstanceIds.N Array of String 批量查询指定的实例 ID,返回结果已 Limit 限制为主。
AzMode String 可用区模式。
  • singleaz:单可用区。
  • multiaz:多可用区。

3. 输出参数

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

4. 示例

示例1 请求示例

输入示例

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

{
    "Limit": "1",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "WanAddress": "xx",
                "RedisShardSize": 1024,
                "RedisShardNum": 3,
                "MonitorVersion": "xx",
                "UpgradeProxyVersion": "5.6.0",
                "InstanceTitle": "xx",
                "ProductType": "xx",
                "UpgradeRedisVersion": "6.2.5",
                "NoAuth": true,
                "PriceId": 13380,
                "Type": 7,
                "Status": 2,
                "Vip6": "xx",
                "VpcId": 0,
                "InstanceNode": [
                    {
                        "InstanceClusterNode": [
                            {
                                "Status": 0,
                                "Name": "xx",
                                "Keys": 0,
                                "Storage": 0,
                                "StorageSlope": 0.0,
                                "QpsSlope": 0.0,
                                "Connected": 0,
                                "RunId": "xx",
                                "DownTime": "xx",
                                "Qps": 0,
                                "Slots": "xx",
                                "CreateTime": "xx",
                                "Role": 0
                            }
                        ],
                        "Id": 0
                    }
                ],
                "Tags": [
                    "xx"
                ],
                "InstanceId": "xx",
                "ClientLimitMax": 0,
                "RegionId": 1,
                "SubStatus": 19,
                "SlaveReadWeight": 0,
                "AutoRenewFlag": 0,
                "OfflineTime": "xx",
                "SubnetId": 0,
                "NodeSet": [
                    {
                        "ZoneName": "xx",
                        "NodeType": 0,
                        "NodeId": 0,
                        "ZoneId": 1
                    }
                ],
                "DiskSize": 0,
                "Engine": "xx",
                "SizeUsed": 0.0,
                "InstanceTags": [
                    {
                        "TagKey": "tke-clusterId",
                        "TagValue": "cls-0kl4et00"
                    }
                ],
                "ProjectId": 0,
                "Region": "xx",
                "DeadlineTime": "2022-11-02 15:04:05",
                "CloseTime": "2022-11-10 15:04:06",
                "ZoneId": 100002,
                "PasswordFree": 0,
                "Appid": 1251006373,
                "WanIp": "xx",
                "NetLimit": 480,
                "InstanceName": "crs-test",
                "Createtime": "2022-08-02 16:27:17",
                "ClientLimit": 10000,
                "PolarisServer": "xx",
                "CurrentRedisVersion": "5.2.0",
                "CurrentProxyVersion": "5.6.0",
                "UniqVpcId": "vpc-fk33jsf4****",
                "DtsStatus": 0,
                "ProjectName": "xx",
                "BillingMode": 1,
                "RemainBandwidthDuration": "xx",
                "ReadOnly": 0,
                "UniqSubnetId": "subnet-6qotc71w",
                "ClientLimitMin": 0,
                "RedisReplicasNum": 1,
                "Port": 6379,
                "Size": 0.0
            }
        ],
        "TotalCount": 1,
        "RequestId": "65e950b9-78e8-49b1-9200-0e62a1925559"
    }
}

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 操作不支持。
目录