Querying the Instance Connection List

Function

This API is used to querying the instance connection list.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
das::showCloudDBAInfo	Read	-	-	-	-

URI

GET /v3/{project_id}/list-connections

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters, including only letters and digits. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
condition	No	String	Definition Keywords such as the DB instance address, instance name, and remarks Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. If this parameter is set to 1 and limit is set to 10, only the second to eleventh records are displayed. Constraints N/A Range [0, 2^31-1] Default Value 0: The query starts from the first data record.
limit	No	Integer	Definition Number of records to be queried. If this parameter is set to 10, a maximum of 10 records can be displayed. Constraints N/A Range [1, 200] Default Value 100
network_type	No	String	Definition Source database type Constraints N/A Range rds gaussdb dds ddm Default Value N/A
datastore_type	No	String	Definition DB engine type Constraints N/A Range mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm Default Value N/A
connection_type	No	String	Definition Connection type Constraints N/A Range NORMAL: created connection SHARE: connection shared by others Default Value N/A
instance_id	No	String	Definition Unique ID of an instance Constraints N/A Range The value can contain 32 characters, including only letters and digits. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_record	Integer	Definition Total number of records Range N/A
das_conn_info_list	Array of Table 4 objects	Definition Connection information list Range N/A

**Table 4** das_conn_info_list
Parameter	Type	Description
connection_id	String	Definition Connection ID Range The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed.
instance_id	String	Definition Instance ID Range The value can contain 32 characters, including only letters and digits.
instance_name	String	Definition Instance name Range N/A
network_type	String	Definition Source database type Range rds gaussdb dds ddm
engine_type	String	Definition DB engine type Range mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm
datastore_version	String	Definition Database version Range N/A
user_name	String	Definition Username Range N/A
database_name	String	Definition Database name Range N/A
is_save_password	Boolean	Definition Whether a password needs to be saved Range N/A
ip_address	String	Definition IP address Range N/A
port	Integer	Definition Port number Range [1,65536]
remarks	String	Definition Remarks Range N/A
create_at	Long	Definition Time when a connection was created Range N/A
status	String	Definition Status Range NORMAL: normal INSTANCE_DELETE: An instance is deleted.
conn_share_type	String	Definition Connection type Range NORMAL: normal connection SHARE: shared connection
shared_user_name	String	Definition Sharer name Range N/A
shared_user_id	String	Definition Sharer ID Range N/A
expired_time	Long	Definition Time when a shared connection expires Range N/A

Example Requests

Querying the instance connection list

GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/list-connections?curpage=0&perpage=50&connectionType=NORMAL

Example Responses

Status code: 200

Successful response

{ 
  "total_record" : 1, 
  "das_conn_info_list" : [ { 
    "engine_type" : "mysql", 
    "datastore_version" : "mysql 5.7.44", 
    "network_type" : "rds", 
    "connection_id" : "bcca4e8e-f0d8-4f96-b359-393a66d29c09", 
    "instance_name" : "rds-mysql-2502", 
    "instance_id" : "364a5d0498974d459782975e8b65bc13in01", 
    "ip_address" : "192.168.0.204", 
    "port" : 3306, 
    "user_name" : "root", 
    "is_save_password" : true, 
    "status" : "NORMAL", 
    "create_at" : 1738745756479, 
    "conn_share_type" : "NORMAL" 
  } ] 
}