Querying Database Users

Function

This API is used to query database users of a specified DB instance.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

• This operation cannot be performed when the DB instance is in the abnormal state.

URI

• URI format

  GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit}

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
  page	Yes	Definition Page number. Constraints N/A Range The value is a positive integer starting from 1. Default Value N/A
  limit	Yes	Definition Specifies the number of records on each page. Constraints N/A Range The value is a positive integer ranging from 1 to 100. Default Value N/A

Request

• Request parameters

  None

Response

• Normal response

  Table 2 Parameters

  Parameter	Type	Description
  users	Array of objects	Definition Each element in the list indicates a database account. For details, see Table 3.
  total_count	Integer	Definition Indicates the total number of database users. Range N/A

  Table 3 users element structure description

  Parameter	Type	Description
  name	String	Definition Indicates the account name. Range N/A
  state	String	Definition Indicates the database user status. Range unavailable: The database user is unavailable. available: The database user is available.

• Example normal response

  {
   "users": [
      {
       "name": "rdsuser",
       "state": "available"
      },
     {
      "name": "login001",
      "state": "available"
      }
   ],
   "total_count": 2
   }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.