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

Logging In to an Instance

Function

This API is used to log in to an instance. High-privilege accounts are preferred, and only the accounts whose passwords are saved can be used for login.

Authorization Information

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

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    das::showCloudDBAInfo

    read

    -

    -

    -

    -

URI

POST /v3/{project_id}/instances/{instance_id}/login

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

connection_id

String

Definition

Connection ID.

Range

N/A

instance_name

String

Definition

Instance name.

Range

N/A

instance_id

String

Definition

Instance ID.

Range

N/A

login_user

String

Definition

Login username.

Range

N/A

database_name

String

Definition

Name of the database to be logged in to.

Range

N/A

engine_type

String

Definition

Engine type.

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/login 
 

Example Responses

Status code: 200

Success.

{
    "connection_id": "f6ec61f9-24c5-4aaf-b42b-d45d23274031",
    "instance_name": "rds-sql-Do not delete 1.",
    "instance_id": "bcfa975193f1402fa11a6d4fd6baf5fbin01",
    "login_user": "rdsDasRead",
    "database_name": "",
    "engine_type": "mysql"
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.