Function
This API is used to add or delete instance tags in batches.
+Function
This API is used to add or delete instance tags in batches.
URI
POST /v2/{project_id}/kafka/{instance_id}/tags/action
@@ -89,7 +89,7 @@String
Tag key, which:
+Tag key.
Must be specified.
Must be unique for the same instance.
Can contain 1 to 128 characters.
diff --git a/docs/dms/api-ref/BatchDeleteGroup.html b/docs/dms/api-ref/BatchDeleteGroup.html index 139c881e..d3f797d0 100644 --- a/docs/dms/api-ref/BatchDeleteGroup.html +++ b/docs/dms/api-ref/BatchDeleteGroup.html @@ -1,7 +1,7 @@ -Batch Deleting Consumer Groups of a Kafka Instance
-Function
This API is used to delete multiple consumer groups of a Kafka instance in batches.
+Deleting Consumer Groups of a Kafka Instance in Batches
+Function
This API is used to delete multiple consumer groups of a Kafka instance in batches.
URI
POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete
diff --git a/docs/dms/api-ref/BatchDeleteInstanceTopic.html b/docs/dms/api-ref/BatchDeleteInstanceTopic.html index d7eb64b2..efe41f05 100644 --- a/docs/dms/api-ref/BatchDeleteInstanceTopic.html +++ b/docs/dms/api-ref/BatchDeleteInstanceTopic.html @@ -1,7 +1,7 @@Batch Deleting Topics of a Kafka Instance
-Function
This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is returned with information about topics that fail to be deleted.
+Function
This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is returned with information about topics that fail to be deleted.
URI
POST /v2/{project_id}/instances/{instance_id}/topics/delete
@@ -22,8 +22,6 @@String
Project ID. For details about how to obtain it, see Obtaining a Project ID.
-Minimum: 1
-Maximum: 64
instance_id
@@ -33,8 +31,6 @@String
Instance ID.
-Minimum: 1
-Maximum: 64
Deleting Users in Batches
-Function
This API is used to delete multiple users of a Kafka instance.
+Function
This API is used to delete multiple users of a Kafka instance.
URI
PUT /v2/{project_id}/instances/{instance_id}/users
diff --git a/docs/dms/api-ref/BatchRestartOrDeleteInstances.html b/docs/dms/api-ref/BatchRestartOrDeleteInstances.html index 81b71b91..86f827c4 100644 --- a/docs/dms/api-ref/BatchRestartOrDeleteInstances.html +++ b/docs/dms/api-ref/BatchRestartOrDeleteInstances.html @@ -1,7 +1,7 @@Batch Restarting or Deleting Instances
-Function
This API is used to restart or delete instances in batches.
+diff --git a/docs/dms/api-ref/CLASS.TXT.json b/docs/dms/api-ref/CLASS.TXT.json index d8cc7bac..ac70dc21 100644 --- a/docs/dms/api-ref/CLASS.TXT.json +++ b/docs/dms/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"This API is used to create a pay-per-use or yearly/monthly-billed instance.POST /v2/{engine}/{project_id}/instancesStatus code: 200Creating a pay-per-use Kafka instance w", + "desc":"This API is used to create an instance.Pay-per-use and yearly/monthly billing modes are supported.POST /v2/{engine}/{project_id}/instancesStatus code: 200Creating a pay-p", "product_code":"dms", "title":"Creating an Instance", "uri":"CreateInstanceByEngine.html", @@ -218,14 +218,14 @@ { "desc":"This API is used to delete multiple consumer groups of a Kafka instance in batches.POST /v2/{project_id}/instances/{instance_id}/groups/batch-deleteStatus code: 200Batch ", "product_code":"dms", - "title":"Batch Deleting Consumer Groups of a Kafka Instance", + "title":"Deleting Consumer Groups of a Kafka Instance in Batches", "uri":"BatchDeleteGroup.html", "doc_type":"api", "p_code":"12", "code":"25" }, { - "desc":"This API is used to create a consumer group.POST /v2/{project_id}/kafka/instances/{instance_id}/groupStatus code: 400Creating a consumer group named testStatus code: 200C", + "desc":"This API is used to create a consumer group.POST /v2/{project_id}/kafka/instances/{instance_id}/groupStatus code: 200Status code: 400Creating a consumer group named testS", "product_code":"dms", "title":"Creating a Consumer Group", "uri":"CreateKafkaConsumerGroup.html", @@ -242,6 +242,96 @@ "p_code":"12", "code":"27" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Smart Connect", + "uri":"topic_300000011.html", + "doc_type":"api", + "p_code":"2", + "code":"28" + }, + { + "desc":"This API is used to enable Smart Connect so you can create a connector.POST /v2/{project_id}/instances/{instance_id}/connectorStatus code: 200To enable Smart Connect for ", + "product_code":"dms", + "title":"Enabling Smart Connect (Pay-per-Use Instance)", + "uri":"CreateConnector.html", + "doc_type":"api", + "p_code":"28", + "code":"29" + }, + { + "desc":"This API is used to disable Smart Connect for a pay-per-use instance.POST /v2/{project_id}/kafka/instances/{instance_id}/delete-connectorNoneStatus code: 200Status code: ", + "product_code":"dms", + "title":"Disabling Smart Connect (Pay-per-Use Instance)", + "uri":"DeleteConnector.html", + "doc_type":"api", + "p_code":"28", + "code":"30" + }, + { + "desc":"This API is used to create a Smart Connect task.POST /v2/{project_id}/instances/{instance_id}/connector/tasksStatus code: 200Creating a dumping task that starts immediate", + "product_code":"dms", + "title":"Creating a Smart Connect Task", + "uri":"CreateConnectorTask.html", + "doc_type":"api", + "p_code":"28", + "code":"31" + }, + { + "desc":"This API is used to query Smart Connect tasks.GET /v2/{project_id}/instances/{instance_id}/connector/tasksNoneStatus code: 200NoneStatus code: 200Successful.See Error Cod", + "product_code":"dms", + "title":"Querying Smart Connect Tasks", + "uri":"ListConnectorTasks.html", + "doc_type":"api", + "p_code":"28", + "code":"32" + }, + { + "desc":"This API is used to query Smart Connect task details.GET /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}NoneStatus code: 200NoneStatus code: 200Success", + "product_code":"dms", + "title":"Querying Smart Connect Task Details", + "uri":"ShowConnectorTask.html", + "doc_type":"api", + "p_code":"28", + "code":"33" + }, + { + "desc":"This API is used to delete a Smart Connect task.DELETE /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}NoneNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Deleting a Smart Connect Task", + "uri":"DeleteConnectorTask.html", + "doc_type":"api", + "p_code":"28", + "code":"34" + }, + { + "desc":"This API is used to pause a Smart Connect task.PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pauseNoneNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Pausing a Smart Connect Task", + "uri":"PauseConnectorTask.html", + "doc_type":"api", + "p_code":"28", + "code":"35" + }, + { + "desc":"This API is used to restart a Smart Connect task.PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resumeNoneNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Restarting a Smart Connect Task", + "uri":"ResumeConnectorTask.html", + "doc_type":"api", + "p_code":"28", + "code":"36" + }, + { + "desc":"This API is used to start a Smart Connect task or restart a paused or running Smart Connect task. Note that the sync progress will reset and the task will restart.PUT /v2", + "product_code":"dms", + "title":"Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task", + "uri":"RestartConnectorTask.html", + "doc_type":"api", + "p_code":"28", + "code":"37" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dms", @@ -249,7 +339,7 @@ "uri":"topic_300000003.html", "doc_type":"api", "p_code":"2", - "code":"28" + "code":"38" }, { "desc":"This API is used to modify instance specifications.POST /v2/{engine}/{project_id}/instances/{instance_id}/extendStatus code: 200Expanding the storage space (pay-per-use)P", @@ -257,8 +347,8 @@ "title":"Increasing Instance Specifications", "uri":"ResizeEngineInstance.html", "doc_type":"api", - "p_code":"28", - "code":"29" + "p_code":"38", + "code":"39" }, { "desc":"This API is used to query the product information for instance specification modification.GET /v2/{engine}/{project_id}/instances/{instance_id}/extendNoneStatus code: 200", @@ -266,8 +356,8 @@ "title":"Querying Product Information for Instance Specification Modification", "uri":"ShowEngineInstanceExtendProductInfo.html", "doc_type":"api", - "p_code":"28", - "code":"30" + "p_code":"38", + "code":"40" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -276,7 +366,7 @@ "uri":"topic_300000004.html", "doc_type":"api", "p_code":"2", - "code":"31" + "code":"41" }, { "desc":"This API is used to create a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/topicsStatus code: 200Creating a topic named test01Status code: 200S", @@ -284,8 +374,8 @@ "title":"Creating a Topic for a Kafka Instance", "uri":"CreateInstanceTopic.html", "doc_type":"api", - "p_code":"31", - "code":"32" + "p_code":"41", + "code":"42" }, { "desc":"This API is used to query details about topics of a Kafka instance.GET /v2/{project_id}/instances/{instance_id}/topicsNoneStatus code: 200Querying the topic listStatus co", @@ -293,8 +383,8 @@ "title":"Listing Topics of a Kafka Instance", "uri":"ListInstanceTopics.html", "doc_type":"api", - "p_code":"31", - "code":"33" + "p_code":"41", + "code":"43" }, { "desc":"This API is used to modify topics of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/topicsNoneModifying parameters of topic-1284340884. Specifically, chang", @@ -302,8 +392,8 @@ "title":"Modifying Topics of a Kafka Instance", "uri":"UpdateInstanceTopic.html", "doc_type":"api", - "p_code":"31", - "code":"34" + "p_code":"41", + "code":"44" }, { "desc":"This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is re", @@ -311,8 +401,8 @@ "title":"Batch Deleting Topics of a Kafka Instance", "uri":"BatchDeleteInstanceTopic.html", "doc_type":"api", - "p_code":"31", - "code":"35" + "p_code":"41", + "code":"45" }, { "desc":"This API is used to query the partition list of a topic.GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/partitionsNoneStatus code: 200Querying the parti", @@ -320,8 +410,8 @@ "title":"Querying the Partition List of a Topic", "uri":"ListTopicPartitions.html", "doc_type":"api", - "p_code":"31", - "code":"36" + "p_code":"41", + "code":"46" }, { "desc":"This API is used to query the current producer list of a topic.GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producersNoneStatus code: 200Querying the", @@ -329,8 +419,8 @@ "title":"Querying the Current Producer List of a Topic", "uri":"ListTopicProducers.html", "doc_type":"api", - "p_code":"31", - "code":"37" + "p_code":"41", + "code":"47" }, { "desc":"This API is used to query topic details of a Kafka instance. (Up to 1s for each instance call)GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}NoneSt", @@ -338,8 +428,8 @@ "title":"Querying Topic Details", "uri":"ShowInstanceTopicDetail.html", "doc_type":"api", - "p_code":"31", - "code":"38" + "p_code":"41", + "code":"48" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -348,7 +438,7 @@ "uri":"topic_300000005.html", "doc_type":"api", "p_code":"2", - "code":"39" + "code":"49" }, { "desc":"This API is used to query the user list.User management is supported only when SASL is enabled for the Kafka instance.GET /v2/{project_id}/instances/{instance_id}/usersNo", @@ -356,8 +446,8 @@ "title":"Querying the User List", "uri":"ShowInstanceUsers.html", "doc_type":"api", - "p_code":"39", - "code":"40" + "p_code":"49", + "code":"50" }, { "desc":"This API is used to create a user for a Kafka instance for which SASL is enabled.POST /v2/{project_id}/instances/{instance_id}/usersStatus code: 400Status code: 403Creati", @@ -365,8 +455,8 @@ "title":"Creating a User", "uri":"CreateInstanceUser.html", "doc_type":"api", - "p_code":"39", - "code":"41" + "p_code":"49", + "code":"51" }, { "desc":"This API is used to delete multiple users of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/usersNoneDeleting users in batches.NoneSee Error Codes.", @@ -374,8 +464,8 @@ "title":"Deleting Users in Batches", "uri":"BatchDeleteInstanceUsers.html", "doc_type":"api", - "p_code":"39", - "code":"42" + "p_code":"49", + "code":"52" }, { "desc":"This API is used to reset a user password.PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}NoneResetting a user password.NoneSee Error Codes.", @@ -383,8 +473,8 @@ "title":"Resetting a User Password", "uri":"ResetUserPasswrod.html", "doc_type":"api", - "p_code":"39", - "code":"43" + "p_code":"49", + "code":"53" }, { "desc":"This API is used to query user permissions.User management is supported only when SASL is enabled for the Kafka instance.GET /v1/{project_id}/instances/{instance_id}/topi", @@ -392,8 +482,8 @@ "title":"Querying User Permissions", "uri":"ShowTopicAccessPolicy.html", "doc_type":"api", - "p_code":"39", - "code":"44" + "p_code":"49", + "code":"54" }, { "desc":"This API is used to grant user permissions.User management is supported only when SASL is enabled for the Kafka instance.POST /v1/{project_id}/instances/{instance_id}/top", @@ -401,8 +491,8 @@ "title":"Granting User Permissions", "uri":"UpdateTopicAccessPolicy.html", "doc_type":"api", - "p_code":"39", - "code":"45" + "p_code":"49", + "code":"55" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -411,16 +501,16 @@ "uri":"topic_300000006.html", "doc_type":"api", "p_code":"2", - "code":"46" + "code":"56" }, { - "desc":"This API is used to query the offset and content of a message. This API queries the message offset based on the timestamp and then queries the message content based on th", + "desc":"This API is used to query the offset and content of a message.This API queries the message offset based on the timestamp and then queries the message content based on the", "product_code":"dms", "title":"Querying Messages", "uri":"ShowInstanceMessages.html", "doc_type":"api", - "p_code":"46", - "code":"47" + "p_code":"56", + "code":"57" }, { "desc":"This API is used to query a message with a specified offset.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/messageNoneStatu", @@ -428,8 +518,8 @@ "title":"Querying a Message with a Specified Offset", "uri":"ShowPartitionMessage.html", "doc_type":"api", - "p_code":"46", - "code":"48" + "p_code":"56", + "code":"58" }, { "desc":"This API is used to query a message with a specified time period.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messagesNoneStatus code: 200Status", @@ -437,8 +527,8 @@ "title":"Querying a Message with a Specified Time Period", "uri":"ShowMessages.html", "doc_type":"api", - "p_code":"46", - "code":"49" + "p_code":"56", + "code":"59" }, { "desc":"This API is used to query the offset of the earliest message in a partition.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/", @@ -446,8 +536,8 @@ "title":"Querying Offset of the Earliest Message in a Partition", "uri":"ShowPartitionBeginningMessage.html", "doc_type":"api", - "p_code":"46", - "code":"50" + "p_code":"56", + "code":"60" }, { "desc":"This API is used to query the offset of the latest message in a partition.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/en", @@ -455,8 +545,8 @@ "title":"Querying Offset of the Latest Message in a Partition", "uri":"ShowPartitionEndMessage.html", "doc_type":"api", - "p_code":"46", - "code":"51" + "p_code":"56", + "code":"61" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -465,7 +555,7 @@ "uri":"topic_300000007.html", "doc_type":"api", "p_code":"2", - "code":"52" + "code":"62" }, { "desc":"This API is used to list background tasks of an instance.GET /v2/{project_id}/instances/{instance_id}/tasksNoneStatus code: 200Status code: 200Background tasks are listed", @@ -473,8 +563,8 @@ "title":"Listing Background Tasks", "uri":"ListBackgroundTasks.html", "doc_type":"api", - "p_code":"52", - "code":"53" + "p_code":"62", + "code":"63" }, { "desc":"This API is used to query a specified background task.GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneStatus code: 200Status code: 200The query is success", @@ -482,8 +572,8 @@ "title":"Querying a Background Task", "uri":"ShowBackgroundTask.html", "doc_type":"api", - "p_code":"52", - "code":"54" + "p_code":"62", + "code":"64" }, { "desc":"This API is used to delete a specified background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneNoneDeleting a specified background taskNoneSee ", @@ -491,8 +581,8 @@ "title":"Deleting a Background Task", "uri":"DeleteBackgroundTask.html", "doc_type":"api", - "p_code":"52", - "code":"55" + "p_code":"62", + "code":"65" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -501,7 +591,7 @@ "uri":"topic_300000008.html", "doc_type":"api", "p_code":"2", - "code":"56" + "code":"66" }, { "desc":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/kafka/{instance_id}/tags/actionNoneCreating instance tags with tag keys key1 and key2 and", @@ -509,8 +599,8 @@ "title":"Batch Adding or Deleting Tags", "uri":"BatchCreateOrDeleteKafkaTag.html", "doc_type":"api", - "p_code":"56", - "code":"57" + "p_code":"66", + "code":"67" }, { "desc":"This API is used to query instance tags.GET /v2/{project_id}/kafka/{instance_id}/tagsNoneStatus code: 200Status code: 200The instance tags are listed successfully.See Err", @@ -518,8 +608,8 @@ "title":"Listing Tags of an Instance", "uri":"ShowKafkaTags.html", "doc_type":"api", - "p_code":"56", - "code":"58" + "p_code":"66", + "code":"68" }, { "desc":"This API is used to query project tags.GET /v2/{project_id}/kafka/tagsNoneStatus code: 200Status code: 200The project tags are listed successfully.See Error Codes.", @@ -527,8 +617,8 @@ "title":"Listing Tags of a Project", "uri":"ShowKafkaProjectTags.html", "doc_type":"api", - "p_code":"56", - "code":"59" + "p_code":"66", + "code":"69" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -537,7 +627,7 @@ "uri":"topic_300000009.html", "doc_type":"api", "p_code":"2", - "code":"60" + "code":"70" }, { "desc":"This API is used to query the start time and end time of maintenance time windows.GET /v2/instances/maintain-windowsNoneStatus code: 200Status code: 200Query succeeded.Se", @@ -545,8 +635,8 @@ "title":"Listing Maintenance Time Windows", "uri":"ShowMaintainWindows.html", "doc_type":"api", - "p_code":"60", - "code":"61" + "p_code":"70", + "code":"71" }, { "desc":"This API is used to query the AZ ID for creating an instance.GET /v2/available-zonesNoneStatus code: 200Status code: 200The AZ information is queried successfully.The ins", @@ -554,8 +644,8 @@ "title":"Listing AZ Information", "uri":"ListAvailableZones.html", "doc_type":"api", - "p_code":"60", - "code":"62" + "p_code":"70", + "code":"72" }, { "desc":"This API is used to query the product specifications list.GET /v2/{engine}/productsNoneStatus code: 200Status code: 200The product specifications are listed successfully.", @@ -563,8 +653,8 @@ "title":"Querying Product Specifications List", "uri":"ListEngineProducts.html", "doc_type":"api", - "p_code":"60", - "code":"63" + "p_code":"70", + "code":"73" }, { "desc":"This API is used to query Kafka instance monitoring dimensions.GET /v2/{project_id}/instances/{instance_id}/ces-hierarchyNoneStatus code: 200Status code: 200Query succeed", @@ -572,8 +662,8 @@ "title":"Querying Kafka Instance Monitoring Dimensions", "uri":"ShowCesHierarchy.html", "doc_type":"api", - "p_code":"60", - "code":"64" + "p_code":"70", + "code":"74" }, { "desc":"This chapter describes fine-grained permissions management for your Kafka instances. If your account does not need individual IAM users, then you may skip over this chapt", @@ -582,7 +672,7 @@ "uri":"api-grant-policy.html", "doc_type":"api", "p_code":"", - "code":"65" + "code":"75" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -591,7 +681,7 @@ "uri":"kafka-api-0001.html", "doc_type":"api", "p_code":"", - "code":"66" + "code":"76" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -599,8 +689,8 @@ "title":"API V1", "uri":"kafka-api-0002.html", "doc_type":"api", - "p_code":"66", - "code":"67" + "p_code":"76", + "code":"77" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -608,8 +698,8 @@ "title":"APIs for Managing Instances", "uri":"kafka-api-180514001.html", "doc_type":"api", - "p_code":"67", - "code":"68" + "p_code":"77", + "code":"78" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Creating an Instance.This API is used to create a Kafka instance.POST /v1", @@ -617,8 +707,8 @@ "title":"Creating an Instance", "uri":"kafka-api-180514002.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"78", + "code":"79" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Querying an Instance.This API is used to query the details about an insta", @@ -626,8 +716,8 @@ "title":"Querying an Instance", "uri":"kafka-api-180514003.html", "doc_type":"api", - "p_code":"68", - "code":"70" + "p_code":"78", + "code":"80" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Modifying Instance Information.This API is used to modify the instance in", @@ -635,8 +725,8 @@ "title":"Modifying an Instance", "uri":"kafka-api-180514004.html", "doc_type":"api", - "p_code":"68", - "code":"71" + "p_code":"78", + "code":"81" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Deleting an Instance.This API is used to delete an instance to release al", @@ -644,8 +734,8 @@ "title":"Deleting an Instance", "uri":"kafka-api-180514005.html", "doc_type":"api", - "p_code":"68", - "code":"72" + "p_code":"78", + "code":"82" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Batch Restarting or Deleting Instances.This API is used to restart or del", @@ -653,8 +743,8 @@ "title":"Restarting or Deleting Instances in Batches", "uri":"kafka-api-180514006.html", "doc_type":"api", - "p_code":"68", - "code":"73" + "p_code":"78", + "code":"83" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing All Instances.This API is used to query the instances of a tenant", @@ -662,8 +752,8 @@ "title":"Querying All Instances", "uri":"kafka-api-180514007.html", "doc_type":"api", - "p_code":"68", - "code":"74" + "p_code":"78", + "code":"84" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Creating a Topic for a Kafka Instance.This API is used to create a topic ", @@ -671,8 +761,8 @@ "title":"Creating a Topic in a Kafka Instance", "uri":"kafka-api-180614001.html", "doc_type":"api", - "p_code":"68", - "code":"75" + "p_code":"78", + "code":"85" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing Topics of a Kafka Instance.This API is used to query details abou", @@ -680,8 +770,8 @@ "title":"Querying a Topic in a Kafka Instance", "uri":"kafka-api-180614002.html", "doc_type":"api", - "p_code":"68", - "code":"76" + "p_code":"78", + "code":"86" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Batch Deleting Topics of a Kafka Instance.This API is used to delete topi", @@ -689,8 +779,8 @@ "title":"Deleting Topics in a Kafka Instance in Batches", "uri":"kafka-api-180614003.html", "doc_type":"api", - "p_code":"68", - "code":"77" + "p_code":"78", + "code":"87" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -698,8 +788,8 @@ "title":"Other APIs", "uri":"kafka-api-190605002.html", "doc_type":"api", - "p_code":"67", - "code":"78" + "p_code":"77", + "code":"88" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing AZ Information.This API is used to query the AZ ID.GET /v1.0/avai", @@ -707,8 +797,8 @@ "title":"Querying AZ Information", "uri":"kafka-api-180514008.html", "doc_type":"api", - "p_code":"78", - "code":"79" + "p_code":"88", + "code":"89" }, { "desc":"This API is out-of-date and may not be maintained in the future.This API is used to query the product specifications to configure the product ID.GET /v1.0/products?engine", @@ -716,8 +806,8 @@ "title":"Querying Product Specifications", "uri":"kafka-api-180514009.html", "doc_type":"api", - "p_code":"78", - "code":"80" + "p_code":"88", + "code":"90" }, { "desc":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing Maintenance Time Windows.This API is used to query the start and ", @@ -725,8 +815,8 @@ "title":"Querying Maintenance Time Windows", "uri":"kafka-api-180514010.html", "doc_type":"api", - "p_code":"78", - "code":"81" + "p_code":"88", + "code":"91" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -734,8 +824,8 @@ "title":"API V2", "uri":"kafka-api-0003.html", "doc_type":"api", - "p_code":"66", - "code":"82" + "p_code":"76", + "code":"92" }, { "desc":"This API is used to create a Kafka instance.This API is out-of-date and may not be maintained in the future. Please use the API described in Creating an Instance.POST /v2", @@ -743,8 +833,8 @@ "title":"Creating an Instance", "uri":"CreatePostPaidInstance.html", "doc_type":"api", - "p_code":"82", - "code":"83" + "p_code":"92", + "code":"93" }, { "desc":"This API is used to add partitions to a topic for a Kafka instance.This API is out-of-date and may not be maintained in the future. Please use the API described in Modify", @@ -752,8 +842,8 @@ "title":"Adding Partitions to a Topic for a Kafka Instance", "uri":"CreatePartition.html", "doc_type":"api", - "p_code":"82", - "code":"84" + "p_code":"92", + "code":"94" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -762,7 +852,7 @@ "uri":"kafka-api-180514011.html", "doc_type":"api", "p_code":"", - "code":"85" + "code":"95" }, { "desc":"Table 1 lists status codes.", @@ -770,8 +860,8 @@ "title":"Status Code", "uri":"kafka-api-0034672261.html", "doc_type":"api", - "p_code":"85", - "code":"86" + "p_code":"95", + "code":"96" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -779,8 +869,8 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"85", - "code":"87" + "p_code":"95", + "code":"97" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -788,8 +878,8 @@ "title":"Instance Status", "uri":"kafka-api-180514012.html", "doc_type":"api", - "p_code":"85", - "code":"88" + "p_code":"95", + "code":"98" }, { "desc":"A project ID is required for some URLs when an API is called. Obtain a project ID using either of the following methods:Obtaining a Project ID by Calling an APIObtaining ", @@ -797,8 +887,8 @@ "title":"Obtaining a Project ID", "uri":"kafka-api-0036212547.html", "doc_type":"api", - "p_code":"85", - "code":"89" + "p_code":"95", + "code":"99" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -807,6 +897,6 @@ "uri":"kafka-api-0034672268.html", "doc_type":"api", "p_code":"", - "code":"90" + "code":"100" } ] \ No newline at end of file diff --git a/docs/dms/api-ref/CreateConnector.html b/docs/dms/api-ref/CreateConnector.html new file mode 100644 index 00000000..bb8f3a80 --- /dev/null +++ b/docs/dms/api-ref/CreateConnector.html @@ -0,0 +1,158 @@ + + +Function
This API is used to restart or delete instances in batches.
When an instance is being restarted, message retrieval and creation requests of the client will be rejected.
Deleting an instance will delete the data in the instance without any backup. Exercise caution when performing this operation.
Enabling Smart Connect (Pay-per-Use Instance)
+++Function
This API is used to enable Smart Connect so you can create a connector.
++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.
+++ diff --git a/docs/dms/api-ref/CreateConnectorTask.html b/docs/dms/api-ref/CreateConnectorTask.html new file mode 100644 index 00000000..dd40ca6e --- /dev/null +++ b/docs/dms/api-ref/CreateConnectorTask.html @@ -0,0 +1,1062 @@ + + +++Parent topic: Smart Connect+Creating a Smart Connect Task
+++Function
This API is used to create a Smart Connect task.
++URI
POST /v2/{project_id}/instances/{instance_id}/connector/tasks
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
++Request Parameters
++ +
+Table 2 Request body parameters Parameter
+Mandatory
+Type
+Description
+task_name
+No
+String
+Smart Connect task name.
+start_later
+No
+Boolean
+Indicates whether to start a task later. false: to create a task and start immediately; true: to create a task and manually start it later in the task list.
+topics
+No
+String
+Topic of a Smart Connect task.
+topics_regex
+No
+String
+Regular expression of the topic of a Smart Connect task.
+source_type
+No
+String
+Source type of a Smart Connect task.
+source_task
+No
++ +Source configuration of a Smart Connect task.
+sink_type
+No
+String
+Target type of a Smart Connect task.
+sink_task
+No
++ +Target type of a Smart Connect task.
++ +
+Table 3 SmartConnectTaskReqSourceConfig Parameter
+Mandatory
+Type
+Description
+redis_address
+No
+String
+Redis instance address. (Mandatory only when the source type is Redis.)
+redis_type
+No
+String
+Redis instance type. (Mandatory only when the source type is Redis.)
+dcs_instance_id
+No
+String
+DCS instance ID. (Mandatory only when the source type is Redis.)
+redis_password
+No
+String
+Redis password. (Mandatory only when the source type is Redis.)
+sync_mode
+No
+String
+Synchronization type: RDB_ONLY indicates full synchronization; CUSTOM_OFFSET indicates full and incremental synchronization. (Mandatory only when the source type is Redis.)
+full_sync_wait_ms
+No
+Integer
+Interval of full synchronization retries, in ms. (Mandatory only when the source type is Redis.)
+full_sync_max_retry
+No
+Integer
+Max. retries of full synchronization. (Mandatory only when the source type is Redis.)
+ratelimit
+No
+Integer
+Rate limit, in KB/s. -1: There is no rate limit. (Mandatory only when the source type is Redis.)
+current_cluster_name
+No
+String
+Current Kafka instance name. (Mandatory only when the source type is Kafka.)
+cluster_name
+No
+String
+Target Kafka instance name. (Mandatory only when the source type is Kafka.)
+user_name
+No
+String
+Username set when SASL_SSL was enabled for a target Kafka instance, or when a SASL_SSL user was created. (Mandatory only when the source type is Kafka and the target Kafka authentication mode is SASL_SSL.)
+password
+No
+String
+Password set when SASL_SSL was enabled for a target Kafka instance, or when a SASL_SSL user was created. (Mandatory only when the source type is Kafka and the target Kafka authentication mode is SASL_SSL.)
+sasl_mechanism
+No
+String
+Target Kafka authentication mode. (Mandatory only when the source type is Kafka and the authentication mode is SASL_SSL.)
+instance_id
+No
+String
+Target Kafka instance ID. (Mandatory only when the source type is Kafka. Specify either instance_id or bootstrap_servers.)
+bootstrap_servers
+No
+String
+Target Kafka instance address. (Mandatory only when the source type is Kafka. Specify either instance_id or bootstrap_servers.)
+security_protocol
+No
+String
+Target Kafka authentication. (Mandatory only when the source type is Kafka).
+There are two authentication modes:
+SASL_SSL: SASL_SSL is enabled.
+PLAINTEXT: SASL_SSL is disabled.
+
direction
+No
+String
+Sync direction: pull replicates data from the target Kafka instance to the current one; push replicates data from the source Kafka instance to the target one; two-way replicates data from the source and target Kafka instance data to each other. (Mandatory only when the source type is Kafka.)
+sync_consumer_offsets_enabled
+No
+Boolean
+Indicates whether to sync the consumption progress. (Mandatory only when the source type is Kafka.)
+replication_factor
+No
+Integer
+Number of topic replicas when a topic is automatically created in the peer instance. The value of this parameter cannot exceed the number of brokers in the peer instance. This parameter overrides the default.replication.factor parameter configured in the target instance. (Mandatory only when the source type is Kafka.)
+task_num
+No
+Integer
+Number of data replication tasks. The default value is 2. You are advised to use the default value. If the sync direction is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. (Mandatory only when the source type is Kafka.)
+rename_topic_enabled
+No
+Boolean
+Indicates whether to rename a topic. If yes, add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. (Mandatory only when the source type is Kafka.)
+provenance_header_enabled
+No
+Boolean
+The target topic receives the replicated messages. The message header contains the message source. If you select Both for Sync Direction, enable Add Source Header to prevent infinite replication. (Mandatory only when the source type is Kafka.)
+consumer_strategy
+No
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Mandatory only when the source type is Kafka.)
+compression_type
+No
+String
+Compression algorithm to use for copying messages. (Mandatory only when the source type is Kafka.)
+none
+gzip
+snappy
+lz4
+zstd
+
topics_mapping
+No
+String
+Topic mapping, which is used to customize the target topic name. Rename Topic and Topic Mapping cannot be configured at the same time. Topic mapping format: source topic:target topic. Use commas (,) to separate multiple topic mappings, for example, topic-sc-1:topic-sc-2,topic-sc-3:topic-sc-4. (Mandatory only when the source type is Kafka.)
++
+Table 4 SmartConnectTaskReqSinkConfig Parameter
+Mandatory
+Type
+Description
+redis_address
+No
+String
+Redis instance address. (Mandatory only when the target type is Redis.)
+redis_type
+No
+String
+Redis instance type. (Mandatory only when the target type is Redis.)
+dcs_instance_id
+No
+String
+DCS instance ID. (Mandatory only when the target type is Redis.)
+redis_password
+No
+String
+Redis password. (Mandatory only when the target type is Redis.)
+consumer_strategy
+No
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Mandatory only when the target type is OBS.)
+destination_file_type
+No
+String
+Dump file format. Only TEXT is supported. (Mandatory only when the target type is OBS.)
+deliver_time_interval
+No
+Integer
+Data dumping intervals, in seconds. The default interval is 300s. (Mandatory only when the target type is OBS.)
+access_key
+No
+String
+AK: access key ID. (Mandatory only when the target type is OBS.)
+secret_key
+No
+String
+SK: secret access key used together with the access key ID. (Mandatory only when the target type is OBS.)
+obs_bucket_name
+No
+String
+Dumping address, which is the OBS bucket used to store the topic data. (Mandatory only when the target type is OBS.)
+obs_path
+No
+String
+Dumping directory, which is the directory for storing topic files dumped to OBS. Use slashes (/) to separate directory levels. (Mandatory only when the target type is OBS.)
+partition_format
+No
+String
+Time directory format. (Mandatory only when the target type is OBS.)
+yyyy: year.
+yyyy/MM: year and month.
+yyyy/MM/dd: year, month, and day.
+yyyy/MM/dd/HH: year, month, day, and hour.
+yyyy/MM/dd/HH/mm: year, month, day, hour, and minute.
+
record_delimiter
+No
+String
+Line break, which is used to separate the user data that is written into the dump file. (Mandatory only when the target type is OBS.)
+Value range:
+Comma (,)
+Semicolon (;)
+Vertical bar (|)
+Newline (\n)
+NULL
+
store_keys
+No
+Boolean
+Specifies whether to dump keys. (Mandatory only when the target type is OBS.)
++Response Parameters
Status code: 200
+ ++ +
+Table 5 Response body parameters Parameter
+Type
+Description
+task_name
+String
+Smart Connect task name.
+topics
+String
+Topic of a Smart Connect task.
+topics_regex
+String
+Regular expression of the topic of a Smart Connect task.
+source_type
+String
+Source type of a Smart Connect task.
+source_task
++ +Source configuration of a Smart Connect task.
+sink_type
+String
+Target type of a Smart Connect task.
+sink_task
++ +Target type of a Smart Connect task.
+id
+String
+ID of a Smart Connect task.
+status
+String
+Smart Connect task status.
+create_time
+Long
+Time when the Smart Connect task was created.
++ +
+Table 6 SmartConnectTaskRespSourceConfig Parameter
+Type
+Description
+redis_address
+String
+Redis instance address. (Displayed only when the source type is Redis.)
+redis_type
+String
+Redis instance type. (Displayed only when the source type is Redis.)
+dcs_instance_id
+String
+DCS instance ID. (Displayed only when the source type is Redis.)
+sync_mode
+String
+Synchronization type: RDB_ONLY indicates full synchronization; CUSTOM_OFFSET indicates full and incremental synchronization. (Displayed only when the source type is Redis.)
+full_sync_wait_ms
+Integer
+Interval of full synchronization retries, in ms. (Displayed only when the source type is Redis.)
+full_sync_max_retry
+Integer
+Max. retries of full synchronization. (Displayed only when the source type is Redis.)
+ratelimit
+Integer
+Rate limit, in KB/s. -1: disable. (Displayed only when the source type is Redis.)
+current_cluster_name
+String
+Current Kafka instance name. (Displayed only when the source type is Kafka.)
+cluster_name
+String
+Target Kafka instance name. (Displayed only when the source type is Kafka.)
+user_name
+String
+Username of the target Kafka instance. (Displayed only when the source type is Kafka.)
+sasl_mechanism
+String
+Target Kafka authentication mode. (Displayed only when the source type is Kafka.)
+instance_id
+String
+Target Kafka instance ID. (Displayed only when the source type is Kafka.)
+bootstrap_servers
+String
+Target Kafka instance address. (Displayed only when the source type is Kafka.)
+security_protocol
+String
+Target Kafka authentication. (Displayed only when the source type is Kafka.)
+direction
+String
+Sync direction. (Displayed only when the source type is Kafka.)
+sync_consumer_offsets_enabled
+Boolean
+Indicates whether to sync the consumption progress. (Displayed only when the source type is Kafka.)
+replication_factor
+Integer
+Number of replicas. (Displayed only when the source type is Kafka.)
+task_num
+Integer
+Number of tasks. (Displayed only when the source type is Kafka.)
+rename_topic_enabled
+Boolean
+Indicates whether to rename a topic. (Displayed only when the source type is Kafka.)
+provenance_header_enabled
+Boolean
+Indicates whether to add the source header. (Displayed only when the source type is Kafka.)
+consumer_strategy
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Displayed only when the source type is Kafka.)
+compression_type
+String
+Compression algorithm. (Displayed only when the source type is Kafka.)
+topics_mapping
+String
+Topic mapping. (Displayed only when the source type is Kafka.)
++
+Table 7 SmartConnectTaskRespSinkConfig Parameter
+Type
+Description
+redis_address
+String
+Redis instance address. (Displayed only when the target type is Redis.)
+redis_type
+String
+Redis instance type. (Displayed only when the target type is Redis.)
+dcs_instance_id
+String
+DCS instance ID. (Displayed only when the target type is Redis.)
+target_db
+Integer
+Target database. The default value is -1. (Displayed only when the target type is Redis.)
+consumer_strategy
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Displayed only when the target type is OBS.)
+destination_file_type
+String
+Dump file format. Only TEXT is supported. (Displayed only when the target type is OBS.)
+deliver_time_interval
+Integer
+Dumping period (s). (Displayed only when the target type is OBS.)
+obs_bucket_name
+String
+Dumping address. (Displayed only when the target type is OBS.)
+obs_path
+String
+Dump directory. (Displayed only when the target type is OBS.)
+partition_format
+String
+Time directory format. (Displayed only when the target type is OBS.)
+record_delimiter
+String
+Line break. (Displayed only when the target type is OBS.)
+store_keys
+Boolean
+Storage key. (Displayed only when the target type is OBS.)
+obs_part_size
+Integer
+Size (in bytes) of each file to be uploaded. The default value is 5242880. (Displayed only when the target type is OBS.)
+flush_size
+Integer
+flush_size. (Displayed only when the target type is OBS.)
+timezone
+String
+Time zone. (Displayed only when the target type is OBS.)
+schema_generator_class
+String
+schema_generator class. The default value is io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator. (Displayed only when the target type is OBS.)
+partitioner_class
+String
+partitioner class. The default value is io.confluent.connect.storage.partitioner.TimeBasedPartitioner. (Displayed only when the target type is OBS.)
+value_converter
+String
+value_converter. The default value is org.apache.kafka.connect.converters.ByteArrayConverter. (Displayed only when the target type is OBS.)
+key_converter
+String
+key_converter. The default value is org.apache.kafka.connect.converters.ByteArrayConverter. (Displayed only when the target type is OBS.)
+kv_delimiter
+String
+kv_delimiter. The default value is :. (Displayed only when the target type is OBS.)
++Example Requests
Creating a dumping task that starts immediately.
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks + +{ + "task_name" : "smart-connect-1", + "start_later" : false, + "source_type" : "NONE", + "topics_regex" : "topic-obs*", + "sink_type" : "OBS_SINK", + "sink_task" : { + "consumer_strategy" : "earliest", + "destination_file_type" : "TEXT", + "deliver_time_interval" : 300, + "access_key" : "********", + "secret_key" : "********", + "obs_bucket_name" : "obs_bucket", + "obs_path" : "obsTransfer-1810125534", + "partition_format" : "yyyy/MM/dd/HH/mm", + "record_delimiter" : "\\n", + "store_keys" : false + } +}+Creating a Kafka data replication task that starts later.
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks + +{ + "task_name" : "smart-connect-2", + "start_later" : true, + "source_type" : "KAFKA_REPLICATOR_SOURCE", + "source_task" : { + "current_cluster_name" : "A", + "cluster_name" : "B", + "user_name" : "user1", + "password" : "********", + "sasl_mechanism" : "SCRAM-SHA-512", + "instance_id" : "b54c9dd8-********-********", + "direction" : "two-way", + "sync_consumer_offsets_enabled" : false, + "replication_factor" : 3, + "task_num" : 2, + "rename_topic_enabled" : false, + "provenance_header_enabled" : true, + "consumer_strategy" : "latest", + "compression_type" : "snappy", + "topics_mapping" : "topic-sc-1:topic-sc-3,topic-sc-2:topic-sc-4" + } +}+Creating a Redis data replication task that starts immediately: full synchronization, 10 maximum retry times, 10,000 ms retry interval, and 10 KB/s bandwidth limit.
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks + +{ + "task_name" : "smart-connect-3", + "start_later" : false, + "source_type" : "REDIS_REPLICATOR_SOURCE", + "source_task" : { + "redis_address" : "192.168.99.249:6379,192.168.120.127:6379,192.168.116.219:6379", + "redis_type" : "cluster", + "redis_password" : "********", + "sync_mode" : "RDB_ONLY", + "full_sync_max_retry" : 10, + "full_sync_wait_ms" : 10000, + "ratelimit" : 10 + }, + "topics" : "topic-sc-3", + "sink_type" : "REDIS_REPLICATOR_SINK", + "sink_task" : { + "redis_address" : "192.168.119.51:6379", + "redis_type" : "standalone", + "redis_password" : "********" + } +}+
+Example Responses
Status code: 200
+Successful.
+{ + "task_name" : "smart-connect-121248117", + "topics" : "topic-sc", + "source_task" : { + "redis_address" : "192.168.91.179:6379", + "redis_type" : "standalone", + "dcs_instance_id" : "949190a2-598a-4afd-99a8-dad3cae1e7cd", + "sync_mode" : "RDB_ONLY,", + "full_sync_wait_ms" : 13000, + "full_sync_max_retry" : 4, + "ratelimit" : -1 + }, + "source_type" : "REDIS_REPLICATOR_SOURCE", + "sink_task" : { + "redis_address" : "192.168.119.51:6379", + "redis_type" : "standalone", + "dcs_instance_id" : "9b981368-a8e3-416a-87d9-1581a968b41b", + "target_db" : -1 + }, + "sink_type" : "REDIS_REPLICATOR_SINK", + "id" : "8a205bbd-7181-4b5e-9bd6-37274ce84577", + "status" : "RUNNING", + "create_time" : 1708427753133 +}++Status Codes
++
+Status Code
+Description
+200
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/CreateInstanceByEngine.html b/docs/dms/api-ref/CreateInstanceByEngine.html index 4c5b50e0..ce4aad06 100644 --- a/docs/dms/api-ref/CreateInstanceByEngine.html +++ b/docs/dms/api-ref/CreateInstanceByEngine.html @@ -1,7 +1,8 @@++Parent topic: Smart Connect+Creating an Instance
-Function
This API is used to create a pay-per-use or yearly/monthly-billed instance.
+Function
This API is used to create an instance.
+Pay-per-use and yearly/monthly billing modes are supported.
URI
POST /v2/{engine}/{project_id}/instances
@@ -22,7 +23,6 @@String
Message engine.
-Default: kafka
project_id
@@ -65,8 +65,8 @@String
Instance description.
-The description can contain a maximum of 1024 characters.
+Description of an instance.
+The description supports up to 1024 characters.
NOTE:The backslash () and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character () before the characters, for example, \ and ".
String
Message engine. Values:
+Version of the message engine. Options:
1.1.0
2.3.0
2.7
+3.x
Authentication mechanism to use after SASL is enabled. This parameter is mandatory if SASL authentication is enabled (ssl_enable=true).
If this parameter is left blank, PLAIN authentication is enabled by default.
-Select both or either of the following mechanisms for SASL authentication. Options:
+Select both or either of the following mechanisms for SASL authentication.
+Options:
PLAIN: simple username and password verification.
SCRAM-SHA-512: user credential verification, which is more secure than PLAIN.
Boolean
Indicates whether to enable IPv6. This parameter is available only when the VPC supports IPv6.
-Default: false
disk_encrypted_enable
@@ -320,6 +321,16 @@Disk encryption key. If disk encryption is not enabled, this parameter is left blank.
connector_enable
+No
+Boolean
+Whether to enable message dumping.
+By default, message dumping is disabled.
+enable_auto_topic
No
@@ -341,11 +352,11 @@String
Storage I/O specification.
-Values:
+Value range:
dms.physical.storage.high.v2: high I/O
dms.physical.storage.ultra.v2: ultra-high I/O
For details about how to select a disk type, see "Disk Types and Disk Performance" in the EVS User Guide.
+For details about how to select a disk type, see "Disk Types and Disk Performance" in the EVS User Guide.
enterprise_project_id
@@ -372,9 +383,9 @@String
CPU architecture. Currently, only the x86 architecture is supported.
-Options:
-X86
+CPU architecture. Currently supported: x86.
+Value range:
+X86
String
Tag key, which:
+Tag key.
Must be specified.
Must be unique for the same instance.
Can contain 1 to 128 characters.
@@ -556,7 +567,7 @@ "name" : "kafka-test", "description" : "", "engine" : "kafka", - "engine_version" : "2.7", + "engine_version" : "2.7,3.x", "storage_space" : 300, "vpc_id" : "********-9b4a-44c5-a964-************", "subnet_id" : "********-8fbf-4438-ba71-************", diff --git a/docs/dms/api-ref/CreateInstanceTopic.html b/docs/dms/api-ref/CreateInstanceTopic.html index d0801184..7f9f1a86 100644 --- a/docs/dms/api-ref/CreateInstanceTopic.html +++ b/docs/dms/api-ref/CreateInstanceTopic.html @@ -1,7 +1,7 @@Creating a Topic for a Kafka Instance
-Function
This API is used to create a topic for a Kafka instance.
+Function
This API is used to create a topic for a Kafka instance.
URI
POST /v2/{project_id}/instances/{instance_id}/topics
@@ -22,8 +22,6 @@String
Project ID. For details about how to obtain it, see Obtaining a Project ID.
-Minimum: 1
-Maximum: 64
instance_id
@@ -33,8 +31,6 @@String
Instance ID.
-Minimum: 1
-Maximum: 64
String
Topic name. A topic name consists of 3 to 200 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), periods (.), and digits.
-Minimum: 3
-Maximum: 200
replication
@@ -69,9 +63,8 @@Integer
Number of replicas, which is configured to ensure data reliability. Value range: 1 to 3.
-Minimum: 1
-Maximum: 3
+Number of replicas, which is configured to ensure data reliability.
+Value range: 1 to 3.
sync_message_flush
@@ -89,9 +82,7 @@Integer
Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: 1–100.
-Minimum: 1
-Maximum: 100
+Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: 1–200
sync_replication
@@ -109,7 +100,7 @@Integer
Indicates the retention period of a message. The default value is 72.Value range: 1–720. Unit: hour.
+Indicates the retention period of a message. The default value is 72.The value range is 1–720, in hours.
topic_other_configs
@@ -119,7 +110,6 @@Array of topic_other_configs objects
Topic configuration.
-Array Length: 0 - 100
topic_desc
@@ -129,8 +119,6 @@String
Topic description.
-Minimum: 0
-Maximum: 200
String
Topic name.
-Minimum: 3
-Maximum: 200
Creating a User
-Function
This API is used to create a user for a Kafka instance for which SASL is enabled.
+-Function
This API is used to create a user for a Kafka instance for which SASL is enabled.
URI
POST /v2/{project_id}/instances/{instance_id}/users
@@ -65,8 +65,6 @@String
User description.
-Minimum: 0
-Maximum: 200
user_passwd
@@ -77,7 +75,8 @@Password.
This parameter is mandatory for creating a user.
-The password must be different from the username. The password must meet the following complexity requirements:
+The password must be different from the username.
+The password must meet the following complexity requirements:
Can contain 8 to 32 characters.
Must contain at least three of the following character types:
Lowercase letters
diff --git a/docs/dms/api-ref/CreateKafkaConsumerGroup.html b/docs/dms/api-ref/CreateKafkaConsumerGroup.html index 524d7350..8aad988a 100644 --- a/docs/dms/api-ref/CreateKafkaConsumerGroup.html +++ b/docs/dms/api-ref/CreateKafkaConsumerGroup.html @@ -1,7 +1,7 @@Creating a Consumer Group
-Function
This API is used to create a consumer group.
+Function
This API is used to create a consumer group.
URI
POST /v2/{project_id}/kafka/instances/{instance_id}/group
@@ -64,17 +64,15 @@String
Consumer group description.
-Minimum: 0
-Maximum: 200
Response Parameters
Status code: 400
+Response Parameters
Status code: 200
-Table 3 Response body parameters Parameter
++
+Table 3 Response body parameters Parameter
Type
error_code
+-
String
Error code.
+Specified IPv4 private IP addresses.
+The number of specified IP addresses must be less than or equal to the number of new brokers.
+If the number of specified IP addresses is less than the number of brokers, the unspecified brokers are randomly assigned private IP addresses.
error_msg
+Status code: 400
+ +Table 4 Response body parameters Parameter
+Type
+Description
+error_code
String
+String
Error description.
+Error code.
+error_msg
+String
+Error description.
Initiating Partition Reassigning for a Kafka Instance
-Function
This API is used to submit a partition rebalancing task to a Kafka instance or calculate estimated rebalancing time.
+Function
This API is used to submit a partition rebalancing task to a Kafka instance or calculate estimated rebalancing time.
URI
POST /v2/kafka/{project_id}/instances/{instance_id}/reassign
@@ -91,7 +91,6 @@Boolean
Set true to perform time estimation tasks and false to perform rebalancing tasks.
-Default: false
Deleting a Background Task
-Function
This API is used to delete a specified background task.
+Function
This API is used to delete a specified background task.
URI
DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
diff --git a/docs/dms/api-ref/DeleteConnector.html b/docs/dms/api-ref/DeleteConnector.html new file mode 100644 index 00000000..62ddee26 --- /dev/null +++ b/docs/dms/api-ref/DeleteConnector.html @@ -0,0 +1,95 @@ + + +Disabling Smart Connect (Pay-per-Use Instance)
+++Function
This API is used to disable Smart Connect for a pay-per-use instance.
++URI
POST /v2/{project_id}/kafka/instances/{instance_id}/delete-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
None
++Response Parameters
Status code: 200
+ ++
+Table 2 Response body parameters Parameter
+Type
+Description
+job_id
+String
+ID of the job for asynchronously executing the deletion task.
++Example Requests
POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/delete-connector++Example Responses
Status code: 200
+Smart Connect disabling task submitted successfully.
+{ + "job_id" : "d366178c-29ea-4d5c-a344-fa2ece4a1836" +}++Status Codes
++
+Status Code
+Description
+200
+Smart Connect disabling task submitted successfully.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/DeleteConnectorTask.html b/docs/dms/api-ref/DeleteConnectorTask.html new file mode 100644 index 00000000..e5cb2c37 --- /dev/null +++ b/docs/dms/api-ref/DeleteConnectorTask.html @@ -0,0 +1,81 @@ + + +++Parent topic: Smart Connect+Deleting a Smart Connect Task
+++Function
This API is used to delete a Smart Connect task.
++URI
DELETE /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
+task_id
+Yes
+String
+Smart Connect task ID.
++Request Parameters
None
++Response Parameters
None
++Example Requests
DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}++Example Responses
None
++Status Codes
++
+Status Code
+Description
+204
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/DeleteGroup.html b/docs/dms/api-ref/DeleteGroup.html index ca263896..70449721 100644 --- a/docs/dms/api-ref/DeleteGroup.html +++ b/docs/dms/api-ref/DeleteGroup.html @@ -1,7 +1,7 @@++Parent topic: Smart Connect+Deleting a Consumer Group from a Kafka Instance
-Function
This API is used to delete a consumer group from a Kafka instance.
+Function
This API is used to delete a consumer group from a Kafka instance.
URI
DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}
diff --git a/docs/dms/api-ref/DeleteInstance.html b/docs/dms/api-ref/DeleteInstance.html index f4d9d775..458b8694 100644 --- a/docs/dms/api-ref/DeleteInstance.html +++ b/docs/dms/api-ref/DeleteInstance.html @@ -1,7 +1,7 @@Deleting an Instance
-Function
This API is used to delete an instance to release all the resources occupied by it.
+Function
This API is used to delete an instance to release all the resources occupied by it.
URI
DELETE /v2/{project_id}/instances/{instance_id}
diff --git a/docs/dms/api-ref/ErrorCode.html b/docs/dms/api-ref/ErrorCode.html index 5d2bcdc6..715756bb 100644 --- a/docs/dms/api-ref/ErrorCode.html +++ b/docs/dms/api-ref/ErrorCode.html @@ -1,7 +1,7 @@Error Codes
-+Status Code
Error Codes
@@ -605,9 +605,9 @@ A password:DMS.00400102
The number of partitions created for a Kafka topic must be within the range of 1-20.
+The number of partitions created for a Kafka topic must be within the range of 1-200.
The number of partitions created for a topic in a Kafka instance must be within the range of 1-20.
+The number of partitions created for a topic in a Kafka instance must be within the range of 1-200.
Check the number of partitions of the topic.
400
DMS.00400975
+Failed to query topics.
+Failed to query topics.
+Check whether the topic exists.
+400
+DMS.00404033
Does not support extend rabbitMQ disk space.
@@ -1769,6 +1780,17 @@ A password:500
DMS.00500990
+Failed to update topics.
+Failed to update topics.
+Contact technical support.
+500
+DMS.00501000
Failed to create agency, may be you do not have the agency permission.
diff --git a/docs/dms/api-ref/ListAvailableZones.html b/docs/dms/api-ref/ListAvailableZones.html index d7400e46..58787ea2 100644 --- a/docs/dms/api-ref/ListAvailableZones.html +++ b/docs/dms/api-ref/ListAvailableZones.html @@ -1,7 +1,7 @@Listing AZ Information
-Function
This API is used to query the AZ ID for creating an instance.
+Function
This API is used to query the AZ ID for creating an instance.
diff --git a/docs/dms/api-ref/ListBackgroundTasks.html b/docs/dms/api-ref/ListBackgroundTasks.html index 27befb23..1cd6f967 100644 --- a/docs/dms/api-ref/ListBackgroundTasks.html +++ b/docs/dms/api-ref/ListBackgroundTasks.html @@ -1,7 +1,7 @@URI
GET /v2/available-zones
Listing Background Tasks
-Function
This API is used to list background tasks of an instance.
+Function
This API is used to list background tasks of an instance.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks
diff --git a/docs/dms/api-ref/ListConnectorTasks.html b/docs/dms/api-ref/ListConnectorTasks.html new file mode 100644 index 00000000..02f85028 --- /dev/null +++ b/docs/dms/api-ref/ListConnectorTasks.html @@ -0,0 +1,635 @@ + + +Querying Smart Connect Tasks
+++Function
This API is used to query Smart Connect tasks.
++URI
GET /v2/{project_id}/instances/{instance_id}/connector/tasks
+ ++ +
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
++
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+offset
+No
+Integer
+Offset, which is the position where the query starts. The value must be greater than or equal to 0.
+limit
+No
+Integer
+Maximum number of instances returned in the current query. The default value is 10. The value ranges from 1 to 50.
++Request Parameters
None
++Response Parameters
Status code: 200
+ ++ +
+Table 3 Response body parameters Parameter
+Type
+Description
+tasks
+Array of SmartConnectTaskEntity objects
+Smart Connect task details.
+total_number
+Integer
+Number of Smart Connect tasks.
+max_tasks
+Integer
+Maximum number of Smart Connect tasks.
+quota_tasks
+Integer
+Smart Connect task quota.
++ +
+Table 4 SmartConnectTaskEntity Parameter
+Type
+Description
+task_name
+String
+Smart Connect task name.
+topics
+String
+Topic of a Smart Connect task.
+topics_regex
+String
+Regular expression of the topic of a Smart Connect task.
+source_type
+String
+Source type of a Smart Connect task.
+source_task
++ +Source configuration of a Smart Connect task.
+sink_type
+String
+Target type of a Smart Connect task.
+sink_task
++ +Target type of a Smart Connect task.
+id
+String
+ID of a Smart Connect task.
+status
+String
+Smart Connect task status.
+create_time
+Long
+Time when the Smart Connect task was created.
++ +
+Table 5 SmartConnectTaskRespSourceConfig Parameter
+Type
+Description
+redis_address
+String
+Redis instance address. (Displayed only when the source type is Redis.)
+redis_type
+String
+Redis instance type. (Displayed only when the source type is Redis.)
+dcs_instance_id
+String
+DCS instance ID. (Displayed only when the source type is Redis.)
+sync_mode
+String
+Synchronization type: RDB_ONLY indicates full synchronization; CUSTOM_OFFSET indicates full and incremental synchronization. (Displayed only when the source type is Redis.)
+full_sync_wait_ms
+Integer
+Interval of full synchronization retries, in ms. (Displayed only when the source type is Redis.)
+full_sync_max_retry
+Integer
+Max. retries of full synchronization. (Displayed only when the source type is Redis.)
+ratelimit
+Integer
+Rate limit, in KB/s. -1: disable. (Displayed only when the source type is Redis.)
+current_cluster_name
+String
+Current Kafka instance name. (Displayed only when the source type is Kafka.)
+cluster_name
+String
+Target Kafka instance name. (Displayed only when the source type is Kafka.)
+user_name
+String
+Username of the target Kafka instance. (Displayed only when the source type is Kafka.)
+sasl_mechanism
+String
+Target Kafka authentication mode. (Displayed only when the source type is Kafka.)
+instance_id
+String
+Target Kafka instance ID. (Displayed only when the source type is Kafka.)
+bootstrap_servers
+String
+Target Kafka instance address. (Displayed only when the source type is Kafka.)
+security_protocol
+String
+Target Kafka authentication. (Displayed only when the source type is Kafka.)
+direction
+String
+Sync direction. (Displayed only when the source type is Kafka.)
+sync_consumer_offsets_enabled
+Boolean
+Indicates whether to sync the consumption progress. (Displayed only when the source type is Kafka.)
+replication_factor
+Integer
+Number of replicas. (Displayed only when the source type is Kafka.)
+task_num
+Integer
+Number of tasks. (Displayed only when the source type is Kafka.)
+rename_topic_enabled
+Boolean
+Indicates whether to rename a topic. (Displayed only when the source type is Kafka.)
+provenance_header_enabled
+Boolean
+Indicates whether to add the source header. (Displayed only when the source type is Kafka.)
+consumer_strategy
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Displayed only when the source type is Kafka.)
+compression_type
+String
+Compression algorithm. (Displayed only when the source type is Kafka.)
+topics_mapping
+String
+Topic mapping. (Displayed only when the source type is Kafka.)
++
+Table 6 SmartConnectTaskRespSinkConfig Parameter
+Type
+Description
+redis_address
+String
+Redis instance address. (Displayed only when the target type is Redis.)
+redis_type
+String
+Redis instance type. (Displayed only when the target type is Redis.)
+dcs_instance_id
+String
+DCS instance ID. (Displayed only when the target type is Redis.)
+target_db
+Integer
+Target database. The default value is -1. (Displayed only when the target type is Redis.)
+consumer_strategy
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Displayed only when the target type is OBS.)
+destination_file_type
+String
+Dump file format. Only TEXT is supported. (Displayed only when the target type is OBS.)
+deliver_time_interval
+Integer
+Dumping period (s). (Displayed only when the target type is OBS.)
+obs_bucket_name
+String
+Dumping address. (Displayed only when the target type is OBS.)
+obs_path
+String
+Dump directory. (Displayed only when the target type is OBS.)
+partition_format
+String
+Time directory format. (Displayed only when the target type is OBS.)
+record_delimiter
+String
+Line break. (Displayed only when the target type is OBS.)
+store_keys
+Boolean
+Storage key. (Displayed only when the target type is OBS.)
+obs_part_size
+Integer
+Size (in bytes) of each file to be uploaded. The default value is 5242880. (Displayed only when the target type is OBS.)
+flush_size
+Integer
+flush_size. (Displayed only when the target type is OBS.)
+timezone
+String
+Time zone. (Displayed only when the target type is OBS.)
+schema_generator_class
+String
+schema_generator class. The default value is io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator. (Displayed only when the target type is OBS.)
+partitioner_class
+String
+partitioner class. The default value is io.confluent.connect.storage.partitioner.TimeBasedPartitioner. (Displayed only when the target type is OBS.)
+value_converter
+String
+value_converter. The default value is org.apache.kafka.connect.converters.ByteArrayConverter. (Displayed only when the target type is OBS.)
+key_converter
+String
+key_converter. The default value is org.apache.kafka.connect.converters.ByteArrayConverter. (Displayed only when the target type is OBS.)
+kv_delimiter
+String
+kv_delimiter. The default value is :. (Displayed only when the target type is OBS.)
++Example Requests
None
++Example Responses
Status code: 200
+Successful.
+{ + "tasks" : [ { + "task_name" : "smart-connect-1571576841", + "topics" : "topic-1643449744", + "source_task" : { + "current_cluster_name" : "A", + "cluster_name" : "B", + "direction" : "pull", + "bootstrap_servers" : "192.168.45.58:9092,192.168.44.1:9092,192.168.41.230:9092,192.168.43.112:9092", + "instance_id" : "59f6d088-****-****-****-********", + "consumer_strategy" : "earliest", + "sync_consumer_offsets_enabled" : false, + "rename_topic_enabled" : false, + "provenance_header_enabled" : false, + "security_protocol" : "PLAINTEXT", + "sasl_mechanism" : "PLAIN", + "user_name" : "", + "topics_mapping" : "", + "compression_type" : "none", + "task_num" : 2, + "replication_factor" : 3 + }, + "source_type" : "KAFKA_REPLICATOR_SOURCE", + "sink_task" : null, + "sink_type" : "NONE", + "id" : "194917d0-****-****-****-********", + "status" : "RUNNING", + "create_time" : 1708427753133 + }, { + "task_name" : "smart-connect-1", + "topics_regex" : "topic-obs*", + "source_task" : null, + "source_type" : "NONE", + "sink_task" : { + "consumer_strategy" : "earliest", + "destination_file_type" : "TEXT", + "obs_bucket_name" : "abcabc", + "obs_path" : "obsTransfer-1810125534", + "partition_format" : "yyyy/MM/dd/HH/mm", + "record_delimiter" : "\\n", + "deliver_time_interva" : 300, + "obs_part_size" : 5242880, + "flush_size" : 1000000, + "timezone" : "Asia/Chongqing", + "schema_generator_class" : "io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator", + "partitioner_class" : "io.confluent.connect.storage.partitioner.TimeBasedPartitioner", + "value_converter" : "org.apache.kafka.connect.converters.ByteArrayConverter", + "key_converter" : "org.apache.kafka.connect.converters.ByteArrayConverter", + "store_keys" : false, + "kv_delimiter" : ":" + }, + "sink_type" : "OBS_SINK", + "id" : "3c0ac4d1-****-****-****-********", + "status" : "RUNNING", + "create_time" : 1708565483911 + }, { + "task_name" : "smart-connect-121248117", + "topics" : "topic-sc", + "source_task" : { + "redis_address" : "192.168.91.179:6379", + "redis_type" : "standalone", + "dcs_instance_id" : "949190a2-598a-4afd-99a8-dad3cae1e7cd", + "sync_mode" : "RDB_ONLY", + "full_sync_wait_ms" : 13000, + "full_sync_max_retry" : 4, + "ratelimit" : -1 + }, + "source_type" : "REDIS_REPLICATOR_SOURCE", + "sink_task" : { + "redis_address" : "192.168.119.51:6379", + "redis_type" : "standalone", + "dcs_instance_id" : "9b981368-a8e3-416a-87d9-1581a968b41b", + "target_db" : -1 + }, + "sink_type" : "REDIS_REPLICATOR_SINK", + "id" : "8a205bbd-****-****-****-********", + "status" : "RUNNING", + "create_time" : 1708427753133 + } ], + "total_number" : 3, + "max_tasks" : 18, + "quota_tasks" : 18 +}++Status Codes
++
+Status Code
+Description
+200
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/ListEngineProducts.html b/docs/dms/api-ref/ListEngineProducts.html index 0e1de03e..d60fa325 100644 --- a/docs/dms/api-ref/ListEngineProducts.html +++ b/docs/dms/api-ref/ListEngineProducts.html @@ -1,7 +1,7 @@++Parent topic: Smart Connect+Querying Product Specifications List
-Function
This API is used to query the product specifications list.
+Function
This API is used to query the product specifications list.
URI
GET /v2/{engine}/products
@@ -22,7 +22,6 @@String
Message engine.
-Default: kafka
Example Responses
Status code: 200
The product specifications are listed successfully.
+Successful.
{ "engine" : "kafka", "versions" : [ "1.1.0", "2.3.0" ], @@ -537,6 +537,7 @@ } } ] }+
Status Codes
Status Code
diff --git a/docs/dms/api-ref/ListInstanceConsumerGroups.html b/docs/dms/api-ref/ListInstanceConsumerGroups.html index 772b3217..11669cd3 100644 --- a/docs/dms/api-ref/ListInstanceConsumerGroups.html +++ b/docs/dms/api-ref/ListInstanceConsumerGroups.html @@ -1,7 +1,7 @@Querying All Consumer Groups
-Function
This API is used to query all consumer groups.
+Function
This API is used to query all consumer groups.
URI
GET /v2/{project_id}/instances/{instance_id}/groups
diff --git a/docs/dms/api-ref/ListInstanceTopics.html b/docs/dms/api-ref/ListInstanceTopics.html index 1708629b..9e3dabc8 100644 --- a/docs/dms/api-ref/ListInstanceTopics.html +++ b/docs/dms/api-ref/ListInstanceTopics.html @@ -1,7 +1,7 @@Listing Topics of a Kafka Instance
-Function
This API is used to query details about topics of a Kafka instance.
+Function
This API is used to query details about topics of a Kafka instance.
URI
GET /v2/{project_id}/instances/{instance_id}/topics
diff --git a/docs/dms/api-ref/ListInstances.html b/docs/dms/api-ref/ListInstances.html index 04bc7291..ebe9b1bb 100644 --- a/docs/dms/api-ref/ListInstances.html +++ b/docs/dms/api-ref/ListInstances.html @@ -1,7 +1,7 @@Listing All Instances
-Function
This API is used to query the instances of an account by the specified conditions.
+Function
This API is used to query the instances of an account by the specified conditions.
URI
GET /v2/{project_id}/instances
@@ -40,12 +40,11 @@engine
No
+Yes
String
Message engine. Value: kafka.
-Default: kafka
name
@@ -72,7 +71,8 @@String
Instance status. For details, see Instance Status.
+Instance status.
+For details, see Instance Status.
include_failure
@@ -252,7 +252,7 @@String
Resource specification code.
+Resource specifications.
dms.instance.kafka.cluster.c3.mini: Kafka instance with 100 MB/s bandwidth
dms.instance.kafka.cluster.c3.small.2: Kafka instance with 300 MB/s bandwidth
dms.instance.kafka.cluster.c3.middle.2: Kafka instance with 600 MB/s bandwidth
@@ -521,13 +521,6 @@Public network access bandwidth.
kafka_manager_enable
-Boolean
-Whether Kafka Manager is enabled.
-new_auth_cert
Boolean
@@ -542,6 +535,13 @@Cross-VPC access information.
connector_enable
+Boolean
+Whether dumping is enabled. Dumping is not supported for the new specification type.
+connector_node_num
Integer
@@ -595,7 +595,13 @@String
Time when public access was enabled for an instance. The value can be true, actived, closed, or false.
+Time when public access was enabled for an instance.
+Value range:
+true: enabled
+actived: disabled
+closed: disabled
+false: disabled
+
node_num
@@ -656,7 +662,7 @@String
Tag key, which:
+Tag key.
Must be specified.
Must be unique for the same instance.
Can contain 1 to 128 characters.
@@ -710,8 +716,6 @@ "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "user_name" : "paas_dms", "access_user" : "root", - "kafka_manager_enable" : false, - "kafka_manager_user" : "root", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00", "enable_log_collection" : false, diff --git a/docs/dms/api-ref/ListTopicPartitions.html b/docs/dms/api-ref/ListTopicPartitions.html index 79073cd7..f2bf3bb5 100644 --- a/docs/dms/api-ref/ListTopicPartitions.html +++ b/docs/dms/api-ref/ListTopicPartitions.html @@ -1,7 +1,7 @@Querying the Partition List of a Topic
-Function
This API is used to query the partition list of a topic.
+Function
This API is used to query the partition list of a topic.
URI
GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/partitions
@@ -22,8 +22,6 @@String
Project ID. For details about how to obtain it, see Obtaining a Project ID.
-Minimum: 1
-Maximum: 64
instance_id
@@ -33,8 +31,6 @@String
Instance ID.
-Minimum: 1
-Maximum: 64
topic
@@ -44,8 +40,6 @@String
Topic.
-Minimum: 1
-Maximum: 200
Integer
Offset. The records after this offset will be queried.
-Minimum: 0
-Maximum: 10000
limit
@@ -80,8 +72,6 @@Integer
Maximum number of records that can be returned.
-Minimum: 1
-Maximum: 50
Integer
Total records.
-Minimum: 0
-Maximum: 100
partitions
@@ -114,7 +102,6 @@Array of partitions objects
Partition array.
-Array Length: 0 - 50
Integer
Partition ID.
-Minimum: 0
-Maximum: 100
start_offset
@@ -143,8 +128,6 @@Long
Start offset.
-Minimum: 0
-Maximum: 9223372036854775807
last_offset
@@ -152,8 +135,6 @@Long
Last offset.
-Minimum: 0
-Maximum: 9223372036854775807
message_count
@@ -161,8 +142,6 @@Long
Number of messages in a partition.
-Minimum: 0
-Maximum: 9223372036854775807
last_update_time
@@ -170,8 +149,6 @@Long
Last update time.
-Minimum: 0
-Maximum: 9223372036854775807
Querying the Current Producer List of a Topic
-Function
This API is used to query the current producer list of a topic.
+Function
This API is used to query the current producer list of a topic.
URI
GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers
@@ -22,8 +22,6 @@String
Project ID. For details about how to obtain it, see Obtaining a Project ID.
-Minimum: 1
-Maximum: 64
instance_id
@@ -33,8 +31,6 @@String
Instance ID.
-Minimum: 1
-Maximum: 64
topic
@@ -44,8 +40,6 @@String
Topic.
-Minimum: 1
-Maximum: 200
Integer
Offset. The records after this offset will be queried.
-Minimum: 0
-Maximum: 10000
limit
@@ -80,8 +72,6 @@Integer
Maximum number of records that can be returned.
-Minimum: 1
-Maximum: 50
Integer
Total records.
-Minimum: 0
-Maximum: 10000
producers
@@ -114,7 +102,6 @@Array of producers objects
Producer list.
-Array Length: 0 - 50
String
Producer address.
-Minimum: 0
-Maximum: 64
broker_address
@@ -143,8 +128,6 @@String
Broker address.
-Minimum: 0
-Maximum: 64
join_time
@@ -152,8 +135,6 @@Long
Time when the broker was connected.
-Minimum: 0
-Maximum: 9223372036854775807
Modifying Instance Configurations
-Function
This API is used to modify instance configurations.
+Function
This API is used to modify instance configurations.
URI
PUT /v2/{project_id}/instances/{instance_id}/configs
diff --git a/docs/dms/api-ref/PauseConnectorTask.html b/docs/dms/api-ref/PauseConnectorTask.html new file mode 100644 index 00000000..4c7fc986 --- /dev/null +++ b/docs/dms/api-ref/PauseConnectorTask.html @@ -0,0 +1,81 @@ + + +Pausing a Smart Connect Task
+++Function
This API is used to pause a Smart Connect task.
++URI
PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pause
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
+task_id
+Yes
+String
+Smart Connect task ID.
++Request Parameters
None
++Response Parameters
None
++Example Requests
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pause++Example Responses
None
++Status Codes
++
+Status Code
+Description
+204
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/ResetMessageOffset.html b/docs/dms/api-ref/ResetMessageOffset.html index 01e26893..b8e0f18f 100644 --- a/docs/dms/api-ref/ResetMessageOffset.html +++ b/docs/dms/api-ref/ResetMessageOffset.html @@ -1,7 +1,7 @@++Parent topic: Smart Connect+Resetting Consumer Group Offset to the Specified Position
-Function
Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset.After a client is stopped, the server considers the client offline only after the time period specified in ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG (1000 ms by default).
+Function
Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset.After a client is stopped, the server considers the client offline only after the time period specified in ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG (1000 ms by default).
URI
POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset
diff --git a/docs/dms/api-ref/ResetPassword.html b/docs/dms/api-ref/ResetPassword.html index 81cbbad1..e2e4b646 100644 --- a/docs/dms/api-ref/ResetPassword.html +++ b/docs/dms/api-ref/ResetPassword.html @@ -1,7 +1,7 @@Resetting the Password
-Function
This API is used to reset the password for an instance with SSL enabled.
+Function
This API is used to reset the password for an instance with SSL enabled.
URI
POST /v2/{project_id}/instances/{instance_id}/password
diff --git a/docs/dms/api-ref/ResetUserPasswrod.html b/docs/dms/api-ref/ResetUserPasswrod.html index 7601af85..b7e08d58 100644 --- a/docs/dms/api-ref/ResetUserPasswrod.html +++ b/docs/dms/api-ref/ResetUserPasswrod.html @@ -1,7 +1,7 @@Resetting a User Password
-Function
This API is used to reset a user password.
+Function
This API is used to reset a user password.
URI
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}
@@ -65,7 +65,8 @@New password.
This parameter is mandatory for resetting a user password.
-It cannot be the username or the username spelled backwards. The password must meet the following complexity requirements:
+It cannot be the username or the username spelled backwards.
+The password must meet the following complexity requirements:
Can contain 8 to 32 characters.
Must contain at least three of the following character types:
Lowercase letters
diff --git a/docs/dms/api-ref/ResizeEngineInstance.html b/docs/dms/api-ref/ResizeEngineInstance.html index f9dfa266..b732d614 100644 --- a/docs/dms/api-ref/ResizeEngineInstance.html +++ b/docs/dms/api-ref/ResizeEngineInstance.html @@ -1,7 +1,7 @@Increasing Instance Specifications
-Function
This API is used to modify instance specifications.
+Function
This API is used to modify instance specifications.
URI
POST /v2/{engine}/{project_id}/instances/{instance_id}/extend
@@ -22,7 +22,6 @@String
Message engine.
-Default: kafka
project_id
@@ -64,11 +63,11 @@String
Type of the change.
-Value:
-storage: Expand the storage space without adding brokers.
+Change type.
+Value range:
+storage: Expand the storage without changing the broker quantity.
horizontal: Add brokers without resizing the storage space of each broker.
-vertical: Modify the underlying flavor of brokers without adding brokers or storage space.
+vertical: Scale up the broker flavor without changing the broker quantity and storage.
Integer
This parameter is valid only when oper_type is set to horizontal.
-A maximum of 30 brokers are supported.
new_product_id
diff --git a/docs/dms/api-ref/RestartConnectorTask.html b/docs/dms/api-ref/RestartConnectorTask.html new file mode 100644 index 00000000..9d19ff06 --- /dev/null +++ b/docs/dms/api-ref/RestartConnectorTask.html @@ -0,0 +1,81 @@ + + +Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task
+++Function
This API is used to start a Smart Connect task or restart a paused or running Smart Connect task. Note that the sync progress will reset and the task will restart.
++URI
PUT /v2/{project_id}/kafka/instances/{instance_id}/connector/tasks/{task_id}/restart
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
+task_id
+Yes
+String
+Smart Connect task ID.
++Request Parameters
None
++Response Parameters
None
++Example Requests
PUT https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/connector/tasks/{task_id}/restart++Example Responses
None
++Status Codes
++
+Status Code
+Description
+204
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/ResumeConnectorTask.html b/docs/dms/api-ref/ResumeConnectorTask.html new file mode 100644 index 00000000..1b620a3e --- /dev/null +++ b/docs/dms/api-ref/ResumeConnectorTask.html @@ -0,0 +1,81 @@ + + +++Parent topic: Smart Connect+Restarting a Smart Connect Task
+++Function
This API is used to restart a Smart Connect task.
++URI
PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resume
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
+task_id
+Yes
+String
+Smart Connect task ID.
++Request Parameters
None
++Response Parameters
None
++Example Requests
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resume++Example Responses
None
++Status Codes
++
+Status Code
+Description
+204
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/ShowBackgroundTask.html b/docs/dms/api-ref/ShowBackgroundTask.html index c307c161..8f03970d 100644 --- a/docs/dms/api-ref/ShowBackgroundTask.html +++ b/docs/dms/api-ref/ShowBackgroundTask.html @@ -1,7 +1,7 @@++Parent topic: Smart Connect+Querying a Background Task
-Function
This API is used to query a specified background task.
+Function
This API is used to query a specified background task.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
diff --git a/docs/dms/api-ref/ShowCesHierarchy.html b/docs/dms/api-ref/ShowCesHierarchy.html index 458f791f..27442bd6 100644 --- a/docs/dms/api-ref/ShowCesHierarchy.html +++ b/docs/dms/api-ref/ShowCesHierarchy.html @@ -1,7 +1,7 @@Querying Kafka Instance Monitoring Dimensions
-Function
This API is used to query Kafka instance monitoring dimensions.
+Function
This API is used to query Kafka instance monitoring dimensions.
URI
GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy
diff --git a/docs/dms/api-ref/ShowCluster.html b/docs/dms/api-ref/ShowCluster.html index f62072d7..56f3968b 100644 --- a/docs/dms/api-ref/ShowCluster.html +++ b/docs/dms/api-ref/ShowCluster.html @@ -1,7 +1,7 @@Querying Kafka Cluster Metadata
-Function
This API is used to query Kafka cluster metadata.
+Function
This API is used to query Kafka cluster metadata.
URI
GET /v2/{project_id}/instances/{instance_id}/management/cluster
diff --git a/docs/dms/api-ref/ShowConnectorTask.html b/docs/dms/api-ref/ShowConnectorTask.html new file mode 100644 index 00000000..f15c8964 --- /dev/null +++ b/docs/dms/api-ref/ShowConnectorTask.html @@ -0,0 +1,513 @@ + + +Querying Smart Connect Task Details
+++Function
This API is used to query Smart Connect task details.
++URI
GET /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details, see Obtaining a Project ID.
+instance_id
+Yes
+String
+Instance ID.
+task_id
+Yes
+String
+Smart Connect task ID.
++Request Parameters
None
++Response Parameters
Status code: 200
+ ++ +
+Table 2 Response body parameters Parameter
+Type
+Description
+task_name
+String
+Smart Connect task name.
+topics
+String
+Topic of a Smart Connect task.
+topics_regex
+String
+Regular expression of the topic of a Smart Connect task.
+source_type
+String
+Source type of a Smart Connect task.
+source_task
++ +Source configuration of a Smart Connect task.
+sink_type
+String
+Target type of a Smart Connect task.
+sink_task
++ +Target type of a Smart Connect task.
+id
+String
+ID of a Smart Connect task.
+status
+String
+Smart Connect task status.
+create_time
+Long
+Time when the Smart Connect task was created.
++ +
+Table 3 SmartConnectTaskRespSourceConfig Parameter
+Type
+Description
+redis_address
+String
+Redis instance address. (Displayed only when the source type is Redis.)
+redis_type
+String
+Redis instance type. (Displayed only when the source type is Redis.)
+dcs_instance_id
+String
+DCS instance ID. (Displayed only when the source type is Redis.)
+sync_mode
+String
+Synchronization type: RDB_ONLY indicates full synchronization; CUSTOM_OFFSET indicates full and incremental synchronization. (Displayed only when the source type is Redis.)
+full_sync_wait_ms
+Integer
+Interval of full synchronization retries, in ms. (Displayed only when the source type is Redis.)
+full_sync_max_retry
+Integer
+Max. retries of full synchronization. (Displayed only when the source type is Redis.)
+ratelimit
+Integer
+Rate limit, in KB/s. -1: disable. (Displayed only when the source type is Redis.)
+current_cluster_name
+String
+Current Kafka instance name. (Displayed only when the source type is Kafka.)
+cluster_name
+String
+Target Kafka instance name. (Displayed only when the source type is Kafka.)
+user_name
+String
+Username of the target Kafka instance. (Displayed only when the source type is Kafka.)
+sasl_mechanism
+String
+Target Kafka authentication mode. (Displayed only when the source type is Kafka.)
+instance_id
+String
+Target Kafka instance ID. (Displayed only when the source type is Kafka.)
+bootstrap_servers
+String
+Target Kafka instance address. (Displayed only when the source type is Kafka.)
+security_protocol
+String
+Target Kafka authentication. (Displayed only when the source type is Kafka.)
+direction
+String
+Sync direction. (Displayed only when the source type is Kafka.)
+sync_consumer_offsets_enabled
+Boolean
+Indicates whether to sync the consumption progress. (Displayed only when the source type is Kafka.)
+replication_factor
+Integer
+Number of replicas. (Displayed only when the source type is Kafka.)
+task_num
+Integer
+Number of tasks. (Displayed only when the source type is Kafka.)
+rename_topic_enabled
+Boolean
+Indicates whether to rename a topic. (Displayed only when the source type is Kafka.)
+provenance_header_enabled
+Boolean
+Indicates whether to add the source header. (Displayed only when the source type is Kafka.)
+consumer_strategy
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Displayed only when the source type is Kafka.)
+compression_type
+String
+Compression algorithm. (Displayed only when the source type is Kafka.)
+topics_mapping
+String
+Topic mapping. (Displayed only when the source type is Kafka.)
++
+Table 4 SmartConnectTaskRespSinkConfig Parameter
+Type
+Description
+redis_address
+String
+Redis instance address. (Displayed only when the target type is Redis.)
+redis_type
+String
+Redis instance type. (Displayed only when the target type is Redis.)
+dcs_instance_id
+String
+DCS instance ID. (Displayed only when the target type is Redis.)
+target_db
+Integer
+Target database. The default value is -1. (Displayed only when the target type is Redis.)
+consumer_strategy
+String
+Start offset. latest: Obtain the latest data; earliest: Obtain the earliest data. (Displayed only when the target type is OBS.)
+destination_file_type
+String
+Dump file format. Only TEXT is supported. (Displayed only when the target type is OBS.)
+deliver_time_interval
+Integer
+Dumping period (s). (Displayed only when the target type is OBS.)
+obs_bucket_name
+String
+Dumping address. (Displayed only when the target type is OBS.)
+obs_path
+String
+Dump directory. (Displayed only when the target type is OBS.)
+partition_format
+String
+Time directory format. (Displayed only when the target type is OBS.)
+record_delimiter
+String
+Line break. (Displayed only when the target type is OBS.)
+store_keys
+Boolean
+Storage key. (Displayed only when the target type is OBS.)
+obs_part_size
+Integer
+Size (in bytes) of each file to be uploaded. The default value is 5242880. (Displayed only when the target type is OBS.)
+flush_size
+Integer
+flush_size. (Displayed only when the target type is OBS.)
+timezone
+String
+Time zone. (Displayed only when the target type is OBS.)
+schema_generator_class
+String
+schema_generator class. The default value is io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator. (Displayed only when the target type is OBS.)
+partitioner_class
+String
+partitioner class. The default value is io.confluent.connect.storage.partitioner.TimeBasedPartitioner. (Displayed only when the target type is OBS.)
+value_converter
+String
+value_converter. The default value is org.apache.kafka.connect.converters.ByteArrayConverter. (Displayed only when the target type is OBS.)
+key_converter
+String
+key_converter. The default value is org.apache.kafka.connect.converters.ByteArrayConverter. (Displayed only when the target type is OBS.)
+kv_delimiter
+String
+kv_delimiter. The default value is :. (Displayed only when the target type is OBS.)
++Example Requests
None
++Example Responses
Status code: 200
+Successful.
+{ + "task_name" : "smart-connect-121248117", + "topics" : "topic-sc", + "source_task" : { + "redis_address" : "192.168.91.179:6379", + "redis_type" : "standalone", + "dcs_instance_id" : "949190a2-598a-4afd-99a8-dad3cae1e7cd", + "sync_mode" : "RDB_ONLY,", + "full_sync_wait_ms" : 13000, + "full_sync_max_retry" : 4, + "ratelimit" : -1 + }, + "source_type" : "REDIS_REPLICATOR_SOURCE", + "sink_task" : { + "redis_address" : "192.168.119.51:6379", + "redis_type" : "standalone", + "dcs_instance_id" : "9b981368-a8e3-416a-87d9-1581a968b41b", + "target_db" : -1 + }, + "sink_type" : "REDIS_REPLICATOR_SINK", + "id" : "8a205bbd-7181-4b5e-9bd6-37274ce84577", + "status" : "RUNNING", + "create_time" : 1708427753133 +}++Status Codes
++
+Status Code
+Description
+200
+Successful.
++Error Codes
See Error Codes.
+++ diff --git a/docs/dms/api-ref/ShowCoordinators.html b/docs/dms/api-ref/ShowCoordinators.html index f0b96846..78d8370e 100644 --- a/docs/dms/api-ref/ShowCoordinators.html +++ b/docs/dms/api-ref/ShowCoordinators.html @@ -1,7 +1,7 @@++Parent topic: Smart Connect+Querying Coordinator Details of a Kafka Instance
-Function
This API is used to query coordinator details of a Kafka instance.
+Function
This API is used to query coordinator details of a Kafka instance.
URI
GET /v2/{project_id}/instances/{instance_id}/management/coordinators
diff --git a/docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html b/docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html index 2938cf36..3f9c80aa 100644 --- a/docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html +++ b/docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html @@ -1,7 +1,7 @@Querying Product Information for Instance Specification Modification
-Function
This API is used to query the product information for instance specification modification.
+Function
This API is used to query the product information for instance specification modification.
URI
GET /v2/{engine}/{project_id}/instances/{instance_id}/extend
@@ -22,7 +22,6 @@String
Message engine.
-Default: kafka
project_id
@@ -337,6 +336,7 @@Example Responses
Status code: 200
Successfully queried the product information for instance specification modification.
+Product information for instance specification modification queried.
{ "engine" : "kafka", "versions" : [ "1.1.0", "2.7" ], @@ -586,6 +586,7 @@ "unavailable_zones" : [ ] } ] }+
Status Codes
Status Code
diff --git a/docs/dms/api-ref/ShowGroup.html b/docs/dms/api-ref/ShowGroup.html index 40eb6eb0..3de9cfe2 100644 --- a/docs/dms/api-ref/ShowGroup.html +++ b/docs/dms/api-ref/ShowGroup.html @@ -1,7 +1,7 @@Querying a Specific Consumer Group
-Function
This API is used to query a specific consumer group.
+Function
This API is used to query a specific consumer group.
URI
GET /v2/{project_id}/instances/{instance_id}/groups/{group}
diff --git a/docs/dms/api-ref/ShowGroups.html b/docs/dms/api-ref/ShowGroups.html index dbb8dfe8..a4cf98f4 100644 --- a/docs/dms/api-ref/ShowGroups.html +++ b/docs/dms/api-ref/ShowGroups.html @@ -1,7 +1,7 @@Querying Consumer Group Details
-Function
This API is used to query consumer group details.
+Function
This API is used to query consumer group details.
URI
GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}
diff --git a/docs/dms/api-ref/ShowInstance.html b/docs/dms/api-ref/ShowInstance.html index 59614540..341e22be 100644 --- a/docs/dms/api-ref/ShowInstance.html +++ b/docs/dms/api-ref/ShowInstance.html @@ -1,7 +1,7 @@Querying an Instance
-Function
This API is used to query the details about a specified instance.
+Function
This API is used to query the details about a specified instance.
URI
GET /v2/{project_id}/instances/{instance_id}
@@ -137,7 +137,7 @@String
Resource specification code.
+Resource specifications.
dms.instance.kafka.cluster.c3.mini: Kafka instance with 100 MB/s bandwidth
dms.instance.kafka.cluster.c3.small.2: Kafka instance with 300 MB/s bandwidth
dms.instance.kafka.cluster.c3.middle.2: Kafka instance with 600 MB/s bandwidth
@@ -406,13 +406,6 @@Public network access bandwidth.
kafka_manager_enable
-Boolean
-Whether Kafka Manager is enabled.
-new_auth_cert
Boolean
@@ -427,6 +420,13 @@Cross-VPC access information.
connector_enable
+Boolean
+Whether dumping is enabled. Dumping is not supported for the new specification type.
+connector_node_num
Integer
@@ -480,7 +480,13 @@String
Time when public access was enabled for an instance. The value can be true, actived, closed, or false.
+Time when public access was enabled for an instance.
+Value range:
+true: enabled
+actived: disabled
+closed: disabled
+false: disabled
+
node_num
@@ -541,7 +547,7 @@String
Tag key, which:
+Tag key.
Must be specified.
Must be unique for the same instance.
Can contain 1 to 128 characters.
@@ -595,8 +601,6 @@ "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "user_name" : "paas_dms", "access_user" : "root", - "kafka_manager_enable" : false, - "kafka_manager_user" : "root", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00", "enable_log_collection" : false, diff --git a/docs/dms/api-ref/ShowInstanceConfigs.html b/docs/dms/api-ref/ShowInstanceConfigs.html index ced11cb8..b377f4bf 100644 --- a/docs/dms/api-ref/ShowInstanceConfigs.html +++ b/docs/dms/api-ref/ShowInstanceConfigs.html @@ -1,7 +1,7 @@Obtaining Instance Configurations
-Function
This API is used to obtain instance configurations.
+Function
This API is used to obtain instance configurations.
URI
GET /v2/{project_id}/instances/{instance_id}/configs
diff --git a/docs/dms/api-ref/ShowInstanceMessages.html b/docs/dms/api-ref/ShowInstanceMessages.html index 0333faeb..5743a52a 100644 --- a/docs/dms/api-ref/ShowInstanceMessages.html +++ b/docs/dms/api-ref/ShowInstanceMessages.html @@ -1,7 +1,8 @@Querying Messages
-Function
This API is used to query the offset and content of a message. This API queries the message offset based on the timestamp and then queries the message content based on the offset.
+Function
This API is used to query the offset and content of a message.
+This API queries the message offset based on the timestamp and then queries the message content based on the offset.
URI
GET /v2/{project_id}/instances/{instance_id}/messages
@@ -143,9 +144,8 @@
String
Keyword. The value ranges from 0 to 50.
-Minimum: 0
-Maximum: 50
+Keyword.
+The value ranges from 0 to 50.
Querying Topic Details
-Function
This API is used to query topic details of a Kafka instance. (Up to 1s for each instance call)
+Function
This API is used to query topic details of a Kafka instance. (Up to 1s for each instance call)
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}
diff --git a/docs/dms/api-ref/ShowInstanceUsers.html b/docs/dms/api-ref/ShowInstanceUsers.html index 223b68fb..074d108d 100644 --- a/docs/dms/api-ref/ShowInstanceUsers.html +++ b/docs/dms/api-ref/ShowInstanceUsers.html @@ -1,7 +1,7 @@Querying the User List
-Function
This API is used to query the user list.
+Function
This API is used to query the user list.
User management is supported only when SASL is enabled for the Kafka instance.
URI
GET /v2/{project_id}/instances/{instance_id}/users
diff --git a/docs/dms/api-ref/ShowKafkaProjectTags.html b/docs/dms/api-ref/ShowKafkaProjectTags.html index 21039a75..0dde646f 100644 --- a/docs/dms/api-ref/ShowKafkaProjectTags.html +++ b/docs/dms/api-ref/ShowKafkaProjectTags.html @@ -1,7 +1,7 @@Listing Tags of a Project
-Function
This API is used to query project tags.
+Function
This API is used to query project tags.
URI
GET /v2/{project_id}/kafka/tags
diff --git a/docs/dms/api-ref/ShowKafkaTags.html b/docs/dms/api-ref/ShowKafkaTags.html index 3f45cc19..404a728f 100644 --- a/docs/dms/api-ref/ShowKafkaTags.html +++ b/docs/dms/api-ref/ShowKafkaTags.html @@ -1,7 +1,7 @@Listing Tags of an Instance
-Function
This API is used to query instance tags.
+Function
This API is used to query instance tags.
URI
GET /v2/{project_id}/kafka/{instance_id}/tags
@@ -72,7 +72,7 @@String
Tag key, which:
+Tag key.
Must be specified.
Must be unique for the same instance.
Can contain 1 to 128 characters.
diff --git a/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html b/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html index 8cf20dd8..1e621a87 100644 --- a/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html +++ b/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html @@ -1,7 +1,7 @@Querying the Disk Usage Status of Topics
-Function
This API is used to query the broker disk usage of topics.
+Function
This API is used to query the broker disk usage of topics.
URI
GET /v2/{project_id}/instances/{instance_id}/topics/diskusage
diff --git a/docs/dms/api-ref/ShowMaintainWindows.html b/docs/dms/api-ref/ShowMaintainWindows.html index 3e14d840..81cd9c6d 100644 --- a/docs/dms/api-ref/ShowMaintainWindows.html +++ b/docs/dms/api-ref/ShowMaintainWindows.html @@ -1,7 +1,7 @@Listing Maintenance Time Windows
-Function
This API is used to query the start time and end time of maintenance time windows.
+Function
This API is used to query the start time and end time of maintenance time windows.
diff --git a/docs/dms/api-ref/ShowMessages.html b/docs/dms/api-ref/ShowMessages.html index 897cf432..4f9ed490 100644 --- a/docs/dms/api-ref/ShowMessages.html +++ b/docs/dms/api-ref/ShowMessages.html @@ -1,7 +1,7 @@URI
GET /v2/instances/maintain-windows
Querying a Message with a Specified Time Period
-Function
This API is used to query a message with a specified time period.
+Function
This API is used to query a message with a specified time period.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
@@ -190,7 +190,8 @@
Long
Time when a message is created. The value is a Unix timestamp. The unit is millisecond.
+Time when a message is created.
+The value is a Unix timestamp. The unit is millisecond.
Querying Offset of the Earliest Message in a Partition
-Function
This API is used to query the offset of the earliest message in a partition.
+Function
This API is used to query the offset of the earliest message in a partition.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/beginning-message
@@ -93,7 +93,8 @@Long
Time when a message is created. The value is a Unix timestamp. The unit is millisecond.
+Time when a message is created.
+The value is a Unix timestamp. The unit is millisecond.
Querying Offset of the Latest Message in a Partition
-Function
This API is used to query the offset of the latest message in a partition.
+Function
This API is used to query the offset of the latest message in a partition.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/end-message
@@ -93,7 +93,8 @@Long
Time when a message is created. The value is a Unix timestamp. The unit is millisecond.
+Time when a message is created.
+The value is a Unix timestamp. The unit is millisecond.
Querying a Message with a Specified Offset
-Function
This API is used to query a message with a specified offset.
+Function
This API is used to query a message with a specified offset.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/message
@@ -156,7 +156,8 @@Long
Time when a message is created. The value is a Unix timestamp. The unit is millisecond.
+Time when a message is created.
+The value is a Unix timestamp. The unit is millisecond.
Querying User Permissions
-Function
This API is used to query user permissions.
+Function
This API is used to query user permissions.
User management is supported only when SASL is enabled for the Kafka instance.
URI
GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy
diff --git a/docs/dms/api-ref/UpdateInstance.html b/docs/dms/api-ref/UpdateInstance.html index 1bf83bbe..89cb19cf 100644 --- a/docs/dms/api-ref/UpdateInstance.html +++ b/docs/dms/api-ref/UpdateInstance.html @@ -1,7 +1,7 @@Modifying Instance Information
-Function
This API is used to modify the instance information.
+Function
This API is used to modify the instance information.
URI
PUT /v2/{project_id}/instances/{instance_id}
@@ -64,8 +64,8 @@String
Instance description.
-The description can contain a maximum of 1024 characters.
+Description of an instance.
+The description supports up to 1024 characters.
NOTE:The backslash () and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character () before the characters, for example, \ and ".
Configuring Automatic Topic Creation
-Function
This API is used to enable or disable automatic topic creation.
+Function
This API is used to enable or disable automatic topic creation.
URI
POST /v2/{project_id}/instances/{instance_id}/autotopic
diff --git a/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html b/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html index 9a0a3be7..d5bfc0e4 100644 --- a/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html +++ b/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html @@ -1,7 +1,7 @@Modifying the Private IP Address for Cross-VPC Access
-Function
This API is used to modify the private IP address for cross-VPC access.
+Function
This API is used to modify the private IP address for cross-VPC access.
URI
POST /v2/{project_id}/instances/{instance_id}/crossvpc/modify
diff --git a/docs/dms/api-ref/UpdateInstanceTopic.html b/docs/dms/api-ref/UpdateInstanceTopic.html index a8dd0f2d..29fd3831 100644 --- a/docs/dms/api-ref/UpdateInstanceTopic.html +++ b/docs/dms/api-ref/UpdateInstanceTopic.html @@ -1,7 +1,7 @@Modifying Topics of a Kafka Instance
-Function
This API is used to modify topics of a Kafka instance.
+Function
This API is used to modify topics of a Kafka instance.
URI
PUT /v2/{project_id}/instances/{instance_id}/topics
@@ -22,8 +22,6 @@String
Project ID. For details about how to obtain it, see Obtaining a Project ID.
-Minimum: 1
-Maximum: 64
instance_id
@@ -33,8 +31,6 @@String
Instance ID.
-Minimum: 1
-Maximum: 64
Granting User Permissions
-Function
This API is used to grant user permissions.
+Function
This API is used to grant user permissions.
User management is supported only when SASL is enabled for the Kafka instance.
URI
POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy
diff --git a/docs/dms/api-ref/UpdateTopicReplica.html b/docs/dms/api-ref/UpdateTopicReplica.html index 3c4928cb..e74cf410 100644 --- a/docs/dms/api-ref/UpdateTopicReplica.html +++ b/docs/dms/api-ref/UpdateTopicReplica.html @@ -1,7 +1,7 @@Reassigning Replicas of a Topic for a Kafka Instance
-Function
This API is used to reassign replicas of a topic for a Kafka instance.
+Function
This API is used to reassign replicas of a topic for a Kafka instance.
URI
POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignment
diff --git a/docs/dms/api-ref/api-grant-policy.html b/docs/dms/api-ref/api-grant-policy.html index 38c7f8d1..168ee8b2 100644 --- a/docs/dms/api-ref/api-grant-policy.html +++ b/docs/dms/api-ref/api-grant-policy.html @@ -4,14 +4,14 @@This chapter describes fine-grained permissions management for your Kafka instances. If your account does not need individual IAM users, then you may skip over this chapter.
By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
-For details about DMS system policies, see section "Permission" in Distributed Message Service User Guide.
+For details about DMS system policies, see Permissions Management.
Policy-based authorization is useful if you want to allow or deny the access to an API.
An account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query Kafka instances using an API, the user must have been granted permissions that allow the dms:instance:create action.
-Supported Actions
DMS for Kafka provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
- Permission: a statement in a policy that allows or denies certain operations.
- APIs: REST APIs that can be called by a user who has been granted specific permissions.
- Action: Specific operations that are allowed or denied.
- IAM projects or enterprise projects: A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list.
DMS supports the following actions in custom policies:
-- Lifecycle management actions, including actions supported by Kafka instance lifecycle management APIs, such as the APIs for creating an instance, querying the instance list, modifying instance information, and batch restarting or deleting instances.
- Instance management actions, including actions supported by Kafka instance management APIs, such as the APIs for resetting passwords and enabling or disabling automatic topic creation.
- Topic management actions, including actions supported by topic management APIs, such as the APIs for creating, querying, and modifying topics.
- User management actions, including actions supported by user management APIs, such as the APIs for creating users, querying users, and configuring user permissions.
- Message query actions, including actions supported by message query APIs, such as the API for querying messages.
- Background task management actions, including actions supported by background task management APIs, such as the APIs for querying the background task list of an instance and querying a specified background task.
- Tag management actions, including actions supported by tag management APIs, such as the APIs for querying instance tags and project tags.
- Lifecycle management actions, including actions supported by Kafka instance lifecycle management APIs, such as the APIs for creating an instance, querying the instance list, modifying instance information, and batch restarting or deleting instances.
- Instance management actions, including actions supported by Kafka instance management APIs, such as the APIs for resetting passwords and configuring automatic topic creation.
- Smart Connect actions, including actions supported by Smart Connect APIs, such as the APIs for enabling or disabling Smart Connect, creating a Smart Connect task.
- Specification modification management action, supported by the specification modification management API for modifying instance specifications.
- Topic management actions, including actions supported by topic management APIs, such as the APIs for creating, querying, and modifying topics.
- User management actions, including actions supported by user management APIs, such as the APIs for creating users, querying users, and configuring user permissions.
- Message query actions, including actions supported by message query APIs, such as the API for querying messages.
- Background task management actions, including actions supported by background task management APIs, such as the APIs for querying the background task list of an instance and querying a specified background task.
- Tag management actions, including actions supported by tag management APIs, such as the APIs for querying instance tags and project tags.
Topic Management
-Table 3 Topic management Permission
++Smart Connect
++
+Table 3 Smart Connect Permission
API
+API
Action
+Action
IAM Projects
+IAM Projects
Enterprise Projects
+Enterprise Projects
Creating a topic in a Kafka instance
+Enabling Smart Connect
POST /v2/{project_id}/instances/{instance_id}/topics
+POST /v2/{project_id}/instances/{instance_id}/connector
dms:instance:modify
+dms:instance:connector
√
+√
√
+√
Querying a topic in a Kafka instance
+Disabling Smart Connect
GET /v2/{project_id}/instances/{instance_id}/topics
+POST /v2/{project_id}/kafka/instances/{instance_id}/delete-connector
dms:instance:get
+dms:instance:connector
√
+√
√
+√
Modifying topics of a Kafka instance
+Creating a Smart Connect task
PUT /v2/{project_id}/instances/{instance_id}/topics
+POST /v2/{project_id}/instances/{instance_id}/connector/tasks
dms:instance:modify
+dms:instance:createConnectorSinkTask
√
+√
√
+√
Deleting topics in a Kafka instance in batches
+Listing Smart Connect tasks
POST /v2/{project_id}/instances/{instance_id}/topics/delete
+GET /v2/{project_id}/instances/{instance_id}/connector/tasks
dms:instance:modify
+dms:instance:listConnectorSinkTask
√
+√
√
+√
+Querying Smart Connect task details
+GET /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}
+dms:instance:getConnectorSinkTask
+√
+√
+Deleting Smart Connect tasks
+DELETE /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}
+dms:instance:deleteConnectorSinkTask
+√
+√
+Pausing Smart Connect tasks
+PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pause
+dms:instance:updateConnectorTask
+√
+√
+Restarting Smart Connect tasks
+PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resume
+dms:instance:updateConnectorTask
+√
+√
+Starting a Smart Connect task or restarting a paused or running Smart Connect task
+PUT /v2/{project_id}/kafka/instances/{instance_id}/connector/tasks/{task_id}/restart
+dms:instance:updateConnectorTask
+√
+√
++Specification Modification Management
++
+Table 4 Specification modification management Permission
+API
+Action
+IAM Projects
+Enterprise Projects
+Modifying instance specifications
+POST /v2/{engine}/{project_id}/instances/{instance_id}/extend
+dms:instance:scale
+√
+√
+Topic Management
+Table 5 Topic management Permission
+API
+Action
+IAM Projects
+Enterprise Projects
+Creating a topic in a Kafka instance
+POST /v2/{project_id}/instances/{instance_id}/topics
+dms:instance:modify
+√
+√
+Querying a topic in a Kafka instance
+GET /v2/{project_id}/instances/{instance_id}/topics
+dms:instance:get
+√
+√
+Modifying topics of a Kafka instance
+PUT /v2/{project_id}/instances/{instance_id}/topics
+dms:instance:modify
+√
+√
+Deleting topics in a Kafka instance in batches
+POST /v2/{project_id}/instances/{instance_id}/topics/delete
+dms:instance:modify
+√
+√
User Management
-Table 4 User management Permission
+Table 6 User management Permission
API
+API
Action
+Action
IAM Projects
+IAM Projects
Enterprise Projects
+Enterprise Projects
Querying the user list
+Querying the user list
GET /v2/{project_id}/instances/{instance_id}/users
+GET /v2/{project_id}/instances/{instance_id}/users
dms:instance:get
+dms:instance:get
√
+√
√
+√
Creating a user
+Creating a user
POST /v2/{project_id}/instances/{instance_id}/users
+POST /v2/{project_id}/instances/{instance_id}/users
dms:instance:modify
+dms:instance:modify
√
+√
√
+√
Deleting users in batches
+Deleting users in batches
PUT /v2/{project_id}/instances/{instance_id}/users
+PUT /v2/{project_id}/instances/{instance_id}/users
dms:instance:modify
+dms:instance:modify
√
+√
√
+√
Resetting a user password
+Resetting a user password
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}
+PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}
dms:instance:get
+dms:instance:get
√
+√
√
+√
Querying user permissions
+Querying user permissions
GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy
+GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy
dms:instance:get
+dms:instance:get
√
+√
√
+√
Granting user permissions
+Granting user permissions
POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy
+POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy
dms:instance:modify
+dms:instance:modify
√
+√
√
+√
Message Query
-Table 5 Message query Permission
+Table 7 Message query Permission
API
+API
Action
+Action
IAM Projects
+IAM Projects
Enterprise Projects
+Enterprise Projects
Querying messages
+Querying messages
GET /v2/{project_id}/instances/{instance_id}/messages
+GET /v2/{project_id}/instances/{instance_id}/messages
dms:instance:get
+dms:instance:get
√
+√
√
+√
Background Task Management
-Table 6 Background task management Permission
+Table 8 Background task management Permission
API
+API
Action
+Action
IAM Projects
+IAM Projects
Enterprise Projects
+Enterprise Projects
Listing background tasks
+Listing background tasks
GET /v2/{project_id}/instances/{instance_id}/tasks
+GET /v2/{project_id}/instances/{instance_id}/tasks
dms:instance:getBackgroundTask
+dms:instance:getBackgroundTask
√
+√
√
+√
Querying a background task
+Querying a background task
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
+GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
dms:instance:getBackgroundTask
+dms:instance:getBackgroundTask
√
+√
√
+√
Deleting a background task
+Deleting a background task
DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
+DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
dms:instance:deleteBackgroundTask
+dms:instance:deleteBackgroundTask
√
+√
√
+√
Tag Management
-Table 7 Tag management Permission
+Table 9 Tag management Permission
API
+API
Action
+Action
IAM Projects
+IAM Projects
Enterprise Projects
+Enterprise Projects
Batch adding or deleting tags
+Batch adding or deleting tags
POST /v2/{project_id}/kafka/{instance_id}/tags/action
+POST /v2/{project_id}/kafka/{instance_id}/tags/action
dms:instance:modify
+dms:instance:modify
√
+√
√
+√
Listing tags of an instance
+Listing tags of an instance
GET /v2/{project_id}/kafka/{instance_id}/tags
+GET /v2/{project_id}/kafka/{instance_id}/tags
dms:instance:get
+dms:instance:get
√
+√
√
+√
Listing tags of a project
+Listing tags of a project
GET /v2/{project_id}/kafka/tags
+GET /v2/{project_id}/kafka/tags
dms:instance:get
+dms:instance:get
√
+√
√
+√
2023-12-28
+2024-07-19
+Added:
+- Added Smart Connect APIs.
2023-12-28
Modified the following content:
- Added section Permissions and Supported Actions.
- Added APIs for obtaining instance configurations, modifying instance configurations, creating a consumer group, increasing instance specifications, and querying product information for instance specification modification.
- Added the charging_mode parameter to section Querying an Instance.
- Changed new_password to mandatory in section Resetting the Password.
diff --git a/docs/dms/api-ref/kafka-api-180514012.html b/docs/dms/api-ref/kafka-api-180514012.html index 3ed3a3ba..6df1f8f8 100644 --- a/docs/dms/api-ref/kafka-api-180514012.html +++ b/docs/dms/api-ref/kafka-api-180514012.html @@ -8,32 +8,32 @@Obtaining a Project ID on the Console
A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.
The following procedure describes how to obtain a project ID:
-- Log in to the management console.
- Click the username and choose My Credentials from the drop-down list.
On the My Credentials page, view project IDs in the project list.
+- Log in to the management console.
- Click the username and choose My Credentials from the drop-down list.
On the API Credentials page, view project IDs in the project list.
Figure 1 Viewing a project ID
Creating
+CREATING
The instance is being created.
Running
+RUNNING
The instance is running properly. Instances in this state can provide services.
Faulty
+ERROR
The instance is not running properly.
Restarting
+RESTARTING
The instance is being restarted.
Changing
+EXTENDING
The instance specifications are being changed.
Change failed
+EXTENDEDFAILED
The instance specifications failed to be changed.
- Instance Management
+
- Smart Connect
+- Specification Modification Management
- Topic Management
diff --git a/docs/dms/api-ref/topic_300000001.html b/docs/dms/api-ref/topic_300000001.html index 418ad333..4b116fe8 100644 --- a/docs/dms/api-ref/topic_300000001.html +++ b/docs/dms/api-ref/topic_300000001.html @@ -29,7 +29,7 @@- Deleting a Consumer Group from a Kafka Instance
-
- Batch Deleting Consumer Groups of a Kafka Instance
+- Deleting Consumer Groups of a Kafka Instance in Batches
- Creating a Consumer Group
diff --git a/docs/dms/api-ref/topic_300000009.html b/docs/dms/api-ref/topic_300000009.html index d17f1407..32c59524 100644 --- a/docs/dms/api-ref/topic_300000009.html +++ b/docs/dms/api-ref/topic_300000009.html @@ -1,7 +1,7 @@
Other APIs
-
+-
diff --git a/docs/dms/api-ref/topic_300000011.html b/docs/dms/api-ref/topic_300000011.html
new file mode 100644
index 00000000..fe4c9e37
--- /dev/null
+++ b/docs/dms/api-ref/topic_300000011.html
@@ -0,0 +1,32 @@
+
+
+
- Enabling Smart Connect (Pay-per-Use Instance)
+
+ - Disabling Smart Connect (Pay-per-Use Instance)
+
+ - Creating a Smart Connect Task
+
+ - Querying Smart Connect Tasks
+
+ - Querying Smart Connect Task Details
+
+ - Deleting a Smart Connect Task
+
+ - Pausing a Smart Connect Task
+
+ - Restarting a Smart Connect Task
+
+ - Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task
+
+
Smart Connect
++
+++-
+
++Parent topic: APIs V2 (Recommended)+