This API is used to remove a node from a cluster before the cluster is initialized. If you set a password in the request, you must specify the X-OCS-Auth field in the header for authentication.
Call description
Limitations
If you set a password in the request, you must specify the X-OCS-Auth field in the header for authentication. For more information, see Authentication based on public-key encryption.
Request path
DELETE /api/v1/agent POST /api/v1/agent/remove
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| ip | String | Yes | xxx.xxx.1 | The IP address of the node that you want to remove from the agent. |
| port | Integer | Yes | 2886 | The port number of the node that you want to remove from the agent. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. |
| data | Object | The information about the asynchronous task. For more information, see GetDagDetails. |
| error | Object | The information about the error that occurred. |
Examples
Sample request
{
"ip":"xxx.xxx.1",
"port":2886
}
Sample response
{
"successful": true,
"timestamp": "2024-01-09T11:53:04.340558805+08:00",
"duration": 1,
"status": 200,
"traceId": "1a4ef28ea713c837",
"data": {
"id": "22130706433028869",
"dag_id": 2,
"name": "Remove all agents",
"stage": 1,
"max_stage": 2,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T11:53:04.339374213+08:00",
"end_time": "2024-01-09T11:53:04.339374213+08:00",
"additional_data": null,
"nodes": null
}
}