Updated on 2025-08-11 GMT+08:00

Deleting a Schema

Function

This API is used to delete a schema of a database in a specified instance. Before calling this API:

Constraints

  • This operation cannot be performed when the instance is in any of the following statuses: creating, changing instance specifications, frozen, or abnormal.
  • This API can only be used to delete a schema at a time.

URI

DELETE /v3/{project_id}/instances/{instance_id}/schema

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

db_name

Yes

String

Definition

Database name.

Constraints

The name cannot be a template database and must be an existing database name.

Template databases include postgres, template0, template1.

Range

N/A

Default Value

N/A

schema

Yes

String

Definition

Schema name.

Constraints

The name can contain 1 to 63 characters. Only letters, digits, and underscores (_) are allowed. It cannot start with pg or a digit, and must be different from template database names and existing schema names.

Template databases include postgres, template0, template1.

Existing schemas include public and information_schema.

Range

N/A

Default Value

N/A

Response Parameters

None

Example Request

Deleting a schema from the gaussdb_test database
DELETE https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schema
{ 
   "db_name" : "gaussdb_test", 
   "schema" : "rds001"
 }

Example Response

None

Status Codes

Error Codes

For details, see Error Codes.