ListInstances - Data Management - Alibaba Cloud Documentation Center

Queries the information about database instances.

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.

debugging

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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListInstances	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.	3***
SearchKey	string	No	The keyword that is used to search for database instances.	test
DbType	string	No	The type of the database. For more information about the valid values of this parameter, see DbType parameter.	MySQL
EnvType	string	No	The type of the environment to which the database instance belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	product
InstanceSource	string	No	The source of the database instance. Valid values: PUBLIC_OWN: a self-managed database instance that is deployed on the Internet RDS: an ApsaraDB RDS instance ECS_OWN: a self-managed database that is deployed on an Elastic Compute Service (ECS) instance VPC_IDC: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)	RDS
NetType	string	No	The network type of the database instance. Valid values: CLASSIC: classic network VPC: VPC	VPC
InstanceState	string	No	The status of the database instance. Valid values: NORMAL: normal DISABLE: disabled	NORMAL
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. The number cannot exceed 100.	50

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of database instances that are returned.	1
RequestId	string	The ID of the request.	B4B07137-F6AE-4756-8474-7F92BB6C4E04
ErrorCode	string	The error code that is returned.	UnknownError
ErrorMessage	string	The error message that is returned.	UnknownError
InstanceList	object []	The information about the database instances that are returned.
VpcId	string	The ID of the VPC to which the database instance belongs.	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	The account that is used to log on to the database.	dbUser
DbaId	string	The ID of the database administrator (DBA) for the database instance.	31****
UseDsql	integer	Indicates whether the cross-database query feature is enabled for the database instance. Valid values: 0: disabled 1: enabled	1
Port	integer	The port number that is used to connect to the database instance.	3306
EcsInstanceId	string	The ID of the ECS instance on which the database instance is deployed.	150****
EnvType	string	The type of the environment to which the database instance belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: SIT environment uat: UAT environment pet: stress testing environment stag: STAG environment	product
Sid	string	The system ID (SID) of the database instance.	test
OwnerIdList	array	The ID of the owner for the database instance.
	string		123453
SafeRuleId	string	The ID of the security rule set for the database instance.	1
OwnerNameList	array	The nickname of the owner for the database instance.
	string		yuyang_test
DbaNickName	string	The nickname of the DBA for the database instance.	dbaName
QueryTimeout	integer	The timeout period for querying data in the database instance.	60
InstanceSource	string	The source of the database instance.	RDS
Host	string	The host address that is used to connect to the database instance.	****.mysql.rds.aliyuncs.com
State	string	The status of the database instance.	NORMAL
DataLinkName	string	The name of the database link for the database instance.	dblink_test
ExportTimeout	integer	The timeout period for exporting data from the database instance.	86400
InstanceId	string	The ID of the database instance.	150***
InstanceType	string	The type of the database instance.	mysql
DatabasePassword	string	The password that is used to log on to the database.	******
InstanceAlias	string	The alias of the database instance.	test
DdlOnline	integer	Indicates whether the lock-free schema change feature is enabled for the database instance.	1
EcsRegion	string	The ID of the region in which the database instance resides.	cn-hangzhou
StandardGroup	object	The control mode of the database instance.
GroupName	string	The name of the security rule set corresponding to the control mode.	test
GroupMode	string	The type of the control mode. Valid values: COMMON: Security Collaboration NONE_CONTROL: Flexible Management STABLE: Stable Change	COMMON
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "InstanceList": {
    "Instance": [
      {
        "VpcId": "vpc-o6wrloqsdqc9io3mg****",
        "DatabaseUser": "dbUser",
        "DbaId": "31****",
        "UseDsql": 1,
        "Port": 3306,
        "EcsInstanceId": "150****",
        "EnvType": "product",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "123453"
          ]
        },
        "SafeRuleId": "1",
        "OwnerNameList": {
          "OwnerNames": [
            "yuyang_test"
          ]
        },
        "DbaNickName": "dbaName",
        "QueryTimeout": 60,
        "InstanceSource": "RDS",
        "Host": "****.mysql.rds.aliyuncs.com",
        "State": "NORMAL",
        "DataLinkName": "dblink_test",
        "ExportTimeout": 86400,
        "InstanceId": "150***",
        "InstanceType": "mysql",
        "DatabasePassword": "******",
        "InstanceAlias": "test",
        "DdlOnline": 1,
        "EcsRegion": "cn-hangzhou",
        "StandardGroup": {
          "GroupName": "test",
          "GroupMode": "COMMON"
        },
        "SellSitd": true
      }
    ]
  },
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history