Function
This API is used to add or delete instance tags in batches.
URI
POST /v2/{project_id}/kafka/{instance_id}/tags/action
+URI
POST /v2/{project_id}/kafka/{instance_id}/tags/action
Parameter |
@@ -21,7 +21,7 @@
String |
-Project ID. + | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
instance_id @@ -89,9 +89,13 @@ |
String |
-Tag key, which can contain a maximum of 36 Unicode characters. -The key cannot be left blank or be an empty string. -It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/ + | Tag key, which: +
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value @@ -100,9 +104,11 @@ |
String |
-Tag value, which can contain a maximum of 43 Unicode characters. -The value cannot be left blank or be an empty string. -It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/ + | Tag value. +
|
Parameter |
@@ -21,7 +21,7 @@
String |
-Project ID. + | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
|
|---|---|---|---|---|
instance_id @@ -48,13 +48,13 @@ | ||||
[items] + | ||||
group_ids |
Yes |
Array of strings |
-List of consumer groups to be deleted. + | IDs of all consumer groups to be deleted. |
Example Requests
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete
+Example Requests
Batch deleting consumer groups
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete
-[ "group1", "group2" ]
+{
+ "group_ids" : [ "get-sync-group0", "get-sync-group1" ]
+}
Example Responses
Status code: 200
The consumer groups are deleted successfully.
diff --git a/docs/dms/api-ref/BatchDeleteInstanceTopic.html b/docs/dms/api-ref/BatchDeleteInstanceTopic.html
index 45435975..d7eb64b2 100644
--- a/docs/dms/api-ref/BatchDeleteInstanceTopic.html
+++ b/docs/dms/api-ref/BatchDeleteInstanceTopic.html
@@ -1,9 +1,9 @@
Batch Deleting Topics of a Kafka Instance
-Function
This API is used to delete multiple topics of a Kafka instance in batches. If some consumer groups are deleted successfully while some fail to be deleted, a success response is returned with information about consumer groups 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
+URI
POST /v2/{project_id}/instances/{instance_id}/topics/delete
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
+Minimum: 1
+Maximum: 64
instance_id
@@ -31,6 +33,8 @@
String
Instance ID.
+Minimum: 1
+Maximum: 64
Array of strings
List of topics to delete.
+Topics to delete.
+This parameter is mandatory when instance topics are deleted in batches.
-Example Requests
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/delete
+Example Requests
Batch deleting topics
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/delete
{
"topics" : [ "topic01" ]
@@ -118,10 +124,7 @@
The deletion is successful.
{
"topics" : [ {
- "id" : "haha",
- "success" : true
- }, {
- "id" : "aabb",
+ "id" : "topic01",
"success" : true
} ]
}
diff --git a/docs/dms/api-ref/BatchDeleteInstanceUsers.html b/docs/dms/api-ref/BatchDeleteInstanceUsers.html
index 3b30ed1b..1c1ab666 100644
--- a/docs/dms/api-ref/BatchDeleteInstanceUsers.html
+++ b/docs/dms/api-ref/BatchDeleteInstanceUsers.html
@@ -3,7 +3,7 @@
Deleting Users in Batches
Function
This API is used to delete multiple users of a Kafka instance.
-URI
PUT /v2/{project_id}/instances/{instance_id}/users
+URI
PUT /v2/{project_id}/instances/{instance_id}/users
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -55,6 +55,7 @@
String
Deletion type. Currently, only delete is supported.
+This parameter is mandatory for deleting a user.
users
@@ -64,6 +65,7 @@
Array of strings
User list.
+This parameter is mandatory for deleting a user.
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.
-URI
POST /v2/{project_id}/instances/action
+URI
POST /v2/{project_id}/instances/action
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
The instances are restarted or deleted successfully.
204
+All Kafka instances that fail to be created are deleted successfully.
+
diff --git a/docs/dms/api-ref/CLASS.TXT.json b/docs/dms/api-ref/CLASS.TXT.json
index 92df60bc..d8cc7bac 100644
--- a/docs/dms/api-ref/CLASS.TXT.json
+++ b/docs/dms/api-ref/CLASS.TXT.json
@@ -27,16 +27,16 @@
"code":"3"
},
{
- "desc":"This API is used to create a Kafka instance.POST /v2/{project_id}/instancesStatus code: 200Creating a Kafka instance.Status code: 200An instance is created successfully.S",
+ "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",
"product_code":"dms",
"title":"Creating an Instance",
- "uri":"CreatePostPaidInstance.html",
+ "uri":"CreateInstanceByEngine.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
- "desc":"This API is used to query the instances of an account by the specified conditions.GET /v2/{project_id}/instancesNoneStatus code: 200Status code: 200All instances are list",
+ "desc":"This API is used to query the instances of an account by the specified conditions.GET /v2/{project_id}/instancesNoneStatus code: 200Querying the instance listStatus code:",
"product_code":"dms",
"title":"Listing All Instances",
"uri":"ListInstances.html",
@@ -45,7 +45,7 @@
"code":"5"
},
{
- "desc":"This API is used to query the details about a specified instance.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Status code: 200The instance is queried s",
+ "desc":"This API is used to query the details about a specified instance.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Querying an instanceStatus code: 200Speci",
"product_code":"dms",
"title":"Querying an Instance",
"uri":"ShowInstance.html",
@@ -54,7 +54,7 @@
"code":"6"
},
{
- "desc":"This API is used to delete an instance to release all the resources occupied by it.DELETE /v2/{project_id}/instances/{instance_id}NoneNoneNoneSee Error Codes.",
+ "desc":"This API is used to delete an instance to release all the resources occupied by it.DELETE /v2/{project_id}/instances/{instance_id}NoneNoneDeleting an instanceNoneSee Erro",
"product_code":"dms",
"title":"Deleting an Instance",
"uri":"DeleteInstance.html",
@@ -80,6 +80,24 @@
"p_code":"3",
"code":"9"
},
+ {
+ "desc":"This API is used to obtain instance configurations.GET /v2/{project_id}/instances/{instance_id}/configsNoneStatus code: 200Status code: 200Configuration obtained.See Erro",
+ "product_code":"dms",
+ "title":"Obtaining Instance Configurations",
+ "uri":"ShowInstanceConfigs.html",
+ "doc_type":"api",
+ "p_code":"3",
+ "code":"10"
+ },
+ {
+ "desc":"This API is used to modify instance configurations.PUT /v2/{project_id}/instances/{instance_id}/configsStatus code: 200Modifying the threshold for idle connection timeout",
+ "product_code":"dms",
+ "title":"Modifying Instance Configurations",
+ "uri":"ModifyInstanceConfigs.html",
+ "doc_type":"api",
+ "p_code":"3",
+ "code":"11"
+ },
{
"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",
@@ -87,16 +105,16 @@
"uri":"topic_300000001.html",
"doc_type":"api",
"p_code":"2",
- "code":"10"
+ "code":"12"
},
{
- "desc":"This API is used to reset the password.POST /v2/{project_id}/instances/{instance_id}/passwordNoneNoneSee Error Codes.",
+ "desc":"This API is used to reset the password for an instance with SSL enabled.POST /v2/{project_id}/instances/{instance_id}/passwordNoneResetting a passwordNoneSee Error Codes.",
"product_code":"dms",
"title":"Resetting the Password",
"uri":"ResetPassword.html",
"doc_type":"api",
- "p_code":"10",
- "code":"11"
+ "p_code":"12",
+ "code":"13"
},
{
"desc":"This API is used to enable or disable automatic topic creation.POST /v2/{project_id}/instances/{instance_id}/autotopicNoneEnabling automatic topic creation.NoneSee Error ",
@@ -104,8 +122,8 @@
"title":"Configuring Automatic Topic Creation",
"uri":"UpdateInstanceAutoCreateTopic.html",
"doc_type":"api",
- "p_code":"10",
- "code":"12"
+ "p_code":"12",
+ "code":"14"
},
{
"desc":"This API is used to modify the private IP address for cross-VPC access.POST /v2/{project_id}/instances/{instance_id}/crossvpc/modifyStatus code: 200Modifying the private ",
@@ -113,8 +131,8 @@
"title":"Modifying the Private IP Address for Cross-VPC Access",
"uri":"UpdateInstanceCrossVpcIp.html",
"doc_type":"api",
- "p_code":"10",
- "code":"13"
+ "p_code":"12",
+ "code":"15"
},
{
"desc":"This API is used to query Kafka cluster metadata.GET /v2/{project_id}/instances/{instance_id}/management/clusterNoneStatus code: 200Status code: 200Kafka cluster metadata",
@@ -122,8 +140,8 @@
"title":"Querying Kafka Cluster Metadata",
"uri":"ShowCluster.html",
"doc_type":"api",
- "p_code":"10",
- "code":"14"
+ "p_code":"12",
+ "code":"16"
},
{
"desc":"This API is used to query consumer group details.GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}NoneStatus code: 200Status code: 200The consumer gr",
@@ -131,17 +149,17 @@
"title":"Querying Consumer Group Details",
"uri":"ShowGroups.html",
"doc_type":"api",
- "p_code":"10",
- "code":"15"
+ "p_code":"12",
+ "code":"17"
},
{
- "desc":"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, th",
+ "desc":"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 ",
"product_code":"dms",
"title":"Resetting Consumer Group Offset to the Specified Position",
"uri":"ResetMessageOffset.html",
"doc_type":"api",
- "p_code":"10",
- "code":"16"
+ "p_code":"12",
+ "code":"18"
},
{
"desc":"This API is used to query coordinator details of a Kafka instance.GET /v2/{project_id}/instances/{instance_id}/management/coordinatorsNoneStatus code: 200Status code: 200",
@@ -149,44 +167,35 @@
"title":"Querying Coordinator Details of a Kafka Instance",
"uri":"ShowCoordinators.html",
"doc_type":"api",
- "p_code":"10",
- "code":"17"
+ "p_code":"12",
+ "code":"19"
},
{
- "desc":"This API is used to add partitions to a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignmentNoneNone",
- "product_code":"dms",
- "title":"Adding Partitions to a Topic for a Kafka Instance",
- "uri":"CreatePartition.html",
- "doc_type":"api",
- "p_code":"10",
- "code":"18"
- },
- {
- "desc":"This API is used to reassign replicas of a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignmentNoneNon",
+ "desc":"This API is used to reassign replicas of a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignmentNoneRea",
"product_code":"dms",
"title":"Reassigning Replicas of a Topic for a Kafka Instance",
"uri":"UpdateTopicReplica.html",
"doc_type":"api",
- "p_code":"10",
- "code":"19"
+ "p_code":"12",
+ "code":"20"
},
{
- "desc":"This API is used to query the broker disk usage of topics.GET /v2/{project_id}/instances/{instance_id}/topics/diskusageNoneStatus code: 200Status code: 200The query is su",
+ "desc":"This API is used to query the broker disk usage of topics.GET /v2/{project_id}/instances/{instance_id}/topics/diskusageNoneStatus code: 200Querying the disk usage status ",
"product_code":"dms",
"title":"Querying the Disk Usage Status of Topics",
"uri":"ShowKafkaTopicPartitionDiskusage.html",
"doc_type":"api",
- "p_code":"10",
- "code":"20"
+ "p_code":"12",
+ "code":"21"
},
{
- "desc":"This API is used to query all consumer groups.GET /v2/{project_id}/instances/{instance_id}/groupsNoneStatus code: 200Status code: 200All consumer groups are queried succe",
+ "desc":"This API is used to query all consumer groups.GET /v2/{project_id}/instances/{instance_id}/groupsNoneStatus code: 200Querying the consumer group listStatus code: 200All c",
"product_code":"dms",
"title":"Querying All Consumer Groups",
"uri":"ListInstanceConsumerGroups.html",
"doc_type":"api",
- "p_code":"10",
- "code":"21"
+ "p_code":"12",
+ "code":"22"
},
{
"desc":"This API is used to query a specific consumer group.GET /v2/{project_id}/instances/{instance_id}/groups/{group}NoneStatus code: 200Status code: 200A specific consumer gro",
@@ -194,8 +203,8 @@
"title":"Querying a Specific Consumer Group",
"uri":"ShowGroup.html",
"doc_type":"api",
- "p_code":"10",
- "code":"22"
+ "p_code":"12",
+ "code":"23"
},
{
"desc":"This API is used to delete a consumer group from a Kafka instance.DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}NoneNoneNoneSee Error Codes.",
@@ -203,17 +212,35 @@
"title":"Deleting a Consumer Group from a Kafka Instance",
"uri":"DeleteGroup.html",
"doc_type":"api",
- "p_code":"10",
- "code":"23"
+ "p_code":"12",
+ "code":"24"
},
{
- "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: 200Status",
+ "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",
"uri":"BatchDeleteGroup.html",
"doc_type":"api",
- "p_code":"10",
- "code":"24"
+ "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",
+ "product_code":"dms",
+ "title":"Creating a Consumer Group",
+ "uri":"CreateKafkaConsumerGroup.html",
+ "doc_type":"api",
+ "p_code":"12",
+ "code":"26"
+ },
+ {
+ "desc":"This API is used to submit a partition rebalancing task to a Kafka instance or calculate estimated rebalancing time.POST /v2/kafka/{project_id}/instances/{instance_id}/re",
+ "product_code":"dms",
+ "title":"Initiating Partition Reassigning for a Kafka Instance",
+ "uri":"CreateReassignmentTask.html",
+ "doc_type":"api",
+ "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.",
@@ -222,25 +249,25 @@
"uri":"topic_300000003.html",
"doc_type":"api",
"p_code":"2",
- "code":"25"
+ "code":"28"
},
{
- "desc":"This API is used to modify instance specifications.POST /v2/{project_id}/instances/{instance_id}/extendStatus code: 200Pay-per-use instance (old specifications)Status cod",
+ "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",
"product_code":"dms",
- "title":"Modifying Instance Specifications",
- "uri":"ResizeInstance.html",
+ "title":"Increasing Instance Specifications",
+ "uri":"ResizeEngineInstance.html",
"doc_type":"api",
- "p_code":"25",
- "code":"26"
+ "p_code":"28",
+ "code":"29"
},
{
- "desc":"This API is used to query the product information for instance specification modification.GET /v2/{project_id}/instances/{instance_id}/extendNoneStatus code: 200Status co",
+ "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",
"product_code":"dms",
"title":"Querying Product Information for Instance Specification Modification",
- "uri":"ShowInstanceExtendProductInfo.html",
+ "uri":"ShowEngineInstanceExtendProductInfo.html",
"doc_type":"api",
- "p_code":"25",
- "code":"27"
+ "p_code":"28",
+ "code":"30"
},
{
"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.",
@@ -249,61 +276,70 @@
"uri":"topic_300000004.html",
"doc_type":"api",
"p_code":"2",
- "code":"28"
+ "code":"31"
},
{
- "desc":"This API is used to create a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/topicsStatus code: 200Status code: 200The creation is successful.See",
+ "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",
"product_code":"dms",
"title":"Creating a Topic for a Kafka Instance",
"uri":"CreateInstanceTopic.html",
"doc_type":"api",
- "p_code":"28",
- "code":"29"
+ "p_code":"31",
+ "code":"32"
},
{
- "desc":"This API is used to query details about topics of a Kafka instance.GET /v2/{project_id}/instances/{instance_id}/topicsNoneStatus code: 200Status code: 200The query is suc",
+ "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",
"product_code":"dms",
"title":"Listing Topics of a Kafka Instance",
"uri":"ListInstanceTopics.html",
"doc_type":"api",
- "p_code":"28",
- "code":"30"
+ "p_code":"31",
+ "code":"33"
},
{
- "desc":"This API is used to modify topics of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/topicsNoneNoneSee Error Codes.",
+ "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",
"product_code":"dms",
"title":"Modifying Topics of a Kafka Instance",
"uri":"UpdateInstanceTopic.html",
"doc_type":"api",
- "p_code":"28",
- "code":"31"
+ "p_code":"31",
+ "code":"34"
},
{
- "desc":"This API is used to delete multiple topics of a Kafka instance in batches. If some consumer groups are deleted successfully while some fail to be deleted, a success respo",
+ "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",
"product_code":"dms",
"title":"Batch Deleting Topics of a Kafka Instance",
"uri":"BatchDeleteInstanceTopic.html",
"doc_type":"api",
- "p_code":"28",
- "code":"32"
+ "p_code":"31",
+ "code":"35"
},
{
- "desc":"This API is used to clean up multiple topics of a Kafka instance in batches.POST /v2/kafka/{project_id}/instances/{instance_id}/topics/cleanupStatus code: 200Status code:",
+ "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",
"product_code":"dms",
- "title":"Batch Cleaning Up Topics of a Kafka Instance",
- "uri":"BatchCleanupInstanceTopic.html",
+ "title":"Querying the Partition List of a Topic",
+ "uri":"ListTopicPartitions.html",
"doc_type":"api",
- "p_code":"28",
- "code":"33"
+ "p_code":"31",
+ "code":"36"
},
{
- "desc":"This API is used to query topic details of a Kafka instance.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}NoneStatus code: 200Status code: 200The ",
+ "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",
+ "product_code":"dms",
+ "title":"Querying the Current Producer List of a Topic",
+ "uri":"ListTopicProducers.html",
+ "doc_type":"api",
+ "p_code":"31",
+ "code":"37"
+ },
+ {
+ "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",
"product_code":"dms",
"title":"Querying Topic Details",
"uri":"ShowInstanceTopicDetail.html",
"doc_type":"api",
- "p_code":"28",
- "code":"34"
+ "p_code":"31",
+ "code":"38"
},
{
"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.",
@@ -312,7 +348,7 @@
"uri":"topic_300000005.html",
"doc_type":"api",
"p_code":"2",
- "code":"35"
+ "code":"39"
},
{
"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",
@@ -320,8 +356,8 @@
"title":"Querying the User List",
"uri":"ShowInstanceUsers.html",
"doc_type":"api",
- "p_code":"35",
- "code":"36"
+ "p_code":"39",
+ "code":"40"
},
{
"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",
@@ -329,8 +365,8 @@
"title":"Creating a User",
"uri":"CreateInstanceUser.html",
"doc_type":"api",
- "p_code":"35",
- "code":"37"
+ "p_code":"39",
+ "code":"41"
},
{
"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.",
@@ -338,8 +374,8 @@
"title":"Deleting Users in Batches",
"uri":"BatchDeleteInstanceUsers.html",
"doc_type":"api",
- "p_code":"35",
- "code":"38"
+ "p_code":"39",
+ "code":"42"
},
{
"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.",
@@ -347,8 +383,8 @@
"title":"Resetting a User Password",
"uri":"ResetUserPasswrod.html",
"doc_type":"api",
- "p_code":"35",
- "code":"39"
+ "p_code":"39",
+ "code":"43"
},
{
"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",
@@ -356,8 +392,8 @@
"title":"Querying User Permissions",
"uri":"ShowTopicAccessPolicy.html",
"doc_type":"api",
- "p_code":"35",
- "code":"40"
+ "p_code":"39",
+ "code":"44"
},
{
"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",
@@ -365,8 +401,8 @@
"title":"Granting User Permissions",
"uri":"UpdateTopicAccessPolicy.html",
"doc_type":"api",
- "p_code":"35",
- "code":"41"
+ "p_code":"39",
+ "code":"45"
},
{
"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.",
@@ -375,7 +411,7 @@
"uri":"topic_300000006.html",
"doc_type":"api",
"p_code":"2",
- "code":"42"
+ "code":"46"
},
{
"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",
@@ -383,8 +419,8 @@
"title":"Querying Messages",
"uri":"ShowInstanceMessages.html",
"doc_type":"api",
- "p_code":"42",
- "code":"43"
+ "p_code":"46",
+ "code":"47"
},
{
"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",
@@ -392,8 +428,8 @@
"title":"Querying a Message with a Specified Offset",
"uri":"ShowPartitionMessage.html",
"doc_type":"api",
- "p_code":"42",
- "code":"44"
+ "p_code":"46",
+ "code":"48"
},
{
"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",
@@ -401,8 +437,8 @@
"title":"Querying a Message with a Specified Time Period",
"uri":"ShowMessages.html",
"doc_type":"api",
- "p_code":"42",
- "code":"45"
+ "p_code":"46",
+ "code":"49"
},
{
"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}/",
@@ -410,8 +446,8 @@
"title":"Querying Offset of the Earliest Message in a Partition",
"uri":"ShowPartitionBeginningMessage.html",
"doc_type":"api",
- "p_code":"42",
- "code":"46"
+ "p_code":"46",
+ "code":"50"
},
{
"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",
@@ -419,8 +455,8 @@
"title":"Querying Offset of the Latest Message in a Partition",
"uri":"ShowPartitionEndMessage.html",
"doc_type":"api",
- "p_code":"42",
- "code":"47"
+ "p_code":"46",
+ "code":"51"
},
{
"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.",
@@ -429,7 +465,7 @@
"uri":"topic_300000007.html",
"doc_type":"api",
"p_code":"2",
- "code":"48"
+ "code":"52"
},
{
"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",
@@ -437,8 +473,8 @@
"title":"Listing Background Tasks",
"uri":"ListBackgroundTasks.html",
"doc_type":"api",
- "p_code":"48",
- "code":"49"
+ "p_code":"52",
+ "code":"53"
},
{
"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",
@@ -446,17 +482,17 @@
"title":"Querying a Background Task",
"uri":"ShowBackgroundTask.html",
"doc_type":"api",
- "p_code":"48",
- "code":"50"
+ "p_code":"52",
+ "code":"54"
},
{
- "desc":"This API is used to delete a specified background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneNoneNoneSee Error Codes.",
+ "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 ",
"product_code":"dms",
"title":"Deleting a Background Task",
"uri":"DeleteBackgroundTask.html",
"doc_type":"api",
- "p_code":"48",
- "code":"51"
+ "p_code":"52",
+ "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.",
@@ -465,16 +501,16 @@
"uri":"topic_300000008.html",
"doc_type":"api",
"p_code":"2",
- "code":"52"
+ "code":"56"
},
{
- "desc":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/kafka/{instance_id}/tags/actionNoneNoneSee Error Codes.",
+ "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",
"product_code":"dms",
"title":"Batch Adding or Deleting Tags",
"uri":"BatchCreateOrDeleteKafkaTag.html",
"doc_type":"api",
- "p_code":"52",
- "code":"53"
+ "p_code":"56",
+ "code":"57"
},
{
"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",
@@ -482,8 +518,8 @@
"title":"Listing Tags of an Instance",
"uri":"ShowKafkaTags.html",
"doc_type":"api",
- "p_code":"52",
- "code":"54"
+ "p_code":"56",
+ "code":"58"
},
{
"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.",
@@ -491,8 +527,8 @@
"title":"Listing Tags of a Project",
"uri":"ShowKafkaProjectTags.html",
"doc_type":"api",
- "p_code":"52",
- "code":"55"
+ "p_code":"56",
+ "code":"59"
},
{
"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,43 +537,52 @@
"uri":"topic_300000009.html",
"doc_type":"api",
"p_code":"2",
- "code":"56"
+ "code":"60"
},
{
- "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: 200The consumption of",
+ "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",
"product_code":"dms",
"title":"Listing Maintenance Time Windows",
"uri":"ShowMaintainWindows.html",
"doc_type":"api",
- "p_code":"56",
- "code":"57"
+ "p_code":"60",
+ "code":"61"
},
{
- "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.See Err",
+ "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",
"product_code":"dms",
"title":"Listing AZ Information",
"uri":"ListAvailableZones.html",
"doc_type":"api",
- "p_code":"56",
- "code":"58"
+ "p_code":"60",
+ "code":"62"
},
{
- "desc":"This API is used to query the product specifications to configure the product ID (product_id).For example, to create a pay-per-use Kafka instance with 100 MB/s bandwidth,",
+ "desc":"This API is used to query the product specifications list.GET /v2/{engine}/productsNoneStatus code: 200Status code: 200The product specifications are listed successfully.",
"product_code":"dms",
- "title":"Listing Product Specifications",
- "uri":"ListProducts_0.html",
+ "title":"Querying Product Specifications List",
+ "uri":"ListEngineProducts.html",
"doc_type":"api",
- "p_code":"56",
- "code":"59"
+ "p_code":"60",
+ "code":"63"
},
{
- "desc":"This API is used to query Kafka instance monitoring dimensions.GET /v2/{project_id}/instances/{instance_id}/ces-hierarchyNoneStatus code: 200Status code: 200The informati",
+ "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",
"product_code":"dms",
"title":"Querying Kafka Instance Monitoring Dimensions",
"uri":"ShowCesHierarchy.html",
"doc_type":"api",
- "p_code":"56",
- "code":"60"
+ "p_code":"60",
+ "code":"64"
+ },
+ {
+ "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",
+ "product_code":"dms",
+ "title":"Permissions and Supported Actions",
+ "uri":"api-grant-policy.html",
+ "doc_type":"api",
+ "p_code":"",
+ "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.",
@@ -546,7 +591,7 @@
"uri":"kafka-api-0001.html",
"doc_type":"api",
"p_code":"",
- "code":"61"
+ "code":"66"
},
{
"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.",
@@ -554,8 +599,8 @@
"title":"API V1",
"uri":"kafka-api-0002.html",
"doc_type":"api",
- "p_code":"61",
- "code":"62"
+ "p_code":"66",
+ "code":"67"
},
{
"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.",
@@ -563,8 +608,8 @@
"title":"APIs for Managing Instances",
"uri":"kafka-api-180514001.html",
"doc_type":"api",
- "p_code":"62",
- "code":"63"
+ "p_code":"67",
+ "code":"68"
},
{
"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",
@@ -572,8 +617,8 @@
"title":"Creating an Instance",
"uri":"kafka-api-180514002.html",
"doc_type":"api",
- "p_code":"63",
- "code":"64"
+ "p_code":"68",
+ "code":"69"
},
{
"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",
@@ -581,8 +626,8 @@
"title":"Querying an Instance",
"uri":"kafka-api-180514003.html",
"doc_type":"api",
- "p_code":"63",
- "code":"65"
+ "p_code":"68",
+ "code":"70"
},
{
"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",
@@ -590,8 +635,8 @@
"title":"Modifying an Instance",
"uri":"kafka-api-180514004.html",
"doc_type":"api",
- "p_code":"63",
- "code":"66"
+ "p_code":"68",
+ "code":"71"
},
{
"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",
@@ -599,8 +644,8 @@
"title":"Deleting an Instance",
"uri":"kafka-api-180514005.html",
"doc_type":"api",
- "p_code":"63",
- "code":"67"
+ "p_code":"68",
+ "code":"72"
},
{
"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",
@@ -608,8 +653,8 @@
"title":"Restarting or Deleting Instances in Batches",
"uri":"kafka-api-180514006.html",
"doc_type":"api",
- "p_code":"63",
- "code":"68"
+ "p_code":"68",
+ "code":"73"
},
{
"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",
@@ -617,8 +662,8 @@
"title":"Querying All Instances",
"uri":"kafka-api-180514007.html",
"doc_type":"api",
- "p_code":"63",
- "code":"69"
+ "p_code":"68",
+ "code":"74"
},
{
"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 ",
@@ -626,8 +671,8 @@
"title":"Creating a Topic in a Kafka Instance",
"uri":"kafka-api-180614001.html",
"doc_type":"api",
- "p_code":"63",
- "code":"70"
+ "p_code":"68",
+ "code":"75"
},
{
"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",
@@ -635,8 +680,8 @@
"title":"Querying a Topic in a Kafka Instance",
"uri":"kafka-api-180614002.html",
"doc_type":"api",
- "p_code":"63",
- "code":"71"
+ "p_code":"68",
+ "code":"76"
},
{
"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",
@@ -644,8 +689,8 @@
"title":"Deleting Topics in a Kafka Instance in Batches",
"uri":"kafka-api-180614003.html",
"doc_type":"api",
- "p_code":"63",
- "code":"72"
+ "p_code":"68",
+ "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.",
@@ -653,8 +698,8 @@
"title":"Other APIs",
"uri":"kafka-api-190605002.html",
"doc_type":"api",
- "p_code":"62",
- "code":"73"
+ "p_code":"67",
+ "code":"78"
},
{
"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",
@@ -662,8 +707,8 @@
"title":"Querying AZ Information",
"uri":"kafka-api-180514008.html",
"doc_type":"api",
- "p_code":"73",
- "code":"74"
+ "p_code":"78",
+ "code":"79"
},
{
"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",
@@ -671,8 +716,8 @@
"title":"Querying Product Specifications",
"uri":"kafka-api-180514009.html",
"doc_type":"api",
- "p_code":"73",
- "code":"75"
+ "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 Listing Maintenance Time Windows.This API is used to query the start and ",
@@ -680,8 +725,35 @@
"title":"Querying Maintenance Time Windows",
"uri":"kafka-api-180514010.html",
"doc_type":"api",
- "p_code":"73",
- "code":"76"
+ "p_code":"78",
+ "code":"81"
+ },
+ {
+ "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":"API V2",
+ "uri":"kafka-api-0003.html",
+ "doc_type":"api",
+ "p_code":"66",
+ "code":"82"
+ },
+ {
+ "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",
+ "product_code":"dms",
+ "title":"Creating an Instance",
+ "uri":"CreatePostPaidInstance.html",
+ "doc_type":"api",
+ "p_code":"82",
+ "code":"83"
+ },
+ {
+ "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",
+ "product_code":"dms",
+ "title":"Adding Partitions to a Topic for a Kafka Instance",
+ "uri":"CreatePartition.html",
+ "doc_type":"api",
+ "p_code":"82",
+ "code":"84"
},
{
"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.",
@@ -690,7 +762,7 @@
"uri":"kafka-api-180514011.html",
"doc_type":"api",
"p_code":"",
- "code":"77"
+ "code":"85"
},
{
"desc":"Table 1 lists status codes.",
@@ -698,8 +770,8 @@
"title":"Status Code",
"uri":"kafka-api-0034672261.html",
"doc_type":"api",
- "p_code":"77",
- "code":"78"
+ "p_code":"85",
+ "code":"86"
},
{
"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.",
@@ -707,8 +779,8 @@
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
- "p_code":"77",
- "code":"79"
+ "p_code":"85",
+ "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.",
@@ -716,8 +788,17 @@
"title":"Instance Status",
"uri":"kafka-api-180514012.html",
"doc_type":"api",
- "p_code":"77",
- "code":"80"
+ "p_code":"85",
+ "code":"88"
+ },
+ {
+ "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 ",
+ "product_code":"dms",
+ "title":"Obtaining a Project ID",
+ "uri":"kafka-api-0036212547.html",
+ "doc_type":"api",
+ "p_code":"85",
+ "code":"89"
},
{
"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.",
@@ -726,6 +807,6 @@
"uri":"kafka-api-0034672268.html",
"doc_type":"api",
"p_code":"",
- "code":"81"
+ "code":"90"
}
]
\ No newline at end of file
diff --git a/docs/dms/api-ref/CreateInstanceByEngine.html b/docs/dms/api-ref/CreateInstanceByEngine.html
new file mode 100644
index 00000000..4c5b50e0
--- /dev/null
+++ b/docs/dms/api-ref/CreateInstanceByEngine.html
@@ -0,0 +1,618 @@
+
+
+Creating an Instance
+Function
This API is used to create a pay-per-use or yearly/monthly-billed instance.
+
+URI
POST /v2/{engine}/{project_id}/instances
+
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+engine
+Yes
+String
+Message engine.
+Default: kafka
+project_id
+Yes
+String
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
+
+
+
+Request Parameters
+Table 2 Request body parameters Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Instance name.
+An instance name can contain 4 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
+description
+No
+String
+Instance description.
+The description can contain a maximum of 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 ".
+
+engine
+Yes
+String
+Message engine. Value: kafka.
+engine_version
+Yes
+String
+Message engine. Values:
+1.1.0
+2.3.0
+2.7
+
+broker_num
+Yes
+Integer
+Number of brokers.
+storage_space
+Yes
+Integer
+Message storage space in GB. Value range:
+300–300,000 GB for c6.2u4g.cluster Kafka instances
+300–600,000 GB for c6.4u8g.cluster Kafka instances
+300–1,500,000 GB for c6.8u16g.cluster Kafka instances
+300–1,500,000 GB for c6.12u24g.cluster Kafka instances
+300–1,500,000 GB for c6.16u32g.cluster Kafka instances
+
+access_user
+No
+String
+This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.
+A username must start with a letter and only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain 4 to 64 characters.
+password
+No
+String
+This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.
+Instance password.
+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
+Uppercase letters
+Digits
+Special characters include (`~!@#$ %^&*()-_=+|[{}]:'",<.>/?) and spaces, and cannot start with a hyphen (-).
+
+
+vpc_id
+Yes
+String
+VPC ID.
+To obtain it, log in to the VPC console and view the VPC ID on the VPC details page.
+security_group_id
+Yes
+String
+ID of the security group to which the instance belongs.
+To obtain it, log in to the VPC console and view the security group ID on the security group details page.
+subnet_id
+Yes
+String
+Subnet information.
+To obtain it, log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
+available_zones
+Yes
+Array of strings
+ID of the AZ where instance brokers reside and which has available resources. Obtain the AZ ID by referring to Listing AZ Information.
+This parameter cannot be empty or null.
+A Kafka instance can be deployed in 1 AZ or at least 3 AZs. When specifying AZs for brokers, use commas (,) to separate multiple AZs.
+product_id
+Yes
+String
+Product ID.
+You can obtain a product ID from Querying Product Specifications List.
+maintain_begin
+No
+String
+Time at which the maintenance window starts. The format is HH:mm.
+maintain_end
+No
+String
+Time at which the maintenance window ends. The format is HH:mm.
+enable_publicip
+No
+Boolean
+Whether to enable public access. By default, public access is disabled.
+true: enable
+false: disable
+
+publicip_id
+No
+String
+ID of the EIP bound to the instance.
+Use commas (,) to separate multiple EIP IDs.
+This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).
+ssl_enable
+No
+Boolean
+Whether to enable SSL encryption for access.
+This setting is fixed once the instance is created.
+true: enable
+false: disable
+
+kafka_security_protocol
+No
+String
+Security protocol to use after SASL is enabled. This parameter is mandatory if SASL authentication is enabled (ssl_enable=true).
+If this parameter is left blank, SASL_SSL authentication is enabled by default.
+This setting is fixed once the instance is created.
+SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
+SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol uses the SCRAM-SHA-512 mechanism and delivers high performance.
+
+sasl_enabled_mechanisms
+No
+Array of strings
+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:
+PLAIN: simple username and password verification.
+SCRAM-SHA-512: user credential verification, which is more secure than PLAIN.
+
+retention_policy
+No
+String
+Action to be taken when the memory usage reaches the disk capacity threshold.
+The value can be:
+produce_reject: New messages cannot be created.
+time_base: The earliest messages are deleted.
+
+ipv6_enable
+No
+Boolean
+Indicates whether to enable IPv6. This parameter is available only when the VPC supports IPv6.
+Default: false
+disk_encrypted_enable
+No
+Boolean
+Indicates whether to enable disk encryption.
+disk_encrypted_key
+No
+String
+Disk encryption key. If disk encryption is not enabled, this parameter is left blank.
+enable_auto_topic
+No
+Boolean
+Whether to enable automatic topic creation.
+true: enable
+false: disable
+
+If it is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is created in or retrieved from a topic that does not exist.
+The default value is false.
+storage_spec_code
+Yes
+String
+Storage I/O specification.
+Values:
+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.
+enterprise_project_id
+No
+String
+Enterprise project ID. This parameter is mandatory for an enterprise project account.
+tags
+No
+Array of TagEntity objects
+Tag list.
+arch_type
+No
+String
+CPU architecture. Currently, only the x86 architecture is supported.
+Options:
+X86
+
+vpc_client_plain
+No
+Boolean
+Intra-VPC plaintext access.
+bss_param
+No
+BssParam object
+Parameter related to the yearly/monthly billing mode.
+If this parameter is left blank, the billing mode is pay-per-use by default. If this parameter is not left blank, the billing mode is yearly/monthly.
+
+
+
+Table 3 TagEntity Parameter
+Mandatory
+Type
+Description
+key
+No
+String
+Tag key, which:
+Must be specified.
+Must be unique for the same instance.
+Can contain 1 to 128 characters.
+Can contain letters, digits, spaces, and special characters _.:=+-@
+Cannot start or end with a space.
+
+value
+No
+String
+Tag value.
+Can contain 0 to 255 characters.
+Can contain letters, digits, spaces, and special characters _.:=+-@
+Cannot start or end with a space.
+
+
+
+
+Table 4 BssParam Parameter
+Mandatory
+Type
+Description
+is_auto_renew
+No
+Boolean
+Whether auto renewal is enabled.
+Options:
+true: Auto renewal is enabled.
+false: Auto renewal is not enabled.
+
+By default, auto renewal is disabled.
+charging_mode
+No
+String
+Billing mode.
+This parameter specifies a payment mode.
+Options:
+prePaid: yearly/monthly billing.
+postPaid: pay-per-use billing.
+
+The default value is postPaid.
+is_auto_pay
+No
+Boolean
+Specifies whether the order is automatically or manually paid.
+Options:
+true: The order will be automatically paid.
+false: The order must be manually paid.
+
+The default payment mode is manual.
+period_type
+No
+String
+Subscription period type.
+Options:
+month
+year:
+
+This parameter is valid and mandatory only when chargingMode is set to prePaid. **
+period_num
+No
+Integer
+Subscribed periods.
+Options:
+If periodType is month, the value ranges from 1 to 9.
+If periodType is year, the value ranges from 1 to 3.
+
+**This parameter is valid and mandatory only when chargingMode is set to prePaid. **
+
+
+
+Response Parameters
Status code: 200
+
+Table 5 Response body parameters Parameter
+Type
+Description
+instance_id
+String
+Instance ID.
+
+
+
+Example Requests
Creating a pay-per-use Kafka instance whose version is 2.7, specifications are 2 vCPUs | 4 GB x 3, and storage space is 300 GB
+POST https://{endpoint}/v2/{engine}/{project_id}/instances
+
+{
+ "name" : "kafka-test",
+ "description" : "",
+ "engine" : "kafka",
+ "engine_version" : "2.7",
+ "storage_space" : 300,
+ "vpc_id" : "********-9b4a-44c5-a964-************",
+ "subnet_id" : "********-8fbf-4438-ba71-************",
+ "security_group_id" : "********-e073-4aad-991f-************",
+ "available_zones" : [ "********706d4c1fb0eb72f0********" ],
+ "product_id" : "c6.2u4g.cluster",
+ "ssl_enable" : true,
+ "kafka_security_protocol" : "SASL_SSL",
+ "sasl_enabled_mechanisms" : [ "SCRAM-SHA-512" ],
+ "storage_spec_code" : "dms.physical.storage.ultra.v2",
+ "broker_num" : 3,
+ "arch_type" : "X86",
+ "enterprise_project_id" : "0",
+ "access_user" : "********",
+ "password" : "********",
+ "enable_publicip" : true,
+ "tags" : [ {
+ "key" : "aaa",
+ "value" : "111"
+ } ],
+ "retention_policy" : "time_base",
+ "disk_encrypted_enable" : true,
+ "disk_encrypted_key" : "********-b953-4875-a743-************",
+ "publicip_id" : "********-88fc-4a8c-86d0-************,********-16af-455d-8d54-************,********-3d69-4367-95ab-************",
+ "vpc_client_plain" : true,
+ "enable_auto_topic" : true
+}
+
+Example Responses
Status code: 200
+Instance created successfully.
+{
+ "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
+}
+
+Status Codes
+Status Code
+Description
+200
+Instance created successfully.
+
+
+
+Error Codes
See Error Codes.
+
+
+
+
+Parent topic: Lifecycle Management
+
+
+
diff --git a/docs/dms/api-ref/CreateInstanceTopic.html b/docs/dms/api-ref/CreateInstanceTopic.html
index dad105b5..d0801184 100644
--- a/docs/dms/api-ref/CreateInstanceTopic.html
+++ b/docs/dms/api-ref/CreateInstanceTopic.html
@@ -3,7 +3,7 @@
Creating 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
+URI
POST /v2/{project_id}/instances/{instance_id}/topics
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
+Minimum: 1
+Maximum: 64
instance_id
@@ -31,6 +33,8 @@
String
Instance ID.
+Minimum: 1
+Maximum: 64
String
Topic name, which consists of 4 to 64 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), and digits.
+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
@@ -64,6 +70,8 @@
Integer
Number of replicas, which is configured to ensure data reliability. Value range: 1 to 3.
+Minimum: 1
+Maximum: 3
sync_message_flush
@@ -82,6 +90,8 @@
Integer
Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: 1–100.
+Minimum: 1
+Maximum: 100
sync_replication
@@ -99,7 +109,60 @@
Integer
Message retention period. The default value is 72.Value range: 1-720. Unit: hour.
+Indicates the retention period of a message. The default value is 72.Value range: 1–720. Unit: hour.
+topic_other_configs
+No
+Array of topic_other_configs objects
+Topic configuration.
+Array Length: 0 - 100
+topic_desc
+No
+String
+Topic description.
+Minimum: 0
+Maximum: 200
+
+
+
+Table 3 topic_other_configs Parameter
+Mandatory
+Type
+Description
+name
+No
+String
+Configuration name.
+value
+No
+String
+Configuration value.
Response Parameters
Status code: 200
-Table 3 Response body parameters Parameter
+Table 4 Response body parameters Parameter
Type
String
Topic name.
+Minimum: 3
+Maximum: 200
-Example Requests
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
+Example Requests
Creating a topic named test01
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
{
- "id" : "kafka01"
+ "id" : "test01",
+ "partition" : 3,
+ "replication" : 3,
+ "retention_time" : 72,
+ "sync_message_flush" : false,
+ "sync_replication" : "false",
+ "topic_other_configs" : [ {
+ "name" : "message.timestamp.type",
+ "value" : "LogAppendTime"
+ }, {
+ "name" : "max.message.bytes",
+ "value" : 10485760
+ } ],
+ "topic_desc" : ""
}
Example Responses
Status code: 200
-The creation is successful.
+Successful. A topic name is returned.
{
- "name" : "kafka01"
+ "name" : "test01"
}
Status Codes
@@ -148,7 +227,7 @@
200
The creation is successful.
+Successful. A topic name is returned.
Creating a User
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
+URI
POST /v2/{project_id}/instances/{instance_id}/users
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -55,6 +55,18 @@
String
Username.
+This parameter is mandatory for creating a user.
+user_desc
+No
+String
+User description.
+Minimum: 0
+Maximum: 200
user_passwd
@@ -63,14 +75,15 @@
String
User password.
+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:
-Contains 8 to 32 characters.
-Contains at least two of the following character types:
+Can contain 8 to 32 characters.
+Must contain at least three of the following character types:
Lowercase letters
Uppercase letters
Digits
-Special characters `~!@#$%^&*()-_=+|[{}]:'"",<.>/?
+Special characters include (`~!@#$ %^&*()-_=+|[{}]:'",<.>/?) and spaces, and cannot start with a hyphen (-).
-Example Requests
Creating a user.
+Example Requests
Creating a user whose username is test and password is Cxxx3
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
{
"user_name" : "test",
- "user_passwd" : "Cloud@123"
+ "user_passwd" : "Cxxx3"
}
Example Responses
None
diff --git a/docs/dms/api-ref/BatchCleanupInstanceTopic.html b/docs/dms/api-ref/CreateKafkaConsumerGroup.html
similarity index 59%
rename from docs/dms/api-ref/BatchCleanupInstanceTopic.html
rename to docs/dms/api-ref/CreateKafkaConsumerGroup.html
index a967fd48..524d7350 100644
--- a/docs/dms/api-ref/BatchCleanupInstanceTopic.html
+++ b/docs/dms/api-ref/CreateKafkaConsumerGroup.html
@@ -1,9 +1,9 @@
-
+
-Batch Cleaning Up Topics of a Kafka Instance
-Function
This API is used to clean up multiple topics of a Kafka instance in batches.
+Creating a Consumer Group
+Function
This API is used to create a consumer group.
-URI
POST /v2/kafka/{project_id}/instances/{instance_id}/topics/cleanup
+URI
POST /v2/{project_id}/kafka/instances/{instance_id}/group
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -38,7 +38,7 @@
Request Parameters
-Table 2 Request body parameters Parameter
+Table 2 Request body parameters Parameter
Mandatory
topics
+group_name
+Yes
+String
+Consumer group name.
+group_desc
No
Array of strings
+String
List of topics to be cleared up.
+Consumer group description.
+Minimum: 0
+Maximum: 200
-Response Parameters
Status code: 200
+Response Parameters
Status code: 400
-Table 3 Response body parameters Parameter
+Table 3 Response body parameters Parameter
Type
topics
+error_code
Array of topics objects
+String
Topic list.
+Error code.
-
-
-Table 4 topics Parameter
-Type
-Description
-id
+error_msg
String
+String
Topic name.
-success
-Boolean
-Whether the cleanup was successful.
+Error description.
-Example Requests
POST https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/topics/cleanup
+Example Requests
Creating a consumer group named test
+POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/group
{
- "topics" : [ "topic_1", "topic_2" ]
+ "group_name" : "test"
}
Example Responses
Status code: 200
-The cleanup is successful.
-{
- "topics" : [ {
- "id" : "topic_1",
- "success" : true
- }, {
- "id" : "topic_2",
- "success" : true
- } ]
-}
+Creation succeeded.
+success
Status Codes
-Status Code
+Status Code
Description
200
The cleanup is successful.
+Creation succeeded.
+400
+Creation failed.
Adding Partitions to a Topic for a Kafka Instance
-Function
This API is used to add partitions to a topic for a Kafka instance.
+Function
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 Modifying Topics of a Kafka Instance.
+
-URI
POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment
+URI
POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment
-Table 1 Path Parameters Parameter
+Table 1 URI parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID.
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
String
+String
Instance ID.
+Instance ID.
topic
+topic
Yes
+Yes
String
+String
Topic name.
+Topic name.
-Request Parameters
-Table 2 Request body parameters Parameter
+Request
+Table 2 Request parameter Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
partition
+partition
No
+No
Integer
+Integer
Total number of partitions after the addition. The value must be larger than current number of partitions and smaller than or equal to 100.
+Total number of partitions after the addition. The value must be larger than current number of partitions. Maximum value: 100.
-Response Parameters
None
+Response
None.
-Example Requests
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment
+Example Request
Adding partitions to a topic.
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment
{
"partition" : 3
}
-Example Responses
None
+Example Response
None.
-Status Codes
-Status Code
+Status Code
+Status Code
Description
+Description
204
+204
Partitions are added successfully.
+Partitions added successfully.
-
-Parent topic: Instance Management
+Parent topic: API V2
diff --git a/docs/dms/api-ref/CreatePostPaidInstance.html b/docs/dms/api-ref/CreatePostPaidInstance.html
index d667c5fb..55a49f42 100644
--- a/docs/dms/api-ref/CreatePostPaidInstance.html
+++ b/docs/dms/api-ref/CreatePostPaidInstance.html
@@ -1,425 +1,423 @@
Creating an Instance
-Function
This API is used to create a Kafka instance.
+Function
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.
+
-URI
POST /v2/{project_id}/instances
+URI
POST /v2/{project_id}/instances
-Table 1 Path Parameters Parameter
+Table 1 URI parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID.
+Project ID. For details, see Obtaining a Project ID.
-Request Parameters
-Table 2 Request body parameters Parameter
+Request Parameters
+Table 2 Request body parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
name
+name
Yes
+Yes
String
+String
Instance name.
-An instance name starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-).
+Instance name.
+An instance name starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-).
description
+description
No
+No
String
+String
Instance description.
-The description can contain a maximum of 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 ".
+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 \".
engine
+engine
Yes
+Yes
String
+String
Message engine. Value: kafka.
+Message engine. Set the value to kafka.
engine_version
+engine_version
Yes
+Yes
String
+String
Version of the message engine. Options:
-1.1.0
-2.3.0
-2.7
+Version of the message engine. Options:
+- 1.1.0
- 2.3.0
- 2.7
+
specification
+No
+String
+Baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. Unit: MB Value range:
+- 100 MB
- 300 MB
- 600 MB
- 1200 MB
+Note: The value of this parameter is determined by the product ID (product_id) and does not need to set manually.
+broker_num
+No
+Integer
+Number of brokers.
+This parameter can be left blank.
+storage_space
+Yes
+Integer
+Message storage space, in GB.
+- Kafka instance with specification being 100MB: 600–90,000 GB
- Kafka instance with specification being 300MB: 1200–90,000 GB
- Kafka instance with specification being 600MB: 2400–90,000 GB
- Kafka instance with specification being 1200MB: 4800–90,000 GB
+partition_num
+No
+Integer
+Maximum number of partitions in a Kafka instance.
+- When specification is 100MB: 300
- When specification is 300MB: 900
- When specification is 600MB: 1800
- When specification is 1200MB: 1800
+access_user
+No
+String
+This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.
+The username must be 4 to 64 characters long and can contain only letters, digits, and hyphens (-).
+password
+No
+String
+This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.
+Instance password.
+The password must meet the following complexity requirements:
+- Can contain 8 to 32 characters.
- Contain at least two of the following character types:
- Lowercase letters
- Uppercase letters
- Digits
- Special characters (`~!@#$%^&*()-_=+|[{}]:'",<.>/?)
specification
+vpc_id
No
+Yes
String
+String
This parameter indicates the bandwidth of the instance, that is, the maximum amount of data that can be transferred per unit time. Unit: MB. Options:
-100MB
-300MB
-600MB
-1200MB
-
-Note: The value of this parameter is determined by the product ID (product_id) and does not need to set manually.
+VPC ID.
+To obtain it, log in to the VPC console and view the VPC ID on the VPC details page.
broker_num
+security_group_id
No
+Yes
Integer
+String
Number of brokers.
-You do not need to set this parameter.
+Security group which the instance belongs to.
+To obtain it, log in to the VPC console and view the security group ID on the security group details page.
storage_space
+subnet_id
Yes
+Yes
Integer
+String
Message storage space in GB. Value range:
-600–90,000 GB for 100 MB/s Kafka instances
-1200–90,000 GB for 300 MB/s Kafka instances
-2400–90,000 GB for 600 MB/s Kafka instances
-4800–90,000 GB for 1200 MB/s Kafka instances
-
+Subnet information.
+To obtain it, log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
partition_num
+available_zones
No
+Yes
Integer
+Array of strings
Maximum number of partitions in a Kafka instance.
-The value is 300 when specification is 100MB.
-The value is 900 when specification is 300MB.
-The value is 1800 when specification is 600MB.
-The value is 1800 when specification is 1200MB.
-
+ID of the AZ where instance brokers reside and which has available resources. Obtain the AZ ID by referring to Listing AZ Information.
+This parameter cannot be empty or null. When creating a Kafka instance, you can select either 1 AZ or at least 3 AZ. When specifying AZs for brokers, use commas (,) to separate multiple AZs.
access_user
+product_id
No
+Yes
String
+String
This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.
-The username must be 4 to 64 characters long and can contain only letters, digits, and hyphens (-).
+Product ID.
+To create a Kafka instance, the following specifications are available: (product_id/specification/partition_num/storage_space)
+00300-30308-0--0/100MB/300/600
+00300-30310-0--0/300MB/900/1200
+00300-30312-0--0/600MB/1800/2400
+00300-30314-0--0/1200MB/1800/4800
password
+maintain_begin
No
+No
String
+String
This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.
-Instance password.
-The password must meet the following complexity requirements:
-Contains 8 to 32 characters.
-Contains at least two of the following character types:
-Lowercase letters
-Uppercase letters
-Digits
-Special characters `~!@#$%^&*()-_=+|[{}]:'"",<.>/?
-
-
+Time at which the maintenance time window starts. Format: HH:mm.
+- The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window.
- The start time must be set to 22:00, 02:00, 06:00, 10:00, 14:00, or 18:00.
- Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_begin is left blank, parameter maintain_end is also left blank. In this case, the system automatically set the start time to 02:00.
vpc_id
+maintain_end
Yes
+No
String
+String
VPC ID.
-To obtain it, log in to the VPC console and view the VPC ID on the VPC details page.
+Time at which the maintenance time window ends. Format: HH:mm.
+- The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window.
- The end time is four hours later than the start time. For example, if the start time is 22:00, the end time is 02:00.
- Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also left blank. In this case, the system automatically set the end time to 06:00.
security_group_id
+enable_publicip
Yes
+No
String
+Boolean
ID of the security group to which the instance belongs.
-To obtain it, log in to the VPC console and view the security group ID on the security group details page.
+Indicates whether to enable public access. By default, public access is disabled.
+- true: enable
- false: disable
subnet_id
+public_bandwidth
Yes
+No
String
+Integer
Subnet information.
-To obtain it, log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
+Public network bandwidth. Unit: Mbit/s When specification is 100MB, the value must be a multiple of the number of brokers and fall in the range from 3 to 900. When specification is 300MB, the value must be a multiple of the number of brokers and fall in the range from 3 to 900. When specification is 600MB, the value must be a multiple of the number of brokers and fall in the range from 4 to 1200. When specification is 1200MB, the value must be a multiple of the number of brokers and fall in the range from 8 to 2400.
available_zones
+publicip_id
Yes
+No
Array of strings
+String
ID of the AZ where instance brokers reside and which has available resources. This parameter cannot be empty or null. A Kafka instance can be deployed in 1 AZ or at least 3 AZs. When specifying AZs for brokers, separate multiple AZs with commas (,).
+ID of the elastic IP address (EIP) bound to an instance.
+Use commas (,) to separate multiple EIP IDs.
+This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).
product_id
+ssl_enable
Yes
+No
String
+Boolean
Product ID. You can obtain the product ID from Querying Product Specifications.
+Indicates whether to enable SSL-encrypted access.
+This setting is fixed once the instance is created.
+- true: enable
- false: disable
maintain_begin
+kafka_security_protocol
No
+No
String
+String
Time at which the maintenance time window starts. Format: HH:mm.
-The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window.
-The start time must be set to 22:00, 02:00, 06:00, 10:00, 14:00, or 18:00.
-The start time and end time must be set in pairs. If the start time is left blank, the end time must also be left blank. In this case, the system automatically sets the start time to 02:00.
-
+Security protocol to use after SASL is enabled. This parameter is mandatory if SASL authentication is enabled (that is, when ssl_enable is set to true).
+If this parameter is left blank, SASL_SSL authentication is enabled by default.
+This setting is fixed once the instance is created.
+- SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
- SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol uses the SCRAM-SHA-512 mechanism to deliver better performance.
maintain_end
+sasl_enabled_mechanisms
No
+No
String
+Array of strings
Time at which the maintenance time window ends. Format: HH:mm.
-The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window.
-The end time is four hours later than the start time. For example, if the start time is 22:00, the end time is 02:00.
-The start time and end time must be set in pairs. If the end time is left blank, the start time is also left blank. In this case, the system automatically sets the end time to 06:00.
-
+Authentication mechanism to use after SASL is enabled. This parameter is mandatory if SASL authentication is enabled (that is, when ssl_enable is set to 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:
+- PLAIN: simple username and password verification.
- SCRAM-SHA-512: user credential verification, which is more secure than PLAIN.
enable_publicip
+retention_policy
No
+No
Boolean
+String
Whether to enable public access. By default, public access is disabled.
-true: enable
-false: disable
-
+Action to be taken when the memory usage reaches the disk capacity threshold.
+Options:
+- produce_reject: New messages cannot be created.
- time_base: The earliest messages are deleted.
public_bandwidth
+disk_encrypted_enable
No
+No
Integer
+Boolean
Public network bandwidth. Unit: Mbit/s.
-Value range:
-When specification is 100MB, the value must be a multiple of the number of brokers and fall in the range from 3 to 900.
-When specification is 300MB, the value must be a multiple of the number of brokers and fall in the range from 3 to 900.
-When specification is 600MB, the value must be a multiple of the number of brokers and fall in the range from 4 to 1200.
-
-When specification is 1200MB, the value must be a multiple of the number of brokers and fall in the range from 8 to 2400.
+Indicates whether to enable disk encryption.
publicip_id
+disk_encrypted_key
No
+No
String
+String
ID of the EIP bound to the instance.
-Use commas (,) to separate multiple EIP IDs.
-This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).
+Disk encryption key. If disk encryption is not enabled, this parameter is left blank.
ssl_enable
+connector_enable
No
+No
Boolean
+Boolean
Whether to enable SSL encryption for access.
-This setting is fixed once the instance is created.
-true: enable
-false: disable
-
+Indicates whether to enable message dumping.
+By default, message dumping is disabled.
retention_policy
+enable_auto_topic
No
+No
String
+Boolean
Action to be taken when the memory usage reaches the disk capacity threshold.
-The value can be:
-produce_reject: New messages cannot be created.
-time_base: The earliest messages are deleted.
-
+Indicates whether to enable automatic topic creation.
+- true: enable
- false: disable
+If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist.
+The default value is false.
disk_encrypted_enable
+storage_spec_code
No
+Yes
Boolean
+String
Indicates whether disk encryption is enabled.
+Storage I/O specification.
+- The value is dms.physical.storage.high or dms.physical.storage.ultra when the parameter specification is 100MB or 300MB.
- The value is dms.physical.storage.ultra when the parameter specification is 600MB or 1200MB.
+For details on how to select a disk type, see "Disk Types and Disk Performance" in Elastic Volume Service User Guide.
disk_encrypted_key
+tags
No
+No
String
+Array of TagEntity objects
Disk encryption key. If disk encryption is not enabled, this parameter is left blank.
-enable_auto_topic
-No
-Boolean
-Whether to enable automatic topic creation.
-true: enable
-false: disable
-
-If it is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is created in or retrieved from a topic that does not exist.
-The default value is false.
-storage_spec_code
-Yes
-String
-Product ID. You can obtain the product ID from Querying Product Specifications. " Storage I/O specification.
-dms.physical.storage.high or dms.physical.storage.ultra when the parameter specification is 100MB or 300MB
-dms.physical.storage.ultra when the parameter specification is 600MB or 1200MB
-
-For details on how to select a disk type, see "Disk Types and Disk Performance".
-tags
-No
-Array of TagEntity objects
-Tag list.
+List of tags.
-Table 3 TagEntity Parameter
+Table 3 TagEntity Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
No
+No
String
+String
Tag key, which can contain a maximum of 36 Unicode characters.
-The key cannot be left blank or be an empty string.
-It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/
+Tag key.
+- Cannot be left blank.
- Must be unique for the same instance.
- Can contain 1 to 128 characters.
- Can contain letters, digits, spaces, and special characters _.:=+-@
- Cannot start or end with a space.
value
+value
No
+No
String
+String
Tag value, which can contain a maximum of 43 Unicode characters.
-The value cannot be left blank or be an empty string.
-It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/
+Value.
+- Can contain 0 to 255 characters.
- Can contain letters, digits, spaces, and special characters _.:=+-@
- Cannot start or end with a space.
-Response Parameters
Status code: 200
+Response Parameters
Status code: 200
-Table 4 Response body parameters Parameter
+Table 4 Response body parameter Parameter
Type
+Type
Description
+Description
instance_id
+instance_id
String
+String
Instance ID.
+Instance ID.
-Example Requests
Creating a Kafka instance.
-POST https://{endpoint}/v2/{project_id}/instances
+Example Requests
Creating a Kafka instance.
+POST https://{endpoint}/v2/{project_id}/instances
{
"name" : "kafka-test",
@@ -435,6 +433,8 @@
"maintain_begin" : "22:00",
"maintain_end" : "02:00",
"ssl_enable" : true,
+ "kafka_security_protocol" : "SASL_SSL",
+ "sasl_enabled_mechanisms" : [ "SCRAM-SHA-512" ],
"enable_publicip" : true,
"publicip_id" : "6db1129f-16af-455d-8d54-************,bb200202-423f-49e4-bae7-************,ca8801e8-6620-42af-b506-************",
"access_user" : "root",
@@ -446,34 +446,34 @@
"storage_spec_code" : "dms.physical.storage.ultra"
}
-Example Responses
Status code: 200
-An instance is created successfully.
-{
+Example Response
Status code: 200
+Instance created successfully.
+{
"instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}
-Status Codes
-Status Code
+Status Code
+Status Code
Description
+Description
200
+200
An instance is created successfully.
+Instance created successfully.
-
-Parent topic: Lifecycle Management
+Parent topic: API V2
diff --git a/docs/dms/api-ref/CreateReassignmentTask.html b/docs/dms/api-ref/CreateReassignmentTask.html
new file mode 100644
index 00000000..e9f09844
--- /dev/null
+++ b/docs/dms/api-ref/CreateReassignmentTask.html
@@ -0,0 +1,278 @@
+
+
+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.
+
+URI
POST /v2/kafka/{project_id}/instances/{instance_id}/reassign
+
+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
+reassignments
+Yes
+Array of PartitionReassignEntity objects
+Reassignment plan.
+throttle
+No
+Integer
+Reassignment threshold.
+is_schedule
+No
+Boolean
+Indicates whether the task is scheduled. If no, is_schedule and execute_at can be left blank. If yes, is_schedule is true and execute_at must be specified.
+execute_at
+No
+Long
+Schedule time. The value is a UNIX timestamp, in ms.
+time_estimate
+No
+Boolean
+Set true to perform time estimation tasks and false to perform rebalancing tasks.
+Default: false
+
+
+
+Table 3 PartitionReassignEntity Parameter
+Mandatory
+Type
+Description
+topic
+Yes
+String
+Topic name.
+brokers
+No
+Array of integers
+List of brokers to which partitions are reassigned. This parameter is mandatory in automatic assignment.
+replication_factor
+No
+Integer
+Replication factor, which can be specified in automatic assignment.
+assignment
+No
+Array of TopicAssignment objects
+Manually specified assignment plan. The brokers parameter and this parameter cannot be empty at the same time.
+
+
+
+
+
+Response Parameters
Status code: 200
+
+Table 5 Response body parameters Parameter
+Type
+Description
+job_id
+String
+Task ID. Only job_id is returned for a rebalancing task.
+reassignment_time
+Integer
+Estimated time, in seconds. Only reassignment_time is returned for a time estimation task.
+
+
+
+Example Requests
POST https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/reassign
+
+{
+ "reassignments" : [ {
+ "topic" : "topic-1513476102",
+ "brokers" : [ 0, 1, 2 ],
+ "replication_factor" : 3,
+ "assignment" : [ {
+ "partition" : 0,
+ "partition_brokers" : [ 0, 1, 2 ]
+ }, {
+ "partition" : 1,
+ "partition_brokers" : [ 1, 2, 0 ]
+ }, {
+ "partition" : 2,
+ "partition_brokers" : [ 2, 0, 1 ]
+ } ]
+ }, {
+ "topic" : "topic-1513558717",
+ "brokers" : [ 0, 1, 4 ],
+ "replication_factor" : 3,
+ "assignment" : [ {
+ "partition" : 0,
+ "partition_brokers" : [ 0, 1, 2 ]
+ }, {
+ "partition" : 1,
+ "partition_brokers" : [ 1, 2, 0 ]
+ }, {
+ "partition" : 2,
+ "partition_brokers" : [ 2, 0, 1 ]
+ } ]
+ } ],
+ "throttle" : 10000000,
+ "time_estimate" : false
+}
+
+Example Responses
Status code: 200
+Rebalancing task submitted or the estimated time is returned.
+{
+ "job_id" : "8a2c259182ab0e9d0182ab1882560009",
+ "reassignment_time" : 10
+}
+
+Status Codes
+Status Code
+Description
+200
+Rebalancing task submitted or the estimated time is returned.
+
+
+
+Error Codes
See Error Codes.
+
+
+
+
+Parent topic: Instance Management
+
+
+
diff --git a/docs/dms/api-ref/DeleteBackgroundTask.html b/docs/dms/api-ref/DeleteBackgroundTask.html
index 262b2fe4..0318f9d1 100644
--- a/docs/dms/api-ref/DeleteBackgroundTask.html
+++ b/docs/dms/api-ref/DeleteBackgroundTask.html
@@ -3,7 +3,7 @@
Deleting a Background Task
Function
This API is used to delete a specified background task.
-URI
DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
+URI
DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -50,7 +50,8 @@
Response Parameters
None
-Example Requests
DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}
+Example Requests
Deleting a specified background task
+DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}
Example Responses
None
diff --git a/docs/dms/api-ref/DeleteGroup.html b/docs/dms/api-ref/DeleteGroup.html
index 713cea75..ca263896 100644
--- a/docs/dms/api-ref/DeleteGroup.html
+++ b/docs/dms/api-ref/DeleteGroup.html
@@ -3,7 +3,7 @@
Deleting 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}
+URI
DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
diff --git a/docs/dms/api-ref/DeleteInstance.html b/docs/dms/api-ref/DeleteInstance.html
index c8749241..f4d9d775 100644
--- a/docs/dms/api-ref/DeleteInstance.html
+++ b/docs/dms/api-ref/DeleteInstance.html
@@ -3,7 +3,7 @@
Deleting an Instance
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}
+URI
DELETE /v2/{project_id}/instances/{instance_id}
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -41,7 +41,8 @@
Response Parameters
None
-Example Requests
DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}
+Example Requests
Deleting an instance
+DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}
Example Responses
None
diff --git a/docs/dms/api-ref/ErrorCode.html b/docs/dms/api-ref/ErrorCode.html
index 8db71122..5d2bcdc6 100644
--- a/docs/dms/api-ref/ErrorCode.html
+++ b/docs/dms/api-ref/ErrorCode.html
@@ -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-20.
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-20.
Check the number of partitions of the topic.
DMS.00400103
The number of replicas created for a Kafka topic must be within the range of 1–20.
+The number of replicas created for a Kafka topic must be within the range of 1-20.
The number of replicas created for a topic in a Kafka instance must be within the range of 1–20.
+The number of replicas created for a topic in a Kafka instance must be within the range of 1-20.
Check the number of replicas of the topic.
DMS.00400105
The message retention period of a Kafka topic must be within the range of 1–168.
+The message retention period of a Kafka topic must be within the range of 1-168.
The aging time of a topic in a Kafka instance must be within the range of 1–168.
+The aging time of a topic in a Kafka instance must be within the range of 1-168.
Check the aging time of the topic.
400
DMS.00400126
-Invalid period time.
-Invalid time period for yearly/monthly billing.
-Check the time period for yearly/monthly billing.
-400
-DMS.00400127
Instance not support to change retention_policy.
@@ -781,11 +770,11 @@ A password:
DMS.00400142
The yearly/monthly charging function is not enabled.
+Timestamp is invalid.
The yearly/monthly charging function is not enabled.
+Timestamp is invalid.
Purchase an on-demand instance.
+Enter a correct timestamp.
400
@@ -803,11 +792,11 @@ A password:
DMS.00400800
Duplicate topic name.Invalid request. You can create, delete, or query a topic only for a Kafka instance.Invalid parameter. Error information varies by scenario.
+Invalid request parameter. Check the request parameter.
Invalid {0} in the request.
+Invalid request parameter.
Check the instance.
+Check the request parameters.
400
@@ -823,6 +812,28 @@ A password:
400
DMS.00400970
+RabbitMQ plugin is not exist
+Invalid plugin name
+Check the plugin list.
+400
+DMS.00400971
+The instance ssl is off.
+The instance ssl is off.
+View the instance details and check whether SSL is enabled.
+400
+DMS.00404033
Does not support extend rabbitMQ disk space.
@@ -834,6 +845,28 @@ A password:
400
DMS.00500986
+Your account has been restricted.
+Your account is suspended.
+Contact the billing center.
+400
+DMS.00500987
+Balance is not enough
+Insufficient balance.
+Top up your account and try again later.
+400
+DMS.10240002
The number of queried queues exceeds the upper limit.
@@ -1012,9 +1045,9 @@ A password:
DMS.10240021
The value of time_wait is not within the value range of 1–60.
+The value of time_wait is not within the value range of 1-60.
The value of time_wait is not within the range of 1–60.
+The value of time_wait is not within the range of 1-60.
Check the value of time_wait.
DMS.10240022
The value of max Consume Count must be within the range of 1–100.
+The value of max Consume Count must be within the range of 1-100.
The value of max Consume Count must be within the range of 1–100.
+The value of max Consume Count must be within the range of 1-100.
Check the value of max Consume Count.
DMS.10240027
The value of retention_hours must be an integer in the range of 1–72.
+The value of retention_hours must be an integer in the range of 1-72.
The value of retention_hours must be an integer in the range of 1–72.
+The value of retention_hours must be an integer in the range of 1-72.
Check the value of retention_hours.
DMS.10542206
The value of ack_wait must be within the range of 15–300.
+The value of ack_wait must be within the range of 15-300.
The value of ack_wait must be within the range of 15–300.
+The value of ack_wait must be within the range of 15-300.
Check the value of ack_wait.
Check the request format.
400
+DMS.50050004
+The consumer group is offline.
+The consumer group is offline.
+Start the consumer instance in the consumer group.
+401
DMS.10240101
@@ -1408,9 +1452,9 @@ A password:
DMS.10240307
The consumer group quota must be within the range of 1–10.
+The consumer group quota must be within the range of 1-10.
The consumer group quota must be within the range of 1–10.
+The consumer group quota must be within the range of 1-10.
Check whether the number of consumer groups exceeds the quota.
DMS.10240308
The queue quota must be within the range of 1–20.
+The queue quota must be within the range of 1-20.
The queue quota must be within the range of 1–20.
+The queue quota must be within the range of 1-20.
Check whether the number of queues exceeds the quota.
Check the request method.
408
+DMS.111501024
+Query timed out
+Message query timeout
+Please query later
+500
DMS.00500000
@@ -1714,6 +1769,50 @@ A password:
500
DMS.00501000
+Failed to create agency, may be you do not have the agency permission.
+Failed to create agency
+check whether the current user has the agency permission.
+500
+DMS.00501001
+Failed to get agency roleId.
+Failed to get agency roleId.
+retry the request later
+500
+DMS.00501002
+Failed to query agency roleId.
+Failed to query the role ID based on the role name.
+Check whether the role name in the request is correct.
+500
+DMS.00501003
+Failed to grant role to agency.
+Failed to grant role to agency.
+Try again later, or contact technical support
+500
+DMS.10250002
Internal service error.
@@ -1778,6 +1877,28 @@ A password:
Check tag_type.
501
+DMS.111501026
+Query reach maximum byte
+The total number of bytes in the query exceeds the upper limit.
+Shorten the time range to ensure that the number of queried bytes does not exceed the limit, or use other methods to query data.
+503
+DMS.111501025
+Query Busy. Please try again later.
+Message query busy
+Please query later
+
diff --git a/docs/dms/api-ref/ListAvailableZones.html b/docs/dms/api-ref/ListAvailableZones.html
index bb632a90..d7400e46 100644
--- a/docs/dms/api-ref/ListAvailableZones.html
+++ b/docs/dms/api-ref/ListAvailableZones.html
@@ -3,7 +3,7 @@
Listing AZ Information
Function
This API is used to query the AZ ID for creating an instance.
-URI
GET /v2/available-zones
+URI
GET /v2/available-zones
Request Parameters
None
@@ -26,7 +26,7 @@
available_zones
Array of available_zones objects
+Array of AvailableZonesResp objects
Array of AZs.
-Table 2 available_zones Parameter
+Table 2 AvailableZonesResp Parameter
Type
soldOut
-Boolean
-Whether resources are sold out.
-id
+id
String
String
Whether there are available resources in the AZ.
-default_az
-Boolean
-Whether the AZ is the default AZ.
-remain_time
-Long
-Remaining time.
-ipv6_enable
-Boolean
-Whether IPv6 is supported.
+Indicates whether the AZ has available resources.
Example Responses
Status code: 200
The AZ information is queried successfully.
+The instance is queried. An example returned result is as follows.
{
"region_id" : "xxx",
"available_zones" : [ {
- "soldOut" : false,
"id" : "d539378ec1314c85b76fefa3f7071458",
"code" : "xxx",
"name" : "AZ 2.",
"port" : "8003",
- "resource_availability" : "true",
- "default_az" : true,
- "remain_time" : 9223372036854776000,
- "ipv6_enable" : false
+ "resource_availability" : "true"
}, {
- "soldOut" : false,
"id" : "9f1c5806706d4c1fb0eb72f0a9b18c77",
"code" : "xxx",
"name" : "AZ 3.",
"port" : "443",
- "resource_availability" : "true",
- "default_az" : false,
- "remain_time" : 9223372036854776000,
- "ipv6_enable" : false
+ "resource_availability" : "true"
} ]
}
+
Status Codes
Status Code
diff --git a/docs/dms/api-ref/ListBackgroundTasks.html b/docs/dms/api-ref/ListBackgroundTasks.html
index a3ffe14a..27befb23 100644
--- a/docs/dms/api-ref/ListBackgroundTasks.html
+++ b/docs/dms/api-ref/ListBackgroundTasks.html
@@ -3,7 +3,7 @@
Listing Background Tasks
Function
This API is used to list background tasks of an instance.
-URI
GET /v2/{project_id}/instances/{instance_id}/tasks
+URI
GET /v2/{project_id}/instances/{instance_id}/tasks
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
diff --git a/docs/dms/api-ref/ListEngineProducts.html b/docs/dms/api-ref/ListEngineProducts.html
new file mode 100644
index 00000000..0e1de03e
--- /dev/null
+++ b/docs/dms/api-ref/ListEngineProducts.html
@@ -0,0 +1,565 @@
+
+
+Querying Product Specifications List
+Function
This API is used to query the product specifications list.
+
+URI
GET /v2/{engine}/products
+
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+engine
+Yes
+String
+Message engine.
+Default: kafka
+
+
+
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+product_id
+No
+String
+Product ID.
+
+
+
+Request Parameters
None
+
+Response Parameters
Status code: 200
+
+Table 3 Response body parameters Parameter
+Type
+Description
+engine
+String
+Message engine of DMS.
+versions
+Array of strings
+Supported versions.
+products
+Array of ListEngineProductsEntity objects
+Product specification details.
+
+
+
+Table 4 ListEngineProductsEntity Parameter
+Type
+Description
+type
+String
+Product type. Currently, single-node and cluster types are supported.
+product_id
+String
+Product ID.
+ecs_flavor_id
+String
+ECS flavor.
+arch_types
+Array of strings
+CPU architecture.
+charging_mode
+Array of strings
+Billing mode. hourly: pay-per-use
+ios
+Array of ListEngineIosEntity objects
+List of supported disk I/O types.
+support_features
+Array of ListEngineSupportFeaturesEntity objects
+List of features supported by instances of the current specifications.
+properties
+ListEnginePropertiesEntity object
+Attribute of instances of the current specifications.
+
+
+
+Table 5 ListEngineIosEntity Parameter
+Type
+Description
+io_spec
+String
+Disk I/O code.
+type
+String
+Disk type.
+available_zones
+Array of strings
+Available AZs.
+unavailable_zones
+Array of strings
+Unavailable AZs.
+
+
+
+Table 6 ListEngineSupportFeaturesEntity Parameter
+Type
+Description
+name
+String
+Feature name.
+properties
+
+
+Description of the features supported by the instance.
+
+
+
+Table 7 ListEngineSupportFeaturesPropertiesEntity Parameter
+Type
+Description
+max_task
+String
+Maximum number of dumping tasks.
+min_task
+String
+Minimum number of dumping tasks.
+max_node
+String
+Maximum number of dumping nodes.
+min_node
+String
+Minimum number of dumping nodes.
+
+
+
+Table 8 ListEnginePropertiesEntity Parameter
+Type
+Description
+max_partition_per_broker
+String
+Maximum number of partitions of each broker.
+max_broker
+String
+Maximum number of brokers.
+max_storage_per_node
+String
+Maximum storage space of each broker. The unit is GB.
+max_consumer_per_broker
+String
+Maximum number of consumers of each broker.
+min_broker
+String
+Minimum number of brokers.
+max_bandwidth_per_broker
+String
+Maximum bandwidth of each broker.
+min_storage_per_node
+String
+Minimum storage space of each broker. The unit is GB.
+max_tps_per_broker
+String
+Maximum TPS of each broker.
+product_alias
+String
+Alias of product_id.
+
+
+
+Example Requests
GET https://{endpoint}/v2/kafka/products
+
+Example Responses
Status code: 200
+The product specifications are listed successfully.
+{
+ "engine" : "kafka",
+ "versions" : [ "1.1.0", "2.3.0" ],
+ "products" : [ {
+ "type" : "cluster",
+ "product_id" : "c6.2u4g.cluster",
+ "ecs_flavor_id" : "c6.large.2",
+ "billing_code" : "dms.platinum.c6",
+ "arch_types" : [ "X86" ],
+ "charging_mode" : [ "monthly", "hourly" ],
+ "ios" : [ {
+ "io_spec" : "dms.physical.storage.high.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ }, {
+ "io_spec" : "dms.physical.storage.ultra.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ } ],
+ "support_features" : [ {
+ "name" : "connector_obs",
+ "properties" : {
+ "max_task" : "10",
+ "max_node" : "10",
+ "min_task" : "1",
+ "min_node" : "2"
+ }
+ } ],
+ "properties" : {
+ "max_partition_per_broker" : "250",
+ "max_broker" : "30",
+ "max_storage_per_node" : "10000",
+ "max_consumer_per_broker" : "4000",
+ "min_broker" : "3",
+ "max_bandwidth_per_broker" : "100",
+ "min_storage_per_node" : "200",
+ "max_tps_per_broker" : "30000",
+ "product_alias" : "kafka.2u4g.cluster"
+ }
+ }, {
+ "type" : "cluster",
+ "product_id" : "c6.4u8g.cluster",
+ "ecs_flavor_id" : "c6.xlarge.2",
+ "billing_code" : "dms.platinum.c6",
+ "arch_types" : [ "X86" ],
+ "charging_mode" : [ "monthly", "hourly" ],
+ "ios" : [ {
+ "io_spec" : "dms.physical.storage.high.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ }, {
+ "io_spec" : "dms.physical.storage.ultra.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ } ],
+ "support_features" : [ {
+ "name" : "connector_obs",
+ "properties" : {
+ "max_task" : "10",
+ "max_node" : "10",
+ "min_task" : "1",
+ "min_node" : "2"
+ }
+ } ],
+ "properties" : {
+ "max_partition_per_broker" : "500",
+ "max_broker" : "30",
+ "max_storage_per_node" : "20000",
+ "max_consumer_per_broker" : "4000",
+ "min_broker" : "3",
+ "max_bandwidth_per_broker" : "100",
+ "min_storage_per_node" : "400",
+ "max_tps_per_broker" : "100000",
+ "product_alias" : "kafka.4u8g.cluster"
+ }
+ }, {
+ "type" : "cluster",
+ "product_id" : "c6.8u16g.cluster",
+ "ecs_flavor_id" : "c6.2xlarge.2",
+ "billing_code" : "dms.platinum.c6",
+ "arch_types" : [ "X86" ],
+ "charging_mode" : [ "monthly", "hourly" ],
+ "ios" : [ {
+ "io_spec" : "dms.physical.storage.high.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ }, {
+ "io_spec" : "dms.physical.storage.ultra.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ } ],
+ "support_features" : [ {
+ "name" : "connector_obs",
+ "properties" : {
+ "max_task" : "10",
+ "max_node" : "10",
+ "min_task" : "1",
+ "min_node" : "2"
+ }
+ } ],
+ "properties" : {
+ "max_partition_per_broker" : "1000",
+ "max_broker" : "30",
+ "max_storage_per_node" : "30000",
+ "max_consumer_per_broker" : "4000",
+ "min_broker" : "3",
+ "max_bandwidth_per_broker" : "100",
+ "min_storage_per_node" : "800",
+ "max_tps_per_broker" : "150000",
+ "product_alias" : "kafka.8u16g.cluster"
+ }
+ }, {
+ "type" : "cluster",
+ "product_id" : "c6.12u24g.cluster",
+ "ecs_flavor_id" : "c6.3xlarge.2",
+ "billing_code" : "dms.platinum.c6",
+ "arch_types" : [ "X86" ],
+ "charging_mode" : [ "monthly", "hourly" ],
+ "ios" : [ {
+ "io_spec" : "dms.physical.storage.high.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ }, {
+ "io_spec" : "dms.physical.storage.ultra.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ } ],
+ "support_features" : [ {
+ "name" : "connector_obs",
+ "properties" : {
+ "max_task" : "10",
+ "max_node" : "10",
+ "min_task" : "1",
+ "min_node" : "2"
+ }
+ } ],
+ "properties" : {
+ "max_partition_per_broker" : "1500",
+ "max_broker" : "30",
+ "max_storage_per_node" : "30000",
+ "max_consumer_per_broker" : "4000",
+ "min_broker" : "3",
+ "max_bandwidth_per_broker" : "100",
+ "min_storage_per_node" : "1200",
+ "max_tps_per_broker" : "200000",
+ "product_alias" : "kafka.12u24g.cluster"
+ }
+ }, {
+ "type" : "cluster",
+ "product_id" : "c6.16u32g.cluster",
+ "ecs_flavor_id" : "c6.4xlarge.2",
+ "billing_code" : "dms.platinum.c6",
+ "arch_types" : [ "X86" ],
+ "charging_mode" : [ "monthly", "hourly" ],
+ "ios" : [ {
+ "io_spec" : "dms.physical.storage.high.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ }, {
+ "io_spec" : "dms.physical.storage.ultra.v2",
+ "type" : "evs",
+ "available_zones" : [ "xxx", "xxx" ],
+ "unavailable_zones" : [ "xxx", "xxx" ]
+ } ],
+ "support_features" : [ {
+ "name" : "connector_obs",
+ "properties" : {
+ "max_task" : "10",
+ "max_node" : "10",
+ "min_task" : "1",
+ "min_node" : "2"
+ }
+ } ],
+ "properties" : {
+ "max_partition_per_broker" : "2000",
+ "max_broker" : "30",
+ "max_storage_per_node" : "30000",
+ "max_consumer_per_broker" : "4000",
+ "min_broker" : "3",
+ "max_bandwidth_per_broker" : "100",
+ "min_storage_per_node" : "1600",
+ "max_tps_per_broker" : "250000",
+ "product_alias" : "kafka.16u32g.cluster"
+ }
+ } ]
+}
+
+Status Codes
+Status Code
+Description
+200
+The product specifications are listed successfully.
+
+
+
+Error Codes
See Error Codes.
+
+
+
+
+Parent topic: Other APIs
+
+
+
diff --git a/docs/dms/api-ref/ListInstanceConsumerGroups.html b/docs/dms/api-ref/ListInstanceConsumerGroups.html
index 9ae8e1a6..772b3217 100644
--- a/docs/dms/api-ref/ListInstanceConsumerGroups.html
+++ b/docs/dms/api-ref/ListInstanceConsumerGroups.html
@@ -3,7 +3,7 @@
Querying All Consumer Groups
Function
This API is used to query all consumer groups.
-URI
GET /v2/{project_id}/instances/{instance_id}/groups
+URI
GET /v2/{project_id}/instances/{instance_id}/groups
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -90,11 +90,11 @@
group_ids
+groups
Array of strings
+Array of GroupInfoSimple objects
All consumer group IDs.
+All consumer groups.
total
@@ -104,33 +104,99 @@
Total number of consumer groups.
next_offset
+
+
+
+Table 4 GroupInfoSimple Parameter
+Type
+Description
+createdAt
Integer
+Long
Sequence number of the next consumer group.
+Creation time.
previous_offset
+group_id
Integer
+String
Sequence number of the previous consumer group.
+Consumer group ID.
+state
+String
+Consumer group status. The value can be:
+Dead: The consumer group has no members or metadata.
+Empty: The consumer group has metadata but has no members.
+PreparingRebalance: The consumer group is to be rebalanced.
+CompletingRebalance: All members have joined the group.
+Stable: Members in the consumer group can consume messages. "
+
+coordinator_id
+Integer
+Coordinator ID.
+group_desc
+String
+Consumer group description.
+lag
+Long
+Number of accumulated messages.
-Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offest={offest}&limit={limit}&group={group}
+Example Requests
Querying the consumer group list
+GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offest={offest}&limit={limit}&group={group}
Example Responses
Status code: 200
All consumer groups are queried successfully.
{
- "group_ids" : [ "groupId_1", "groupId_2", "groupId_3" ],
- "total" : 5,
- "next_offset" : 4,
- "previous_offset" : 0
+ "groups" : [ {
+ "createdAt" : 1691401194847,
+ "group_id" : "consumer-1",
+ "state" : "EMPTY",
+ "coordinator_id" : 1,
+ "lag" : 0,
+ "group_desc" : null
+ }, {
+ "createdAt" : 1691401194960,
+ "group_id" : "consumer-2",
+ "state" : "STABLE",
+ "coordinator_id" : 2,
+ "lag" : 0,
+ "group_desc" : null
+ }, {
+ "createdAt" : 1691401207309,
+ "group_id" : "consumer-3",
+ "state" : "STABLE",
+ "coordinator_id" : 3,
+ "lag" : 0,
+ "group_desc" : null
+ } ],
+ "total" : 3
}
Status Codes
diff --git a/docs/dms/api-ref/ListInstanceTopics.html b/docs/dms/api-ref/ListInstanceTopics.html
index 7d84bd32..1708629b 100644
--- a/docs/dms/api-ref/ListInstanceTopics.html
+++ b/docs/dms/api-ref/ListInstanceTopics.html
@@ -3,7 +3,7 @@
Listing 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
+URI
GET /v2/{project_id}/instances/{instance_id}/topics
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -36,12 +36,44 @@
+
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+offset
+No
+String
+Offset, which is the position where the query starts. The value must be greater than or equal to 0.
+limit
+No
+String
+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 2 Response body parameters Parameter
+Table 3 Response body parameters Parameter
Type
Total number of partitions.
topic_max_partitions
+Integer
+Maximum number of partitions in a single topic.
+topics
Array of TopicEntity objects
@@ -88,7 +127,7 @@
-Table 3 TopicEntity Parameter
+Table 4 TopicEntity Parameter
Type
Topic type. Options: 0: common topic; 1: system (internal) topic.
topic_other_configs
+Array of topic_other_configs objects
+Other topic configurations.
+topic_desc
+String
+Topic description.
+created_at
+Long
+Topic creation time.
+
+
+
+Table 5 topic_other_configs Parameter
+Type
+Description
+name
+String
+Configuration name.
+valid_values
+String
+Valid value.
+default_value
+String
+Default value.
+config_type
+String
+Configuration type. The value can be dynamic or static.
+value
+String
+Configuration value.
+value_type
+String
+Configuration value type.
+
-Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
+Example Requests
Querying the topic list
+GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10
Example Responses
Status code: 200
The query is successful.
{
- "total" : 3,
- "size" : 3,
+ "total" : 1,
+ "size" : 0,
"topics" : [ {
"policiesOnly" : false,
- "name" : "topic-11",
+ "name" : "Topic-test01",
"replication" : 3,
"partition" : 3,
"retention_time" : 72,
- "sync_replication" : false,
- "sync_message_flush" : false,
+ "sync_replication" : "false",
+ "sync_message_flush" : "false",
+ "topic_other_configs" : [ {
+ "name" : "max.message.bytes",
+ "valid_values" : "[0...10485760]",
+ "default_value" : "10485760",
+ "config_type" : "dynamic",
+ "value" : "10485760",
+ "value_type" : "int"
+ }, {
+ "name" : "message.timestamp.type",
+ "valid_values" : "[CreateTime, LogAppendTime]",
+ "default_value" : "LogAppendTime",
+ "config_type" : "dynamic",
+ "value" : "LogAppendTime",
+ "value_type" : "string"
+ } ],
"external_configs" : { },
- "topic_type" : 0
- }, {
- "policiesOnly" : false,
- "name" : "topic-2077405901",
- "replication" : 3,
- "partition" : 3,
- "retention_time" : 72,
- "sync_replication" : false,
- "sync_message_flush" : true,
- "external_configs" : { },
- "topic_type" : 0
- }, {
- "policiesOnly" : false,
- "name" : "topic-test",
- "replication" : 3,
- "partition" : 3,
- "retention_time" : 1,
- "sync_replication" : true,
- "sync_message_flush" : false,
- "external_configs" : { },
- "topic_type" : 0
- } ]
+ "topic_type" : 0,
+ "topic_desc" : "This is a test topic",
+ "created_at" : 1688112779916
+ } ],
+ "remain_partitions" : 294,
+ "max_partitions" : 300,
+ "topic_max_partitions" : 200
}
Status Codes
diff --git a/docs/dms/api-ref/ListInstances.html b/docs/dms/api-ref/ListInstances.html
index a119f91e..04bc7291 100644
--- a/docs/dms/api-ref/ListInstances.html
+++ b/docs/dms/api-ref/ListInstances.html
@@ -3,7 +3,7 @@
Listing All Instances
Function
This API is used to query the instances of an account by the specified conditions.
-URI
GET /v2/{project_id}/instances
+URI
GET /v2/{project_id}/instances
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
String
Message engine. Value: kafka.
+Default: kafka
name
@@ -71,7 +72,7 @@
String
Instance status.
+Instance status. For details, see Instance Status.
include_failure
@@ -80,8 +81,8 @@
String
Whether to return the number of instances that fail to be created.
-If the value is true, the number of instances that failed to be created is returned. If the value is not true, the number is not returned.
+Indicates whether to return the number of instances that fail to be created.
+If the value is true, the number of instances that failed to be created is returned. If the value is false, the number is not returned.
exact_match_name
@@ -94,6 +95,33 @@
The default value is false*, indicating that a fuzzy search is performed based on a specified instance name. If the value is true, the instance that precisely matches a specified instance name is queried.
enterprise_project_id
+No
+String
+Enterprise project ID.
+offset
+No
+String
+Offset, which is the position where the query starts. The value must be greater than or equal to 0.
+limit
+No
+String
+Maximum number of instances returned in the current query. The default value is 10. The value ranges from 1 to 50.
+
@@ -210,7 +238,7 @@
String
Instance status.
+Instance status. For details, see Instance Status.
instance_id
@@ -232,6 +260,13 @@
charging_mode
+Integer
+Billing mode. 1: pay-per-use.
+vpc_id
String
@@ -323,6 +358,36 @@
broker_ssl_enable
+Boolean
+Indicates whether to enable encrypted replica transmission among brokers.
+true: enable
+false: disable
+
+kafka_security_protocol
+String
+Security protocol to use after SASL is enabled.
+SASL_SSL: Data is encrypted with SSL certificates for high-security transmission.
+SASL_PLAINTEXT: Data is transmitted in plaintext with username and password authentication. This protocol uses the SCRAM-SHA-512 mechanism and delivers high performance.
+
+sasl_enabled_mechanisms
+Array of strings
+Authentication mechanism used after SASL is enabled.
+PLAIN: simple username and password verification.
+SCRAM-SHA-512: user credential verification, which is more secure than PLAIN.
+
+ssl_two_way_enable
Boolean
@@ -330,14 +395,18 @@
Indicates whether to enable two-way authentication.
enable_auto_topic
+cert_replaced
Boolean
Whether automatic topic creation is enabled.
-true: enabled
-false: disabled
-
+Whether the certificate can be replaced.
+enterprise_project_id
+String
+Enterprise project ID.
type
@@ -382,6 +451,13 @@
AZ to which the instance brokers belong. The AZ ID is returned.
available_zone_names
+Array of strings
+Name of the AZ to which the instance node belongs. The AZ name is returned.
+total_storage_space
Integer
@@ -445,6 +521,20 @@
Public network access bandwidth.
kafka_manager_enable
+Boolean
+Whether Kafka Manager is enabled.
+new_auth_cert
+Boolean
+Indicates whether to enable a new certificate.
+cross_vpc_info
String
@@ -452,6 +542,13 @@
Cross-VPC access information.
connector_node_num
+Integer
+Number of connectors.
+rest_connect_address
String
@@ -459,34 +556,6 @@
Kafka REST connection address.
public_boundwidth
-Integer
-Public network access bandwidth. To be deleted.
-message_query_inst_enable
-Boolean
-Whether message query is enabled.
-vpc_client_plain
-Boolean
-Whether intra-VPC plaintext access is enabled.
-support_features
-String
-List of features supported by the Kafka instance.
-pod_connect_address
String
@@ -515,6 +584,13 @@
Private connection address of a Kafka instance.
ces_version
+String
+Cloud Eye version.
+public_access_enabled
String
@@ -536,6 +612,13 @@
Indicates whether access control is enabled.
new_spec_billing_enable
+Boolean
+Whether billing based on new specifications is enabled.
+broker_num
Integer
@@ -573,29 +656,36 @@
String
Tag key, which can contain a maximum of 36 Unicode characters.
-The key cannot be left blank or be an empty string.
-It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/
+Tag key, which:
+Must be specified.
+Must be unique for the same instance.
+Can contain 1 to 128 characters.
+Can contain letters, digits, spaces, and special characters _.:=+-@
+Cannot start or end with a space.
+
value
String
Tag value, which can contain a maximum of 43 Unicode characters.
-The value cannot be left blank or be an empty string.
-It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/
+Tag value.
+Can contain 0 to 255 characters.
+Can contain letters, digits, spaces, and special characters _.:=+-@
+Cannot start or end with a space.
+
-Example Requests
GET https://{endpoint}/v2/{project_id}/instances
+Example Requests
Querying the instance list
+GET https://{endpoint}/v2/{project_id}/instances
Example Responses
Status code: 200
-All instances are listed successfully.
-{
+Instance list queried.
+{
"instances" : [ {
"name" : "kafka-2085975099",
"engine" : "kafka",
@@ -616,18 +706,25 @@
"security_group_name" : "Sys-default",
"subnet_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"available_zones" : [ "38b0f7a602344246bcb0da47b5d548e7" ],
+ "available_zone_names" : [ "AZ1" ],
"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,
+ "new_auth_cert" : false,
"storage_space" : 492,
"total_storage_space" : 600,
"used_storage_space" : 25,
"partition_num" : "300",
"enable_publicip" : false,
- "ssl_enable" : false,
+ "ssl_enable" : true,
+ "broker_ssl_enable" : false,
+ "cert_replaced" : false,
+ "kafka_security_protocol" : "SASL_SSL",
"management_connect_address" : "https://192.168.0.100:9999",
"cross_vpc_info" : "{\"192.168.0.61\":{\"advertised_ip\":\"192.168.0.61\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.72\":{\"advertised_ip\":\"192.168.0.72\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.100\":{\"advertised_ip\":\"192.168.0.100\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}",
"storage_resource_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
@@ -635,30 +732,24 @@
"service_type" : "advanced",
"storage_type" : "hec",
"enterprise_project_id" : "0",
- "is_logical_volume" : true,
- "extend_times" : 0,
"retention_policy" : "produce_reject",
"ipv6_enable" : false,
"ipv6_connect_addresses" : [ ],
- "connector_enable" : false,
- "connector_id" : "",
"rest_enable" : false,
"rest_connect_address" : "",
"kafka_public_status" : "closed",
- "public_boundwidth" : 0,
- "message_query_inst_enable" : true,
- "vpc_client_plain" : false,
- "support_features" : "kafka.new.pod.port,feature.physerver.kafka.topic.modify,feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,roma_app_enable,features.log.collection,auto_topic_switch,feature.physerver.kafka.user.manager",
+ "public_bandwidth" : 0,
"trace_enable" : false,
"agent_enable" : false,
"pod_connect_address" : "100.86.75.15:9080,100.86.142.77:9080,100.86.250.167:9080",
"disk_encrypted" : false,
"kafka_private_connect_address" : "192.168.0.61:9092,192.168.0.100:9092,192.168.0.72:9092",
- "enable_auto_topic" : false,
+ "new_spec_billing_enable" : false,
"ces_version" : "linux"
} ],
"instance_num" : 1
}
+
Status Codes
Status Code
@@ -669,7 +760,7 @@
200
All instances are listed successfully.
+Instance list queried.
Listing Product Specifications
-Function
This API is used to query the product specifications to configure the product ID (product_id).For example, to create a pay-per-use Kafka instance with 100 MB/s bandwidth, locate the section where the value of bandwidth is 100MB under "Hourly" in the response message. Then, the value of product_id in the same section is the product ID that should be configured for the Kafka instance.unavailable_zones indicates AZs where there are no available resources. If the value is empty, all AZs are available. Otherwise, the AZs listed in the value do not have sufficient resources. Ensure that the AZs where you want to create the instance are not listed here.
-
-URI
GET /v2/products
-
-Table 1 Query Parameters Parameter
-Mandatory
-Type
-Description
-engine
-Yes
-String
-Message engine. Currently, only Kafka is supported.
-
-
-
-Request Parameters
None
-
-Response Parameters
Status code: 200
-
-Table 2 Response body parameters Parameter
-Type
-Description
-Hourly
-Array of Hourly objects
-List of pay-per-use products.
-Monthly
-Array of Monthly objects
-List of products in yearly/monthly billing mode. Currently, you cannot create yearly/monthly Kafka instances by calling APIs.
-
-
-
-Table 3 Hourly Parameter
-Type
-Description
-name
-String
-Message engine, which is kafka.
-version
-String
-Version of the message engine. Currently, only 1.1.0 and 2.3.0 is supported.
-values
-Array of values objects
-Product specifications.
-
-
-
-Table 4 values Parameter
-Type
-Description
-detail
-Array of detail objects
-Specification details.
-name
-String
-Instance type.
-unavailable_zones
-Array of strings
-AZs where resources are sold out.
-available_zones
-Array of strings
-List of AZs where there are available resources.
-
-
-
-Table 5 detail Parameter
-Type
-Description
-tps
-String
-Maximum number of messages per unit time.
-storage_space
-String
-Message storage space.
-partition_num
-String
-Number of partitions in a Kafka instance.
-product_id
-String
-Product ID.
-spec_code
-String
-Specification ID.
-io
-Array of io objects
-I/O information.
-bandwidth
-String
-Bandwidth of a Kafka instance.
-unavailable_zones
-Array of strings
-AZs where resources are sold out.
-available_zones
-Array of strings
-List of AZs where there are available resources.
-ecs_flavor_id
-String
-Flavor of the corresponding ECS.
-arch_type
-String
-Instance architecture type. Currently, only x86 is supported.
-
-
-
-Table 6 io Parameter
-Type
-Description
-io_type
-String
-I/O type.
-storage_spec_code
-String
-I/O specifications.
-available_zones
-Array of strings
-List of AZs where there are available I/O resources.
-unavailable_zones
-Array of strings
-List of AZs where I/O resources are sold out.
-volume_type
-String
-Disk type.
-
-
-
-Table 7 Monthly Parameter
-Type
-Description
-name
-String
-Message engine, which is kafka.
-version
-String
-Version of the message engine. Currently, only 1.1.0 and 2.3.0 is supported.
-values
-Array of values objects
-Product specifications.
-
-
-
-Table 8 values Parameter
-Type
-Description
-detail
-Array of detail objects
-Specification details.
-name
-String
-Instance type.
-unavailable_zones
-Array of strings
-AZs where resources are sold out.
-available_zones
-Array of strings
-List of AZs where there are available resources.
-
-
-
-Table 9 detail Parameter
-Type
-Description
-tps
-String
-Maximum number of messages per unit time.
-storage_space
-String
-Message storage space.
-partition_num
-String
-Number of partitions in a Kafka instance.
-product_id
-String
-Product ID.
-spec_code
-String
-Specification ID.
-io
-Array of io objects
-I/O information.
-bandwidth
-String
-Bandwidth of a Kafka instance.
-unavailable_zones
-Array of strings
-AZs where resources are sold out.
-available_zones
-Array of strings
-List of AZs where there are available resources.
-ecs_flavor_id
-String
-Flavor of the corresponding ECS.
-arch_type
-String
-Instance architecture type. Currently, only x86 is supported.
-
-
-
-Table 10 io Parameter
-Type
-Description
-io_type
-String
-I/O type.
-storage_spec_code
-String
-I/O specifications.
-available_zones
-Array of strings
-List of AZs where there are available I/O resources.
-unavailable_zones
-Array of strings
-List of AZs where I/O resources are sold out.
-volume_type
-String
-Disk type.
-
-
-
-Example Requests
GET https://{endpoint}/v2/products?engine=kafka
-
-Example Responses
Status code: 200
-The product specifications are listed successfully.
-{
- "Hourly" : [ {
- "name" : "kafka",
- "version" : "1.1.0",
- "values" : [ {
- "detail" : [ {
- "tps" : "50000",
- "storage_space" : "200",
- "partition_num" : "300",
- "product_id" : "00300-30308-0--0",
- "spec_code" : "dms.instance.kafka.cluster.c3.mini",
- "io" : [ {
- "io_type" : "normal",
- "storage_spec_code" : "dms.physical.storage.normal",
- "available_zones" : [ "xxx", "xxx" ],
- "volume_type" : "SATA"
- }, {
- "io_type" : "high",
- "storage_spec_code" : "dms.physical.storage.high",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SAS"
- }, {
- "io_type" : "ultra",
- "storage_spec_code" : "dms.physical.storage.ultra",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SSD"
- } ],
- "bandwidth" : "100MB",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ "xxx" ],
- "ecs_flavor_id" : "s6.large.2",
- "arch_type" : "X86"
- }, {
- "tps" : "100000",
- "storage_space" : "1200",
- "partition_num" : "900",
- "product_id" : "00300-30310-0--0",
- "spec_code" : "dms.instance.kafka.cluster.c3.small.2",
- "io" : [ {
- "io_type" : "normal",
- "storage_spec_code" : "dms.physical.storage.normal",
- "available_zones" : [ "xxx", "xxx" ],
- "volume_type" : "SATA"
- }, {
- "io_type" : "high",
- "storage_spec_code" : "dms.physical.storage.high",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SAS"
- }, {
- "io_type" : "ultra",
- "storage_spec_code" : "dms.physical.storage.ultra",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SSD"
- } ],
- "bandwidth" : "300MB",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ "xxx" ],
- "ecs_flavor_id" : "c3.medium.2",
- "arch_type" : "X86"
- } ],
- "name" : "cluster",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ "xxx" ]
- } ]
- } ],
- "Monthly" : [ {
- "name" : "kafka",
- "version" : "1.1.0",
- "values" : [ {
- "detail" : [ {
- "tps" : "50000",
- "storage_space" : "200",
- "partition_num" : "300",
- "product_id" : "00300-30309-0--0",
- "spec_code" : "dms.instance.kafka.cluster.c3.mini",
- "io" : [ {
- "io_type" : "normal",
- "storage_spec_code" : "dms.physical.storage.normal",
- "available_zones" : [ "xxx", "xxx" ],
- "volume_type" : "SATA"
- }, {
- "io_type" : "high",
- "storage_spec_code" : "dms.physical.storage.high",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SAS"
- }, {
- "io_type" : "ultra",
- "storage_spec_code" : "dms.physical.storage.ultra",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SSD"
- } ],
- "bandwidth" : "100MB",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ "xxx" ],
- "ecs_flavor_id" : "s6.large.2",
- "arch_type" : "X86"
- }, {
- "tps" : "100000",
- "storage_space" : "1200",
- "partition_num" : "900",
- "product_id" : "00300-30311-0--0",
- "spec_code" : "dms.instance.kafka.cluster.c3.small.2",
- "io" : [ {
- "io_type" : "normal",
- "storage_spec_code" : "dms.physical.storage.normal",
- "available_zones" : [ "xxx", "xxx" ],
- "volume_type" : "SATA"
- }, {
- "io_type" : "high",
- "storage_spec_code" : "dms.physical.storage.high",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SAS"
- }, {
- "io_type" : "ultra",
- "storage_spec_code" : "dms.physical.storage.ultra",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ ],
- "volume_type" : "SSD"
- } ],
- "bandwidth" : "300MB",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ "xxx" ],
- "ecs_flavor_id" : "c3.medium.2",
- "arch_type" : "X86"
- } ],
- "name" : "cluster",
- "unavailable_zones" : [ "xxx", "xxx" ],
- "available_zones" : [ "xxx" ]
- } ]
- } ]
-}
-
-Status Codes
-Status Code
-Description
-200
-The product specifications are listed successfully.
-
-
-
-Error Codes
See Error Codes.
-
-
-
-
-Parent topic: Other APIs
-
-
-
diff --git a/docs/dms/api-ref/ListTopicPartitions.html b/docs/dms/api-ref/ListTopicPartitions.html
new file mode 100644
index 00000000..79073cd7
--- /dev/null
+++ b/docs/dms/api-ref/ListTopicPartitions.html
@@ -0,0 +1,233 @@
+
+
+Querying 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
+
+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.
+Minimum: 1
+Maximum: 64
+instance_id
+Yes
+String
+Instance ID.
+Minimum: 1
+Maximum: 64
+topic
+Yes
+String
+Topic.
+Minimum: 1
+Maximum: 200
+
+
+
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+offset
+No
+Integer
+Offset. The records after this offset will be queried.
+Minimum: 0
+Maximum: 10000
+limit
+No
+Integer
+Maximum number of records that can be returned.
+Minimum: 1
+Maximum: 50
+
+
+
+Request Parameters
None
+
+Response Parameters
Status code: 200
+
+Table 3 Response body parameters Parameter
+Type
+Description
+total
+Integer
+Total records.
+Minimum: 0
+Maximum: 100
+partitions
+Array of partitions objects
+Partition array.
+Array Length: 0 - 50
+
+
+
+Table 4 partitions Parameter
+Type
+Description
+partition
+Integer
+Partition ID.
+Minimum: 0
+Maximum: 100
+start_offset
+Long
+Start offset.
+Minimum: 0
+Maximum: 9223372036854775807
+last_offset
+Long
+Last offset.
+Minimum: 0
+Maximum: 9223372036854775807
+message_count
+Long
+Number of messages in a partition.
+Minimum: 0
+Maximum: 9223372036854775807
+last_update_time
+Long
+Last update time.
+Minimum: 0
+Maximum: 9223372036854775807
+
+
+
+Example Requests
Querying the partition list of a topic
+GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/partitions?start=1&limit=10
+
+Example Responses
Status code: 200
+The partition list of the topic is queried successfully.
+{
+ "total" : 3,
+ "partitions" : [ {
+ "partition" : 0,
+ "start_offset" : 0,
+ "last_offset" : 1216303,
+ "message_count" : 1216303,
+ "last_update_time" : 1688011291458
+ }, {
+ "partition" : 1,
+ "start_offset" : 0,
+ "last_offset" : 985447,
+ "message_count" : 985447,
+ "last_update_time" : 1688011291469
+ }, {
+ "partition" : 2,
+ "start_offset" : 0,
+ "last_offset" : 923340,
+ "message_count" : 923340,
+ "last_update_time" : 1688011291526
+ } ]
+}
+
+Status Codes
+Status Code
+Description
+200
+The partition list of the topic is queried successfully.
+
+
+
+Error Codes
See Error Codes.
+
+
+
+
+Parent topic: Topic Management
+
+
+
diff --git a/docs/dms/api-ref/ListTopicProducers.html b/docs/dms/api-ref/ListTopicProducers.html
new file mode 100644
index 00000000..fdca954b
--- /dev/null
+++ b/docs/dms/api-ref/ListTopicProducers.html
@@ -0,0 +1,209 @@
+
+
+Querying 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
+
+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.
+Minimum: 1
+Maximum: 64
+instance_id
+Yes
+String
+Instance ID.
+Minimum: 1
+Maximum: 64
+topic
+Yes
+String
+Topic.
+Minimum: 1
+Maximum: 200
+
+
+
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+offset
+No
+Integer
+Offset. The records after this offset will be queried.
+Minimum: 0
+Maximum: 10000
+limit
+No
+Integer
+Maximum number of records that can be returned.
+Minimum: 1
+Maximum: 50
+
+
+
+Request Parameters
None
+
+Response Parameters
Status code: 200
+
+Table 3 Response body parameters Parameter
+Type
+Description
+total
+Integer
+Total records.
+Minimum: 0
+Maximum: 10000
+producers
+Array of producers objects
+Producer list.
+Array Length: 0 - 50
+
+
+
+Table 4 producers Parameter
+Type
+Description
+producer_address
+String
+Producer address.
+Minimum: 0
+Maximum: 64
+broker_address
+String
+Broker address.
+Minimum: 0
+Maximum: 64
+join_time
+Long
+Time when the broker was connected.
+Minimum: 0
+Maximum: 9223372036854775807
+
+
+
+Example Requests
Querying the current producer list of a topic
+GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers?offset=0&limit=10
+
+Example Responses
Status code: 200
+The current producer list of the topic is queried successfully.
+{
+ "total" : 3,
+ "producers" : [ {
+ "producer_address" : "192.0.0.149:40443",
+ "broker_address" : "192.0.0.146:9092",
+ "join_time" : 1687204743328
+ }, {
+ "producer_address" : "192.0.0.149:13807",
+ "broker_address" : "192.0.0.80:9092",
+ "join_time" : 1687204745939
+ }, {
+ "producer_address" : "192.0.0.149:31876",
+ "broker_address" : "192.0.0.71:9092",
+ "join_time" : 1687204744934
+ } ]
+}
+
+Status Codes
+Status Code
+Description
+200
+The current producer list of the topic is queried successfully.
+
+
+
+Error Codes
See Error Codes.
+
+
+
+
+Parent topic: Topic Management
+
+
+
diff --git a/docs/dms/api-ref/ResizeInstance.html b/docs/dms/api-ref/ModifyInstanceConfigs.html
similarity index 55%
rename from docs/dms/api-ref/ResizeInstance.html
rename to docs/dms/api-ref/ModifyInstanceConfigs.html
index 49dcc5a3..f9ae04cc 100644
--- a/docs/dms/api-ref/ResizeInstance.html
+++ b/docs/dms/api-ref/ModifyInstanceConfigs.html
@@ -1,9 +1,9 @@
-
+
-Modifying Instance Specifications
-Function
This API is used to modify instance specifications.
+Modifying Instance Configurations
+Function
This API is used to modify instance configurations.
-URI
POST /v2/{project_id}/instances/{instance_id}/extend
+URI
PUT /v2/{project_id}/instances/{instance_id}/configs
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -38,7 +38,7 @@
Request Parameters
-Table 2 Request body parameters Parameter
+Table 2 Request body parameters Parameter
Mandatory
new_spec_code
+kafka_configs
No
String
+Array of ModifyInstanceConfig objects
Specification ID after the change. If only the disk size is expanded, the specification ID remains unchanged.
+Configurations to be modified.
new_storage_space
+
+
+
+Table 3 ModifyInstanceConfig Parameter
+Mandatory
+Type
+Description
+name
No
+No
Integer
+String
Message storage space in GB after the change. If the bandwidth is expanded, new_storage_space cannot be smaller than the minimum disk size specified by the bandwidth.
+Names of configurations to be modified.
oper_type
+value
No
+No
String
+String
Specification modification type. The new specifications support the following types: horizontal, vertical, node, and storage.
-new_broker_num
-No
-Integer
-Number of cluster nodes after the specifications are changed.
-new_product_id
-No
-String
-Product ID after the specifications are changed. This parameter must be specified for vertical expansion (scale-up).
+New value of the modified configuration.
Response Parameters
Status code: 200
-Table 3 Response body parameters Parameter
+Table 4 Response body parameters Parameter
Type
String
ID of the specification modification task.
+Configuration modification task ID.
+dynamic_config
+Integer
+Number of dynamic configuration parameters to be modified.
+static_config
+Integer
+Number of static configuration parameters to be modified.
-Example Requests
Pay-per-use instance (old specifications)
-POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/extend
+Example Requests
Modifying the threshold for idle connection timeout and the log deletion interval.
+PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/configs
{
- "new_spec_code" : "dms.instance.kafka.cluster.c3.mini",
- "new_storage_space" : 1000
+ "kafka_configs" : [ {
+ "name" : "connections.max.idle.ms",
+ "value" : "500000"
+ }, {
+ "name" : "log.retention.hours",
+ "value" : "66"
+ } ]
}
Example Responses
Status code: 200
-Instance specifications are modified successfully.
+Configuration modified.
{
- "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"
+ "job_id" : "8abfa7b38ba79a20018ba9afc550576a",
+ "dynamic_config" : 0,
+ "static_config" : 2
}
Status Codes
-Status Code
+Status Code
Description
200
Instance specifications are modified successfully.
+Configuration modified.
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
+URI
POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -59,7 +59,7 @@
topic
Yes
+No
String
partition
No
+Yes
Integer
No
Integer
+Long
Resetting consumer group offset to the specified position.
If this position is earlier than the current earliest offset, the offset will be reset to the earliest offset.
@@ -92,7 +92,7 @@
No
Integer
+Long
Specified time that the offset is to be reset to. The value is a Unix timestamp, in millisecond.
If this time is earlier than the current earliest timestamp, the offset will be reset to the earliest timestamp.
diff --git a/docs/dms/api-ref/ResetPassword.html b/docs/dms/api-ref/ResetPassword.html
index 4495cd12..81cbbad1 100644
--- a/docs/dms/api-ref/ResetPassword.html
+++ b/docs/dms/api-ref/ResetPassword.html
@@ -1,9 +1,9 @@
Resetting the Password
-Function
This API is used to reset the password.
+Function
This API is used to reset the password for an instance with SSL enabled.
-URI
POST /v2/{project_id}/instances/{instance_id}/password
+URI
POST /v2/{project_id}/instances/{instance_id}/password
Table 1 Path Parameters Parameter
String
Project ID.
+Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id
@@ -50,7 +50,7 @@
new_password
No
+Yes
String
Response Parameters
None
-Example Requests
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/password
+Example Requests
Resetting a password
+POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/password
{
"new_password" : "********"
diff --git a/docs/dms/api-ref/ResetUserPasswrod.html b/docs/dms/api-ref/ResetUserPasswrod.html
index 62e0b6e5..7601af85 100644
--- a/docs/dms/api-ref/ResetUserPasswrod.html
+++ b/docs/dms/api-ref/ResetUserPasswrod.html
@@ -3,7 +3,7 @@
Resetting a User Password
Function
This API is used to reset a user password.
-URI
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}
+URI
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}