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

Queries the details of an ApsaraDB Tair (Redis-compatible) database 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 list of instance details.
	array<object>
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-bp1nme44gek34slfc****
PrivateIp	string	The private IP address of the VPC. Note This parameter is not returned if the network type of the instance is classic network.	172.16.49.***
Capacity	integer	The storage capacity. Unit: MB.	1024
CreateTime	string	The time when the instance was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2019-03-06T10:42:03Z
ConnectionDomain	string	The internal network endpoint of the instance.	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	Indicates whether the instance is managed by ApsaraDB RDS. Valid values: true: Yes. false: No.	true
ChargeType	string	The billing method. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go.	PostPaid
StorageType	string	The storage type.	essd_pl1
VpcAuthMode	string	The VPC authentication mode. Valid values: Open: Password authentication is required. Close: Password authentication is disabled, which means the password-free access in VPCs feature is enabled.	Open
ArchitectureType	string	The architecture of the instance. Valid values: cluster: Cluster Edition. standard: Standard Edition. rwsplit: Read/Write Splitting Edition.	standard
AvailabilityValue	string	The availability metric for the current month.	100%
NetworkType	string	The network type. 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 This parameter is not returned if the instance does not have a secondary zone.	cn-hongkong-h
PackageType	string	The plan type. Valid values: standard: Standard plan. customized: Custom plan. This plan is discontinued.	standard
EngineVersion	string	The Redis-compatible 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 in JSON format. For more details, see Metric description. To query 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 VPC-connected instance.	r-bp1d72gwl41z7f****
Bandwidth	integer	The bandwidth. Unit: MB/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. This parameter is applicable only to the China site.	2
ReplicaCount	integer	The number of secondary nodes in the primary zone. Note The ReplicaCount and SlaveReplicaCount parameters are applicable only to cloud-native instances. If the instance uses the cluster architecture, these parameters indicate the number of secondary nodes in the primary and secondary zones for a single shard.	1
SlaveReplicaCount	integer	The number of secondary 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 applicable only to cloud-native instances with read/write splitting enabled. If the instance uses the cluster architecture, these parameters indicate the number of read-only nodes in the primary and secondary zones for a single shard.	5
SlaveReadOnlyCount	integer	The number of read-only nodes in the secondary zone. This parameter is returned only when read/write splitting is enabled in a multi-zone deployment.	2
GlobalInstanceId	string	The distributed instance ID to which the instance belongs. Note This parameter is returned only when the instance is a child instance of a distributed instance.	gr-bp14rkqrhac****
QPS	integer	The theoretical maximum queries per second (QPS).	100000
AuditLogRetention	string	The retention period of audit logs. Unit: days. A value of 0 indicates that the audit log feature is not enabled. For more information about how to enable the feature, see Enable the audit log feature.	15
ZoneType	string	The zone type. Valid values: singlezone: Single-zone deployment. doublezone: Dual-zone deployment.	singlezone
MaintainStartTime	string	The start time of the maintenance window. The time is displayed in the HH:mmZ format in UTC.	18:00Z
MaintainEndTime	string	The end time of the maintenance window. The time is displayed in the HH:mmZ format 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 shard specification of the instance, and the InstanceClass parameter indicates the virtual specification. Note To query the price of an instance with this specification, specify the instance specification returned by this parameter when you call the DescribePrice operation.	tair.rdb.with.proxy.1g
InstanceId	string	The instance ID.	r-bp1d72gwl41z7f****
InstanceType	string	The instance type. Valid values: Tair Redis The Redis instance type is also returned for classic memory-optimized Tair instances. Memcache	Redis
HasRenewChangeOrder	string	Specifies whether there is an unexecuted renewal and upgrade/downgrade order. Valid values: true: Yes. false: No.	false
InstanceReleaseProtection	boolean	Indicates whether release protection is enabled for the instance. Valid values: true: Enabled. false: Disabled.	false
ReplicationMode	string	The replica architecture. Valid values: master-slave: Primary/secondary architecture of Standard Edition. cluster: Cluster architecture, including Read/Write Splitting Edition or Cluster Edition. db: Cloud-native sharded cluster architecture.	master-slave
RegionId	string	The region ID.	cn-hangzhou
EndTime	string	The time when the upfront instance expires. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2019-04-06T10:42:03Z
VSwitchId	string	The vSwitch ID.	vsw-bp1e7clcw529l773d****
ReplicaId	string	The replica ID.	bls-awxxxxxxxxxxxxx
NodeType	string	The node type. Valid values: double: Dual-replica. single: Single-replica. readone: Read/Write Splitting Edition instance with the classic architecture and one read-only node. readthree: Read/Write Splitting Edition instance with the classic architecture and three read-only nodes.	double
Connections	integer	The maximum number of connections to the instance.	10000
BackupLogStartTime	string	The earliest point in time to which data can be flashed back. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC. Note This parameter is returned only when the data flashback feature is enabled for the instance. When you call the RestoreInstance operation to flash back data, you can use the value of this parameter to determine the earliest point in time to which data can be flashed back. This is also the earliest point in time that can be specified for RestoreTime.	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 status of the instance. Valid values: Normal: Normal. Creating: Creating. Changing: Modifying. Inactive: Disabled. Flushing: Purge. Released: Released. Transforming: Transforming. Migrating: Migrating. BackupRecovering: Restoring from backup. MinorVersionUpgrading: Minor version upgrade in progress. NetworkModifying: Modifying network. SSLModifying: Modifying SSL. MajorVersionUpgrading: Major engine version upgrade in progress. The instance remains accessible. Note For more information about instance statuses and their impacts, see Instance statuses and impacts.	Normal
Engine	string	The database engine. The value is fixed as Redis.	Redis
Storage	string	The storage space of Tair ESSD instances.	50
CloudType	string	This parameter is displayed only for CloudBox instances.	cloudbox
IsOrderCompleted	boolean	Indicates whether the instance order is completed. This parameter is used to determine whether a specification change order has reached the final state. Valid values: true: The specification change is completed, or no specification change is performed. false: The specification change is in progress.	true
IsSupportTDE	boolean	Indicates whether the instance type and version support TDE. A value of true indicates that TDE is supported. A value of false indicates that TDE is not supported. TDE is supported by cloud-native Tair memory-optimized RDB instances of versions 6.0, 7.0, and 8.1, and local disk .amber. performance-enhanced instances of version 5.0.	true
Tags	object
Tag	array<object>	The tag information.
	object	The tag information.
Key	string	The tag key.	tagkey
Value	string	The tag value.	tagvalue
AutoSecondaryZone	boolean	Indicates whether the secondary zone is automatically assigned. Valid values: true: Automatically assigned. false: Not automatically assigned.	true
ComputingType	string	The compute resource type of the instance.	Ecs

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": "Ecs"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.