All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeInstancesOverview

    Document Center

    Tair (Redis® OSS-Compatible):DescribeInstancesOverview

    Last Updated:Dec 19, 2024

    Queries the overview information of one or more Tair (Redis OSS-compatible) instances.

    Operation description

    If you do not specify the InstanceIds parameter when you call this operation, the overview information of all instances is returned.

    Note This operation returns non-paged results.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:DescribeInstancesOverviewget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region in which the instances you want to query reside. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    InstanceIdsstringNo

    The IDs of instances.

    Note By default, all instances that belong to this account are queried. If you specify multiple instance IDs, separate the instance IDs with commas (,).
    		r-bp1zxszhcgatnx****
    InstanceStatusstringNo

    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 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, see Instance states and impacts.
    		Normal
    ChargeTypestringNo

    The billing method of the instance. Valid values:

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

    The network type of the instance. Valid values:

    • CLASSIC: classic network
    • VPC: Virtual Private Cloud (VPC)
    		CLASSIC
    EngineVersionstringNo

    The database engine version of the instance.

    Enumeration Value:
    • 4.0: 4.0.
    • 5.0: 5.0.
    • 6.0: 6.0.
    • 7.0: 7.0.
    • 2.8: 2.8.
    		4.0
    InstanceClassstringNo

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

    		redis.master.small.default
    VpcIdstringNo

    The ID of the VPC.

    		vpc-bp1nme44gek34slfc****
    VSwitchIdstringNo

    The ID of the vSwitch.

    		vsw-bp1e7clcw529l773d****
    InstanceTypestringNo

    The category of the instance. Valid values:

    • Tair
    • Redis
    • Memcache
    		Redis
    SearchKeystringNo

    The keyword used for fuzzy search. The keyword can be based on an instance ID or an instance description.

    		apitest
    ArchitectureTypestringNo

    The architecture of the instance. Valid values:

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

    The zone ID of the instance.

    		cn-hangzhou-b
    ResourceGroupIdstringNo

    The ID of the resource group to which the instances you want to query belong.

    Note You can query resource group IDs by using the ApsaraDB for Redis console or by calling the ListResourceGroups operation. For more information, see View basic information of a resource group.
    		rg-acfmyiu4ekp****
    EditionTypestringNo

    The edition of the instance. Valid values:

    • Community: Community Edition
    • Enterprise: Enhanced Edition (Tair)
    		Enterprise
    PrivateIpstringNo

    The private IP address of the instance.

    		172.16.49.***

    Response parameters

    ParameterTypeDescriptionExample
    object

    The information about the instances.

    RequestIdstring

    The ID of the request.

    		1E83311F-0EE4-4922-A3BF-730B312B****
    TotalCountinteger

    The total number of instances.

    		1
    Instancesarray<object>

    An array of instances.

    KVStoreInstanceobject

    The information about the instance.

    VpcIdstring

    The ID of the 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.

    		4096
    CreateTimestring

    The time when the instance was created.

    		2018-11-07T08:49:00Z
    ConnectionDomainstring

    The internal endpoint of the instance.

    		r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    ChargeTypestring

    The billing method of the instance. Valid values:

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

    The architecture of the instance. Valid values:

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

    The network type of the instance. Valid values:

    • CLASSIC: classic network
    • VPC: VPC
    		CLASSIC
    EngineVersionstring

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

    		4.0
    InstanceNamestring

    The name of the instance.

    		apitest
    GlobalInstanceIdstring

    The ID of the distributed instance.

    Note This parameter is returned only when the instance is a child instance of a distributed instance.
    		gr-bp14rkqrhac****
    InstanceClassstring

    The instance type of the instance.

    		redis.logic.sharding.2g.2db.0rodb.4proxy.default
    InstanceIdstring

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    InstanceTypestring

    The category of the instance. Valid values:

    • Tair
    • Redis
    • Memcache
    		Redis
    RegionIdstring

    The region ID of the instance.

    		cn-hangzhou
    EndTimestring

    The time when the subscription instance expires.

    		2022-06-13T16:00:00Z
    VSwitchIdstring

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

    		vsw-bp1e7clcw529l773d****
    ResourceGroupIdstring

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

    		rg-acfmyiu4ekp****
    ZoneIdstring

    The zone ID of the instance.

    		cn-hangzhou-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 certificate of the instance is being changed.
    • MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains accessible during the upgrade.
    		Normal
    SecondaryZoneIdstring

    Instance's secondary zone id.

    Note This parameter is only returned when the instance has a secondary zone ID.
    		cn-hangzhou-g

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "PrivateIp": "172.16.49.***",
      "Capacity": 4096,
      "CreateTime": "2018-11-07T08:49:00Z",
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PostPaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "4.0",
      "InstanceName": "apitest",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceType": "Redis",
      "RegionId": "cn-hangzhou",
      "EndTime": "2022-06-13T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "ResourceGroupId": "rg-acfmyiu4ekp****",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Normal",
      "SecondaryZoneId": "cn-hangzhou-g"
    }
  ]
}

    Error codes

    HTTP status codeError codeError message
    400InvalidInstanceIds.MalformedThe Specified parameter InstanceIds is not valid.

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

    Change history

    Change timeSummary of changesOperation
    2023-06-12The Error code has changedView Change Details
    2023-03-06The Error code has changed. The response structure of the API has changedView Change Details
    2021-11-23Add OperationView Change Details