Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Development Tool/ Creating an Instance Connection
Updated on 2025-11-26 GMT+08:00
View PDF
Share

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

    Dependency

    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

Explanation:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters, including only letters and digits.

Default value:

N/A

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

The value can contain 32 characters, including only letters and digits.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

engine_type

Yes

String

Explanation:

DB engine type

Constraints:

N/A

Values:

  • mysql
  • sqlserver
  • postgresql
  • taurus
  • gaussdbv5
  • mongodb
  • ddm

Default value:

N/A

network_type

Yes

String

Explanation:

Source database type

Constraints:

N/A

Values:

  • rds
  • gaussdb
  • dds
  • ddm

Default value:

N/A

username

Yes

String

Explanation:

Username

Constraints:

N/A

Values:

N/A

Default value:

N/A

is_save_password

Yes

Boolean

Explanation:

Whether a password needs to be saved

Constraints:

N/A

Values:

N/A

Default value:

N/A

password

Yes

String

Explanation:

Password

Constraints:

N/A

Values:

N/A

Default value:

N/A

node_ids

No

Array of strings

Explanation:

Unique ID of a node

Constraints:

N/A

Values:

The value can contain 32 characters, including only letters and digits.

Default value:

N/A

remarks

No

String

Explanation:

Remarks

Constraints:

N/A

Values:

N/A

Default value:

N/A

port

No

Integer

Explanation:

Port

Constraints:

N/A

Values:

[1,65536]

Default value:

N/A

database_name

No

String

Explanation:

Database name

Constraints:

N/A

Values:

N/A

Default value:

N/A

sql_record_flag

No

Boolean

Explanation:

SQL record switch

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

connection_id

String

Explanation:

Connection ID

Values:

The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed.

Example Request

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 Response

Status code: 200

Successful request

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

Status Code

Status Code

Description

200

Successful request

400

Client error

500

Server error

Error Codes

See Error Codes.

Parent topic: Development Tool