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

Logging In to an Instance

Function

This API is used to log in to an instance.

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:connection:login

    connection

    Instance

    -

    das:connections:login

    -

URI

POST /v3/{project_id}/connections/{connection_id}/login-actions

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

connection_id

Yes

String

Definition

Connection ID established between a database account and the database. The database user ID is created using the API in Creating an Instance Connection.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

login

No

Table 3 Object

Definition

Login information with a saved password

Constraints

N/A

Range

N/A

Default Value

N/A

logout

No

Table 4 Object

Definition

Logout information

Constraints

N/A

Range

N/A

Default Value

N/A

retry_login

No

Table 5 Object

Definition

Login information without a password saved

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 LoginInfo

Parameter

Mandatory

Type

Description

username

No

String

Definition

Username for logging in to a database

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 LogoutInfo

Parameter

Mandatory

Type

Description

username

No

String

Definition

Username for logging out of a database

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 RetryLoginInfo

Parameter

Mandatory

Type

Description

username

No

String

Definition

Username for logging in to a database

Constraints

N/A

Range

N/A

Default Value

N/A

password

Yes

String

Definition

Password for logging in to a database

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

Response Parameters

None

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/login-actions
 
{
  "retry_login": {
    "username": "my_username",
    "password": "my_password",
    "is_save_password": false
  }
}

Example Responses

Status code: 200

Success.

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.