DescribeDBInstanceAttribute-阿里云帮助中心

Queries the details of an instance.

Operation description

Subscription instances cannot be deleted.

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 instance status. Valid values: CREATING: creating ACTIVE: running RESOURCE_CHANGING: upgrading ORDER_PREPARING: confirming order READONLY_RESOURCE_CHANGING: changing resources (instance write-locked) DELETING: deleting	ACTIVE
SubDomain	string	The zone.	cn-beijing-h-aliyun
GmtModified	string	The time when the instance was modified, such as restart or public network application. The time is displayed in the yyyy-MM-ddTHH:mmZ format (UTC time).	2023-08-17T09:58Z
LockMode	integer	The lock mode of the instance. Valid values: lock, which indicates that the instance is automatically locked due to expiration or overdue payment.	lock
LockReason	string	The reason why the instance is locked.	nolock
ResourceCpu	integer	The number of resource CPUs.	8
StorageSize	integer	The size of the storage space.	400
ObjectStoreSize	integer	The storage space.	0
MaintainStarttime	string	A reserved parameter. It is not returned and therefore does not apply to the time format.	Reserved parameter, not returned
MaintainEndtime	string	A reserved parameter. It is not returned and therefore does not apply to the time format.	Reserved parameter, not returned
DBClusterList	array<object>	The list of clusters to which the instance belongs.
	object	The cluster list.
DbInstanceName	string	The name of the instance.	Instance test
DbClusterId	string	The ID of the cluster.	selectdb-cn-h033cjs****-be
DbClusterName	string	The name of the cluster.	test01
Status	string	The status of the cluster. Valid values: CREATING: creating ACTIVATION: running RESOURCE_CHANGING: upgrading ORDER_PREPARING: confirming order READONLY_RESOURCE_CHANGING: changing resources (instance write-locked) DELETING: deleting	ACTIVATION
CreatedTime	string	The time when the cluster was created. The time is displayed in the ISO 8601 format and includes the time zone information.	2023-08-14T09:24:13Z
DbClusterClass	string	The specifications of the cluster. Valid values: selectdb.xlarge: 4 cores, 16 GB selectdb.2xlarge: 8 cores, 32 GB selectdb.4xlarge: 16 cores, 64 GB selectdb.8xlarge: 32 cores, 128 GB selectdb.16xlarge: 64 cores, 256 GB selectdb.24xlarge: 96 cores, 384 GB selectdb.32xlarge: 128 cores, 512 GB selectdb.g.xlarge: 4 cores, 16 GB selectdb.g.2xlarge: 8 cores, 32 GB selectdb.g.4xlarge: 16 cores, 64 GB selectdb.g.8xlarge: 32 cores, 128 GB selectdb.g.16xlarge: 64 cores, 256 GB selectdb.g.24xlarge: 96 cores, 384 GB selectdb.g.32xlarge: 128 cores, 512 GB	selectdb.2xlarge
CpuCores	integer	The number of CPU cores.	8
Memory	integer	The memory size.	64
CacheStorageType	string	The type of the cache storage.	cloud_essd
PerformanceLevel	string	The performance level (PL).	PL1
CacheStorageSizeGB	string	The size of the cache storage. Unit: GB.	200
StartTime	string	The time when the cluster was started. The time is displayed in the ISO 8601 format and includes the time zone information.	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 modified. The time is displayed in the ISO 8601 format and includes the time zone information.	2024-07-02T16:35:44+08:00
ScalingRulesEnable	boolean	Specifies whether the time-based elastic policy is enabled.	false
ZoneId	string	The ID of the zone.	cn-hangzhou-k
VSwitchId	string	The ID of the vSwitch.	vsw-t4n8x7jcc8rknon85tqoa
SubDomain	string	The subdomain.	Reserved parameter, not returned
ClusterBinding	string	The bound target cluster.	selectdb-cn-7213cjv****-be
ClusterNodeType	string	The type of the cluster node. This parameter takes effect only in serverless mode. Valid values: base : The CPU-to-memory ratio of 1 SCU is 1:4.	base
ClusterNodeCount	integer	The number of cluster nodes. This parameter takes effect only in serverless mode.	1
ScaleMax	number	The maximum number of RDS Capacity Units (RCUs) for the auto scaling range of the instance.	4
ScaleMin	number	The minimum number of RDS Capacity Units (RCUs) for the auto scaling range of the instance.	0.5
Engine	string	The database engine.	selectdb
EngineVersion	string	The database engine 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, in ISO 8601 format with time zone information.	2023-08-14T03:00:42Z
CanUpgradeVersions	array	The versions to which the instance can be upgraded.	"4.1.10-20260922"
	string	The information about the upgradable version.	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, in ISO 8601 format with time zone information.	2023-09-17T00:00Z
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aekzbck4asz3dsa
Tags	array<object>	The instance tag list information.
	object	The instance tag list.
