Remove a connectable OceanBase cluster from an OBProxy cluster

2024-11-06 03:13:28  Updated

Description

You can call this operation to remove a connectable OceanBase cluster from an OBProxy cluster.

Call description

Prerequisite

You have passed the authentication for the OCP application service.

Request path

DELETE /api/v2/obproxy/clusters/{id}/obLinks/{obClusterName}

Request parameters

Path parameters

Parameter Type Required Example value Description
id Long Yes 1 The ID of the OBProxy cluster.
obClusterName String Yes obcluster The name of the OceanBase cluster.

Response parameters

Parameter Type Description
successful Boolean Indicates whether the request was successful.
timestamp Datetime The timestamp when the server completed the request.
duration Integer The time taken by the server to process the request, in milliseconds.
status Integer An HTTP status code.
traceId String The trace ID of the request. This trace ID is used for troubleshooting.
server String The address of the application server that responded to the request.

Examples

Sample request

DELETE /api/v2/obproxy/clusters/1/obLinks/obcluster

Sample response

{
        "duration": 121,
        "server": "a83ad33525",
        "status": 200,
        "successful": true,
        "timestamp": "2021-09-03T16:48:32.957+08:00",
        "traceId": "87dbc0dd2459490c"
}

Contact Us