Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Deleting an Instance
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Deleting an Instance

Function

This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.

Constraints

This API supports the following instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:delete

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:delete

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Example Requests

URI example 
DELETE https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02

Example Responses

Status code: 202

Accepted

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances