Function

This API is used to obtain a list of self-built databases of a specified DB instance.

URI

• URI format

  PATH: /rds/v1/{project_id}/instances/{instanceId}/databases

  Method: GET

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  instanceId	Yes	Specifies the primary node ID of the DB instance. NOTE: This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.

• Restrictions

  Currently, only the DB engine Microsoft SQL Server is supported by the API.

  The query result indicates the names of databases in the Running state.

Request

None

Normal Response

• Parameter description

  Table 2 Parameter description

  Name	Type	Description
  instanceId	String	Indicates the primary node ID of the DB instance. NOTE: This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.
  type	String	Indicates the DB engine. Currently, Microsoft SQL Server is supported.
  databases	Dictionary data structure. For details, see Table 3.	Indicates the list of database information.

  Table 3 databases field data structure description

  Name	Type	Description
  name	String	Indicates the database name.
  status	String	Indicates the database status. Valid values: Creating Running Deleting
  characterSetName	String	Indicates the charset.

• Response example

  {
     "instanceId": "69900b70d1f445ca8592278f5ea3ceddno04",
     "type": "SQLServer",
      "databases": [
          {
              "name": "user01",
              "status": "Running",
              "characterSetName": "Chinese_PRC_CI_AS"
                       
          },
          {
              "name": "user02",
              "status": "Running",
              "characterSetName": "Chinese_PRC_CI_AS"
  
          }
      ]
  }

Abnormal Response

For details, see Abnormal Request Results.