Creating a Dump Connector for an Instance
Function
This API is used to create a dump connector for an instance.
Currently, this API can only be used to create dump connectors for pay-per-use instances.
Debugging
You can use API Explorer to debug this API.
URI
POST /v2/{project_id}/instances/{instance_id}/connector
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| specification | No | String | Bandwidth for deploying the connector, that is, the maximum amount of data transferred per unit time. Unit: byte/s. The value can be:
If this parameter is not specified, the connector bandwidth will be the same as the instance bandwidth. In earlier phases, you do not need to set this parameter. Keep it the same as the current instance specifications. You can select different specifications as required in the future. |
| node_cnt | No | String | Number of connectors. The value must be at least 2. The default value is 2. |
| spec_code | Yes | String | Specification code of the connector. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | Task ID. |
| connector_id | String | Instance dump ID. |
Example Requests
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector
{
"specification" : "100MB",
"node_cnt" : "",
"spec_code" : "kafka.c3.mini.connector"
} Example Responses
Status code: 200
A dump connector is created successfully.
{
"job_id" : "7c3ec20c-11de-4df9-acc0-7ef1dea25dfe",
"connector_id" : "55b78880-9077-4c74-ad5a-6868555f76a4"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | A dump connector is created successfully. |
Error Codes
See Error Codes.
Last Article: Dumping Management
Next Article: Creating a Dumping Task
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.