All Products
Search
Document Center

ApsaraDB for Redis:DescribeInstanceAttribute

Last Updated:May 23, 2024

Queries the details of an ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 keyAssociated operation
kvstore:DescribeInstanceAttributeRead
  • DBInstance
    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
Instancesobject []

Details about the instances.

VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-bp1nme44gek34slfc****
PrivateIpstring

The private IP address of the instance.

Note This parameter is not returned when 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
  • false
true
ChargeTypestring

The billing method of the instance. Valid values:

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

The storage type.

essd_pl1
VpcAuthModestring

Indicates whether password authentication is enabled. Valid values:

  • Open: Password authentication is enabled.
  • Close: Password authentication is disabled and password-free access is enabled.
Open
ArchitectureTypestring

The architecture of the instance. Valid values:

  • cluster: cluster architecture
  • standard: standard architecture
  • rwsplit: read/write splitting architecture
standard
AvailabilityValuestring

The availability metric of the current month.

100%
NetworkTypestring

The network type of the instance. Valid values:

  • CLASSIC
  • VPC
CLASSIC
Portlong

The service port of the instance.

6379
SecondaryZoneIdstring

The ID of the secondary zone.

Note This parameter is returned only if the instance has a secondary zone ID.
cn-hongkong-h
PackageTypestring

The plan type. 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 Parameter descriptions. You can use the DescribeAuditLogConfig operation to query audit log configurations.

{\"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 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 addresses in the whitelist.

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 replicas. 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.

Note This parameter is returned only when the ApsaraDB for Redis instance is a child instance of a distributed instance.
gr-bp14rkqrhac****
QPSlong

The expected maximum queries per second (QPS).

100000
AuditLogRetentionstring

The retention period of audit logs. Unit: day. A value of 0 indicates that the audit log feature is disabled. For information about how to enable the feature, see Enable the 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 of 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. For more information, see Instance types.

redis.master.small.default
RealInstanceClassstring

If the instance is a cluster instance that uses cloud disks, this parameter indicates the actual instance type of individual shards in the instance. The InstanceClass parameter indicates the virtual instance type.

Note To query fees for instances of the instance type, you can specify the instance type that is returned by this parameter in the DescribePrice operation.
tair.rdb.with.proxy.1g
InstanceIdstring

The ID of the instance.

r-bp1d72gwl41z7f****
InstanceTypestring

The database engine 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
  • false
false
InstanceReleaseProtectionboolean

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

  • true
  • false
false
ReplicationModestring

The architecture of the replica node. Valid values:

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

The region ID.

cn-hangzhou
EndTimestring

The time when the subscription 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.

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 is a standalone instance.
double
Connectionslong

The maximum number of connections supported by the instance.

10000
BackupLogStartTimestring

The earliest point in time to which data can be restored. 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 when the data flashback feature is enabled for the instance. For more information, see Restore data to a point in time by using the data flashback feature.

  • 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
SlaveReadOnlyCountlong

The number of read replicas in the secondary zone. This parameter is returned only after read/write splitting is enabled for the instance across multiple zones.

2
ResourceGroupIdstring

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

rg-acfmyiu4ekp****
ZoneIdstring

The zone ID.

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 unavailable.
  • 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 configurations of the instance are 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, see Instance states and impacts.
Normal
Enginestring

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

Redis
Storagestring

The storage capacity of the cloud disk.

50
CloudTypestring

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

cloudbox
IsOrderCompletedboolean

Indicates whether the order for instance configuration change has reached the final state. Valid values:

  • true: The configuration change has been completed or has not been performed.
  • false: The configurations of the instance are being changed.
true
IsSupportTDEboolean

Indicates whether the transparent data encryption (TDE) feature is supported for the instance. Valid values:

  • true: This feature is supported. This feature is available only for DRAM-based instances that use local disks.
  • false: This feature is not supported.
true
Tagsobject []

Details about the tags.

Keystring

The tag key.

tagkey
Valuestring

The tag value.

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",
        "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,
        "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",
        "SlaveReadOnlyCount": 2,
        "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"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-27The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-10-13The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-03-08The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-07-14The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.