GetInstance - Data Management - Alibaba Cloud Documentation Center

Queries the details of a database instance.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.	2***
Host	string	Yes	The endpoint of the database instance. You can call the ListInstances operation to obtain the endpoint.	172.17.XXX.XXX
Port	integer	Yes	The port number that is used to connect to the database instance. You can call the ListInstances operation to obtain the port number.	5432
Sid	string	No	The system ID (SID) of the database instance. You can call the ListInstances operation to obtain the SID.	test

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instance	object	The details of the database instance.
VpcId	string	The ID of the virtual private cloud (VPC) to which the database instance belongs.	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	The account that is used to log on to the database instance.	dbuser
DbaId	string	The ID of the database administrator (DBA) for the database instance.	29****
UseDsql	integer	Indicates whether the cross-database query feature is enabled for the database instance. Valid values: 0: disabled 1: enabled	0
Port	integer	The port number that is used to connect to the database instance.	5432
EcsInstanceId	string	The ID of the Elastic Compute Service (ECS) instance on which the database instance is deployed.	i-bp124ldpklqz59y3****
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: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	test
Sid	string	The SID of the database instance.	test
OwnerIdList	array	The IDs of the owners for the database instance.
OwnerIds	string	The ID of the instance Owner.	10****
SafeRuleId	string	The ID of the security rule set for the database instance.	3****
OwnerNameList	array	The nicknames of the owners for the database instance.
OwnerNames	string	The nickname of the instance Owner.	yang_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.	7200
InstanceSource	string	The source of the database instance.	ECS_OWN
Host	string	The host address that is used to connect to the database instance.	192.168.XXX.XXX
State	string	The status of the database instance. Valid values: NORMAL: normal DISABLE: disabled	NORMAL
DataLinkName	string	The name of the database link for the database instance.	test
ExportTimeout	integer	The timeout period for exporting data from the database instance.	86400
InstanceId	string	The ID of the database instance.	188****
InstanceType	string	The type of the database instance.	postgresql
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.	0
EcsRegion	string	The ID of the region in which the database instance resides.	cn-beijing
StandardGroup	object	The control mode of the database instance.
GroupName	string	The name of the security rule set corresponding to the control mode.	test group name
GroupMode	string	The type of the control mode. Valid values: COMMON: Security Collaboration NONE_CONTROL: Flexible Management STABLE: Stable Change	NONE_CONTROL
SellSitd	string	Whether sensitive data protection is enabled. Valid values: true: Enable. false: Close.	false
ErrorCode	string	The error code that is returned.	UnknownError
ErrorMessage	string	The error message that is returned.	UnknownError
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

{
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "test",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "test group name",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "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