Use DescribeInstanceAttribute to query instance attributes - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Retrieves the details of a Tair (Redis-compatible) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeInstanceAttribute

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CA40C261-EB72-4EDA-AC57-958722162595
Instances	object
DBInstanceAttribute	array<object>	The details of the instance.
	array<object>
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-bp1nme44gek34slfc****
PrivateIp	string	The private IP address of the instance. Note This parameter is not returned if the network type of the instance is classic network.	172.16.49.***
Capacity	integer	The memory capacity of the instance. Unit: MB.	1024
CreateTime	string	The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-03-06T10:42:03Z
ConnectionDomain	string	The internal endpoint of the instance.	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	Indicates whether the instance is managed by RDS. Valid values: true: The instance is managed by RDS. false: The instance is not managed by RDS.	true
ChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PostPaid
StorageType	string	The storage type.	essd_pl1
VpcAuthMode	string	The authentication mode for the instance that is deployed in a VPC. Valid values: Open: Password authentication is enabled. Close: Password-free access is enabled.	Open
ArchitectureType	string	The architecture of the instance. Valid values: cluster: The instance is a cluster instance. standard: The instance is a standard instance. rwsplit: The instance is a read/write splitting instance.	standard
AvailabilityValue	string	The availability metric of the instance in the current month.	100%
NetworkType	string	The network type of the instance. Valid values: CLASSIC: classic network VPC: VPC	CLASSIC
Port	integer	The service port of the instance.	6379
SecondaryZoneId	string	The ID of the secondary zone. Note If the instance is not deployed in a secondary zone, this parameter is not returned.	cn-hongkong-h
PackageType	string	The edition of the instance. Valid values: standard: standard edition customized: The customized edition is discontinued.	standard
EngineVersion	string	The database engine version of the instance. Valid values: 2.8, 4.0, 5.0, 6.0, and 7.0.	4.0
Config	string	The parameter settings of the instance. The settings are in the JSON format. For more information, see Parameters. To view the audit log configuration, call the DescribeAuditLogConfig operation.	{\"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	The ID of the instance that is deployed in a VPC.	r-bp1d72gwl41z7f****
Bandwidth	integer	The bandwidth of the instance. Unit: Mbit/s.	10
InstanceName	string	The name of the instance.	apitest
SecurityIPList	string	The IP address whitelist.	127.0.0.1
ShardCount	integer	The number of shards.	2
ReplicaCount	integer	The number of replica nodes in the primary zone. Note The ReplicaCount and SlaveReplicaCount parameters are returned only for cloud-native instances. If the instance uses the cluster architecture, these parameters specify the number of replica nodes per shard in the primary and secondary zones.	1
SlaveReplicaCount	integer	The number of replica nodes in the secondary zone.	1
ReadOnlyCount	integer	The number of read-only nodes in the primary zone. Note The ReadOnlyCount and SlaveReadOnlyCount parameters are returned only for cloud-native instances for which read/write splitting is enabled. If the instance uses the cluster architecture, these parameters specify the number of read-only nodes per shard in the primary and secondary zones.	5
SlaveReadOnlyCount	integer	The number of read-only nodes in the secondary zone. This parameter is returned only when read/write splitting is enabled for an instance that is deployed in multiple zones.	2
GlobalInstanceId	string	The ID of the distributed instance. Note This parameter is returned only for child instances of a distributed instance.	gr-bp14rkqrhac****
QPS	integer	The maximum queries per second (QPS).	100000
AuditLogRetention	string	The retention period of the audit log. Unit: days. A value of 0 indicates that the audit log feature is disabled. For more information about how to enable the audit log feature, see Enable audit logging.	15
ZoneType	string	The zone type of the instance. Valid values: singlezone: single-zone doublezone: multi-zone	singlezone
MaintainStartTime	string	The start time of the maintenance window. The time is in the HH:mmZ format and is displayed in UTC.	18:00Z
MaintainEndTime	string	The end time of the maintenance window. The time is in the HH:mmZ format and is displayed in UTC.	22:00Z
InstanceClass	string	The instance type. For more information, see Instance types.	redis.master.small.default
RealInstanceClass	string	If the instance is a cloud-native cluster instance, this parameter indicates the actual instance type of the shards. In this case, the InstanceClass parameter indicates a virtual instance type. Note To query the fees for an instance of this instance type, specify the value of this parameter in the DescribePrice operation.	tair.rdb.with.proxy.1g
InstanceId	string	The instance ID.	r-bp1d72gwl41z7f****
InstanceType	string	The database engine. Valid values: Tair Redis: ApsaraDB for Redis Community Edition instances and classic ApsaraDB for Redis Enhanced Edition (Tair) memory-type instances are of the Redis database engine. Memcache	Redis
HasRenewChangeOrder	string	Indicates whether a pending order for renewal or configuration change exists for the instance. Valid values: true false	false
InstanceReleaseProtection	boolean	Indicates whether release protection is enabled for the instance. Valid values: true: Release protection is enabled. false: Release protection is disabled.	false
ReplicationMode	string	The replication architecture. Valid values: master-slave: master-replica architecture cluster: cluster architecture, which includes read/write splitting and cluster instances db: cloud-native sharded cluster architecture	master-slave
RegionId	string	The region ID.	cn-hangzhou
EndTime	string	The expiration time of the subscription instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2019-04-06T10:42:03Z
VSwitchId	string	The vSwitch ID.	vsw-bp1e7clcw529l773d****
ReplicaId	string	The ID of the replica node.	bls-awxxxxxxxxxxxxx
NodeType	string	The node type. Valid values: double: The instance has two data nodes. single: The instance has a single data node. readone: The read/write splitting instance has one read-only node. readthree: The read/write splitting instance has three read-only nodes.	double
Connections	integer	The maximum number of connections.	10000
BackupLogStartTime	string	The earliest point in time to which data can be restored. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC. Note This parameter is returned only if the Data Flashback feature is enabled for the instance. When you call the RestoreInstance operation to perform a data flashback, this is the earliest value that can be specified for the RestoreTime parameter.	2021-07-06T05:49:55Z
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmyiu4ekp****
ZoneId	string	The zone ID.	cn-hongkong-b
InstanceStatus	string	The state of the instance. Valid values: Normal: The instance is running as expected. Creating: The instance is being created. Changing: The instance configuration is being changed. Inactive: The instance is disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The billing method of the instance is being changed. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: The minor version of the instance is being updated. NetworkModifying: The network type of the instance is being changed. SSLModifying: The SSL certificate of the instance is being changed. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains accessible during the upgrade. Note For more information about instance states and their impacts, see Instance states.	Normal
Engine	string	The database engine. The value is fixed as Redis.	Redis
Storage	string	The storage space of an ApsaraDB for Redis Enhanced Edition (Tair) instance that uses enhanced SSDs (ESSDs).	50
CloudType	string	This parameter is returned only for ApsaraDB for Redis instances that are created in Alibaba Cloud clouds.	cloudbox
IsOrderCompleted	boolean	Indicates whether a configuration change is complete. Valid values: true: The configuration change is complete, or no configuration change is in progress. false: The configuration change is in progress.	true
IsSupportTDE	boolean	Indicates whether Transparent Data Encryption (TDE) is supported. Valid values: true: TDE is supported. This feature is supported only for ApsaraDB for Redis Enhanced Edition (Tair) memory-type instances. false: TDE is not supported.	true
Tags	object
Tag	array<object>	The tags.
	object	The tag.
Key	string	The key of the tag.	tagkey
Value	string	The value of the tag.	tagvalue
AutoSecondaryZone	boolean	Indicates whether the secondary zone is automatically selected. Valid values: true: The secondary zone is automatically selected. false: The secondary zone is not automatically selected.	true
ComputingType	string

Examples

Success response

JSON format

{
  "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": 1,
        "SlaveReplicaCount": 1,
        "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"
            }
          ]
        },
        "AutoSecondaryZone": true,
        "ComputingType": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.