All Products
Search
Document Center

Tair:DescribeInstanceAttribute

Last Updated:Mar 20, 2023

Queries the details of an ApsaraDB for Redis instance.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociation operation
kvstore:DescribeInstanceAttributeREAD
  • Redis
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CA40C261-EB72-4EDA-AC57-958722162595
Instancesarray

Details of the instance.

object
VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-bp1nme44gek34slfc****
PrivateIpstring

The private IP address of the instance.

NoteThis parameter is not returned if the instance is deployed in the classic network.
172.16.49.***
Capacitylong

The storage capacity of the instance. Unit: MB.

1024
CreateTimestring

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
ConnectionDomainstring

The internal endpoint of the instance.

r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRdsboolean

Indicates whether the instance is managed by ApsaraDB RDS. Valid values:

  • true: yes
  • false: no
true
ChargeTypestring

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
PostPaid
VpcAuthModestring

The VPC authentication mode. Valid values:

  • Open: enables password authentication.
  • Close: disables password authentication and enables password-free access. For more information, see Enable password-free access.
Open
ArchitectureTypestring

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
AvailabilityValuestring

The availability metric of the current month.

100%
NetworkTypestring

The network type of the instance. Valid values:

  • CLASSIC: classic network
  • VPC: VPC
CLASSIC
Portlong

The service port of the instance.

6379
SecondaryZoneIdstring

The ID of the secondary zone.

NoteThis parameter is returned only if the instance is deployed in two zones.
cn-hongkong-h
PackageTypestring

The plan type of the instance. Valid values:

  • standard: standard plan.
  • customized: custom plan. This plan type is phased out.
standard
EngineVersionstring

The database engine version of the instance. Valid values: 2.8, 4.0, and 5.0.

4.0
Configstring

The parameter configurations of the instance in the JSON format. For more information, see Modify the parameters of an ApsaraDB for Redis instance.

{\"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}
VpcCloudInstanceIdstring

The ID of the instance that is deployed in the VPC.

r-bp1d72gwl41z7f****
Bandwidthlong

The bandwidth of the instance. Unit: Mbit/s.

10
InstanceNamestring

The name of the instance.

apitest
SecurityIPListstring

The IP address whitelist of the instance.

127.0.0.1
ShardCountinteger

The number of shards. This parameter is available only for ApsaraDB for Redis instances that are purchased on the China site (aliyun.com).

2
ReadOnlyCountinteger

The number of read-only nodes. This parameter is available only for read/write splitting instances that use cloud disks.

5
GlobalInstanceIdstring

The ID of the distributed instance to which the instance belongs.

NoteThis parameter is returned only if the instance is a child instance of the distributed instance.
gr-bp14rkqrhac****
QPSlong

The expected maximum queries per second (QPS).

100000
AuditLogRetentionstring

The retention period of audit logs. 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 the new audit log feature.

15
ZoneTypestring

The deployment type of the instance. Valid values:

  • singlezone: The instance is deployed in a single zone.
  • doublezone: The instance is deployed in two zones in the same region.
singlezone
MaintainStartTimestring

The start time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.

18:00Z
MaintainEndTimestring

The end time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.

22:00Z
InstanceClassstring

The instance type of the instance. For more information, see Instance types.

redis.master.small.default
RealInstanceClassstring

If the instance is a cloud-disk cluster instance, this parameter indicates the instance type of shards. The InstanceClass parameter indicates a virtual instance type.

NoteTo query the instance fees of this instance type, you can call the DescribePrice operation and specify the return value of this parameter.
tair.rdb.with.proxy.1g
InstanceIdstring

The ID of the instance

r-bp1d72gwl41z7f****
InstanceTypestring

The edition of the instance. Valid values:

  • Tair
  • Redis
  • Memcache
Redis
HasRenewChangeOrderstring

Indicates whether your Alibaba Cloud account has pending orders for renewal and configuration change. Valid values:

  • true: yes
  • false: no
false
InstanceReleaseProtectionboolean

Indicates whether the release protection feature is enabled for the instance. Valid values:

  • true: yes
  • false: no
false
ReplicationModestring

The architecture of the instance replica. Valid values:

  • master-slave: standard master-replica architecture.
  • cluster: cluster architecture, which includes the read/write splitting instances and cluster instances.
master-slave
RegionIdstring

The region ID of the instance.

cn-hangzhou
EndTimestring

The time when the subscription instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-04-06T10:42:03Z
VSwitchIdstring

The ID of the vSwitch to which the instance is connected.

vsw-bp1e7clcw529l773d****
ReplicaIdstring

The ID of the replica node.

bls-awxxxxxxxxxxxxx
NodeTypestring

The node type. Valid values:

  • double: The instance contains a master node and a replica node.
  • single: The instance contains only a master node. This node type is phrased out.
double
Connectionslong

The maximum number of connections supported by the instance.

10000
BackupLogStartTimestring

The earliest point in time to which you can restore data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time 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 implement data flashback, you can obtain the earliest point in time for data flashback from the return value of this parameter and set the RestoreTime parameter to this point in time.
  • 2021-07-06T05:49:55Z
    ResourceGroupIdstring

    The ID of the resource group to which the instance belongs.

    rg-acfmyiu4ekp****
    ZoneIdstring

    The zone ID of the instance.

    cn-hongkong-b
    InstanceStatusstring

    The state of the instance. Valid values:

    • Normal: The instance is normal.
    • Creating: The instance is being created.
    • Changing: The configurations of the instance are 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.
    • Unavailable: The instance is suspended.
    • Error: The instance failed to be created.
    • 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 available during the upgrade.
    NoteFor more information about instance states, see Instance states and impacts.
    Normal
    Enginestring

    The database engine of the instance. The return value is Redis.

    Redis
    CloudTypestring

    This parameter is returned only if the instance is in a cloud box.

    cloudbox
    Tagsarray

    Details of the tags.

    object
    Keystring

    The key of the tag.

    tagkey
    Valuestring

    The value of the tag.

    tagvalue

    Examples

    Sample success responses

    JSONformat

    {
      "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",
            "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,
            "ReadOnlyCount": 5,
            "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",
            "CloudType": "cloudbox",
            "Tags": {
              "Tag": [
                {
                  "Key": "tagkey",
                  "Value": "tagvalue"
                }
              ]
            }
          }
        ]
      }
    }

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-07-14The response structure of the API operation changes.
    Change itemChange content
    Output ParametersThe response structure of the API operation changes.