TagKey	string	The key of the tag.	testKey
TagValue	string	The value of the tag.	testValue
RegionId	string	The region ID.	cn-beijing
ZoneId	string	The zone ID of the instance.	cn-beijing-h
VpcId	string	The ID of the VPC to which the instance belongs.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	The ID of the vSwitch.	vsw-bp18iztwqrs8qj2nc6nyu
DeployScheme	string	The deployment mode of the instance.	multi_az
MultiZone	array<object>	The multi-zone configurations. Note This parameter is valid only when DeployScheme is set to multi_az.
	object	The multi-zone configuration.
ZoneId	string	The ID of the zone.	cn-hangzhou-k
VSwitchIds	array	The IDs of the vSwitches.
	string	The ID of the vSwitch.	vsw-bp10dbralpn4bzmgkkh8f
Cidr	string	The Classless Inter-Domain Routing block information 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. Valid values: true: The Serverless feature is enabled. false: The Serverless feature is disabled.	false
SecGroupConnValid	string	Indicates whether port direct connection is enabled for the VPC where the instance is deployed. Valid values: true: Port direct connection is enabled. false: Port direct connection is disabled.	false
VirtualClusterList	array<object>	The list of virtual clusters.
	object	The list of virtual clusters.
DbClusterId	string	The ID of the cluster.	selectdb-vcg-33cjs****-be
DbClusterName	string	The name of the cluster.	vgcdemo
Status	string	The status 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 instance was created, in ISO 8601 format with time zone information.	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 secondary cluster.	selectdb-x6u7***-be
StandbyClusterName	string	The name of the secondary cluster.	test2
ConfigPatternType	string	The configuration template applied to the instance. Valid values: normal : General analysis scenarios. log : Log analysis scenarios. point_query : Point query scenarios.	log
OTelGrafanaServiceStatus	string	The status of the OTel collector and Grafana services. Valid values: creating : Creating. not_enabled : Not enabled. activation : Enabled.	not_enabled
OTelBearerToken	string	The OTel collector bearer token.	nDVkJstxQEwyXIae8cRBzK33Hev68len
LangfuseInstanceIds	array	The list of Langfuse instance IDs associated with the SelectDB instance.	["lfu-xxkshuf23sdj"]
	string	The Langfuse instance ID associated with the SelectDB instance.	lfu-xxkshuf23sdj
CanUpgradeVersionCommunityMap	object	The community editions corresponding to the upgradable versions.	{"4.1.10-20260922":"Apache Doris 3.1.4","4.0.12-20260801":"Apache Doris 3.0.11"}
	string	The version.	Apache Doris 3.0.11
CommunityVersion	string	The community version corresponding to the current version.	Apache Doris 4.0.8
MCPServerServiceStatus	string	The MCP Server service status.	not_enabled
FEClusterList	array<object>	The FE cluster list.
	object	The FE cluster information.
DbClusterId	string	The name of the FE cluster.	selectdb-cn-7213cjv****-fe
Status	string	The status of the FE cluster.	ACTIVATION
SingleNodeCpuCores	integer	The number of CPU cores per node in the FE cluster.	4
SingleNodeMemoryInGB	integer	The memory per node in the FE cluster, in GB.	16
NodeCount	integer	The number of nodes in the FE cluster.	1
TdeEnabled	boolean	Indicates whether TDE is enabled for the instance.	true
TdeMode	string	The specific TDE mode enabled for the instance. Valid values: MANAGED : Managed key.	MANAGED
TdeAlgorithm	string	The algorithm used for TDE on the instance.	AES256

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": "Reserved parameter, not currently returned",
  "MaintainEndtime": "Reserved parameter, not currently returned",
  "DBClusterList": [
    {
      "DbInstanceName": "Test instance",
      "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": "Reserved parameter, not returned",
      "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"
    }
  ],
  "ConfigPatternType": "log",
  "OTelGrafanaServiceStatus": "not_enabled",
  "OTelBearerToken": "nDVkJstxQEwyXIae8cRBzK33Hev68len",
  "LangfuseInstanceIds": [
    "lfu-xxkshuf23sdj"
  ],
  "CanUpgradeVersionCommunityMap": {
    "key": "{'4.0.12-20260801': 'Apache Doris 3.0.11'}"
  },
  "CommunityVersion": "Apache Doris 4.0.8",
  "MCPServerServiceStatus": "not_enabled",
  "FEClusterList": [
    {
      "DbClusterId": "selectdb-cn-7213cjv****-fe",
      "Status": "ACTIVATION",
      "SingleNodeCpuCores": 4,
      "SingleNodeMemoryInGB": 16,
      "NodeCount": 1
    }
  ],
  "TdeEnabled": true,
  "TdeMode": "MANAGED",
  "TdeAlgorithm": "AES256"
}

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.