Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Deleting a StarRocks Instance
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a StarRocks Instance

Function

This API is used to delete a StarRocks instance. Before calling this API:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

GaussDB(for MySQL) instance ID, which is compliant with the UUID format.

starrocks_instance_id

Yes

String

StarRocks instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Content-Type

Yes

String

Content type. Value: application/json

X-Language

No

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

workflow_id

String

Workflow ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Deleting a StarRocks instance

DELETE https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/starrocks/9ac58f9b88744f8a87893d22f6ef9a28in17

Example Response

Status code: 200

Success.

{
  "workflow_id" : "e1bfd0d1-b8d8-417c-9947-7e2ae0de9745"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)