This topic describes the OpenAPI CreateMilvusDataSource provided by OceanBase Migration Service (OMS).
Function
This API is used to create a Milvus data source.
API details
Constraints
This API is applicable to OMS V4.3.2 and later.
Request path
POST /api/v2?Action=CreateMilvusDataSource
Request parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | The identifier of the data source. We recommend that you use a combination of Chinese characters, digits, and letters. The name cannot contain spaces and must be no longer than 32 characters. |
| region | string | The region to which the data source belongs. |
| ip | string | The IP address of the database host. |
| port | integer | The port number of the IP address of the database host. |
| enableIncrSync | boolean | Specifies whether to enable incremental synchronization. |
| kafkaEndpointId | string | The ID of the Kafka data source that stores the log information of the Milvus database. |
| kafkaTopics | string | The topics in the Kafka data source that store the log information of the Milvus database. |
| etcdEndpoint | string | The endpoint of the etcd service that stores the metadata of the Milvus database. |
| etcdRootPath | string | The root prefix of the key in etcd where the Milvus database stores data. |
| etcdMetaSubPath | string | The subprefix of the key in etcd where the Milvus database stores metadata. |
| dbType | string | The type of the database. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call was successful. |
| errorDetail | object | The details of the error. |
| code | string | The error code. |
| message | string | The description. |
| advice | string | The recommendation. |
| requestId | string | The request ID. |
| pageNumber | integer | The page number, which takes effect when you perform a paginated query. |
| pageSize | integer | The page size, which takes effect when you perform a paginated query. |
| totalCount | integer | The total number of items, which takes effect when you perform a paginated query. |
| cost | string | The time consumed by the request, in seconds. |
| data | string | The ID of the Milvus data source. |
Examples
Request example
{
"name": "milvus_test",
"region": "cn-shanghai",
"ip": "xxx.xxx.xxx.1",
"port": "23530",
"enableIncrSync": true,
"kafkaEndpointId": "e_76fy****",
"kafkaTopics": [
"test_topic"
],
"etcdEndpoint": "http://xxx.xxx.xxx.2:2379",
"etcdRootPath": "etcd_root_path",
"etcdMetaSubPath": "etcd_meta_sub_path",
"dbType": "MILVUS"
}
Response example
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":"a7b57****",
"pageNumber":null,
"pageSize":null,
"totalCount":null,
"cost":"27 ms",
"data":"e_edz****"
}