All Products
Search
Document Center

Hologres:DeleteInstance

Last Updated:Mar 03, 2024

Deletes a Hologres instance.

Operation description

Note Before you call this operation, read the documentation and make sure that you understand the prerequisites and impacts of this operation.
  • After you delete a Hologres instance, data and objects in the instance cannot be restored. Proceed with caution. For more information, see Billing overview.
  • You can delete only pay-as-you-go instances.
  • If you want to unsubscribe from a subscription instance, submit a ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/instances/{instanceId}/delete

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region in which the Hologres instance resides.

cn-hangzhou
instanceIdstringNo

The instance ID.

hgpostcn-cn-7mz2vmu30003

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

CB13FFDD-2DF8-5396-A848-2D6A31245B6D
Databoolean

The returned result, which indicates whether the request was successful.

Valid values:

  • true

  • false

true
Successboolean

Indicates whether the call was successful.

true
ErrorCodestring

The error code returned.

null
ErrorMessagestring

The error message returned.

null
HttpStatusCodestring

The HTTP status Code

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "CB13FFDD-2DF8-5396-A848-2D6A31245B6D",
  "Data": true,
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history