Use DescribeDBInstanceAttribute to query instance details - ApsaraDB for SelectDB - Alibaba Cloud - ApsaraDB for SelectDB

Retrieves the details of a specified 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

selectdb:DescribeDBInstanceAttribute

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	selectdb-cn-7213cjv****
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	06758CAB-1204-5852-A471-29C87D5C1D0F
Status	string	The state of the instance. Valid values: CREATING: The instance is being created. ACTIVE: The instance is running. RESOURCE_CHANGING: The instance is being upgraded or downgraded. ORDER_PREPARING: The order is being confirmed. READONLY_RESOURCE_CHANGING: The instance configuration is being changed and the instance is write-locked. DELETING: The instance is being deleted.	ACTIVE
SubDomain	string	The zone of the instance .	cn-beijing-h-aliyun
GmtModified	string	The time when the instance was last modified, such as a restart or a public IP address application. The time is in the yyyy-MM-ddTHH:mmZ format and is displayed in UTC.	2023-08-17T09:58Z
LockMode	integer	The lock mode of the instance. The value is lock. The instance is automatically locked when it expires or has an overdue payment.	lock
LockReason	string	The reason why the instance is locked.	nolock
ResourceCpu	integer	The number of CPU cores.	8
StorageSize	integer	The storage size.	400
ObjectStoreSize	integer	The object storage size.	0
MaintainStarttime	string	The start time of the maintenance window.	预留参数，暂不返回
MaintainEndtime	string	The end time of the maintenance window.	预留参数，暂不返回
DBClusterList	array<object>	The information about the clusters to which the instance belongs.
	object	The list of clusters.
DbInstanceName	string	The instance name.	实例测试
DbClusterId	string	The cluster ID.	selectdb-cn-h033cjs****-be
DbClusterName	string	The cluster name.	test01
Status	string	The state of the cluster. Valid values: CREATING: The cluster is being created. ACTIVATION: The cluster is running. RESOURCE_CHANGING: The cluster is being upgraded or downgraded. ORDER_PREPARING: The order is being confirmed. READONLY_RESOURCE_CHANGING: The cluster configuration is being changed and the instance is write-locked. DELETING: The cluster is being deleted.	ACTIVATION
CreatedTime	string	The time when the cluster was created.	2023-08-14T09:24:13Z
DbClusterClass	string	The cluster specifications. Valid values: selectdb.xlarge: 4 cores, 16 GB memory. selectdb.2xlarge: 8 cores, 32 GB memory. selectdb.4xlarge: 16 cores, 64 GB memory. selectdb.8xlarge: 32 cores, 128 GB memory. selectdb.16xlarge: 64 cores, 256 GB memory. selectdb.24xlarge: 96 cores, 384 GB memory. selectdb.32xlarge: 128 cores, 512 GB memory.	selectdb.2xlarge
CpuCores	integer	The number of CPU cores.	8
Memory	integer	The memory size.	64
CacheStorageType	string	The cache storage type.	cloud_essd
PerformanceLevel	string	The performance level (PL).	PL1
CacheStorageSizeGB	string	The cache storage size. Unit: GB.	200
StartTime	string	The time when the cluster was started.	2023-08-14T09:24:13Z
ChargeType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Prepaid
ModifiedTime	string	The time when the cluster was last modified.	2024-07-02T16:35:44+08:00
ScalingRulesEnable	boolean	Indicates whether a scheduled elastic policy is enabled.	false
ZoneId	string	The zone ID.	cn-hangzhou-k
VSwitchId	string	The vSwitch ID.	vsw-t4n8x7jcc8rknon85tqoa
SubDomain	string	The subdomain.	预留参数，暂不返回。
ClusterBinding	string	The target cluster to which the current cluster is attached.	selectdb-cn-7213cjv****-be
ClusterNodeType	string	The node type of the cluster. This parameter is valid only for serverless instances. Valid values: base : The ratio of CPU cores to memory is 1:4 for 1 SCU.	base
ClusterNodeCount	integer	The number of nodes in the cluster. This parameter is valid only for serverless instances.	1
ScaleMax	number	The maximum value for the auto-scaling range of RDS Capacity Units (RCUs) for the instance.	4
ScaleMin	number	The minimum value for the auto-scaling range of RDS Capacity Units (RCUs) for the instance.	0.5
Engine	string	The database type.	selectdb
EngineVersion	string	The database version.	2.4
EngineMinorVersion	string	The minor engine version of the instance.	3.0.1
DBInstanceId	string	The instance ID.	selectdb-cn-7213cjv****
Description	string	The description of the instance.	test
CreateTime	string	The time when the instance was created.	2023-08-14T03:00:42Z
CanUpgradeVersions	array	The engine versions to which the instance can be upgraded.
	string	A list of version upgrade information.	test
ChargeType	string	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Prepaid
ExpireTime	string	The time when the instance expires.	2023-09-17T00:00Z
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aekzbck4asz3dsa
Tags	array<object>	The information about the tags of the instance.
	object	The list of tags.
TagKey	string	The tag key.	testKey
TagValue	string	The tag value.	testValue
RegionId	string	The region ID.	cn-beijing
ZoneId	string	The zone ID of the instance.	cn-beijing-h
VpcId	string	The VPC ID of the instance.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	The vSwitch ID.	vsw-bp18iztwqrs8qj2nc6nyu
DeployScheme	string	The deployment mode of the instance.	multi_az
MultiZone	array<object>	The multi-zone configuration. Note This parameter is valid only when DeployScheme is set to multi_az.
	object	The list of zones in the multi-zone deployment.
ZoneId	string	The zone ID.	cn-hangzhou-k
VSwitchIds	array	The list of vSwitch IDs.
	string	The vSwitch ID.	vsw-bp10dbralpn4bzmgkkh8f
Cidr	string	The CIDR block of the prefix list entry.	113.88.14.211/32
AvailableIpCount	integer	The number of available IP addresses in the zone.	4096
Serverless	boolean	Indicates whether the serverless feature is enabled for the instance. true: The serverless feature is enabled. false: The serverless feature is not enabled.	false
SecGroupConnValid	string	Indicates whether the direct connection feature is enabled for the port in the VPC where the instance resides. true: The direct connection feature is enabled. false: The direct connection feature is not enabled.	false
VirtualClusterList	array<object>	The list of virtual clusters.
	object
DbClusterId	string	The cluster ID.	selectdb-vcg-33cjs****-be
DbClusterName	string	The cluster name.	vgcdemo
Status	string	The state of the instance. Valid values: CREATING: The instance is being created. RUNNING: The instance is running. DELETING: The instance is being deleted. UPDATING: The instance is being updated.	UPDATING
CreatedTime	string	The time when the cluster was created.	2025-05-31T21:01:09Z
ActiveClusterId	string	The ID of the primary cluster.	selectdb-xx78***-be
ActiveClusterName	string	The name of the primary cluster.	test1
StandbyClusterId	string	The ID of the standby cluster.	selectdb-x6u7***-be
StandbyClusterName	string	The name of the standby cluster.	test2

Examples

Success response

JSON format

{
  "RequestId": "06758CAB-1204-5852-A471-29C87D5C1D0F",
  "Status": "ACTIVE",
  "SubDomain": "cn-beijing-h-aliyun",
  "GmtModified": "2023-08-17T09:58Z",
  "LockMode": 0,
  "LockReason": "nolock",
  "ResourceCpu": 8,
  "StorageSize": 400,
  "ObjectStoreSize": 0,
  "MaintainStarttime": "预留参数，暂不返回",
  "MaintainEndtime": "预留参数，暂不返回\n",
  "DBClusterList": [
    {
      "DbInstanceName": "实例测试",
      "DbClusterId": "selectdb-cn-h033cjs****-be",
      "DbClusterName": "test01",
      "Status": "ACTIVATION",
      "CreatedTime": "2023-08-14T09:24:13Z",
      "DbClusterClass": "selectdb.2xlarge",
      "CpuCores": 8,
      "Memory": 64,
      "CacheStorageType": "cloud_essd",
      "PerformanceLevel": "PL1",
      "CacheStorageSizeGB": "200",
      "StartTime": "2023-08-14T09:24:13Z",
      "ChargeType": "Prepaid",
      "ModifiedTime": "2024-07-02T16:35:44+08:00",
      "ScalingRulesEnable": false,
      "ZoneId": "cn-hangzhou-k",
      "VSwitchId": "vsw-t4n8x7jcc8rknon85tqoa",
      "SubDomain": "预留参数，暂不返回。",
      "ClusterBinding": "selectdb-cn-7213cjv****-be",
      "ClusterNodeType": "base",
      "ClusterNodeCount": 1,
      "ScaleMax": 4,
      "ScaleMin": 0.5
    }
  ],
  "Engine": "selectdb",
  "EngineVersion": "2.4",
  "EngineMinorVersion": "3.0.1",
  "DBInstanceId": "selectdb-cn-7213cjv****",
  "Description": "test",
  "CreateTime": "2023-08-14T03:00:42Z",
  "CanUpgradeVersions": [
    "test"
  ],
  "ChargeType": "Prepaid",
  "ExpireTime": "2023-09-17T00:00Z",
  "ResourceGroupId": "rg-aekzbck4asz3dsa",
  "Tags": [
    {
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ],
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-h",
  "VpcId": "vpc-bp175iuvg8nxqraf2****",
  "VSwitchId": "vsw-bp18iztwqrs8qj2nc6nyu",
  "DeployScheme": "multi_az",
  "MultiZone": [
    {
      "ZoneId": "cn-hangzhou-k",
      "VSwitchIds": [
        "vsw-bp10dbralpn4bzmgkkh8f"
      ],
      "Cidr": "113.88.14.211/32",
      "AvailableIpCount": 4096
    }
  ],
  "Serverless": false,
  "SecGroupConnValid": "false",
  "VirtualClusterList": [
    {
      "DbClusterId": "selectdb-vcg-33cjs****-be",
      "DbClusterName": "vgcdemo",
      "Status": "UPDATING",
      "CreatedTime": "2025-05-31T21:01:09Z",
      "ActiveClusterId": "selectdb-xx78***-be",
      "ActiveClusterName": "test1",
      "StandbyClusterId": "selectdb-x6u7***-be\n",
      "StandbyClusterName": "test2"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	english description1
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	english description1
400	InvalidDBName	The specified database name is not allowed.	english description1
400	CreateOrderFailed	Failed to create order.	Failed to create order.
400	InvalidDBName.Duplicate	Specified DB name already exists in the This instance.	New Cluster Name
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	The requested operation cannot be performed while the cluster is not running.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	english description1
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	english description1
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	The instance is in a state that does not support the current operation.
403	MoneyLessThan100	The Account Monet less Than 100.	english description1
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	english description1
403	InsufficientResourceCapacity	The resource is out of usage.	Not enough resources, please try again later.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	Instance does not exist.
404	InvalidClusterInstance.NotFound	Specified cluster instance does not exist.	SelectDB instance does not exist.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	english description1
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	english description1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	english description1
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	english description1
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	english description1
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	english description1

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.