• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. OpenStack trove API v1.0
  5. DB Instance Management
  6. Obtaining Detailed Information of a Specified DB Instance

Obtaining Detailed Information of a Specified DB Instance

Function

This API is used to obtain detailed information of a specified DB instance.

URI

  • URI format

    PATH: /{versionId}/{project_id}/instances/{instanceId}

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

    Specifies the API version. It is case-sensitive and the value is v1.0.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instanceId

    Yes

    Specifies the ID of the queried DB instance.

  • Restrictions

    Currently, only the DB engines MySQL and PostgreSQL are supported by the API.

Request

N/A

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    instance

    Dictionary data structure. For details, see Table 3.

    Indicates the DB instance information.

    Table 3 instance field data structure description

    Name

    Type

    Description

    configurationStatus

    String

    Indicates the parameter group status.

    paramsGroupId

    String

    Indicates the parameter group ID.

    type

    String

    Indicates the DB instance type.

    subnetid

    String

    Indicates the subnet ID.

    role

    String

    Indicates the DB instance role.

    internalSubnetId

    String

    Indicates the internal subnet ID.

    group

    String

    Indicates the group which the DB instance belongs to.

    The value is 1, indicating that the detailed information of a single DB instance is obtained.

    securegroup

    String

    Indicates the security group ID.

    vpc

    String

    Indicates the VPC ID.

    azcode

    String

    Indicates the AZ.

    region

    String

    Indicates the region where the DB instance is deployed.

    created

    String

    Indicates the DB instance creation time.

    updated

    String

    Indicates the updated time, which is the same as created.

    status

    String

    Indicates the DB instance status.

    Value:
    • If the value is BUILD, the instance is being created.
    • If the value is ACTIVE, the instance is normal.
    • If the value is FAILED, the instance is abnormal.
    • If the value is MODIFYING, the instance is being scaled up.
    • If the value is REBOOTING, the instance is being rebooted.
    • If the value is RESTORING, the instance is being restored.

    name

    String

    Indicates the DB instance name.

    publicEndpoint

    String

    Indicates the EIP for public access, including the IP address and port number.

    dbPort

    Int

    Indicates the database port number.

    links

    List data structure. For details, see Table 4.

    Indicates the link address.

    id

    String

    Indicates the DB instance ID.

    flavor

    Dictionary data structure. For details, see Table 5.

    Indicates the DB instance specifications.

    volume

    Dictionary data structure. For details, see Table 6.

    Indicates the volume information.

    datastore

    Dictionary data structure. For details, see Table 7.

    Indicates the database information.

    fault

    Dictionary data structure. For details, see Table 8.

    This parameter is valid when the DB instance is faulty.

    configuration

    Dictionary data structure. For details, see Table 9.

    This parameter is valid when a parameter group exists.

    locality

    String

    Currently, this parameter is not supported.

    replicas

    Dictionary data structure. For details, see Table 10.

    This parameter is valid when obtaining the primary DB instance information.

    dbuser

    String

    Indicates the new administrator account.

    storageEngine

    String

    Indicates the storage engine.

    payModel

    Int

    Indicates the payment mode.

    cluster_id

    String

    Indicates the cluster ID.

    Table 4 links field data structure description

    Name

    Type

    Description

    rel

    String

    Its value is self or bookmark.

    href

    String

    Its value is "".

    Table 5 flavor field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the specification ID.

    links

    List data structure. For details, see Table 4.

    Indicates the link address.

    Table 6 volume field data structure description

    Name

    Type

    Description

    type

    String

    Indicates the volume type.

    size

    Int

    Indicates the volume size.

    used

    Float

    Indicates the volume utilization.

    Table 7 datastore field data structure description

    Name

    Type

    Description

    type

    String

    Indicates the DB engine type.

    version

    String

    Indicates the database version.

    Table 8 fault field data structure description

    Name

    Type

    Description

    message

    String

    Indicates the message returned when creating the DB instance failed.

    created

    String

    Indicates the DB instance creation time.

    details

    String

    Indicates the fault details.

    Table 9 configuration field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the parameter group ID.

    name

    String

    Indicates the parameter group name.

    links

    List data structure. For details, see Table 4.

    Indicates the link address.

    Table 10 replicas field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the DB instance ID.

    name

    String

    Indicates the DB instance name.

    links

    List data structure. For details, see Table 4.

    Indicates the link address.

  • Response example
    {
      "instance": {
        "configurationStatus": "In-Sync",
        "paramsGroupId": "b89db814-6ba1-454f-a9ad-380064ef0c6f",
        "type": "MySQL",
        "subnetid": "0fb5d084-4e5d-463b-8920-fca10e6b4028",
        "role": "master",
        "internalSubnetId": "330a10fd-3962-44c5-b3a1-1d282617a183",
        "group": "1",
        "securegroup": "ca99fcef-502f-495f-b28d-85c9c6f4666e",
        "vpc": "292997f2-3bf7-4d60-86a5-4e9d593bc850",
        "azcode": "eu-de-01",
        "region": null,
        "created": "2017-05-12T02:18:46",
        "updated": "2017-05-12T02:18:46",
        "status": "ACTIVE",
        "name": "rds-MySQL-1-1",
        "publicEndpoint": "10.11.77.101:8635",
        "dbPort": 8635,
        "links": [
          {
            "rel": "self",
            "href": ""
          },
          {
            "rel": "bookmark",
            "href": ""
          }
        ],
        "id": "e8faac23-8129-4c68-a231-480e46fc5f4f",
        "flavor": {
          "id": "31b2863c-0e15-44fd-a80d-1e83a7aca338",
          "links": [
            {
              "rel": "self",
              "href": ""
            },
            {
              "rel": "bookmark",
              "href": ""
            }
          ]
        },
        "volume": {
          "type": "COMMON",
          "size": 210,
          "used": 25.07
        },
        "datastore": {
          "type": "MySQL",
          "version": "MySQL-5.7.17"
        },
        "fault": null,
        "configuration": null,
        "locality": null,
        "replicas": null,
        "dbuser": "root",
        "storageEngine": null,
        "payModel": 0,
        "cluster_id": "fb22f24c-0466-48f2-8275-70af04ef4935"
      }
    }

Abnormal Response

For details, see Abnormal Request Results.