doc-exports/docs/rds/api-ref/en-us_topic_0032348281.html

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: /rds/v1/{project_id}/instances/{instanceId}

  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.

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.
  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.
  instanceName	String	Indicates the created DB instance name.

• Response example

  {
      "instance": {
          "instanceId": "252f11f1-2912-4c06-be55-1999bde659c5",
          "status": "BUILD",
          "instanceName": "rds-instance-test01"
      }
  }

Abnormal Response

For details, see Abnormal Request Results.

Parent topic: DB Instance Management