DescribeInstancesOverview_云数据库 Tair(兼容 Redis®)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

若您未指定请求参数,将返回所有实例的信息概览。

说明 该接口返回结果均无分页。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
RegionIdstring

实例所属的地域 ID,可调用 DescribeRegions 接口获取。

示例值:cn-hangzhou
InstanceIdsstring

需要查询的实例 ID。展开详情

示例值:r-bp1zxszhcgatnx****
InstanceStatusstring

实例状态,取值:展开详情

示例值:Normal
ChargeTypestring

付费类型,取值:展开详情

示例值:PostPaid枚举值:PrePaidPostPaiddhgpay
NetworkTypestring

网络类型,取值:展开详情

示例值:CLASSIC枚举值:CLASSICVPC
EngineVersionstring

实例兼容 Redis 的版本,返回值:2.84.05.06.07.0

示例值:6.0枚举值:4.05.06.07.02.8
InstanceClassstring

实例规格,请参见实例规格表

示例值:redis.master.small.default
VpcIdstring

专有网络 ID。

示例值:vpc-bp1nme44gek34slfc****
VSwitchIdstring

虚拟交换机 ID。

示例值:vsw-bp1e7clcw529l773d****
InstanceTypestring

实例类型,取值:展开详情

示例值:Redis枚举值:RedisMemcachetair_essdtair_scmtair_rdbTair
SearchKeystring

基于实例 ID 或者实例备注模糊搜索时使用的关键字。

示例值:apitest
ArchitectureTypestring

架构类型,取值:展开详情

示例值:standard
ZoneIdstring

可用区 ID。

示例值:cn-hangzhou-b
ResourceGroupIdstring

资源组 ID。展开详情

示例值:rg-acfmyiu4ekp****
EditionTypestring

实例类型,取值:展开详情

示例值:Enterprise枚举值:EnterpriseCommunity
PrivateIpstring

专有网络 IP 地址。

示例值:172.16.49.***

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:1E83311F-0EE4-4922-A3BF-730B312B****
TotalCountinteger<int32>

实例总个数。

示例值:1
Instancesarray<object>

由 Instance(实例)组成的数组。

返回示例

变更历史

暂无变更历史

相关示例