Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Smart Connect/ Enabling Smart Connect (Pay-per-Use Instance)
Updated on 2026-03-16 GMT+08:00
View PDF

Enabling Smart Connect (Pay-per-Use Instance)

Function

This API is used to enable Smart Connect so you can create a connector.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/connector

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

specification

No

String

Bandwidth for deploying Smart Connect, that is, the maximum amount of data transferred per unit time. Use the bandwidth of the current instance.

node_cnt

No

String

Number of connectors. Min.: 2.

The default value is 2 if it is not specified.

spec_code

No

String

Specification code of the connector. This parameter is mandatory only for old instance flavors.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

connector_id

String

Instance dump ID.

Example Requests

  • To enable Smart Connect for pay-per-use instances using new flavors, set the number of connectors to 2.

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector

{
  "node_cnt" : 2
}

  • To enable Smart Connect for pay-per-use instances using old flavors, set the size of connectors to 100 MB and the number of them to 2.

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector

{
  "specification" : "100MB",
  "node_cnt" : 2,
  "spec_code" : "kafka.c3.mini.connector"
}

Example Responses

Status code: 200

Successful.

{
  "job_id" : "7c3ec20c-11de-4df9-acc0-7ef1dea25dfe",
  "connector_id" : "55b78880-9077-4c74-ad5a-6868555f76a4"
}

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent Topic: Smart Connect