Help Center/ Relational Database Service/ API Reference/ API v3.1 (Recommended)/ Deleting a Database (RDS for SQL Server)
Updated on 2024-06-07 GMT+08:00

Deleting a Database (RDS for SQL Server)

Function

This API is used to delete a database from a specified DB instance.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, or abnormal.

URI

  • URI format

    DELETE /v3.1/{project_id}/instances/{instance_id}/database/{db_name}

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

    db_name

    Yes

    Name of the database to be deleted.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

is_force_delete

No

Boolean

Whether to forcibly delete a database. The default value is false.

Example Request

DELETE https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/a8abe84a41364097be7c233c39275087in04/database/rds-test

{
   "is_force_delete" : false 
 }

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Job ID.

  • Example normal response
    { 
      "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94" 
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.