From a3938c486ccae8f860876b991b892260e9be5489 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Wed, 25 Aug 2021 11:47:14 +0800 Subject: [PATCH 1/2] ticdc-open-api: correct some error --- ticdc/ticdc-open-api.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/ticdc/ticdc-open-api.md b/ticdc/ticdc-open-api.md index a6396f586bce2..f4a737150cc70 100644 --- a/ticdc/ticdc-open-api.md +++ b/ticdc/ticdc-open-api.md @@ -128,7 +128,9 @@ Compared to the optional parameters for creating a replication task using the `c | `mounter_worker_num` | `INT` type. The mounter thread number. (Optional) | | `sink_config` | The configuration parameters of sink. (Optional) | -The meaning and format of `changefeed_id`, `start_ts`, `target_ts`, and `sink_uri` are the same as those described in the [Use `cdc cli` to create a replication task](/ticdc/manage-ticdc.md#create-a-replication-task) document. For the detailed description of these parameters, see this document. Some other parameters in the above table are described further as follows. +The meaning and format of `changefeed_id`, `start_ts`, `target_ts`, and `sink_uri` are the same as those described in the [Use `cdc cli` to create a replication task](/ticdc/manage-ticdc.md#create-a-replication-task) document. For the detailed description of these parameters, see this document. Note that when you specify the certificate path in `sink_uri`, make sure you have uploaded the corresponding certificate to the corresponding TiCDC server. + +Some other parameters in the above table are described further as follows. `force_replicate`: This parameter defaults to `false`. When it is specified as `true`, TiCDC tries to forcibly replicate tables that do not have a unique index. @@ -170,7 +172,7 @@ The following request creates a replication task with an ID of `test5` and a `si {{< copyable "shell-regular" >}} ```shell -curl -X POST -H "'Content-type':'application/json'" http://127.0.0.1:8300/api/v1/changefeeds -d '{"changefeed_id":"test5","sink_uri":"blcakhole://"}' +curl -X POST -H "'Content-type':'application/json'" http://127.0.0.1:8300/api/v1/changefeeds -d '{"changefeed_id":"test5","sink_uri":"blackhole://"}' ``` If the request is successful, `202 Accepted` is returned. If the request fails, an error message and error code are returned. @@ -219,7 +221,7 @@ To modify the changefeed configuration, follow the steps of `pause the replicati | Parameter name | Description | | :-------------- | :----------------------------------- | -| `changefeed_id` | The ID of the replication task (changefeed) to be updated. | +| `changefeed_id` | The ID of the replication task (changefeed) to be paused. | #### Parameters for the request body @@ -243,7 +245,7 @@ The following request updates the `mounter_worker_num` of the replication task w {{< copyable "shell-regular" >}} ```shell - curl -X POST -H "'Content-type':'application/json'" http://127.0.0.1:8300/api/v1/changefeeds/test1 -d '{"mounter_worker_num":32}' + curl -X PUT -H "'Content-type':'application/json'" http://127.0.0.1:8300/api/v1/changefeeds/test1 -d '{"mounter_worker_num":32}' ``` If the request is successful, `202 Accepted` is returned. If the request fails, an error message and error code are returned. From 2c3bfa01498acc87cd7b88ef8a661a95999004dd Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Wed, 25 Aug 2021 11:54:10 +0800 Subject: [PATCH 2/2] Update ticdc/ticdc-open-api.md Co-authored-by: dongmen <20351731+asddongmen@users.noreply.github.com> --- ticdc/ticdc-open-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-open-api.md b/ticdc/ticdc-open-api.md index f4a737150cc70..e43892a9d3a87 100644 --- a/ticdc/ticdc-open-api.md +++ b/ticdc/ticdc-open-api.md @@ -221,7 +221,7 @@ To modify the changefeed configuration, follow the steps of `pause the replicati | Parameter name | Description | | :-------------- | :----------------------------------- | -| `changefeed_id` | The ID of the replication task (changefeed) to be paused. | +| `changefeed_id` | The ID of the replication task (changefeed) to be updated. | #### Parameters for the request body