• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v1
  5. DB Instance Management
  6. Deleting a DB Instance

Deleting a DB Instance

Function

This API is used to delete a DB instance.

URI

  • URI format

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

    Method: DELETE

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

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

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instanceId

    Yes

    Specifies the DB instance ID.

  • Restrictions

    Standby DB instances cannot be deleted.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Description

    keepLastManualBackup

    No

    This parameter is obsolete. Its value can be left empty or set to an integer and has no impact on calling the API.

    All automated backups will be deleted and all manual backups will be retained.

  • Request example
    {
    "keepLastManualBackup": "0"
    }

Normal Response

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Description

    extendparam

    Dictionary data structure. For details, see Table 4.

    Indicates the returned extendparam key-value pair.

    Table 4 extendparam field data structure description

    Name

    Type

    Description

    jobs

    List data structure. For details, see Table 5.

    Indicates the returned jobs parameter information.

    Table 5 jobs field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the task ID.

  • Response example
    {
       "extendparam": {
          "jobs": [ 
             {
                 "id":"ff8080815a88d52c015a8a0db2250003"
             } 
          ]
       }
    }

Abnormal Response

For details, see Abnormal Request Results.