调用DescribeInstanceAttribute查询Redis实例的详细信息_云数据库 Tair（兼容 Redis®）(Tair)-阿里云帮助中心

查询云数据库 Tair（兼容 Redis）实例的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeInstanceAttribute	get	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	r-bp1zxszhcgatnx****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	CA40C261-EB72-4EDA-AC57-958722162595
Instances	array<object>	实例详细信息列表。
DBInstanceAttribute	object
VpcId	string	专有网络（VPC）的 ID。	vpc-bp1nme44gek34slfc****
PrivateIp	string	专有网络 IP 地址。说明实例的网络类型为经典网络时，不会返回本参数。	172.16.49.***
Capacity	long	存储容量，单位：MB。	1024
CreateTime	string	实例创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-03-06T10:42:03Z
ConnectionDomain	string	实例的内网连接地址。	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	是否属 RDS 管控，返回值： true：是。 false：否。	true
ChargeType	string	付费类型，返回值： PrePaid：预付费，即包年包月。 PostPaid：后付费，即按量付费。	PostPaid
StorageType	string	存储类型。	essd_pl1
VpcAuthMode	string	VPC 认证模式，返回值： Open：需要密码认证。 Close：关闭密码认证，即开启了 VPC 免密功能。	Open
ArchitectureType	string	实例的架构，返回值： cluster：集群版。 standard：标准版。 rwsplit：读写分离版。	standard
AvailabilityValue	string	当月的可用性指标。	100%
NetworkType	string	网络类型，返回值： CLASSIC：经典网络。 VPC：专有网络。	CLASSIC
Port	long	Redis 服务端口。	6379
SecondaryZoneId	string	备可用区 ID。说明实例没有备可用区 ID 时，不返回本参数。	cn-hongkong-h
PackageType	string	套餐类型，返回值： standard：标准套餐。 customized：定制套餐，已下线。	standard
EngineVersion	string	数据库版本，返回值：2.8、4.0、5.0或6.0。	4.0
Config	string	实例的参数配置信息，格式为 JSON，详情请参见参数说明，查看审计日志配置可使用 DescribeAuditLogConfig 接口。	{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
VpcCloudInstanceId	string	VPC 实例 ID。	r-bp1d72gwl41z7f****
Bandwidth	long	带宽，单位：MB/s。	10
InstanceName	string	实例名称。	apitest
SecurityIPList	string	IP 白名单。	127.0.0.1
ShardCount	integer	分片数，本参数仅适用于中国站。当 Redis 实例为集群架构的云原生版实例时，才会返回本参数。	2
ReadOnlyCount	integer	只读节点数，本参数仅适用于云原生版读写分离架构实例。	5
SlaveReadOnlyCount	long	备可用区的只读节点数，该参数仅在多可用区中开启读写分离后才会返回。	2
GlobalInstanceId	string	所属的分布式实例 ID。说明当 Redis 实例为分布式实例中的子实例时，才会返回本参数。	gr-bp14rkqrhac****
QPS	long	理论最大 QPS 值。	100000
AuditLogRetention	string	审计日志中设置的日志保留时间，单位为天。0 代表未开通审计日志，开通方式请参见开通审计日志。	15
ZoneType	string	可用区类型，返回值： singlezone：同城单可用区。 doublezone：同城双可用区。	singlezone
MaintainStartTime	string	可运维开始时间，格式为HH:mmZ（UTC 时间）。	18:00Z
MaintainEndTime	string	可运维结束时间，格式为HH:mmZ（UTC 时间）。	22:00Z
InstanceClass	string	实例规格，请参见实例规格表。	redis.master.small.default
RealInstanceClass	string	当实例为云原生版集群实例时，本参数为云原生版集群实例的实际分片规格，InstanceClass 参数为虚拟规格。说明如需查询该规格的实例费用，可在 DescribePrice 接口中指定本参数返回的实例规格进行查询。	tair.rdb.with.proxy.1g
InstanceId	string	实例 ID。	r-bp1d72gwl41z7f****
InstanceType	string	实例类型，返回值： Tair Redis Memcache	Redis
HasRenewChangeOrder	string	是否有未生效的续费变配订单，返回值： true：是。 false：否。	false
InstanceReleaseProtection	boolean	是否开启了实例释放保护，返回值： true：已开启。 false：未开启。	false
ReplicationMode	string	副本架构，返回值： master-slave：标准版的主从架构。 cluster：集群架构，包含读写分离版或集群版。 db：云原生分片集群架构。	master-slave
RegionId	string	地域 ID。	cn-hangzhou
EndTime	string	预付费实例到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-04-06T10:42:03Z
VSwitchId	string	虚拟交换机 ID。	vsw-bp1e7clcw529l773d****
ReplicaId	string	副本 ID。	bls-awxxxxxxxxxxxxx
NodeType	string	节点类型，返回值： double：双副本。 single：单副本。 readone：经典架构读写分离实例，一个只读节点。 readthree：经典架构读写分离实例，三个只读节点。	double
Connections	long	实例连接数限制。	10000
BackupLogStartTime	string	允许闪回的最早时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明当 Redis 实例开启了数据闪回功能，才会返回本参数。调用 RestoreInstance 接口执行数据闪回时，可通过本参数的返回值确认允许闪回的最早时间点（即 RestoreTime 可传入的最早时间点）。	2021-07-06T05:49:55Z
ResourceGroupId	string	实例所属的资源组 ID。	rg-acfmyiu4ekp****
ZoneId	string	可用区 ID。	cn-hongkong-b
InstanceStatus	string	实例状态，返回值： Normal：正常。 Creating：创建中。 Changing：修改中。 Inactive：被禁用。 Flushing：清除中。 Released：已释放。 Transforming：转换中。 Unavailable：服务停止。 Error：创建失败。 Migrating：迁移中。 BackupRecovering：备份恢复中。 MinorVersionUpgrading：小版本升级中。 NetworkModifying：网络变更中。 SSLModifying：SSL 变更中。 MajorVersionUpgrading：大版本升级中，可正常访问。说明更多实例状态及详细信息，请参见实例状态与影响。	Normal
Engine	string	数据库类型，返回值固定为 Redis。	Redis
Storage	string	Tair ESSD 磁盘型的存储空间。	50
CloudType	string	仅云盒实例显示该参数。	cloudbox
IsOrderCompleted	boolean	实例订单是否完成，用于判断变配订单是否到达终态，返回值： true：变配已完成，或进行未变配。 false：变配中。	true
IsSupportTDE	boolean	实例是否支持开启透明数据加密 TDE（Transparent Data Encryption）功能，返回值： true：支持，仅经典版内存型实例支持。 false：不支持。	true
Tags	array<object>	标签信息。
Tag	object	标签信息。
Key	string	标签 key。	tagkey
Value	string	标签 value。	tagvalue

示例

正常返回示例

JSON格式

{
  "RequestId": "CA40C261-EB72-4EDA-AC57-958722162595",
  "Instances": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "PrivateIp": "172.16.49.***",
        "Capacity": 1024,
        "CreateTime": "2019-03-06T10:42:03Z",
        "ConnectionDomain": "r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com",
        "IsRds": true,
        "ChargeType": "PostPaid",
        "StorageType": "essd_pl1",
        "VpcAuthMode": "Open",
        "ArchitectureType": "standard",
        "AvailabilityValue": "100%",
        "NetworkType": "CLASSIC",
        "Port": 6379,
        "SecondaryZoneId": "cn-hongkong-h",
        "PackageType": "standard",
        "EngineVersion": "4.0",
        "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
        "VpcCloudInstanceId": "r-bp1d72gwl41z7f****",
        "Bandwidth": 10,
        "InstanceName": "apitest",
        "SecurityIPList": "127.0.0.1",
        "ShardCount": 2,
        "ReplicaCount": 0,
        "SlaveReplicaCount": 0,
        "ReadOnlyCount": 5,
        "SlaveReadOnlyCount": 2,
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "QPS": 100000,
        "AuditLogRetention": "15",
        "ZoneType": "singlezone",
        "MaintainStartTime": "18:00Z",
        "MaintainEndTime": "22:00Z",
        "InstanceClass": "redis.master.small.default",
        "RealInstanceClass": "tair.rdb.with.proxy.1g",
        "InstanceId": "r-bp1d72gwl41z7f****",
        "InstanceType": "Redis",
        "HasRenewChangeOrder": "false",
        "InstanceReleaseProtection": false,
        "ReplicationMode": "master-slave",
        "RegionId": "cn-hangzhou",
        "EndTime": "2019-04-06T10:42:03Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "ReplicaId": "bls-awxxxxxxxxxxxxx",
        "NodeType": "double",
        "Connections": 10000,
        "BackupLogStartTime": "2021-07-06T05:49:55Z",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hongkong-b",
        "InstanceStatus": "Normal",
        "Engine": "Redis",
        "Storage": "50",
        "CloudType": "cloudbox",
        "IsOrderCompleted": true,
        "IsSupportTDE": true,
        "Tags": {
          "Tag": [
            {
              "Key": "tagkey",
              "Value": "tagvalue"
            }
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-09	OpenAPI 返回结构发生变更	查看变更详情
2023-12-27	OpenAPI 返回结构发生变更	查看变更详情
2023-10-13	OpenAPI 返回结构发生变更	查看变更详情
2023-03-08	OpenAPI 返回结构发生变更	查看变更详情
2022-07-14	OpenAPI 返回结构发生变更	查看变更详情