Updated on 2026-08-25 GMT+08:00

Creating an Instance Connection

Function

This API is used to create an instance connection.

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:instance:createConnection

Write

Instance

-

das:connections:create

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
das:instance:createConnection	Write	Instance	-	das:connections:create	-

URI

POST /v3/{project_id}/instances/{instance_id}/create-connection

**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. Only letters and digits are supported. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. You can obtain the instance ID from the instance list or instance details. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
engine_type	Yes	String	Definition DB engine type Constraints N/A Range mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm Default Value N/A
network_type	Yes	String	Definition Source database type Constraints N/A Range rds gaussdb dds ddm Default Value N/A
username	Yes	String	Definition Username Constraints N/A Range N/A Default Value N/A
is_save_password	Yes	Boolean	Definition Whether a password needs to be saved Constraints N/A Range N/A Default Value N/A
password	Yes	String	Definition Password Constraints N/A Range N/A Default Value N/A
node_ids	No	Array of strings	Definition Unique ID of a node. You can obtain the node ID from the node list in the instance details. The value can contain 36 characters. Only letters and digits are allowed. Constraints N/A
remarks	No	String	Definition Remarks Constraints N/A Range N/A Default Value N/A
port	No	Integer	Definition Port Constraints N/A Range [1,65536] Default Value N/A
database_name	No	String	Definition Database name Constraints N/A Range N/A Default Value N/A
sql_record_flag	No	Boolean	Definition SQL record switch Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
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.

Example Requests

Creating an instance connection

POST https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/create-connection 

{ 
  "engine_type" : "mysql", 
  "network_type" : "rds", 
  "username" : "root", 
  "is_save_password" : true, 
  "password" : "Gauss_2345", 
  "sql_record_flag" : true, 
  "remarks" : "create by api" 
}

Example Responses

Status code: 200

Success.

{ 
  "connection_id" : "99af0766-c3f4-4e4e-a95e-14a1b070188e" 
}

Status Codes

Status Code	Description
200	Success.
400	Client error
500	Server error

Error Codes

See Error Codes.

Parent topic: Development Tool