diff --git a/docs/dms/api-ref/ALL_META.TXT.json b/docs/dms/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..c8a2ef8e --- /dev/null +++ b/docs/dms/api-ref/ALL_META.TXT.json @@ -0,0 +1,812 @@ +[ + { + "uri":"en-us_topic_0036182510.html", + "product_code":"dms", + "code":"1", + "des":"Public cloud application programming interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ", + "doc_type":"api", + "kw":"Using APIs,API Reference", + "title":"Using APIs", + "githuburl":"" + }, + { + "uri":"kafka-api-200707001.html", + "product_code":"dms", + "code":"2", + "des":"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.", + "doc_type":"api", + "kw":"APIs V2 (Recommended)", + "title":"APIs V2 (Recommended)", + "githuburl":"" + }, + { + "uri":"topic_300000000.html", + "product_code":"dms", + "code":"3", + "des":"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.", + "doc_type":"api", + "kw":"Lifecycle Management", + "title":"Lifecycle Management", + "githuburl":"" + }, + { + "uri":"CreatePostPaidInstance.html", + "product_code":"dms", + "code":"4", + "des":"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", + "doc_type":"api", + "kw":"Creating an Instance,Lifecycle Management,API Reference", + "title":"Creating an Instance", + "githuburl":"" + }, + { + "uri":"ListInstances.html", + "product_code":"dms", + "code":"5", + "des":"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", + "doc_type":"api", + "kw":"Listing All Instances,Lifecycle Management,API Reference", + "title":"Listing All Instances", + "githuburl":"" + }, + { + "uri":"ShowInstance.html", + "product_code":"dms", + "code":"6", + "des":"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", + "doc_type":"api", + "kw":"Querying an Instance,Lifecycle Management,API Reference", + "title":"Querying an Instance", + "githuburl":"" + }, + { + "uri":"DeleteInstance.html", + "product_code":"dms", + "code":"7", + "des":"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.", + "doc_type":"api", + "kw":"Deleting an Instance,Lifecycle Management,API Reference", + "title":"Deleting an Instance", + "githuburl":"" + }, + { + "uri":"UpdateInstance.html", + "product_code":"dms", + "code":"8", + "des":"This API is used to modify the instance information.PUT /v2/{project_id}/instances/{instance_id}NoneModifying the name and description of an instance.PUT https://{endpoin", + "doc_type":"api", + "kw":"Modifying Instance Information,Lifecycle Management,API Reference", + "title":"Modifying Instance Information", + "githuburl":"" + }, + { + "uri":"BatchRestartOrDeleteInstances.html", + "product_code":"dms", + "code":"9", + "des":"This API is used to restart or delete instances in batches.When an instance is being restarted, message retrieval and creation requests of the client will be rejected.Del", + "doc_type":"api", + "kw":"Batch Restarting or Deleting Instances,Lifecycle Management,API Reference", + "title":"Batch Restarting or Deleting Instances", + "githuburl":"" + }, + { + "uri":"topic_300000001.html", + "product_code":"dms", + "code":"10", + "des":"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.", + "doc_type":"api", + "kw":"Instance Management", + "title":"Instance Management", + "githuburl":"" + }, + { + "uri":"ResetPassword.html", + "product_code":"dms", + "code":"11", + "des":"This API is used to reset the password.POST /v2/{project_id}/instances/{instance_id}/passwordNoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Resetting the Password,Instance Management,API Reference", + "title":"Resetting the Password", + "githuburl":"" + }, + { + "uri":"UpdateInstanceAutoCreateTopic.html", + "product_code":"dms", + "code":"12", + "des":"This API is used to enable or disable automatic topic creation.POST /v2/{project_id}/instances/{instance_id}/autotopicNoneEnabling automatic topic creation.NoneSee Error ", + "doc_type":"api", + "kw":"Configuring Automatic Topic Creation,Instance Management,API Reference", + "title":"Configuring Automatic Topic Creation", + "githuburl":"" + }, + { + "uri":"UpdateInstanceCrossVpcIp.html", + "product_code":"dms", + "code":"13", + "des":"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 ", + "doc_type":"api", + "kw":"Modifying the Private IP Address for Cross-VPC Access,Instance Management,API Reference", + "title":"Modifying the Private IP Address for Cross-VPC Access", + "githuburl":"" + }, + { + "uri":"ShowCluster.html", + "product_code":"dms", + "code":"14", + "des":"This API is used to query Kafka cluster metadata.GET /v2/{project_id}/instances/{instance_id}/management/clusterNoneStatus code: 200Status code: 200Kafka cluster metadata", + "doc_type":"api", + "kw":"Querying Kafka Cluster Metadata,Instance Management,API Reference", + "title":"Querying Kafka Cluster Metadata", + "githuburl":"" + }, + { + "uri":"ShowGroups.html", + "product_code":"dms", + "code":"15", + "des":"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", + "doc_type":"api", + "kw":"Querying Consumer Group Details,Instance Management,API Reference", + "title":"Querying Consumer Group Details", + "githuburl":"" + }, + { + "uri":"ResetMessageOffset.html", + "product_code":"dms", + "code":"16", + "des":"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", + "doc_type":"api", + "kw":"Resetting Consumer Group Offset to the Specified Position,Instance Management,API Reference", + "title":"Resetting Consumer Group Offset to the Specified Position", + "githuburl":"" + }, + { + "uri":"ShowCoordinators.html", + "product_code":"dms", + "code":"17", + "des":"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", + "doc_type":"api", + "kw":"Querying Coordinator Details of a Kafka Instance,Instance Management,API Reference", + "title":"Querying Coordinator Details of a Kafka Instance", + "githuburl":"" + }, + { + "uri":"CreatePartition.html", + "product_code":"dms", + "code":"18", + "des":"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", + "doc_type":"api", + "kw":"Adding Partitions to a Topic for a Kafka Instance,Instance Management,API Reference", + "title":"Adding Partitions to a Topic for a Kafka Instance", + "githuburl":"" + }, + { + "uri":"UpdateTopicReplica.html", + "product_code":"dms", + "code":"19", + "des":"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", + "doc_type":"api", + "kw":"Reassigning Replicas of a Topic for a Kafka Instance,Instance Management,API Reference", + "title":"Reassigning Replicas of a Topic for a Kafka Instance", + "githuburl":"" + }, + { + "uri":"ShowKafkaTopicPartitionDiskusage.html", + "product_code":"dms", + "code":"20", + "des":"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", + "doc_type":"api", + "kw":"Querying the Disk Usage Status of Topics,Instance Management,API Reference", + "title":"Querying the Disk Usage Status of Topics", + "githuburl":"" + }, + { + "uri":"ListInstanceConsumerGroups.html", + "product_code":"dms", + "code":"21", + "des":"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", + "doc_type":"api", + "kw":"Querying All Consumer Groups,Instance Management,API Reference", + "title":"Querying All Consumer Groups", + "githuburl":"" + }, + { + "uri":"ShowGroup.html", + "product_code":"dms", + "code":"22", + "des":"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", + "doc_type":"api", + "kw":"Querying a Specific Consumer Group,Instance Management,API Reference", + "title":"Querying a Specific Consumer Group", + "githuburl":"" + }, + { + "uri":"DeleteGroup.html", + "product_code":"dms", + "code":"23", + "des":"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.", + "doc_type":"api", + "kw":"Deleting a Consumer Group from a Kafka Instance,Instance Management,API Reference", + "title":"Deleting a Consumer Group from a Kafka Instance", + "githuburl":"" + }, + { + "uri":"BatchDeleteGroup.html", + "product_code":"dms", + "code":"24", + "des":"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", + "doc_type":"api", + "kw":"Batch Deleting Consumer Groups of a Kafka Instance,Instance Management,API Reference", + "title":"Batch Deleting Consumer Groups of a Kafka Instance", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "product_code":"dms", + "code":"25", + "des":"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.", + "doc_type":"api", + "kw":"Specification Modification Management", + "title":"Specification Modification Management", + "githuburl":"" + }, + { + "uri":"ResizeInstance.html", + "product_code":"dms", + "code":"26", + "des":"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", + "doc_type":"api", + "kw":"Modifying Instance Specifications,Specification Modification Management,API Reference", + "title":"Modifying Instance Specifications", + "githuburl":"" + }, + { + "uri":"ShowInstanceExtendProductInfo.html", + "product_code":"dms", + "code":"27", + "des":"This API is used to query the product information for instance specification modification.GET /v2/{project_id}/instances/{instance_id}/extendNoneStatus code: 200Status co", + "doc_type":"api", + "kw":"Querying Product Information for Instance Specification Modification,Specification Modification Mana", + "title":"Querying Product Information for Instance Specification Modification", + "githuburl":"" + }, + { + "uri":"topic_300000004.html", + "product_code":"dms", + "code":"28", + "des":"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.", + "doc_type":"api", + "kw":"Topic Management", + "title":"Topic Management", + "githuburl":"" + }, + { + "uri":"CreateInstanceTopic.html", + "product_code":"dms", + "code":"29", + "des":"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", + "doc_type":"api", + "kw":"Creating a Topic for a Kafka Instance,Topic Management,API Reference", + "title":"Creating a Topic for a Kafka Instance", + "githuburl":"" + }, + { + "uri":"ListInstanceTopics.html", + "product_code":"dms", + "code":"30", + "des":"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", + "doc_type":"api", + "kw":"Listing Topics of a Kafka Instance,Topic Management,API Reference", + "title":"Listing Topics of a Kafka Instance", + "githuburl":"" + }, + { + "uri":"UpdateInstanceTopic.html", + "product_code":"dms", + "code":"31", + "des":"This API is used to modify topics of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/topicsNoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Modifying Topics of a Kafka Instance,Topic Management,API Reference", + "title":"Modifying Topics of a Kafka Instance", + "githuburl":"" + }, + { + "uri":"BatchDeleteInstanceTopic.html", + "product_code":"dms", + "code":"32", + "des":"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", + "doc_type":"api", + "kw":"Batch Deleting Topics of a Kafka Instance,Topic Management,API Reference", + "title":"Batch Deleting Topics of a Kafka Instance", + "githuburl":"" + }, + { + "uri":"BatchCleanupInstanceTopic.html", + "product_code":"dms", + "code":"33", + "des":"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:", + "doc_type":"api", + "kw":"Batch Cleaning Up Topics of a Kafka Instance,Topic Management,API Reference", + "title":"Batch Cleaning Up Topics of a Kafka Instance", + "githuburl":"" + }, + { + "uri":"ShowInstanceTopicDetail.html", + "product_code":"dms", + "code":"34", + "des":"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 ", + "doc_type":"api", + "kw":"Querying Topic Details,Topic Management,API Reference", + "title":"Querying Topic Details", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "product_code":"dms", + "code":"35", + "des":"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.", + "doc_type":"api", + "kw":"User Management", + "title":"User Management", + "githuburl":"" + }, + { + "uri":"ShowInstanceUsers.html", + "product_code":"dms", + "code":"36", + "des":"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", + "doc_type":"api", + "kw":"Querying the User List,User Management,API Reference", + "title":"Querying the User List", + "githuburl":"" + }, + { + "uri":"CreateInstanceUser.html", + "product_code":"dms", + "code":"37", + "des":"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", + "doc_type":"api", + "kw":"Creating a User,User Management,API Reference", + "title":"Creating a User", + "githuburl":"" + }, + { + "uri":"BatchDeleteInstanceUsers.html", + "product_code":"dms", + "code":"38", + "des":"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.", + "doc_type":"api", + "kw":"Deleting Users in Batches,User Management,API Reference", + "title":"Deleting Users in Batches", + "githuburl":"" + }, + { + "uri":"ResetUserPasswrod.html", + "product_code":"dms", + "code":"39", + "des":"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.", + "doc_type":"api", + "kw":"Resetting a User Password,User Management,API Reference", + "title":"Resetting a User Password", + "githuburl":"" + }, + { + "uri":"ShowTopicAccessPolicy.html", + "product_code":"dms", + "code":"40", + "des":"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", + "doc_type":"api", + "kw":"Querying User Permissions,User Management,API Reference", + "title":"Querying User Permissions", + "githuburl":"" + }, + { + "uri":"UpdateTopicAccessPolicy.html", + "product_code":"dms", + "code":"41", + "des":"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", + "doc_type":"api", + "kw":"Granting User Permissions,User Management,API Reference", + "title":"Granting User Permissions", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "product_code":"dms", + "code":"42", + "des":"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.", + "doc_type":"api", + "kw":"Message Query", + "title":"Message Query", + "githuburl":"" + }, + { + "uri":"ShowInstanceMessages.html", + "product_code":"dms", + "code":"43", + "des":"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", + "doc_type":"api", + "kw":"Querying Messages,Message Query,API Reference", + "title":"Querying Messages", + "githuburl":"" + }, + { + "uri":"ShowPartitionMessage.html", + "product_code":"dms", + "code":"44", + "des":"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", + "doc_type":"api", + "kw":"Querying a Message with a Specified Offset,Message Query,API Reference", + "title":"Querying a Message with a Specified Offset", + "githuburl":"" + }, + { + "uri":"ShowMessages.html", + "product_code":"dms", + "code":"45", + "des":"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", + "doc_type":"api", + "kw":"Querying a Message with a Specified Time Period,Message Query,API Reference", + "title":"Querying a Message with a Specified Time Period", + "githuburl":"" + }, + { + "uri":"ShowPartitionBeginningMessage.html", + "product_code":"dms", + "code":"46", + "des":"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}/", + "doc_type":"api", + "kw":"Querying Offset of the Earliest Message in a Partition,Message Query,API Reference", + "title":"Querying Offset of the Earliest Message in a Partition", + "githuburl":"" + }, + { + "uri":"ShowPartitionEndMessage.html", + "product_code":"dms", + "code":"47", + "des":"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", + "doc_type":"api", + "kw":"Querying Offset of the Latest Message in a Partition,Message Query,API Reference", + "title":"Querying Offset of the Latest Message in a Partition", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "product_code":"dms", + "code":"48", + "des":"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.", + "doc_type":"api", + "kw":"Background Task Management", + "title":"Background Task Management", + "githuburl":"" + }, + { + "uri":"ListBackgroundTasks.html", + "product_code":"dms", + "code":"49", + "des":"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", + "doc_type":"api", + "kw":"Listing Background Tasks,Background Task Management,API Reference", + "title":"Listing Background Tasks", + "githuburl":"" + }, + { + "uri":"ShowBackgroundTask.html", + "product_code":"dms", + "code":"50", + "des":"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", + "doc_type":"api", + "kw":"Querying a Background Task,Background Task Management,API Reference", + "title":"Querying a Background Task", + "githuburl":"" + }, + { + "uri":"DeleteBackgroundTask.html", + "product_code":"dms", + "code":"51", + "des":"This API is used to delete a specified background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneNoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Deleting a Background Task,Background Task Management,API Reference", + "title":"Deleting a Background Task", + "githuburl":"" + }, + { + "uri":"topic_300000008.html", + "product_code":"dms", + "code":"52", + "des":"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.", + "doc_type":"api", + "kw":"Tag Management", + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"BatchCreateOrDeleteKafkaTag.html", + "product_code":"dms", + "code":"53", + "des":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/kafka/{instance_id}/tags/actionNoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Batch Adding or Deleting Tags,Tag Management,API Reference", + "title":"Batch Adding or Deleting Tags", + "githuburl":"" + }, + { + "uri":"ShowKafkaTags.html", + "product_code":"dms", + "code":"54", + "des":"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", + "doc_type":"api", + "kw":"Listing Tags of an Instance,Tag Management,API Reference", + "title":"Listing Tags of an Instance", + "githuburl":"" + }, + { + "uri":"ShowKafkaProjectTags.html", + "product_code":"dms", + "code":"55", + "des":"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.", + "doc_type":"api", + "kw":"Listing Tags of a Project,Tag Management,API Reference", + "title":"Listing Tags of a Project", + "githuburl":"" + }, + { + "uri":"topic_300000009.html", + "product_code":"dms", + "code":"56", + "des":"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.", + "doc_type":"api", + "kw":"Other APIs", + "title":"Other APIs", + "githuburl":"" + }, + { + "uri":"ShowMaintainWindows.html", + "product_code":"dms", + "code":"57", + "des":"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", + "doc_type":"api", + "kw":"Listing Maintenance Time Windows,Other APIs,API Reference", + "title":"Listing Maintenance Time Windows", + "githuburl":"" + }, + { + "uri":"ListAvailableZones.html", + "product_code":"dms", + "code":"58", + "des":"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", + "doc_type":"api", + "kw":"Listing AZ Information,Other APIs,API Reference", + "title":"Listing AZ Information", + "githuburl":"" + }, + { + "uri":"ListProducts_0.html", + "product_code":"dms", + "code":"59", + "des":"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,", + "doc_type":"api", + "kw":"Listing Product Specifications,Other APIs,API Reference", + "title":"Listing Product Specifications", + "githuburl":"" + }, + { + "uri":"ShowCesHierarchy.html", + "product_code":"dms", + "code":"60", + "des":"This API is used to query Kafka instance monitoring dimensions.GET /v2/{project_id}/instances/{instance_id}/ces-hierarchyNoneStatus code: 200Status code: 200The informati", + "doc_type":"api", + "kw":"Querying Kafka Instance Monitoring Dimensions,Other APIs,API Reference", + "title":"Querying Kafka Instance Monitoring Dimensions", + "githuburl":"" + }, + { + "uri":"kafka-api-0001.html", + "product_code":"dms", + "code":"61", + "des":"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.", + "doc_type":"api", + "kw":"Out-of-Date APIs", + "title":"Out-of-Date APIs", + "githuburl":"" + }, + { + "uri":"kafka-api-0002.html", + "product_code":"dms", + "code":"62", + "des":"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.", + "doc_type":"api", + "kw":"API V1", + "title":"API V1", + "githuburl":"" + }, + { + "uri":"kafka-api-180514001.html", + "product_code":"dms", + "code":"63", + "des":"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.", + "doc_type":"api", + "kw":"APIs for Managing Instances", + "title":"APIs for Managing Instances", + "githuburl":"" + }, + { + "uri":"kafka-api-180514002.html", + "product_code":"dms", + "code":"64", + "des":"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", + "doc_type":"api", + "kw":"Creating an Instance,APIs for Managing Instances,API Reference", + "title":"Creating an Instance", + "githuburl":"" + }, + { + "uri":"kafka-api-180514003.html", + "product_code":"dms", + "code":"65", + "des":"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", + "doc_type":"api", + "kw":"Querying an Instance,APIs for Managing Instances,API Reference", + "title":"Querying an Instance", + "githuburl":"" + }, + { + "uri":"kafka-api-180514004.html", + "product_code":"dms", + "code":"66", + "des":"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", + "doc_type":"api", + "kw":"Modifying an Instance,APIs for Managing Instances,API Reference", + "title":"Modifying an Instance", + "githuburl":"" + }, + { + "uri":"kafka-api-180514005.html", + "product_code":"dms", + "code":"67", + "des":"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", + "doc_type":"api", + "kw":"Deleting an Instance,APIs for Managing Instances,API Reference", + "title":"Deleting an Instance", + "githuburl":"" + }, + { + "uri":"kafka-api-180514006.html", + "product_code":"dms", + "code":"68", + "des":"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", + "doc_type":"api", + "kw":"Restarting or Deleting Instances in Batches,APIs for Managing Instances,API Reference", + "title":"Restarting or Deleting Instances in Batches", + "githuburl":"" + }, + { + "uri":"kafka-api-180514007.html", + "product_code":"dms", + "code":"69", + "des":"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", + "doc_type":"api", + "kw":"Querying All Instances,APIs for Managing Instances,API Reference", + "title":"Querying All Instances", + "githuburl":"" + }, + { + "uri":"kafka-api-180614001.html", + "product_code":"dms", + "code":"70", + "des":"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 ", + "doc_type":"api", + "kw":"Creating a Topic in a Kafka Instance,APIs for Managing Instances,API Reference", + "title":"Creating a Topic in a Kafka Instance", + "githuburl":"" + }, + { + "uri":"kafka-api-180614002.html", + "product_code":"dms", + "code":"71", + "des":"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", + "doc_type":"api", + "kw":"Querying a Topic in a Kafka Instance,APIs for Managing Instances,API Reference", + "title":"Querying a Topic in a Kafka Instance", + "githuburl":"" + }, + { + "uri":"kafka-api-180614003.html", + "product_code":"dms", + "code":"72", + "des":"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", + "doc_type":"api", + "kw":"Deleting Topics in a Kafka Instance in Batches,APIs for Managing Instances,API Reference", + "title":"Deleting Topics in a Kafka Instance in Batches", + "githuburl":"" + }, + { + "uri":"kafka-api-190605002.html", + "product_code":"dms", + "code":"73", + "des":"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.", + "doc_type":"api", + "kw":"Other APIs", + "title":"Other APIs", + "githuburl":"" + }, + { + "uri":"kafka-api-180514008.html", + "product_code":"dms", + "code":"74", + "des":"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", + "doc_type":"api", + "kw":"Querying AZ Information,Other APIs,API Reference", + "title":"Querying AZ Information", + "githuburl":"" + }, + { + "uri":"kafka-api-180514009.html", + "product_code":"dms", + "code":"75", + "des":"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", + "doc_type":"api", + "kw":"Querying Product Specifications,Other APIs,API Reference", + "title":"Querying Product Specifications", + "githuburl":"" + }, + { + "uri":"kafka-api-180514010.html", + "product_code":"dms", + "code":"76", + "des":"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 ", + "doc_type":"api", + "kw":"Querying Maintenance Time Windows,Other APIs,API Reference", + "title":"Querying Maintenance Time Windows", + "githuburl":"" + }, + { + "uri":"kafka-api-180514011.html", + "product_code":"dms", + "code":"77", + "des":"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.", + "doc_type":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"kafka-api-0034672261.html", + "product_code":"dms", + "code":"78", + "des":"Table 1 lists status codes.", + "doc_type":"api", + "kw":"Status Code,Appendix,API Reference", + "title":"Status Code", + "githuburl":"" + }, + { + "uri":"ErrorCode.html", + "product_code":"dms", + "code":"79", + "des":"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.", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"kafka-api-180514012.html", + "product_code":"dms", + "code":"80", + "des":"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.", + "doc_type":"api", + "kw":"Instance Status,Appendix,API Reference", + "title":"Instance Status", + "githuburl":"" + }, + { + "uri":"kafka-api-0034672268.html", + "product_code":"dms", + "code":"81", + "des":"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.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/dms/api-ref/BatchCleanupInstanceTopic.html b/docs/dms/api-ref/BatchCleanupInstanceTopic.html new file mode 100644 index 00000000..a967fd48 --- /dev/null +++ b/docs/dms/api-ref/BatchCleanupInstanceTopic.html @@ -0,0 +1,153 @@ + + +

Batch Cleaning Up Topics of a Kafka Instance

+

Function

This API is used to clean up multiple topics of a Kafka instance in batches.

+
+

URI

POST /v2/kafka/{project_id}/instances/{instance_id}/topics/cleanup

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topics

+

No

+

Array of strings

+

List of topics to be cleared up.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

topics

+

Array of topics objects

+

Topic list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 topics

Parameter

+

Type

+

Description

+

id

+

String

+

Topic name.

+

success

+

Boolean

+

Whether the cleanup was successful.

+
+
+
+

Example Requests

POST https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/topics/cleanup
+
+{
+  "topics" : [ "topic_1", "topic_2" ]
+}
+
+

Example Responses

Status code: 200

+

The cleanup is successful.

+
{
+  "topics" : [ {
+    "id" : "topic_1",
+    "success" : true
+  }, {
+    "id" : "topic_2",
+    "success" : true
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The cleanup is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Topic Management
+
+
+ diff --git a/docs/dms/api-ref/BatchCreateOrDeleteKafkaTag.html b/docs/dms/api-ref/BatchCreateOrDeleteKafkaTag.html new file mode 100644 index 00000000..f113e95d --- /dev/null +++ b/docs/dms/api-ref/BatchCreateOrDeleteKafkaTag.html @@ -0,0 +1,153 @@ + + +

Batch Adding or Deleting Tags

+

Function

This API is used to add or delete instance tags in batches.

+
+

URI

POST /v2/{project_id}/kafka/{instance_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

No

+

String

+

Operation. Only lowercase letters are supported.

+

  • create: Tags are created.

    +

  • delete: Tags are deleted.

    +
+

tags

+

No

+

Array of TagEntity objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 TagEntity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

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: =*<>,|/

+

value

+

No

+

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: =*<>,|/

+
+
+
+

Response Parameters

None

+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/kafka/{instance_id}/tags/action
+
+{
+  "action" : "create",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tags are successfully added or deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dms/api-ref/BatchDeleteGroup.html b/docs/dms/api-ref/BatchDeleteGroup.html new file mode 100644 index 00000000..76918d45 --- /dev/null +++ b/docs/dms/api-ref/BatchDeleteGroup.html @@ -0,0 +1,159 @@ + + +

Batch Deleting Consumer Groups of a Kafka Instance

+

Function

This API is used to delete multiple consumer groups of a Kafka instance in batches.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

[items]

+

Yes

+

Array of strings

+

List of consumer groups to be deleted.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

failed_groups

+

Array of failed_groups objects

+

List of consumer groups that failed to be deleted.

+

total

+

Integer

+

Number of records that fail to be deleted.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 failed_groups

Parameter

+

Type

+

Description

+

group_id

+

String

+

ID of consumer groups that failed to be deleted.

+

error_message

+

String

+

Cause of the deletion failure.

+
+
+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete
+
+[ "group1", "group2" ]
+
+

Example Responses

Status code: 200

+

The consumer groups are deleted successfully.

+
{
+  "failed_groups" : [ {
+    "group_id" : "test-1",
+    "error_message" : "UNKNOW"
+  }, {
+    "group_id" : "test-2",
+    "error_message" : "UNKNOW"
+  } ],
+  "total" : 2
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The consumer groups are deleted successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/BatchDeleteInstanceTopic.html b/docs/dms/api-ref/BatchDeleteInstanceTopic.html new file mode 100644 index 00000000..45435975 --- /dev/null +++ b/docs/dms/api-ref/BatchDeleteInstanceTopic.html @@ -0,0 +1,153 @@ + + +

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.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/topics/delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topics

+

No

+

Array of strings

+

List of topics to delete.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

topics

+

Array of topics objects

+

Topic list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 topics

Parameter

+

Type

+

Description

+

id

+

String

+

Topic name.

+

success

+

Boolean

+

Whether the topics are deleted.

+
+
+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/delete
+
+{
+  "topics" : [ "topic01" ]
+}
+
+

Example Responses

Status code: 200

+

The deletion is successful.

+
{
+  "topics" : [ {
+    "id" : "haha",
+    "success" : true
+  }, {
+    "id" : "aabb",
+    "success" : true
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The deletion is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Topic Management
+
+
+ diff --git a/docs/dms/api-ref/BatchDeleteInstanceUsers.html b/docs/dms/api-ref/BatchDeleteInstanceUsers.html new file mode 100644 index 00000000..3b30ed1b --- /dev/null +++ b/docs/dms/api-ref/BatchDeleteInstanceUsers.html @@ -0,0 +1,109 @@ + + +

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

No

+

String

+

Deletion type. Currently, only delete is supported.

+

users

+

No

+

Array of strings

+

User list.

+
+
+
+

Response Parameters

None

+
+

Example Requests

Deleting users in batches.

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
+
+{
+  "action" : "delete",
+  "users" : [ "testuser" ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The deletion is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: User Management
+
+
+ diff --git a/docs/dms/api-ref/BatchRestartOrDeleteInstances.html b/docs/dms/api-ref/BatchRestartOrDeleteInstances.html new file mode 100644 index 00000000..2fde3015 --- /dev/null +++ b/docs/dms/api-ref/BatchRestartOrDeleteInstances.html @@ -0,0 +1,181 @@ + + +

Batch Restarting or Deleting Instances

+

Function

This API is used to restart or delete instances in batches.

+

When an instance is being restarted, message retrieval and creation requests of the client will be rejected.

+

Deleting an instance will delete the data in the instance without any backup. Exercise caution when performing this operation.

+
+

URI

POST /v2/{project_id}/instances/action

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instances

+

No

+

Array of strings

+

List of instance IDs.

+

action

+

Yes

+

String

+

Operation to be performed on instances. The value can be restart or delete.

+

all_failure

+

No

+

String

+

Value kafka indicates all Kafka instances that fail to be created are to be deleted.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

results

+

Array of results objects

+

Result of instance modification.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 results

Parameter

+

Type

+

Description

+

result

+

String

+

Operation result.

+

  • success: The operation succeeded.

    +

  • failed: The operation failed.

    +
+

instance

+

String

+

Instance ID.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

The instances are restarted or deleted successfully.

+
{
+  "results" : [ {
+    "result" : "success",
+    "instance" : "019cacb7-4ff0-4d3c-9f33-f5f7b7fdc0e6"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The instances are restarted or deleted successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dms/api-ref/CLASS.TXT.json b/docs/dms/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..92df60bc --- /dev/null +++ b/docs/dms/api-ref/CLASS.TXT.json @@ -0,0 +1,731 @@ +[ + { + "desc":"Public cloud application programming interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ", + "product_code":"dms", + "title":"Using APIs", + "uri":"en-us_topic_0036182510.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "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":"APIs V2 (Recommended)", + "uri":"kafka-api-200707001.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "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":"Lifecycle Management", + "uri":"topic_300000000.html", + "doc_type":"api", + "p_code":"2", + "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", + "product_code":"dms", + "title":"Creating an Instance", + "uri":"CreatePostPaidInstance.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", + "product_code":"dms", + "title":"Listing All Instances", + "uri":"ListInstances.html", + "doc_type":"api", + "p_code":"3", + "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", + "product_code":"dms", + "title":"Querying an Instance", + "uri":"ShowInstance.html", + "doc_type":"api", + "p_code":"3", + "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.", + "product_code":"dms", + "title":"Deleting an Instance", + "uri":"DeleteInstance.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API is used to modify the instance information.PUT /v2/{project_id}/instances/{instance_id}NoneModifying the name and description of an instance.PUT https://{endpoin", + "product_code":"dms", + "title":"Modifying Instance Information", + "uri":"UpdateInstance.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"This API is used to restart or delete instances in batches.When an instance is being restarted, message retrieval and creation requests of the client will be rejected.Del", + "product_code":"dms", + "title":"Batch Restarting or Deleting Instances", + "uri":"BatchRestartOrDeleteInstances.html", + "doc_type":"api", + "p_code":"3", + "code":"9" + }, + { + "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":"Instance Management", + "uri":"topic_300000001.html", + "doc_type":"api", + "p_code":"2", + "code":"10" + }, + { + "desc":"This API is used to reset the password.POST /v2/{project_id}/instances/{instance_id}/passwordNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Resetting the Password", + "uri":"ResetPassword.html", + "doc_type":"api", + "p_code":"10", + "code":"11" + }, + { + "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 ", + "product_code":"dms", + "title":"Configuring Automatic Topic Creation", + "uri":"UpdateInstanceAutoCreateTopic.html", + "doc_type":"api", + "p_code":"10", + "code":"12" + }, + { + "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 ", + "product_code":"dms", + "title":"Modifying the Private IP Address for Cross-VPC Access", + "uri":"UpdateInstanceCrossVpcIp.html", + "doc_type":"api", + "p_code":"10", + "code":"13" + }, + { + "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", + "product_code":"dms", + "title":"Querying Kafka Cluster Metadata", + "uri":"ShowCluster.html", + "doc_type":"api", + "p_code":"10", + "code":"14" + }, + { + "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", + "product_code":"dms", + "title":"Querying Consumer Group Details", + "uri":"ShowGroups.html", + "doc_type":"api", + "p_code":"10", + "code":"15" + }, + { + "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", + "product_code":"dms", + "title":"Resetting Consumer Group Offset to the Specified Position", + "uri":"ResetMessageOffset.html", + "doc_type":"api", + "p_code":"10", + "code":"16" + }, + { + "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", + "product_code":"dms", + "title":"Querying Coordinator Details of a Kafka Instance", + "uri":"ShowCoordinators.html", + "doc_type":"api", + "p_code":"10", + "code":"17" + }, + { + "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", + "product_code":"dms", + "title":"Reassigning Replicas of a Topic for a Kafka Instance", + "uri":"UpdateTopicReplica.html", + "doc_type":"api", + "p_code":"10", + "code":"19" + }, + { + "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", + "product_code":"dms", + "title":"Querying the Disk Usage Status of Topics", + "uri":"ShowKafkaTopicPartitionDiskusage.html", + "doc_type":"api", + "p_code":"10", + "code":"20" + }, + { + "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", + "product_code":"dms", + "title":"Querying All Consumer Groups", + "uri":"ListInstanceConsumerGroups.html", + "doc_type":"api", + "p_code":"10", + "code":"21" + }, + { + "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", + "product_code":"dms", + "title":"Querying a Specific Consumer Group", + "uri":"ShowGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"22" + }, + { + "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.", + "product_code":"dms", + "title":"Deleting a Consumer Group from a Kafka Instance", + "uri":"DeleteGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"23" + }, + { + "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", + "product_code":"dms", + "title":"Batch Deleting Consumer Groups of a Kafka Instance", + "uri":"BatchDeleteGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"24" + }, + { + "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":"Specification Modification Management", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"2", + "code":"25" + }, + { + "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", + "product_code":"dms", + "title":"Modifying Instance Specifications", + "uri":"ResizeInstance.html", + "doc_type":"api", + "p_code":"25", + "code":"26" + }, + { + "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", + "product_code":"dms", + "title":"Querying Product Information for Instance Specification Modification", + "uri":"ShowInstanceExtendProductInfo.html", + "doc_type":"api", + "p_code":"25", + "code":"27" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Topic Management", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"2", + "code":"28" + }, + { + "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", + "product_code":"dms", + "title":"Creating a Topic for a Kafka Instance", + "uri":"CreateInstanceTopic.html", + "doc_type":"api", + "p_code":"28", + "code":"29" + }, + { + "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", + "product_code":"dms", + "title":"Listing Topics of a Kafka Instance", + "uri":"ListInstanceTopics.html", + "doc_type":"api", + "p_code":"28", + "code":"30" + }, + { + "desc":"This API is used to modify topics of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/topicsNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Modifying Topics of a Kafka Instance", + "uri":"UpdateInstanceTopic.html", + "doc_type":"api", + "p_code":"28", + "code":"31" + }, + { + "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", + "product_code":"dms", + "title":"Batch Deleting Topics of a Kafka Instance", + "uri":"BatchDeleteInstanceTopic.html", + "doc_type":"api", + "p_code":"28", + "code":"32" + }, + { + "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:", + "product_code":"dms", + "title":"Batch Cleaning Up Topics of a Kafka Instance", + "uri":"BatchCleanupInstanceTopic.html", + "doc_type":"api", + "p_code":"28", + "code":"33" + }, + { + "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 ", + "product_code":"dms", + "title":"Querying Topic Details", + "uri":"ShowInstanceTopicDetail.html", + "doc_type":"api", + "p_code":"28", + "code":"34" + }, + { + "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":"User Management", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"2", + "code":"35" + }, + { + "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", + "product_code":"dms", + "title":"Querying the User List", + "uri":"ShowInstanceUsers.html", + "doc_type":"api", + "p_code":"35", + "code":"36" + }, + { + "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", + "product_code":"dms", + "title":"Creating a User", + "uri":"CreateInstanceUser.html", + "doc_type":"api", + "p_code":"35", + "code":"37" + }, + { + "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.", + "product_code":"dms", + "title":"Deleting Users in Batches", + "uri":"BatchDeleteInstanceUsers.html", + "doc_type":"api", + "p_code":"35", + "code":"38" + }, + { + "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.", + "product_code":"dms", + "title":"Resetting a User Password", + "uri":"ResetUserPasswrod.html", + "doc_type":"api", + "p_code":"35", + "code":"39" + }, + { + "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", + "product_code":"dms", + "title":"Querying User Permissions", + "uri":"ShowTopicAccessPolicy.html", + "doc_type":"api", + "p_code":"35", + "code":"40" + }, + { + "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", + "product_code":"dms", + "title":"Granting User Permissions", + "uri":"UpdateTopicAccessPolicy.html", + "doc_type":"api", + "p_code":"35", + "code":"41" + }, + { + "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":"Message Query", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"2", + "code":"42" + }, + { + "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", + "product_code":"dms", + "title":"Querying Messages", + "uri":"ShowInstanceMessages.html", + "doc_type":"api", + "p_code":"42", + "code":"43" + }, + { + "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", + "product_code":"dms", + "title":"Querying a Message with a Specified Offset", + "uri":"ShowPartitionMessage.html", + "doc_type":"api", + "p_code":"42", + "code":"44" + }, + { + "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", + "product_code":"dms", + "title":"Querying a Message with a Specified Time Period", + "uri":"ShowMessages.html", + "doc_type":"api", + "p_code":"42", + "code":"45" + }, + { + "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}/", + "product_code":"dms", + "title":"Querying Offset of the Earliest Message in a Partition", + "uri":"ShowPartitionBeginningMessage.html", + "doc_type":"api", + "p_code":"42", + "code":"46" + }, + { + "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", + "product_code":"dms", + "title":"Querying Offset of the Latest Message in a Partition", + "uri":"ShowPartitionEndMessage.html", + "doc_type":"api", + "p_code":"42", + "code":"47" + }, + { + "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":"Background Task Management", + "uri":"topic_300000007.html", + "doc_type":"api", + "p_code":"2", + "code":"48" + }, + { + "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", + "product_code":"dms", + "title":"Listing Background Tasks", + "uri":"ListBackgroundTasks.html", + "doc_type":"api", + "p_code":"48", + "code":"49" + }, + { + "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", + "product_code":"dms", + "title":"Querying a Background Task", + "uri":"ShowBackgroundTask.html", + "doc_type":"api", + "p_code":"48", + "code":"50" + }, + { + "desc":"This API is used to delete a specified background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Deleting a Background Task", + "uri":"DeleteBackgroundTask.html", + "doc_type":"api", + "p_code":"48", + "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.", + "product_code":"dms", + "title":"Tag Management", + "uri":"topic_300000008.html", + "doc_type":"api", + "p_code":"2", + "code":"52" + }, + { + "desc":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/kafka/{instance_id}/tags/actionNoneNoneSee Error Codes.", + "product_code":"dms", + "title":"Batch Adding or Deleting Tags", + "uri":"BatchCreateOrDeleteKafkaTag.html", + "doc_type":"api", + "p_code":"52", + "code":"53" + }, + { + "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", + "product_code":"dms", + "title":"Listing Tags of an Instance", + "uri":"ShowKafkaTags.html", + "doc_type":"api", + "p_code":"52", + "code":"54" + }, + { + "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.", + "product_code":"dms", + "title":"Listing Tags of a Project", + "uri":"ShowKafkaProjectTags.html", + "doc_type":"api", + "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.", + "product_code":"dms", + "title":"Other APIs", + "uri":"topic_300000009.html", + "doc_type":"api", + "p_code":"2", + "code":"56" + }, + { + "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", + "product_code":"dms", + "title":"Listing Maintenance Time Windows", + "uri":"ShowMaintainWindows.html", + "doc_type":"api", + "p_code":"56", + "code":"57" + }, + { + "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", + "product_code":"dms", + "title":"Listing AZ Information", + "uri":"ListAvailableZones.html", + "doc_type":"api", + "p_code":"56", + "code":"58" + }, + { + "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,", + "product_code":"dms", + "title":"Listing Product Specifications", + "uri":"ListProducts_0.html", + "doc_type":"api", + "p_code":"56", + "code":"59" + }, + { + "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", + "product_code":"dms", + "title":"Querying Kafka Instance Monitoring Dimensions", + "uri":"ShowCesHierarchy.html", + "doc_type":"api", + "p_code":"56", + "code":"60" + }, + { + "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":"Out-of-Date APIs", + "uri":"kafka-api-0001.html", + "doc_type":"api", + "p_code":"", + "code":"61" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"API V1", + "uri":"kafka-api-0002.html", + "doc_type":"api", + "p_code":"61", + "code":"62" + }, + { + "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":"APIs for Managing Instances", + "uri":"kafka-api-180514001.html", + "doc_type":"api", + "p_code":"62", + "code":"63" + }, + { + "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", + "product_code":"dms", + "title":"Creating an Instance", + "uri":"kafka-api-180514002.html", + "doc_type":"api", + "p_code":"63", + "code":"64" + }, + { + "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", + "product_code":"dms", + "title":"Querying an Instance", + "uri":"kafka-api-180514003.html", + "doc_type":"api", + "p_code":"63", + "code":"65" + }, + { + "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", + "product_code":"dms", + "title":"Modifying an Instance", + "uri":"kafka-api-180514004.html", + "doc_type":"api", + "p_code":"63", + "code":"66" + }, + { + "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", + "product_code":"dms", + "title":"Deleting an Instance", + "uri":"kafka-api-180514005.html", + "doc_type":"api", + "p_code":"63", + "code":"67" + }, + { + "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", + "product_code":"dms", + "title":"Restarting or Deleting Instances in Batches", + "uri":"kafka-api-180514006.html", + "doc_type":"api", + "p_code":"63", + "code":"68" + }, + { + "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", + "product_code":"dms", + "title":"Querying All Instances", + "uri":"kafka-api-180514007.html", + "doc_type":"api", + "p_code":"63", + "code":"69" + }, + { + "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 ", + "product_code":"dms", + "title":"Creating a Topic in a Kafka Instance", + "uri":"kafka-api-180614001.html", + "doc_type":"api", + "p_code":"63", + "code":"70" + }, + { + "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", + "product_code":"dms", + "title":"Querying a Topic in a Kafka Instance", + "uri":"kafka-api-180614002.html", + "doc_type":"api", + "p_code":"63", + "code":"71" + }, + { + "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", + "product_code":"dms", + "title":"Deleting Topics in a Kafka Instance in Batches", + "uri":"kafka-api-180614003.html", + "doc_type":"api", + "p_code":"63", + "code":"72" + }, + { + "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":"Other APIs", + "uri":"kafka-api-190605002.html", + "doc_type":"api", + "p_code":"62", + "code":"73" + }, + { + "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", + "product_code":"dms", + "title":"Querying AZ Information", + "uri":"kafka-api-180514008.html", + "doc_type":"api", + "p_code":"73", + "code":"74" + }, + { + "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", + "product_code":"dms", + "title":"Querying Product Specifications", + "uri":"kafka-api-180514009.html", + "doc_type":"api", + "p_code":"73", + "code":"75" + }, + { + "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 ", + "product_code":"dms", + "title":"Querying Maintenance Time Windows", + "uri":"kafka-api-180514010.html", + "doc_type":"api", + "p_code":"73", + "code":"76" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Appendix", + "uri":"kafka-api-180514011.html", + "doc_type":"api", + "p_code":"", + "code":"77" + }, + { + "desc":"Table 1 lists status codes.", + "product_code":"dms", + "title":"Status Code", + "uri":"kafka-api-0034672261.html", + "doc_type":"api", + "p_code":"77", + "code":"78" + }, + { + "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":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"77", + "code":"79" + }, + { + "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":"Instance Status", + "uri":"kafka-api-180514012.html", + "doc_type":"api", + "p_code":"77", + "code":"80" + }, + { + "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":"Change History", + "uri":"kafka-api-0034672268.html", + "doc_type":"api", + "p_code":"", + "code":"81" + } +] \ No newline at end of file diff --git a/docs/dms/api-ref/CreateInstanceTopic.html b/docs/dms/api-ref/CreateInstanceTopic.html new file mode 100644 index 00000000..dad105b5 --- /dev/null +++ b/docs/dms/api-ref/CreateInstanceTopic.html @@ -0,0 +1,166 @@ + + +

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Topic name, which consists of 4 to 64 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), and digits.

+

replication

+

No

+

Integer

+

Number of replicas, which is configured to ensure data reliability. Value range: 1 to 3.

+

sync_message_flush

+

No

+

Boolean

+

Whether synchronous flushing is enabled. The default value is false. Synchronous flushing compromises performance.

+

partition

+

No

+

Integer

+

Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: 1–100.

+

sync_replication

+

No

+

Boolean

+

Whether synchronous replication is enabled. After this function is enabled, the acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

+

retention_time

+

No

+

Integer

+

Message retention period. The default value is 72.Value range: 1-720. Unit: hour.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Topic name.

+
+
+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
+
+{
+  "id" : "kafka01"
+}
+
+

Example Responses

Status code: 200

+

The creation is successful.

+
{
+  "name" : "kafka01"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The creation is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Topic Management
+
+
+ diff --git a/docs/dms/api-ref/CreateInstanceUser.html b/docs/dms/api-ref/CreateInstanceUser.html new file mode 100644 index 00000000..1b631fb5 --- /dev/null +++ b/docs/dms/api-ref/CreateInstanceUser.html @@ -0,0 +1,181 @@ + + +

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

user_name

+

No

+

String

+

Username.

+

user_passwd

+

No

+

String

+

User password.

+

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:

    +

    • Lowercase letters

      +

    • Uppercase letters

      +

    • Digits

      +

    • Special characters `~!@#$%^&*()-_=+|[{}]:'"",<.>/?

      +
    +
+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error description.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Requests

Creating a user.

+
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
+
+{
+  "user_name" : "test",
+  "user_passwd" : "Cloud@123"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

The creation is successful.

+

400

+

Invalid parameters.

+

403

+

Authentication failed.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: User Management
+
+
+ diff --git a/docs/dms/api-ref/CreatePartition.html b/docs/dms/api-ref/CreatePartition.html new file mode 100644 index 00000000..da605229 --- /dev/null +++ b/docs/dms/api-ref/CreatePartition.html @@ -0,0 +1,107 @@ + + +

Adding Partitions to a Topic for a Kafka Instance

+

Function

This API is used to add partitions to a topic for a Kafka instance.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

partition

+

No

+

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.

+
+
+
+

Response Parameters

None

+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment
+
+{
+  "partition" : 3
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Partitions are added successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/CreatePostPaidInstance.html b/docs/dms/api-ref/CreatePostPaidInstance.html new file mode 100644 index 00000000..d667c5fb --- /dev/null +++ b/docs/dms/api-ref/CreatePostPaidInstance.html @@ -0,0 +1,479 @@ + + +

Creating an Instance

+

Function

This API is used to create a Kafka instance.

+
+

URI

POST /v2/{project_id}/instances

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

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 (-).

+

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

+

Version of the message engine. Options:

+

  • 1.1.0

    +

  • 2.3.0

    +

  • 2.7

    +
+

specification

+

No

+

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.

+

broker_num

+

No

+

Integer

+

Number of brokers.

+

You do not need to set this parameter.

+

storage_space

+

Yes

+

Integer

+

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

    +
+

partition_num

+

No

+

Integer

+

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.

    +
+

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:

+

  • Contains 8 to 32 characters.

    +

  • Contains at least two of the following character types:

    +

    • Lowercase letters

      +

    • Uppercase letters

      +

    • Digits

      +

    • Special characters `~!@#$%^&*()-_=+|[{}]:'"",<.>/?

      +
    +
+

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. 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 (,).

+

product_id

+

Yes

+

String

+

Product ID. You can obtain the product ID from Querying Product Specifications.

+

maintain_begin

+

No

+

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.

    +
+

maintain_end

+

No

+

String

+

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.

    +
+

enable_publicip

+

No

+

Boolean

+

Whether to enable public access. By default, public access is disabled.

+

  • true: enable

    +

  • false: disable

    +
+

public_bandwidth

+

No

+

Integer

+

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.

+

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

    +
+

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.

    +
+

disk_encrypted_enable

+

No

+

Boolean

+

Indicates whether disk encryption is enabled.

+

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

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 TagEntity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

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: =*<>,|/

+

value

+

No

+

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: =*<>,|/

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+
+
+
+

Example Requests

Creating a Kafka instance.

+
POST https://{endpoint}/v2/{project_id}/instances
+
+{
+  "name" : "kafka-test",
+  "description" : "",
+  "engine" : "kafka",
+  "engine_version" : "1.1.0",
+  "storage_space" : 300,
+  "vpc_id" : "23921d2a-****-****-****-5f2fa5327a48",
+  "security_group_id" : "2e888928-****-****-****-e36c6520d473",
+  "subnet_id" : "37bb12c9-****-****-****-ae8f7d336ab6",
+  "available_zones" : [ "a0865121f83b41cbafce65930a22a6e8" ],
+  "product_id" : "00300-30310-0--0",
+  "maintain_begin" : "22:00",
+  "maintain_end" : "02:00",
+  "ssl_enable" : true,
+  "enable_publicip" : true,
+  "publicip_id" : "6db1129f-16af-455d-8d54-************,bb200202-423f-49e4-bae7-************,ca8801e8-6620-42af-b506-************",
+  "access_user" : "root",
+  "password" : "**********",
+  "specification" : "300MB",
+  "partition_num" : 900,
+  "retention_policy" : "time_base",
+  "enable_auto_topic" : true,
+  "storage_spec_code" : "dms.physical.storage.ultra"
+}
+
+

Example Responses

Status code: 200

+

An instance is created successfully.

+
{
+  "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

An instance is created successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dms/api-ref/DeleteBackgroundTask.html b/docs/dms/api-ref/DeleteBackgroundTask.html new file mode 100644 index 00000000..262b2fe4 --- /dev/null +++ b/docs/dms/api-ref/DeleteBackgroundTask.html @@ -0,0 +1,81 @@ + + +

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}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

task_id

+

Yes

+

String

+

Task ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The background task is deleted successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Background Task Management
+
+
+ diff --git a/docs/dms/api-ref/DeleteGroup.html b/docs/dms/api-ref/DeleteGroup.html new file mode 100644 index 00000000..713cea75 --- /dev/null +++ b/docs/dms/api-ref/DeleteGroup.html @@ -0,0 +1,81 @@ + + +

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}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

group

+

Yes

+

String

+

Consumer group ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The deletion is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/DeleteInstance.html b/docs/dms/api-ref/DeleteInstance.html new file mode 100644 index 00000000..c8749241 --- /dev/null +++ b/docs/dms/api-ref/DeleteInstance.html @@ -0,0 +1,72 @@ + + +

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}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The specified instance is deleted successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dms/api-ref/ErrorCode.html b/docs/dms/api-ref/ErrorCode.html new file mode 100644 index 00000000..8db71122 --- /dev/null +++ b/docs/dms/api-ref/ErrorCode.html @@ -0,0 +1,1790 @@ + + +

Error Codes

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Error Codes

+

Error Message

+

Description

+

Solution

+

400

+

DMS.00400002

+

The project ID format is invalid.

+

Invalid project ID.

+

Check the project ID format.

+

400

+

DMS.00400004

+

The request body is empty.

+

The request body is empty.

+

Check the request body.

+

400

+

DMS.00400005

+

The message body is not in JSON format or contains invalid characters.

+

Check the project ID format.

+

Check the message body format.

+

400

+

DMS.00400007

+

Unsupported type.

+

Unsupported type.

+

Check the type.

+

400

+

DMS.00400008

+

Unsupported version.

+

Unsupported version.

+

Check the version.

+

400

+

DMS.00400009

+

Invalid product_id.

+

Invalid product_id in the request.

+

Check the product_id parameter.

+

400

+

DMS.00400010

+

Invalid instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

Invalid instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

Check the instance name.

+

400

+

DMS.00400011

+

The instance description can contain a maximum of 1024 characters.

+

The instance description can contain a maximum of 1024 characters.

+

Check the instance description.

+

400

+

DMS.00400012

+

The password does not meet the complexity requirements.An instance password must:Be a string consisting of 8 to 32 characters.Contain at least two of the following character types:Lowercase lettersUppercase lettersDigitsSpecial characters `~!@#$%^&*()-_=+\|[{}];:',<.>/?

+

The password does not meet the complexity requirements. +A password: + - Can contain 8 to 32 characters. + - Must contain at least three of the following character types: letters, digits, and special characters `~!@#$%^&*()-_=+\|[{}]:'", ./? + - Cannot be a weak password.

+

Check whether the password meets the requirements.

+

400

+

DMS.00400013

+

vpc_id in the request is empty.

+

Request parameter vpc_id is empty.

+

Check the vpc_id parameter.

+

400

+

DMS.00400014

+

security_group_id in the request is empty.

+

Request parameter security_group_id is empty.

+

Check the security_group_id parameter.

+

400

+

DMS.00400015

+

Invalid username. A username must be 4 to 64 characters long and consist of only letters, digits, and hyphens (-).

+

Invalid username. A username must be 4 to 64 characters long and consist of only letters, digits, and hyphens (-).

+

Check the username.

+

400

+

DMS.00400016

+

subnet_id in the request is empty.

+

Request parameter subnet_id is empty.

+

Check the subnet_id parameter.

+

400

+

DMS.00400017

+

This DMS instance job task is still running.

+

A background task associated with this instance is running.

+

Try again later.

+

400

+

DMS.00400018

+

This subnet must exist in the VPC.

+

The subnet must exist in the VPC.

+

Check the subnet.

+

400

+

DMS.00400019

+

The password does not meet the complexity requirements.

+

The password does not meet the complexity requirements.

+

Check whether the password meets the requirements.

+

400

+

DMS.00400020

+

DHCP must be enabled for this subnet.

+

DHCP must be enabled for the subnet.

+

Check the DHCP status.

+

400

+

DMS.00400021

+

The isAutoRenew parameter in the request must be either 0 or 1.

+

Invalid isAutoRenew in the request.

+

Check the isAutoRenew parameter.

+

400

+

DMS.00400022

+

Engine does not match the product id.

+

The engine and product ID parameters do not match.

+

Check the engine parameter.

+

400

+

DMS.00400026

+

This operation is not allowed due to the instance status.

+

This operation is not allowed when the instance is in the current state.

+

Check the instance status.

+

400

+

DMS.00400028

+

Query advanced product, specCode not exists.

+

The specCode does not exist during the advanced feature query.

+

Check the origin_spec_code parameter.

+

400

+

DMS.00400029

+

Query advanced product failed, can not find product for request.

+

The specCode does not exist during the advanced feature query.

+

Check the origin_spec_code parameter.

+

400

+

DMS.00400030

+

Invalid DMS instance id. The id must be a uuid.

+

Invalid instance ID.

+

Check the id parameter.

+

400

+

DMS.00400035

+

DMS instance quota of the tenant is insufficient.

+

Insufficient instance quota.

+

Apply for a higher quota.

+

400

+

DMS.00400037

+

The instanceParams parameter in the request contains invalid characters or is not in JSON format.

+

Request parameter instanceParams is not in JSON format or contains invalid characters.

+

Check the request parameter.

+

400

+

DMS.00400038

+

The periodNum parameter in the request must be an integer.

+

The periodNum parameter in the request must be an integer.

+

Check the periodNum parameter.

+

400

+

DMS.00400039

+

The quota limit has been reached.

+

The quota limit has been reached.

+

Apply for a higher quota.

+

400

+

DMS.00400042

+

The AZ does not exist.

+

The AZ does not exist.

+

Check the AZ.

+

400

+

DMS.00400045

+

The instance is not frozen and cannot be unfrozen.

+

The instance cannot be unfrozen because it is not frozen.

+

Check the instance status.

+

400

+

DMS.00400046

+

This security group does not exist.

+

The security group does not exist.

+

Check the security group.

+

400

+

DMS.00400047

+

The periodType parameter in the request must be either 2 or 3.

+

Invalid periodType in the request.

+

Check the periodType parameter.

+

400

+

DMS.00400048

+

Invalid security group rules. Ensure that rules with the protocol being ANY are configured for both the inbound and outbound directions.

+

The security group must have both outbound and inbound rules with protocols set to ANY.

+

Check the security group rules.

+

400

+

DMS.00400049

+

The availability zone does not support ipv6.

+

The AZ does not support IPv6.

+

Select another AZ.

+

400

+

DMS.00400051

+

not found the new setup version tar to upgrade instance.

+

The package for upgrading the instance to the target version is not found.

+

Select another target version.

+

400

+

DMS.00400052

+

only the instance at running status can upgrade.

+

Only running instances can be upgraded.

+

Try again later.

+

400

+

DMS.00400053

+

the upgrade instance version equals to current version.

+

The target version is the same as the current version.

+

Select another target version.

+

400

+

DMS.00400055

+

Resource sold out.

+

Resources, such as ECS and volume resources, are insufficient.

+

Try again later.

+

400

+

DMS.00400060

+

This instance name already exists.

+

The instance name already exists.

+

Check the instance name.

+

400

+

DMS.00400061

+

Invalid instance ID format.

+

Invalid instance ID.

+

Check the instance ID.

+

400

+

DMS.00400062

+

Invalid request parameter.

+

Invalid request parameters.

+

Check the request parameters.

+

400

+

DMS.00400063

+

Invalid configuration parameter {0}.

+

Invalid configuration parameter {0}.

+

Check the parameter.

+

400

+

DMS.00400064

+

The action parameter in the request must be delete or restart.

+

The action parameter in the request must be delete or restart.

+

Check the action parameter.

+

400

+

DMS.00400065

+

The instances parameter in the request is empty.

+

The instances parameter in the request is empty.

+

Check the instances parameter.

+

400

+

DMS.00400066

+

Invalid configuration parameter {0}.

+

Invalid configuration parameter {0}.

+

Check the parameter.

+

400

+

DMS.00400067

+

The available_zones parameter in the request must be an array that contains only one AZ ID.

+

Request parameter available_zones must be an array that contains only one AZ ID.

+

Check the available_zones parameter.

+

400

+

DMS.00400068

+

The VPC does not exist.

+

The VPC does not exist.

+

Check the VPC.

+

400

+

DMS.00400070

+

Invalid task ID format.

+

Invalid task ID.

+

Check the task ID.

+

400

+

DMS.00400081

+

Duplicate instance name.

+

The instance name already exists.

+

Check the instance name.

+

400

+

DMS.00400082

+

Instance id is repeated.

+

The instance ID already exists.

+

Check the instance ID.

+

400

+

DMS.00400085

+

The message body contains invalid characters or is not in JSON format. The error key is <key>.

+

The message body is not in JSON format or contains invalid characters.

+

Check the message body.

+

400

+

DMS.00400099

+

The following instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted.

+

Instances ({}) in the Creating, Starting, Stopping, or Restarting state cannot be deleted.

+

Check the instance status.

+

400

+

DMS.00400100

+

The instances array can contain a maximum of 50 instance IDs.

+

The instances array can contain a maximum of 50 instance IDs.

+

Check the instance quantity.

+

400

+

DMS.00400101

+

The name of a Kafka topic must be 4 to 64 characters long and start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

The name of a topic in a Kafka instance must be 4 to 64 characters long and start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

Check the topic name.

+

400

+

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 topic in a Kafka instance must be within the range of 1–20.

+

Check the number of partitions of the topic.

+

400

+

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 topic in a Kafka instance must be within the range of 1–20.

+

Check the number of replicas of the topic.

+

400

+

DMS.00400105

+

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.

+

Check the aging time of the topic.

+

400

+

DMS.00400106

+

Invalid maintenance time window.

+

Invalid maintenance time window.

+

Check the maintenance time window parameter.

+

400

+

DMS.00400107

+

The instance exists for unpaid sacle up orders. Please process non payment orders first.

+

A specification modification order for the instance is pending.

+

Process the order first.

+

400

+

DMS.00400108

+

The Instance exists for processing sacle up order. Please try again later.

+

A specification modification order for the instance is being processed.

+

Try again later.

+

400

+

DMS.00400124

+

The maximum number of disk expansion times has been reached.

+

The maximum number of disk expansion times has been reached.

+

Check the maximum number of disk expansion times.

+

400

+

DMS.00400125

+

Invalid SPEC_CODE.

+

Invalid SPEC_CODE.

+

Check SPEC_CODE.

+

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.

+

The instance does not support retention policy changes.

+

Contact technical support.

+

400

+

DMS.00400128

+

Invalid public access parameters.

+

Invalid public access parameters.

+

Check the public access parameters.

+

400

+

DMS.00400129

+

Current instance version is less than required.

+

The instance version does not support this operation.

+

Contact technical support.

+

400

+

DMS.00400134

+

There is another order need to pay first.

+

An unpaid order exists.

+

Pay for the order first.

+

400

+

DMS.00400135

+

Not support disk encrypted.

+

Disk encryption is not supported.

+

Do not enable disk encryption.

+

400

+

DMS.00400136

+

Disk encrypted key is null.

+

The disk encryption key is empty.

+

Check the disk encryption key.

+

400

+

DMS.00400137

+

Disk encrypted key state is not enabled.

+

The disk encryption key is not enabled.

+

Enable the disk encryption key.

+

400

+

DMS.00400142

+

The yearly/monthly charging function is not enabled.

+

The yearly/monthly charging function is not enabled.

+

Purchase an on-demand instance.

+

400

+

DMS.00400500

+

Invalid disk space.

+

Invalid disk space.

+

Check the disk space.

+

400

+

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 {0} in the request.

+

Check the instance.

+

400

+

DMS.00400861

+

Replication factor larger than available brokers.

+

The number of replicas in the topic to be created is greater than the number of available brokers.

+

Contact technical support.

+

400

+

DMS.00404033

+

Does not support extend rabbitMQ disk space.

+

The RabbitMQ disk space cannot be expanded.

+

Scale out the RabbitMQ cluster.

+

400

+

DMS.10240002

+

The number of queried queues exceeds the upper limit.

+

The maximum number of queried queues has been reached.

+

Check the queue quantity.

+

400

+

DMS.10240004

+

The tag name is invalid.

+

Invalid tag name.

+

Check the tag name.

+

400

+

DMS.10240005

+

The project ID format is invalid.

+

Invalid project ID.

+

Check the project ID format.

+

400

+

DMS.10240007

+

The name contains invalid characters.

+

The name contains invalid characters.

+

Check the name.

+

400

+

DMS.10240009

+

The message body is not in JSON format or contains invalid characters.

+

The message body is not in JSON format or contains invalid characters.

+

Check the message body.

+

400

+

DMS.10240010

+

The description contains invalid characters.

+

The description contains invalid characters.

+

Check the description.

+

400

+

DMS.10240011

+

The name length must be 1 to 64 characters.

+

The name can contain 1 to 64 characters.

+

Check the name length.

+

400

+

DMS.10240012

+

The name length must be 1 to 32 characters.

+

The name can contain 1 to 32 characters.

+

Check the name length.

+

400

+

DMS.10240013

+

The description length must not exceed 160 characters.

+

The description can contain a maximum of 160 characters.

+

Check the description length.

+

400

+

DMS.10240014

+

The number of consumable messages exceeds the maximum limit.

+

The number of consumable messages is not within the allowed range.

+

Check the number of consumable messages.

+

400

+

DMS.10240015

+

The queue ID format is invalid.

+

Invalid queue ID.

+

Check the queue ID.

+

400

+

DMS.10240016

+

The group ID format is invalid.

+

Invalid group ID.

+

Check the group ID.

+

400

+

DMS.10240017

+

The queue already exists.

+

The queue already exists.

+

Check whether the queue exists.

+

400

+

DMS.10240018

+

The consumer group already exists.

+

The consumer group already exists.

+

Check whether the consumer group exists.

+

400

+

DMS.10240019

+

The number of consumer groups exceeds the upper limit.

+

The number of consumer groups exceeds the upper limit.

+

Check the number of consumer groups.

+

400

+

DMS.10240020

+

The quota is insufficient.

+

Insufficient quota.

+

Check the quota.

+

400

+

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 range of 1–60.

+

Check the value of time_wait.

+

400

+

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.

+

Check the value of max Consume Count.

+

400

+

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.

+

Check the value of retention_hours.

+

400

+

DMS.10240028

+

Non-kafka queues do not support retention_hours.

+

Non-kafka queues do not support retention_hours.

+

Check whether the queue is a Kafka queue. If not, do not set retention_hours.

+

400

+

DMS.10240032

+

The queue is being created.

+

The queue is being created.

+

Check whether the queue is being created.

+

400

+

DMS.10240035

+

The tag key is empty or too long.

+

The tag key of the queue is empty or too long.

+

Check the tag key of the queue.

+

400

+

DMS.10240036

+

The tag key contains invalid characters.

+

The tag key of the queue contains invalid characters.

+

Check the tag key of the queue.

+

400

+

DMS.10240038

+

The tag value is too long.

+

The tag value is too long.

+

Check the tag value of the queue.

+

400

+

DMS.10240039

+

The tag value contains invalid characters.

+

The tag value contains invalid characters.

+

Check the tag value of the queue.

+

400

+

DMS.10240040

+

You can only create or delete tags.

+

You can only create or delete tags.

+

Check whether the operation meets the requirements.

+

400

+

DMS.10240041

+

You can only filter or count tags.

+

You can only filter or count tags.

+

Check whether the operation meets the requirements.

+

400

+

DMS.10240042

+

The number of records on each page for pagination query exceeds the upper limit.

+

The number of records on each page for pagination query exceeds the upper limit.

+

Check the page size.

+

400

+

DMS.10240043

+

The number of skipped records for pagination query exceeds the upper limit.

+

The offset for pagination query exceeds the upper limit.

+

Check the paging offset.

+

400

+

DMS.10240044

+

A maximum of 10 tags can be created.

+

A maximum of 10 tags can be created.

+

Check the tag quantity.

+

400

+

DMS.10240045

+

The tag key has been used.

+

The tag key has been used.

+

Check whether the tag key has been used.

+

400

+

DMS.10540001

+

The message body contains invalid fields.

+

The message body contains invalid fields.

+

Check the message body.

+

400

+

DMS.10540003

+

Message ack status must be either 'success' or 'fail'. It should not be '{status}'.

+

Message ack status must be either success or fail. It should not be {status}.

+

Check whether the status meets the requirements.

+

400

+

DMS.10540004

+

Request error

+

Request error. The queue or group name does not match the handler.

+

Check whether the queue or group name matches the handler.

+

400

+

DMS.10540010

+

The request format is incorrect

+

The request format is incorrect. {Error description}

+

Check the request format.

+

400

+

DMS.10540011

+

The message size is {message size}, larger than the size limit {max allowed size}.

+

The message size is {message size}, larger than the size limit {max allowed size}.

+

Check the request body size.

+

400

+

DMS.10540012

+

The message body is not in JSON format or contains invalid characters.

+

The message body is not in JSON format or contains invalid characters.

+

Check the message body format.

+

400

+

DMS.10540014

+

The URL contains invalid parameters.

+

The URL contains invalid parameters.

+

Check the URL parameters.

+

400

+

DMS.10540202

+

The request format is incorrect

+

The request format is incorrect. {Error description}

+

Check the request format.

+

400

+

DMS.10542204

+

Failed to consume messages due to {desc}.

+

Failed to consume messages. {Error description}

+

Check the error information and rectify the fault accordingly.

+

400

+

DMS.10542205

+

Failed to obtain the consumption instance because the handler does not exist. This may be because the consumer instance is released 1 minute after the message is consumed. As a result, the consumer instance fails to be obtained from the handler.

+

Failed to obtain the consumption instance because the handler does not exist. This may be because the consumer instance is released 1 minute after the message is consumed.

+

Check the handler.

+

400

+

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.

+

Check the value of ack_wait.

+

400

+

DMS.10542209

+

The handler does not exist because the handler fails to be parsed, the message consumption times out, or the message consumption is repeatedly acknowledged.

+

The handler does not exist because the handler fails to be parsed, the message consumption times out, or the message consumption is repeatedly acknowledged.

+

Check whether the handler or consumption acknowledgment times out.

+

400

+

DMS.10542214

+

The request format is incorrect

+

The request format is incorrect. {Error description}

+

Check the request format.

+

401

+

DMS.10240101

+

Invalid token.

+

Invalid token.

+

Check whether the token is valid.

+

401

+

DMS.10240102

+

Expired token.

+

The token has expired.

+

Check whether the token has expired.

+

401

+

DMS.10240103

+

Missing token.

+

The token is missing.

+

Check whether the token is missing.

+

401

+

DMS.10240104

+

The project ID and token do not match.

+

The project ID and token do not match.

+

Check whether the project ID matches the token.

+

403

+

DMS.00403002

+

A tenant has the read-only permission and cannot perform operations on DMS.

+

You cannot perform operations on DMS because you only have read permissions.

+

Check the tenant permission.

+

403

+

DMS.00403003

+

This role does not have the permissions to perform this operation.

+

This role does not have the permissions to perform this operation.

+

Check the role permission.

+

403

+

DMS.10240304

+

Change the quota of a queue or consumer group to a value smaller than the used quota.

+

The quota of a queue or consumer group cannot be smaller than the used amount.

+

Check the quota.

+

403

+

DMS.10240306

+

The tenant has been frozen. You cannot perform operations on DMS.

+

The tenant has been frozen. You cannot perform operations on DMS.

+

Check the tenant status.

+

403

+

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.

+

Check whether the number of consumer groups exceeds the quota.

+

403

+

DMS.10240308

+

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.

+

403

+

DMS.10240309

+

Access denied. You cannot perform operations on DMS.

+

Access denied. You cannot perform operations on DMS.

+

Check whether you have the permission required to perform this operation.

+

403

+

DMS.10240310

+

A tenant has the read-only permission and cannot perform operations on DMS.

+

The tenant has read-only permissions and cannot perform operations on DMS.

+

Check the tenant permission.

+

403

+

DMS.10240311

+

This role does not have the permissions to perform this operation.

+

This role does not have the permissions required to perform operations on DMS.

+

Check the role permission.

+

403

+

DMS.10240312

+

The tenant is restricted and cannot perform operations on DMS.

+

The tenant is restricted and cannot perform operations on DMS.

+

Check the role permission.

+

404

+

DMS.00404001

+

The requested URL does not exist.

+

The requested URL does not exist.

+

Check the URL.

+

404

+

DMS.00404022

+

This instance does not exist.

+

The instance does not exist.

+

Check whether the instance exists.

+

404

+

DMS.10240401

+

The queue ID is incorrect or not found.

+

The queue ID is incorrect or is not found.

+

Check whether the queue ID exists and is correct.

+

404

+

DMS.10240405

+

The consumption group ID is incorrect or not found.

+

The consumption group ID is incorrect or is not found.

+

Check whether the consumer group ID exists and is correct.

+

404

+

DMS.10240406

+

The URL or endpoint does not exist.

+

The URL or endpoint does not exist.

+

Check whether the URL or endpoint exists and is correct.

+

404

+

DMS.10240407

+

The request is too frequent. Flow control is being performed. Please try again later.

+

The request is sent too frequently and flow control is being performed. Please try again later.

+

Try again later.

+

404

+

DMS.10240426

+

No tag containing this key exists.

+

No tags containing this key exist.

+

Check the tag.

+

404

+

DMS.10540401

+

The queue name does not exist.

+

The queue name does not exist.

+

Check whether the queue name exists.

+

405

+

DMS.00405001

+

This request method is not allowed.

+

The request method is not allowed.

+

Check the request method.

+

500

+

DMS.00500000

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500006

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500017

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500024

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500025

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500041

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500052

+

Internal service error.

+

Failed to submit the instance upgrade job.

+

Contact technical support.

+

500

+

DMS.00500053

+

Internal service error.

+

The specified instance node is not found.

+

Contact technical support.

+

500

+

DMS.00500054

+

Internal service error.

+

Failed to generate the password.

+

Contact technical support.

+

500

+

DMS.00500070

+

Internal service error.

+

Failed to configure the instance.

+

Contact technical support.

+

500

+

DMS.00500071

+

Internal service error.

+

Failed to create the instance backup policy.

+

Contact technical support.

+

500

+

DMS.00500094

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.00500106

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.10250002

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.10250003

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.10250004

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.10250005

+

Internal communication error.

+

Internal communication error.

+

Contact technical support.

+

500

+

DMS.10250006

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DMS.10550035

+

tag_type must be either or or and.

+

tag_type must be either 'or' or 'and'.

+

Check tag_type.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/dms/api-ref/ListAvailableZones.html b/docs/dms/api-ref/ListAvailableZones.html new file mode 100644 index 00000000..bb632a90 --- /dev/null +++ b/docs/dms/api-ref/ListAvailableZones.html @@ -0,0 +1,166 @@ + + +

Listing AZ Information

+

Function

This API is used to query the AZ ID for creating an instance.

+
+

URI

GET /v2/available-zones

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 1 Response body parameters

Parameter

+

Type

+

Description

+

region_id

+

String

+

Region ID.

+

available_zones

+

Array of available_zones objects

+

Array of AZs.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 available_zones

Parameter

+

Type

+

Description

+

soldOut

+

Boolean

+

Whether resources are sold out.

+

id

+

String

+

AZ ID.

+

code

+

String

+

AZ code.

+

name

+

String

+

AZ name.

+

port

+

String

+

AZ port.

+

resource_availability

+

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.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/available-zones
+
+

Example Responses

Status code: 200

+

The AZ information is queried successfully.

+
{
+  "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
+  }, {
+    "soldOut" : false,
+    "id" : "9f1c5806706d4c1fb0eb72f0a9b18c77",
+    "code" : "xxx",
+    "name" : "AZ 3.",
+    "port" : "443",
+    "resource_availability" : "true",
+    "default_az" : false,
+    "remain_time" : 9223372036854776000,
+    "ipv6_enable" : false
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The AZ information is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dms/api-ref/ListBackgroundTasks.html b/docs/dms/api-ref/ListBackgroundTasks.html new file mode 100644 index 00000000..a3ffe14a --- /dev/null +++ b/docs/dms/api-ref/ListBackgroundTasks.html @@ -0,0 +1,239 @@ + + +

Listing Background Tasks

+

Function

This API is used to list background tasks of an instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/tasks

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

start

+

No

+

Integer

+

ID of the task where the query starts.

+

limit

+

No

+

Integer

+

Number of tasks to be queried.

+

begin_time

+

No

+

String

+

Time of task where the query starts. The format is YYYYMMDDHHmmss.

+

end_time

+

No

+

String

+

Time of task where the query ends. The format is YYYYMMDDHHmmss.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

task_count

+

String

+

Number of tasks.

+

tasks

+

Array of tasks objects

+

Task list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 tasks

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID.

+

name

+

String

+

Task name.

+

user_name

+

String

+

Username.

+

user_id

+

String

+

User ID.

+

params

+

String

+

Task parameters.

+

status

+

String

+

Task status.

+

created_at

+

String

+

Start time.

+

updated_at

+

String

+

End time.

+
+
+
+

Example Requests

'GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks?start={start}&limit={limit}&begin_time={begin_time}&end_time={end_time}'
+
+

Example Responses

Status code: 200

+

Background tasks are listed successfully.

+
{
+  "task_count" : "4",
+  "tasks" : [ {
+    "id" : "8abfa7b372160bfd0172165864064079",
+    "name" : "modifyAutoTopic",
+    "user_name" : "paas_dms",
+    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
+    "params" : "{\"old_auto_status\":true,\"new_auto_status\":false}",
+    "status" : "EXECUTING",
+    "created_at" : "2020-05-15T03:19:51.046Z",
+    "updated_at" : "2020-05-15T03:19:51.065Z"
+  }, {
+    "id" : "8abfa7b372160bfd017216560af83e6e",
+    "name" : "changeRetentionPolicy",
+    "user_name" : "paas_dms",
+    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
+    "params" : "{\"new_retention_policy\":\"produce_reject\",\"origin_retention_policy\":\"time_base\"}",
+    "status" : "SUCCESS",
+    "created_at" : "2020-05-15T03:17:17.176Z",
+    "updated_at" : "2020-05-15T03:17:22.162Z"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Background tasks are listed successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Background Task Management
+
+
+ diff --git a/docs/dms/api-ref/ListInstanceConsumerGroups.html b/docs/dms/api-ref/ListInstanceConsumerGroups.html new file mode 100644 index 00000000..9ae8e1a6 --- /dev/null +++ b/docs/dms/api-ref/ListInstanceConsumerGroups.html @@ -0,0 +1,160 @@ + + +

Querying All Consumer Groups

+

Function

This API is used to query all consumer groups.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/groups

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
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 consumer group IDs returned in the current query. The default value is 10. The value ranges from 1 to 50.

+

group

+

No

+

String

+

Filter consumer group names that contain specific keywords.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

group_ids

+

Array of strings

+

All consumer group IDs.

+

total

+

Integer

+

Total number of consumer groups.

+

next_offset

+

Integer

+

Sequence number of the next consumer group.

+

previous_offset

+

Integer

+

Sequence number of the previous consumer group.

+
+
+
+

Example Requests

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
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

All consumer groups are queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ListInstanceTopics.html b/docs/dms/api-ref/ListInstanceTopics.html new file mode 100644 index 00000000..7d84bd32 --- /dev/null +++ b/docs/dms/api-ref/ListInstanceTopics.html @@ -0,0 +1,230 @@ + + +

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

total

+

Integer

+

Total number of topics.

+

size

+

Integer

+

Maximum number of records to be displayed on a page.

+

remain_partitions

+

Integer

+

Number of remaining partitions.

+

max_partitions

+

Integer

+

Total number of partitions.

+

topics

+

Array of TopicEntity objects

+

Topic list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 TopicEntity

Parameter

+

Type

+

Description

+

policiesOnly

+

Boolean

+

Whether this policy is the default policy.

+

name

+

String

+

Topic name.

+

replication

+

Integer

+

Number of replicas, which is configured to ensure data reliability.

+

partition

+

Integer

+

Number of topic partitions, which is used to set the number of concurrently consumed messages.

+

retention_time

+

Integer

+

Retention period of a message.

+

sync_replication

+

Boolean

+

Whether synchronous replication is enabled. After this function is enabled, the acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

+

sync_message_flush

+

Boolean

+

Whether synchronous flushing is enabled. The default value is false. Synchronous flushing compromises performance.

+

external_configs

+

Object

+

Extended configuration.

+

topic_type

+

Integer

+

Topic type. Options: 0: common topic; 1: system (internal) topic.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "total" : 3,
+  "size" : 3,
+  "topics" : [ {
+    "policiesOnly" : false,
+    "name" : "topic-11",
+    "replication" : 3,
+    "partition" : 3,
+    "retention_time" : 72,
+    "sync_replication" : false,
+    "sync_message_flush" : false,
+    "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
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Topic Management
+
+
+ diff --git a/docs/dms/api-ref/ListInstances.html b/docs/dms/api-ref/ListInstances.html new file mode 100644 index 00000000..a119f91e --- /dev/null +++ b/docs/dms/api-ref/ListInstances.html @@ -0,0 +1,687 @@ + + +

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

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

engine

+

No

+

String

+

Message engine. Value: kafka.

+

name

+

No

+

String

+

Instance name.

+

instance_id

+

No

+

String

+

Instance ID.

+

status

+

No

+

String

+

Instance status.

+

include_failure

+

No

+

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.

+

exact_match_name

+

No

+

String

+

Whether to search for the instance that precisely matches a specified instance name.

+

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.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

instances

+

Array of ShowInstanceResp objects

+

Instance list.

+

instance_num

+

Integer

+

Number of instances.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ShowInstanceResp

Parameter

+

Type

+

Description

+

name

+

String

+

Instance name.

+

engine

+

String

+

Message engine.

+

engine_version

+

String

+

Version.

+

description

+

String

+

Instance description

+

specification

+

String

+

Instance specifications.

+

storage_space

+

Integer

+

Message storage space in GB.

+

partition_num

+

String

+

Number of partitions in a Kafka instance.

+

used_storage_space

+

Integer

+

Used message storage space in GB.

+

connect_address

+

String

+

IP address of an instance.

+

port

+

Integer

+

Port of an instance.

+

status

+

String

+

Instance status.

+

instance_id

+

String

+

Instance ID.

+

resource_spec_code

+

String

+

Resource specification code.

+

  • dms.instance.kafka.cluster.c3.mini: Kafka instance with 100 MB/s bandwidth

    +

  • dms.instance.kafka.cluster.c3.small.2: Kafka instance with 300 MB/s bandwidth

    +

  • dms.instance.kafka.cluster.c3.middle.2: Kafka instance with 600 MB/s bandwidth

    +

  • dms.instance.kafka.cluster.c3.high.2: Kafka instance with 1200 MB/s bandwidth

    +
+

vpc_id

+

String

+

VPC ID.

+

vpc_name

+

String

+

VPC name.

+

created_at

+

String

+

Time when the instance was created.

+

The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

+

subnet_name

+

String

+

Subnet name.

+

subnet_cidr

+

String

+

Subnet CIDR block.

+

user_id

+

String

+

User ID.

+

user_name

+

String

+

Username.

+

access_user

+

String

+

Username for accessing the instance.

+

maintain_begin

+

String

+

Time at which the maintenance time window starts. The format is HH:mm:ss.

+

maintain_end

+

String

+

Time at which the maintenance time window ends. The format is HH:mm:ss.

+

enable_publicip

+

Boolean

+

Whether public access is enabled for the instance.

+

  • true: enabled

    +

  • false: disabled

    +
+

ssl_enable

+

Boolean

+

Whether security authentication is enabled.

+

  • true: enable

    +

  • false: disabled

    +
+

ssl_two_way_enable

+

Boolean

+

Indicates whether to enable two-way authentication.

+

enable_auto_topic

+

Boolean

+

Whether automatic topic creation is enabled.

+

  • true: enabled

    +

  • false: disabled

    +
+

type

+

String

+

Instance type. The value can be cluster.

+

product_id

+

String

+

Product ID.

+

security_group_id

+

String

+

Security group ID.

+

security_group_name

+

String

+

Security group name.

+

subnet_id

+

String

+

Subnet ID.

+

available_zones

+

Array of strings

+

AZ to which the instance brokers belong. The AZ ID is returned.

+

total_storage_space

+

Integer

+

Message storage space in GB.

+

public_connect_address

+

String

+

Instance public access address. This parameter is available only when public access is enabled for the instance.

+

storage_resource_id

+

String

+

Storage resource ID.

+

storage_spec_code

+

String

+

I/O specifications.

+

service_type

+

String

+

Service type.

+

storage_type

+

String

+

Storage class.

+

retention_policy

+

String

+

Message retention policy.

+

kafka_public_status

+

String

+

Whether public access is enabled for Kafka.

+

public_bandwidth

+

Integer

+

Public network access bandwidth.

+

cross_vpc_info

+

String

+

Cross-VPC access information.

+

rest_connect_address

+

String

+

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

+

Connection address on the tenant side.

+

disk_encrypted

+

Boolean

+

Whether disk encryption is enabled.

+

disk_encrypted_key

+

String

+

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

+

kafka_private_connect_address

+

String

+

Private connection address of a Kafka instance.

+

public_access_enabled

+

String

+

Time when public access was enabled for an instance. The value can be true, actived, closed, or false.

+

node_num

+

Integer

+

Node quantity.

+

enable_acl

+

Boolean

+

Indicates whether access control is enabled.

+

broker_num

+

Integer

+

Broker quantity.

+

tags

+

Array of TagEntity objects

+

Tag list.

+

dr_enable

+

Boolean

+

Indicates whether DR is enabled.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 TagEntity

Parameter

+

Type

+

Description

+

key

+

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: =*<>,|/

+

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: =*<>,|/

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances
+
+

Example Responses

Status code: 200

+

All instances are listed successfully.

+
{
+  "instances" : [ {
+    "name" : "kafka-2085975099",
+    "engine" : "kafka",
+    "port" : 9092,
+    "status" : "RUNNING",
+    "type" : "cluster",
+    "specification" : "100MB",
+    "engine_version" : "1.1.0",
+    "connect_address" : "192.168.0.100,192.168.0.61,192.168.0.72",
+    "instance_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini",
+    "charging_mode" : 1,
+    "vpc_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "vpc_name" : "dms-test",
+    "created_at" : "1585618587087",
+    "product_id" : "00300-30308-0--0",
+    "security_group_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "security_group_name" : "Sys-default",
+    "subnet_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "available_zones" : [ "38b0f7a602344246bcb0da47b5d548e7" ],
+    "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+    "user_name" : "paas_dms",
+    "kafka_manager_user" : "root",
+    "maintain_begin" : "02:00:00",
+    "maintain_end" : "06:00:00",
+    "enable_log_collection" : false,
+    "storage_space" : 492,
+    "total_storage_space" : 600,
+    "used_storage_space" : 25,
+    "partition_num" : "300",
+    "enable_publicip" : false,
+    "ssl_enable" : false,
+    "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",
+    "storage_spec_code" : "dms.physical.storage.ultra",
+    "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",
+    "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,
+    "ces_version" : "linux"
+  } ],
+  "instance_num" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

All instances are listed successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dms/api-ref/ListProducts_0.html b/docs/dms/api-ref/ListProducts_0.html new file mode 100644 index 00000000..c09ed8cd --- /dev/null +++ b/docs/dms/api-ref/ListProducts_0.html @@ -0,0 +1,646 @@ + + +

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/PARAMETERS.txt b/docs/dms/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/dms/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/dms/api-ref/ResetMessageOffset.html b/docs/dms/api-ref/ResetMessageOffset.html new file mode 100644 index 00000000..a8362610 --- /dev/null +++ b/docs/dms/api-ref/ResetMessageOffset.html @@ -0,0 +1,154 @@ + + +

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).

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

group

+

Yes

+

String

+

Consumer group name.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

Yes

+

String

+

Topic name.

+

partition

+

No

+

Integer

+

Partition number. The default value is -1, indicating that all partitions are reset.

+

message_offset

+

No

+

Integer

+

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.

    +

  • If this offset is later than the current largest offset, the offset will be reset to the latest offset.

    +
+

Either message_offset or timestamp must be specified.

+

timestamp

+

No

+

Integer

+

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.

    +

  • If this time is later than the current largest timestamp, the offset will be reset to the latest timestamp.

    +
+

Either message_offset or timestamp must be specified.

+
+
+
+

Response Parameters

None

+
+

Example Requests

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The consumer group offset is successfully reset to the specified position.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ResetPassword.html b/docs/dms/api-ref/ResetPassword.html new file mode 100644 index 00000000..4495cd12 --- /dev/null +++ b/docs/dms/api-ref/ResetPassword.html @@ -0,0 +1,103 @@ + + +

Resetting the Password

+

Function

This API is used to reset the password.

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

new_password

+

No

+

String

+

The password can contain 8 to 32 characters, and must contain at least three types of the following characters:

+

  • Uppercase letters

    +

  • Lowercase letters

    +

  • Digits

    +

  • Special characters`~!@#$%^&*()-_=+\|[{}];:'"",<.>/? and spaces, and cannot start with a hyphen (-).

    +
+
+
+
+

Response Parameters

None

+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/password
+
+{
+  "new_password" : "********"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The password is reset successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ResetUserPasswrod.html b/docs/dms/api-ref/ResetUserPasswrod.html new file mode 100644 index 00000000..62e0b6e5 --- /dev/null +++ b/docs/dms/api-ref/ResetUserPasswrod.html @@ -0,0 +1,108 @@ + + +

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}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

user_name

+

Yes

+

String

+

Username.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

new_password

+

No

+

String

+

New password.

+
+
+
+

Response Parameters

None

+
+

Example Requests

Resetting a user password.

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}
+
+{
+  "new_password" : "Cloud@123"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Password reset successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: User Management
+
+
+ diff --git a/docs/dms/api-ref/ResizeInstance.html b/docs/dms/api-ref/ResizeInstance.html new file mode 100644 index 00000000..49dcc5a3 --- /dev/null +++ b/docs/dms/api-ref/ResizeInstance.html @@ -0,0 +1,159 @@ + + +

Modifying Instance Specifications

+

Function

This API is used to modify instance specifications.

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

new_spec_code

+

No

+

String

+

Specification ID after the change. If only the disk size is expanded, the specification ID remains unchanged.

+

new_storage_space

+

No

+

Integer

+

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.

+

oper_type

+

No

+

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).

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the specification modification task.

+
+
+
+

Example Requests

Pay-per-use instance (old specifications)

+
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/extend
+
+{
+  "new_spec_code" : "dms.instance.kafka.cluster.c3.mini",
+  "new_storage_space" : 1000
+}
+
+

Example Responses

Status code: 200

+

Instance specifications are modified successfully.

+
{
+  "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance specifications are modified successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Specification Modification Management
+
+
+ diff --git a/docs/dms/api-ref/ShowBackgroundTask.html b/docs/dms/api-ref/ShowBackgroundTask.html new file mode 100644 index 00000000..adbb04d8 --- /dev/null +++ b/docs/dms/api-ref/ShowBackgroundTask.html @@ -0,0 +1,189 @@ + + +

Querying a Background Task

+

Function

This API is used to query a specified background task.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

task_id

+

Yes

+

String

+

Task ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

task_count

+

String

+

Number of tasks.

+

tasks

+

Array of tasks objects

+

Task list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 tasks

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID.

+

name

+

String

+

Task name.

+

user_name

+

String

+

Username.

+

user_id

+

String

+

User ID.

+

params

+

String

+

Task parameters.

+

status

+

String

+

Task status.

+

created_at

+

String

+

Start time.

+

updated_at

+

String

+

End time.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "task_count" : "1",
+  "tasks" : [ {
+    "id" : "8abfa7b272adc5b40172b73130065ae7",
+    "name" : "bindInstancePublicIp",
+    "user_name" : "paas_dms",
+    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
+    "params" : "{\"public_ip_id\":\"1aea7aed-e7d8-40ea-b3de-6f3ee9d5db9f\",\"public_ip_address\":\"100.93.2.18\",\"enable_public_ip\":true}",
+    "status" : "SUCCESS",
+    "created_at" : "2020-06-15T08:55:53.606Z",
+    "updated_at" : "2020-06-15T08:55:56.600Z"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Background Task Management
+
+
+ diff --git a/docs/dms/api-ref/ShowCesHierarchy.html b/docs/dms/api-ref/ShowCesHierarchy.html new file mode 100644 index 00000000..4bade613 --- /dev/null +++ b/docs/dms/api-ref/ShowCesHierarchy.html @@ -0,0 +1,442 @@ + + +

Querying Kafka Instance Monitoring Dimensions

+

Function

This API is used to query Kafka instance monitoring dimensions.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

dimensions

+

Array of dimensions objects

+

Monitoring dimensions.

+

instance_ids

+

Array of instance_ids objects

+

Instance information.

+

nodes

+

Array of nodes objects

+

Broker information.

+

queues

+

Array of queues objects

+

Topic information.

+

groups

+

Array of groups objects

+

Consumer group information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 dimensions

Parameter

+

Type

+

Description

+

name

+

String

+

Monitoring dimension name.

+

metrics

+

Array of strings

+

Metric name.

+

key_name

+

Array of strings

+

Key used for monitoring query.

+

dim_router

+

Array of strings

+

Monitoring dimension route.

+

children

+

Array of children objects

+

List of secondary dimensions.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 children

Parameter

+

Type

+

Description

+

name

+

String

+

Secondary dimension name.

+

metrics

+

Array of strings

+

Metrics on the secondary dimension.

+

key_name

+

Array of strings

+

Key used for monitoring query.

+

dim_router

+

Array of strings

+

Monitoring dimension route.

+
+
+ +
+ + + + + + + + + +
Table 5 instance_ids

Parameter

+

Type

+

Description

+

name

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + +
Table 6 nodes

Parameter

+

Type

+

Description

+

name

+

String

+

Broker name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 queues

Parameter

+

Type

+

Description

+

name

+

String

+

Topic name.

+

partitions

+

Array of partitions objects

+

Partition list.

+
+
+ +
+ + + + + + + + + +
Table 8 partitions

Parameter

+

Type

+

Description

+

name

+

String

+

Partition name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 groups

Parameter

+

Type

+

Description

+

name

+

String

+

Consumer group name.

+

queues

+

Array of queues objects

+

Topic information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 queues

Parameter

+

Type

+

Description

+

name

+

String

+

Topic name.

+

partitions

+

Array of partitions objects

+

Partition information.

+
+
+ +
+ + + + + + + + + +
Table 11 partitions

Parameter

+

Type

+

Description

+

name

+

String

+

Partition name.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/ces-hierarchy
+
+

Example Responses

Status code: 200

+

The information is listed successfully.

+
{
+  "dimensions" : [ {
+    "name" : "kafka_instance_id",
+    "metrics" : [ "current_partitions", "current_topics", "group_messages" ],
+    "key_name" : [ "instance_ids" ],
+    "dim_router" : [ "kafka_instance_id" ]
+  }, {
+    "name" : "kafka_broker",
+    "metrics" : [ "broker_data_size", "broker_messages_in_rate", "broker_bytes_out_rate", "broker_bytes_in_rate", "broker_produce_mean", "broker_fetch_mean" ],
+    "key_name" : [ "nodes" ],
+    "dim_router" : [ "kafka_instance_id", "kafka_broker" ]
+  }, {
+    "name" : "kafka_rest",
+    "metrics" : [ "rest_produce_success", "rest_produce_failed", "rest_produce_latency", "rest_produce_msg_num", "rest_produce_flow", "rest_consume_success", "rest_consume_failed", "rest_consume_latency", "rest_consume_msg_num", "rest_consume_flow", "rest_commit_success", "rest_commit_failed", "rest_commit_latency", "rest_commit_msg_num", "rest_commit_flow" ],
+    "key_name" : [ "nodes" ],
+    "dim_router" : [ "kafka_instance_id", "kafka_rest" ]
+  }, {
+    "name" : "kafka_topics",
+    "metrics" : [ "topic_data_size", "topic_messages_in_rate", "topic_bytes_out_rate", "topic_bytes_in_rate", "topic_messages" ],
+    "key_name" : [ "queues" ],
+    "dim_router" : [ "kafka_instance_id", "kafka_topics" ],
+    "children" : [ {
+      "name" : "kafka_partitions",
+      "metrics" : [ "produced_messages", "partition_messages" ],
+      "key_name" : [ "queues", "partitions" ],
+      "dim_router" : [ "kafka_instance_id", "kafka_topics", "kafka_partitions" ]
+    } ]
+  }, {
+    "name" : "kafka_groups_partitions",
+    "metrics" : [ "messages_consumed", "messages_remained" ],
+    "key_name" : [ "groups", "queues", "partitions" ],
+    "dim_router" : [ "kafka_instance_id", "kafka_groups", "kafka_groups_topics", "kafka_groups_partitions" ]
+  } ],
+  "instance_ids" : [ {
+    "name" : "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7"
+  } ],
+  "nodes" : [ {
+    "name" : "broker-0"
+  }, {
+    "name" : "broker-1"
+  }, {
+    "name" : "broker-2"
+  } ],
+  "queues" : [ {
+    "name" : "aaaa",
+    "partitions" : [ {
+      "name" : "0"
+    } ]
+  }, {
+    "name" : "mytest",
+    "partitions" : [ {
+      "name" : "0"
+    }, {
+      "name" : "1"
+    }, {
+      "name" : "2"
+    } ]
+  }, {
+    "name" : "topic-84234378",
+    "partitions" : [ {
+      "name" : "0"
+    }, {
+      "name" : "1"
+    }, {
+      "name" : "2"
+    } ]
+  } ],
+  "groups" : [ {
+    "name" : "test-consumer-group",
+    "queues" : [ {
+      "name" : "mytest",
+      "partitions" : [ {
+        "name" : "0"
+      }, {
+        "name" : "1"
+      }, {
+        "name" : "2"
+      } ]
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The information is listed successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dms/api-ref/ShowCluster.html b/docs/dms/api-ref/ShowCluster.html new file mode 100644 index 00000000..7e62bf4a --- /dev/null +++ b/docs/dms/api-ref/ShowCluster.html @@ -0,0 +1,257 @@ + + +

Querying Kafka Cluster Metadata

+

Function

This API is used to query Kafka cluster metadata.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/cluster

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

cluster object

+

Cluster basic information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 cluster

Parameter

+

Type

+

Description

+

controller

+

String

+

Controller ID.

+

brokers

+

Array of brokers objects

+

Broker list.

+

topics_count

+

Integer

+

Number of topics.

+

partitions_count

+

Integer

+

Number of partitions.

+

online_partitions_count

+

Integer

+

Number of online partitions.

+

replicas_count

+

Integer

+

Number of replicas.

+

isr_replicas_count

+

Integer

+

Total number of in-sync replicas (ISRs).

+

consumers_count

+

Integer

+

Number of consumer groups.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 brokers

Parameter

+

Type

+

Description

+

host

+

String

+

Broker IP address.

+

port

+

Integer

+

Port number.

+

broker_id

+

String

+

Broker ID.

+

is_controller

+

Boolean

+

Whether the broker is a controller.

+

version

+

String

+

Server version.

+

register_time

+

Long

+

Broker registration time, which is a Unix timestamp.

+

is_health

+

Boolean

+

Whether Kafka brokers can be connected.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/cluster
+
+

Example Responses

Status code: 200

+

Kafka cluster metadata is queried successfully.

+
{
+  "cluster" : {
+    "controller" : "2",
+    "brokers" : [ {
+      "host" : "192.168.0.159",
+      "port" : 9093,
+      "broker_id" : "0",
+      "is_controller" : false,
+      "version" : "1.1.0",
+      "register_time" : 1588754647872,
+      "is_health" : true
+    }, {
+      "host" : "192.168.0.48",
+      "port" : 9093,
+      "broker_id" : "1",
+      "is_controller" : false,
+      "version" : "1.1.0",
+      "register_time" : 1588754647653,
+      "is_health" : true
+    }, {
+      "host" : "192.168.0.212",
+      "port" : 9093,
+      "broker_id" : "2",
+      "is_controller" : true,
+      "version" : "1.1.0",
+      "register_time" : 1588754647284,
+      "is_health" : true
+    } ],
+    "topics_count" : 3,
+    "partitions_count" : 9,
+    "online_partitions_count" : 9,
+    "replicas_count" : 27,
+    "isr_replicas_count" : 27,
+    "consumers_count" : 0
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Kafka cluster metadata is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ShowCoordinators.html b/docs/dms/api-ref/ShowCoordinators.html new file mode 100644 index 00000000..e72792ed --- /dev/null +++ b/docs/dms/api-ref/ShowCoordinators.html @@ -0,0 +1,150 @@ + + +

Querying Coordinator Details of a Kafka Instance

+

Function

This API is used to query coordinator details of a Kafka instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/coordinators

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

coordinators

+

Array of coordinators objects

+

List of coordinators of all consumer groups.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 coordinators

Parameter

+

Type

+

Description

+

group_id

+

String

+

Consumer group ID.

+

id

+

Integer

+

Broker ID of the coordinator.

+

host

+

String

+

Address of the coordinator.

+

port

+

Integer

+

Port number.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/coordinators
+
+

Example Responses

Status code: 200

+

Coordinator details of the Kafka instance are queried successfully.

+
{
+  "coordinators" : [ {
+    "group_id" : "XXXX",
+    "id" : 2,
+    "host" : "172.31.1.15",
+    "port" : 9091
+  }, {
+    "group_id" : "XXXX",
+    "id" : 2,
+    "host" : "172.31.1.15",
+    "port" : 9092
+  }, {
+    "group_id" : "XXXX",
+    "id" : 2,
+    "host" : "172.31.1.15",
+    "port" : 9092
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Coordinator details of the Kafka instance are queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ShowGroup.html b/docs/dms/api-ref/ShowGroup.html new file mode 100644 index 00000000..fedec55e --- /dev/null +++ b/docs/dms/api-ref/ShowGroup.html @@ -0,0 +1,284 @@ + + +

Querying a Specific Consumer Group

+

Function

This API is used to query a specific consumer group.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/groups/{group}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

group

+

Yes

+

String

+

Consumer group ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

group

+

group object

+

Consumer group information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 group

Parameter

+

Type

+

Description

+

group_id

+

String

+

Consumer group name.

+

state

+

String

+

Consumer group status. The value can be:

+

  • Dead: The consumer group has no members and no metadata.

    +

  • Empty: The consumer group has metadata but has no members.

    +

  • PreparingRebalance: The consumer group is to be rebalanced.

    +

  • CompletingRebalance: All members have jointed the group.

    +

  • Stable: Members in the consumer group can consume messages normally.

    +
+

coordinator_id

+

Integer

+

Coordinator ID.

+

members

+

Array of members objects

+

Consumer list.

+

group_message_offsets

+

Array of group_message_offsets objects

+

Consumer offset.

+

assignment_strategy

+

String

+

Partition assignment policy.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 members

Parameter

+

Type

+

Description

+

host

+

String

+

Consumer address.

+

member_id

+

String

+

Consumer ID.

+

client_id

+

String

+

Client ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 group_message_offsets

Parameter

+

Type

+

Description

+

partition

+

Integer

+

Partition number.

+

lag

+

Integer

+

Number of remaining messages that can be retrieved, that is, the number of accumulated messages.

+

topic

+

String

+

Topic name.

+

message_current_offset

+

Integer

+

Consumer offset.

+

message_log_end_offset

+

Integer

+

Log end offset (LEO).

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}
+
+

Example Responses

Status code: 200

+

A specific consumer group is queried successfully.

+
{
+  "group" : null,
+  "members" : [ {
+    "host" : "/172.31.1.102",
+    "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785",
+    "client_id" : "consumer-1"
+  } ],
+  "state" : "STABLE",
+  "group_id" : "test-consumer-group",
+  "coordinator_id" : 2,
+  "group_message_offsets" : [ {
+    "partition" : 0,
+    "lag" : 31396,
+    "topic" : "test",
+    "message_current_offset" : 935,
+    "message_log_end_offset" : 32331
+  }, {
+    "partition" : 0,
+    "lag" : 0,
+    "topic" : "aaaa",
+    "message_current_offset" : 0,
+    "message_log_end_offset" : 0
+  }, {
+    "partition" : 1,
+    "lag" : 31279,
+    "topic" : "test",
+    "message_current_offset" : 1058,
+    "message_log_end_offset" : 32337
+  }, {
+    "partition" : 1,
+    "lag" : 0,
+    "topic" : "aaaa",
+    "message_current_offset" : 0,
+    "message_log_end_offset" : 0
+  }, {
+    "partition" : 2,
+    "lag" : 31603,
+    "topic" : "test",
+    "message_current_offset" : 739,
+    "message_log_end_offset" : 32342
+  } ],
+  "assignment_strategy" : "range"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

A specific consumer group is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ShowGroups.html b/docs/dms/api-ref/ShowGroups.html new file mode 100644 index 00000000..754fd33b --- /dev/null +++ b/docs/dms/api-ref/ShowGroups.html @@ -0,0 +1,322 @@ + + +

Querying Consumer Group Details

+

Function

This API is used to query consumer group details.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

group

+

Yes

+

String

+

Consumer group name.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

group

+

group object

+

Consumer group information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 group

Parameter

+

Type

+

Description

+

group_id

+

String

+

Consumer group name.

+

state

+

String

+

Consumer group status. The value can be:

+

  • Dead: The consumer group has no members and no metadata.

    +

  • Empty: The consumer group has metadata but has no members.

    +

  • PreparingRebalance: The consumer group is to be rebalanced.

    +

  • CompletingRebalance: All members have jointed the group.

    +

  • Stable: Members in the consumer group can consume messages normally.

    +
+

coordinator_id

+

Integer

+

Coordinator ID.

+

members

+

Array of members objects

+

Consumer list.

+

group_message_offsets

+

Array of group_message_offsets objects

+

Consumer offset.

+

assignment_strategy

+

String

+

Partition assignment policy.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 members

Parameter

+

Type

+

Description

+

host

+

String

+

Consumer address.

+

assignment

+

Array of assignment objects

+

Details about the partition assigned to the consumer.

+

member_id

+

String

+

Consumer ID.

+

client_id

+

String

+

Client ID.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 assignment

Parameter

+

Type

+

Description

+

topic

+

String

+

Topic name.

+

partitions

+

Array of integers

+

Partition list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 group_message_offsets

Parameter

+

Type

+

Description

+

partition

+

Integer

+

Partition number.

+

lag

+

Integer

+

Number of remaining messages that can be retrieved, that is, the number of accumulated messages.

+

topic

+

String

+

Topic name.

+

message_current_offset

+

Integer

+

Consumer offset.

+

message_log_end_offset

+

Integer

+

Log end offset (LEO).

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/groups/{group}
+
+

Example Responses

Status code: 200

+

The consumer group details are queried successfully.

+
{
+  "group" : {
+    "members" : [ {
+      "host" : "/172.31.1.102",
+      "assignment" : [ {
+        "topic" : "test",
+        "partitions" : [ 0, 1, 2 ]
+      } ],
+      "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785",
+      "client_id" : "consumer-1"
+    } ],
+    "state" : "STABLE",
+    "group_id" : "test-consumer-group",
+    "coordinator_id" : 2,
+    "group_message_offsets" : [ {
+      "partition" : 0,
+      "lag" : 31396,
+      "topic" : "test",
+      "message_current_offset" : 935,
+      "message_log_end_offset" : 32331
+    }, {
+      "partition" : 0,
+      "lag" : 0,
+      "topic" : "aaaa",
+      "message_current_offset" : 0,
+      "message_log_end_offset" : 0
+    }, {
+      "partition" : 1,
+      "lag" : 31279,
+      "topic" : "test",
+      "message_current_offset" : 1058,
+      "message_log_end_offset" : 32337
+    }, {
+      "partition" : 1,
+      "lag" : 0,
+      "topic" : "aaaa",
+      "message_current_offset" : 0,
+      "message_log_end_offset" : 0
+    }, {
+      "partition" : 2,
+      "lag" : 31603,
+      "topic" : "test",
+      "message_current_offset" : 739,
+      "message_log_end_offset" : 32342
+    } ],
+    "assignment_strategy" : "range"
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The consumer group details are queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ShowInstance.html b/docs/dms/api-ref/ShowInstance.html new file mode 100644 index 00000000..925aca91 --- /dev/null +++ b/docs/dms/api-ref/ShowInstance.html @@ -0,0 +1,597 @@ + + +

Querying an Instance

+

Function

This API is used to query the details about a specified instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Instance name.

+

engine

+

String

+

Message engine.

+

engine_version

+

String

+

Version.

+

description

+

String

+

Instance description

+

specification

+

String

+

Instance specifications.

+

storage_space

+

Integer

+

Message storage space in GB.

+

partition_num

+

String

+

Number of partitions in a Kafka instance.

+

used_storage_space

+

Integer

+

Used message storage space in GB.

+

connect_address

+

String

+

IP address of an instance.

+

port

+

Integer

+

Port of an instance.

+

status

+

String

+

Instance status.

+

instance_id

+

String

+

Instance ID.

+

resource_spec_code

+

String

+

Resource specification code.

+

  • dms.instance.kafka.cluster.c3.mini: Kafka instance with 100 MB/s bandwidth

    +

  • dms.instance.kafka.cluster.c3.small.2: Kafka instance with 300 MB/s bandwidth

    +

  • dms.instance.kafka.cluster.c3.middle.2: Kafka instance with 600 MB/s bandwidth

    +

  • dms.instance.kafka.cluster.c3.high.2: Kafka instance with 1200 MB/s bandwidth

    +
+

vpc_id

+

String

+

VPC ID.

+

vpc_name

+

String

+

VPC name.

+

created_at

+

String

+

Time when the instance was created.

+

The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

+

subnet_name

+

String

+

Subnet name.

+

subnet_cidr

+

String

+

Subnet CIDR block.

+

user_id

+

String

+

User ID.

+

user_name

+

String

+

Username.

+

access_user

+

String

+

Username for accessing the instance.

+

maintain_begin

+

String

+

Time at which the maintenance time window starts. The format is HH:mm:ss.

+

maintain_end

+

String

+

Time at which the maintenance time window ends. The format is HH:mm:ss.

+

enable_publicip

+

Boolean

+

Whether public access is enabled for the instance.

+

  • true: enabled

    +

  • false: disabled

    +
+

ssl_enable

+

Boolean

+

Whether security authentication is enabled.

+

  • true: enable

    +

  • false: disabled

    +
+

ssl_two_way_enable

+

Boolean

+

Indicates whether to enable two-way authentication.

+

enable_auto_topic

+

Boolean

+

Whether automatic topic creation is enabled.

+

  • true: enabled

    +

  • false: disabled

    +
+

type

+

String

+

Instance type. The value can be cluster.

+

product_id

+

String

+

Product ID.

+

security_group_id

+

String

+

Security group ID.

+

security_group_name

+

String

+

Security group name.

+

subnet_id

+

String

+

Subnet ID.

+

available_zones

+

Array of strings

+

AZ to which the instance brokers belong. The AZ ID is returned.

+

total_storage_space

+

Integer

+

Message storage space in GB.

+

public_connect_address

+

String

+

Instance public access address. This parameter is available only when public access is enabled for the instance.

+

storage_resource_id

+

String

+

Storage resource ID.

+

storage_spec_code

+

String

+

I/O specifications.

+

service_type

+

String

+

Service type.

+

storage_type

+

String

+

Storage class.

+

retention_policy

+

String

+

Message retention policy.

+

kafka_public_status

+

String

+

Whether public access is enabled for Kafka.

+

public_bandwidth

+

Integer

+

Public network access bandwidth.

+

cross_vpc_info

+

String

+

Cross-VPC access information.

+

rest_connect_address

+

String

+

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

+

Connection address on the tenant side.

+

disk_encrypted

+

Boolean

+

Whether disk encryption is enabled.

+

disk_encrypted_key

+

String

+

Disk encryption key. If disk encryption is not enabled, this parameter is left blank.

+

kafka_private_connect_address

+

String

+

Private connection address of a Kafka instance.

+

public_access_enabled

+

String

+

Time when public access was enabled for an instance. The value can be true, actived, closed, or false.

+

node_num

+

Integer

+

Node quantity.

+

enable_acl

+

Boolean

+

Indicates whether access control is enabled.

+

broker_num

+

Integer

+

Broker quantity.

+

tags

+

Array of TagEntity objects

+

Tag list.

+

dr_enable

+

Boolean

+

Indicates whether DR is enabled.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 TagEntity

Parameter

+

Type

+

Description

+

key

+

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: =*<>,|/

+

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: =*<>,|/

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}
+
+

Example Responses

Status code: 200

+

The instance is queried successfully.

+
{
+  "name" : "kafka-2085975099",
+  "engine" : "kafka",
+  "port" : 9092,
+  "status" : "RUNNING",
+  "type" : "cluster",
+  "specification" : "100MB",
+  "engine_version" : "1.1.0",
+  "connect_address" : "192.168.0.100,192.168.0.61,192.168.0.72",
+  "instance_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini",
+  "charging_mode" : 1,
+  "vpc_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "vpc_name" : "dms-test",
+  "created_at" : "1585618587087",
+  "product_id" : "00300-30308-0--0",
+  "security_group_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "security_group_name" : "Sys-default",
+  "subnet_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "available_zones" : [ "38b0f7a602344246bcb0da47b5d548e7" ],
+  "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "user_name" : "paas_dms",
+  "kafka_manager_user" : "root",
+  "maintain_begin" : "02:00:00",
+  "maintain_end" : "06:00:00",
+  "enable_log_collection" : false,
+  "storage_space" : 492,
+  "total_storage_space" : 600,
+  "used_storage_space" : 25,
+  "partition_num" : "300",
+  "enable_publicip" : false,
+  "ssl_enable" : false,
+  "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",
+  "storage_spec_code" : "dms.physical.storage.ultra",
+  "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",
+  "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,
+  "ces_version" : "linux"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The instance is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dms/api-ref/ShowInstanceExtendProductInfo.html b/docs/dms/api-ref/ShowInstanceExtendProductInfo.html new file mode 100644 index 00000000..edbd78ed --- /dev/null +++ b/docs/dms/api-ref/ShowInstanceExtendProductInfo.html @@ -0,0 +1,763 @@ + + +

Querying Product Information for Instance Specification Modification

+

Function

This API is used to query the product information for instance specification modification.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/extend

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

  • platinum: platinum edition

    +
+

engine

+

Yes

+

String

+

Message engine. Currently supported: kafka.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

hourly

+

Array of hourly objects

+

List of 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 4 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 5 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 6 detail

Parameter

+

Type

+

Description

+

tps

+

String

+

Maximum number of messages per unit time.

+

storage

+

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.

+

recommend_max_consGroups

+

String

+

Recommended maximum number of consumer groups 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 7 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 8 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 9 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 10 detail

Parameter

+

Type

+

Description

+

tps

+

String

+

Maximum number of messages per unit time.

+

storage

+

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 11 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/{project_id}/instances/{instance_id}/extend?type={type}&engine={engine}
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "hourly" : [ {
+    "name" : "kafka",
+    "version" : "1.1.0",
+    "values" : [ {
+      "detail" : [ {
+        "tps" : "50000",
+        "storage" : "200",
+        "partition_num" : "300",
+        "product_id" : "00300-30316-0--0",
+        "spec_code" : "kafka.c3.mini.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "100MB",
+        "recommend_max_consGroups" : "60",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.large.2",
+        "arch_type" : "X86"
+      }, {
+        "tps" : "100000",
+        "storage" : "396",
+        "partition_num" : "900",
+        "product_id" : "00300-30340-0--0",
+        "spec_code" : "kafka.c3.small.2.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "300MB",
+        "recommend_max_consGroups" : "300",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.xlarge.2",
+        "arch_type" : "X86"
+      }, {
+        "tps" : "200000",
+        "storage" : "1056",
+        "partition_num" : "1800",
+        "product_id" : "00300-30342-0--0",
+        "spec_code" : "kafka.c3.middle.2.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "600MB",
+        "recommend_max_consGroups" : "600",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.2xlarge.2",
+        "arch_type" : "X86"
+      }, {
+        "tps" : "300000",
+        "storage" : "2112",
+        "partition_num" : "1800",
+        "product_id" : "00300-30344-0--0",
+        "spec_code" : "kafka.c3.high.2.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "1200MB",
+        "recommend_max_consGroups" : "600",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.2xlarge.2",
+        "arch_type" : "X86"
+      } ],
+      "name" : "cluster",
+      "unavailable_zones" : [ "xxx", "xxx" ],
+      "available_zones" : [ "xxx", "xxx" ]
+    } ]
+  } ],
+  "monthly" : [ {
+    "name" : "kafka",
+    "version" : "1.1.0",
+    "values" : [ {
+      "detail" : [ {
+        "tps" : "50000",
+        "storage" : "200",
+        "partition_num" : "300",
+        "product_id" : "00300-30317-0--0",
+        "spec_code" : "kafka.c3.mini.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "100MB",
+        "recommend_max_consGroups" : "60",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.large.2",
+        "arch_type" : "X86"
+      }, {
+        "tps" : "100000",
+        "storage" : "396",
+        "partition_num" : "900",
+        "product_id" : "00300-30341-0--0",
+        "spec_code" : "kafka.c3.small.2.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "300MB",
+        "recommend_max_consGroups" : "300",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.xlarge.2",
+        "arch_type" : "X86"
+      }, {
+        "tps" : "200000",
+        "storage" : "1056",
+        "partition_num" : "1800",
+        "product_id" : "00300-30343-0--0",
+        "spec_code" : "kafka.c3.middle.2.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "600MB",
+        "recommend_max_consGroups" : "600",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.2xlarge.2",
+        "arch_type" : "X86"
+      }, {
+        "tps" : "300000",
+        "storage" : "2112",
+        "partition_num" : "1800",
+        "product_id" : "00300-30345-0--0",
+        "spec_code" : "kafka.c3.high.2.connector",
+        "io" : [ {
+          "io_type" : "high",
+          "storage_spec_code" : "dms.physical.storage.high",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SAS"
+        }, {
+          "io_type" : "ultra",
+          "storage_spec_code" : "dms.physical.storage.ultra",
+          "available_zones" : [ "xxx", "xxx" ],
+          "volume_type" : "SSD"
+        } ],
+        "bandwidth" : "1200MB",
+        "recommend_max_consGroups" : "600",
+        "unavailable_zones" : [ "xxx", "xxx" ],
+        "available_zones" : [ "xxx", "xxx" ],
+        "ecs_flavor_id" : "c6.2xlarge.2",
+        "arch_type" : "X86"
+      } ],
+      "name" : "cluster",
+      "unavailable_zones" : [ "xxx", "xxx" ],
+      "available_zones" : [ "xxx", "xxx" ]
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Specification Modification Management
+
+
+ diff --git a/docs/dms/api-ref/ShowInstanceMessages.html b/docs/dms/api-ref/ShowInstanceMessages.html new file mode 100644 index 00000000..0a1adfb9 --- /dev/null +++ b/docs/dms/api-ref/ShowInstanceMessages.html @@ -0,0 +1,383 @@ + + +

Querying Messages

+

Function

This API is used to query the offset and content of a message. This API queries the message offset based on the timestamp and then queries the message content based on the offset.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/messages

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Tenant's project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

Yes

+

String

+

Topic name.

+

A topic name must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits.

+

asc

+

No

+

Boolean

+

Whether to sort messages by time.

+

start_time

+

No

+

String

+

Start time.

+

The value is a Unix timestamp, in millisecond.

+

This parameter is mandatory when you query the message offset.

+

end_time

+

No

+

String

+

End time.

+

The value is a Unix timestamp, in millisecond.

+

This parameter is mandatory when you query the message offset.

+

limit

+

No

+

String

+

Page size. The value ranges from 0 to 50.

+

offset

+

No

+

String

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

download

+

No

+

Boolean

+

Whether download is required.

+

message_offset

+

No

+

String

+

Message offset.

+

This parameter is mandatory when you query the message content.

+

If start_time and end_time are not empty, this parameter is invalid.

+

partition

+

No

+

String

+

Partition.

+

This parameter is mandatory when you query the message content.

+

If start_time and end_time are not empty, this parameter is invalid.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

messages

+

Array of MessagesEntity objects

+

Message list.

+

total

+

Long

+

Total number of messages.

+

size

+

Long

+

Number of messages.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MessagesEntity

Parameter

+

Type

+

Description

+

topic

+

String

+

Topic name.

+

partition

+

Integer

+

Partition where the message is located.

+

key

+

String

+

Message key.

+

value

+

String

+

Message content.

+

size

+

Integer

+

Message size.

+

timestamp

+

Long

+

Topic name.

+

huge_message

+

Boolean

+

Big data flag.

+

message_offset

+

Integer

+

Message offset.

+

message_id

+

String

+

Message ID.

+

app_id

+

String

+

Application ID.

+

tag

+

String

+

Message label.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error description.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "messages" : [ {
+    "topic" : "topic-test",
+    "partition" : 0,
+    "value" : "hello world",
+    "size" : 21,
+    "timestamp" : 1607598463502,
+    "huge_message" : false,
+    "message_offset" : 4,
+    "message_id" : "",
+    "app_id" : "",
+    "tag" : ""
+  } ],
+  "total" : 1,
+  "size" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+

400

+

Invalid parameters.

+

403

+

Authentication failed.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Message Query
+
+
+ diff --git a/docs/dms/api-ref/ShowInstanceTopicDetail.html b/docs/dms/api-ref/ShowInstanceTopicDetail.html new file mode 100644 index 00000000..2821fa2e --- /dev/null +++ b/docs/dms/api-ref/ShowInstanceTopicDetail.html @@ -0,0 +1,308 @@ + + +

Querying Topic Details

+

Function

This API is used to query topic details of a Kafka instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

topic

+

String

+

Topic name.

+

partitions

+

Array of partitions objects

+

Partition list.

+

group_subscribed

+

Array of strings

+

List of consumer groups that subscribe to the topic.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 partitions

Parameter

+

Type

+

Description

+

partition

+

Integer

+

Partition ID.

+

leader

+

Integer

+

ID of the broker where the leader replica resides.

+

leo

+

Integer

+

LEO of the partition leader replica.

+

hw

+

Integer

+

High watermark (HW) of the partition.

+

lso

+

Integer

+

Log start offset (LSO) of the partition leader replica.

+

last_update_timestamp

+

Long

+

Time when the last message was written to the partition.

+

The value is a Unix timestamp.

+

Unit: ms

+

replicas

+

Array of replicas objects

+

Replica list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 replicas

Parameter

+

Type

+

Description

+

broker

+

Integer

+

ID of the broker where the replica resides.

+

leader

+

Boolean

+

Whether the replica is the leader.

+

in_sync

+

Boolean

+

Whether the replica is in the ISR.

+

size

+

Integer

+

Current log size of the replica. Unit: byte.

+

lag

+

Integer

+

Number of messages that lag behind the high watermark in the replica.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "topic" : "test",
+  "partitions" : [ {
+    "partition" : 0,
+    "leader" : 2,
+    "replicas" : [ {
+      "broker" : 2,
+      "leader" : true,
+      "in_sync" : true,
+      "size" : 123971146,
+      "lag" : 0
+    }, {
+      "broker" : 1,
+      "leader" : false,
+      "in_sync" : true,
+      "size" : 123971146,
+      "lag" : 0
+    }, {
+      "broker" : 0,
+      "leader" : false,
+      "in_sync" : true,
+      "size" : 123971146,
+      "lag" : 0
+    } ],
+    "lso" : 0,
+    "leo" : 13598,
+    "hw" : 13598,
+    "last_update_timestamp" : 1571477180985
+  }, {
+    "partition" : 2,
+    "leader" : 1,
+    "replicas" : [ {
+      "broker" : 1,
+      "leader" : true,
+      "in_sync" : true,
+      "size" : 123889531,
+      "lag" : 0
+    }, {
+      "broker" : 0,
+      "leader" : false,
+      "in_sync" : true,
+      "size" : 123889531,
+      "lag" : 0
+    }, {
+      "broker" : 2,
+      "leader" : false,
+      "in_sync" : true,
+      "size" : 123889531,
+      "lag" : 0
+    } ],
+    "lso" : 0,
+    "leo" : 13601,
+    "hw" : 13601,
+    "last_update_timestamp" : 1571477077146
+  }, {
+    "partition" : 1,
+    "leader" : 0,
+    "replicas" : [ {
+      "broker" : 0,
+      "leader" : true,
+      "in_sync" : true,
+      "size" : 127245604,
+      "lag" : 0
+    }, {
+      "broker" : 2,
+      "leader" : false,
+      "in_sync" : true,
+      "size" : 127245604,
+      "lag" : 0
+    }, {
+      "broker" : 1,
+      "leader" : false,
+      "in_sync" : true,
+      "size" : 127245604,
+      "lag" : 0
+    } ],
+    "lso" : 0,
+    "leo" : 13599,
+    "hw" : 13599,
+    "last_update_timestamp" : 1571477172959
+  } ],
+  "group_subscribed" : [ "test-consumer-group" ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Topic Management
+
+
+ diff --git a/docs/dms/api-ref/ShowInstanceUsers.html b/docs/dms/api-ref/ShowInstanceUsers.html new file mode 100644 index 00000000..ef45d692 --- /dev/null +++ b/docs/dms/api-ref/ShowInstanceUsers.html @@ -0,0 +1,152 @@ + + +

Querying the User List

+

Function

This API is used to query the user list.

+

User management is supported only when SASL is enabled for the Kafka instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/users

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

users

+

Array of ShowInstanceUsersEntity objects

+

User list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 ShowInstanceUsersEntity

Parameter

+

Type

+

Description

+

user_name

+

String

+

Username.

+

role

+

String

+

User role.

+

default_app

+

Boolean

+

Whether an application is the default application.

+

created_time

+

Long

+

Creation time.

+
+
+
+

Example Requests

Querying the user list.

+
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "users" : [ {
+    "user_name" : "xxxa",
+    "role" : "guest",
+    "default_app" : false,
+    "created_time" : 1615431764734
+  }, {
+    "user_name" : "test",
+    "role" : "guest",
+    "default_app" : false,
+    "created_time" : 1615364062463
+  }, {
+    "user_name" : "ROOT",
+    "role" : "guest",
+    "default_app" : false,
+    "created_time" : 1617194246328
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: User Management
+
+
+ diff --git a/docs/dms/api-ref/ShowKafkaProjectTags.html b/docs/dms/api-ref/ShowKafkaProjectTags.html new file mode 100644 index 00000000..ca0870e1 --- /dev/null +++ b/docs/dms/api-ref/ShowKafkaProjectTags.html @@ -0,0 +1,122 @@ + + +

Listing Tags of a Project

+

Function

This API is used to query project tags.

+
+

URI

GET /v2/{project_id}/kafka/tags

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of TagMultyValueEntity objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 TagMultyValueEntity

Parameter

+

Type

+

Description

+

key

+

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: =*<>,|/

+

values

+

Array of strings

+

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: =*<>,|/

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/kafka/tags
+
+

Example Responses

Status code: 200

+

The project tags are listed successfully.

+
{
+  "tags" : [ {
+    "key" : "key1",
+    "values" : [ "value-test", "value1" ]
+  }, {
+    "key" : "key2",
+    "values" : [ "value2" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The project tags are listed successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dms/api-ref/ShowKafkaTags.html b/docs/dms/api-ref/ShowKafkaTags.html new file mode 100644 index 00000000..f2510127 --- /dev/null +++ b/docs/dms/api-ref/ShowKafkaTags.html @@ -0,0 +1,131 @@ + + +

Listing Tags of an Instance

+

Function

This API is used to query instance tags.

+
+

URI

GET /v2/{project_id}/kafka/{instance_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of TagEntity objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 TagEntity

Parameter

+

Type

+

Description

+

key

+

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: =*<>,|/

+

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: =*<>,|/

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/kafka/{instance_id}/tags
+
+

Example Responses

Status code: 200

+

The instance tags are listed successfully.

+
{
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The instance tags are listed successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html b/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html new file mode 100644 index 00000000..53ff0010 --- /dev/null +++ b/docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html @@ -0,0 +1,295 @@ + + +

Querying the Disk Usage Status of Topics

+

Function

This API is used to query the broker disk usage of topics.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/topics/diskusage

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

minSize

+

No

+

String

+

Querying partitions by the used disk space. Options: 1 KB, 1 MB and 1 GB. Default value: 1 GB.

+

top

+

No

+

String

+

Querying partitions by top disk usage.

+

percentage

+

No

+

String

+

Querying partitions by the percentage of the used disk space.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

broker_list

+

Array of DiskusageEntity objects

+

Broker list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 DiskusageEntity

Parameter

+

Type

+

Description

+

broker_name

+

String

+

Broker name.

+

data_disk_size

+

String

+

Disk capacity.

+

data_disk_use

+

String

+

Used disk space.

+

data_disk_free

+

String

+

Remaining disk space.

+

data_disk_use_percentage

+

String

+

Message label.

+

status

+

String

+

Message label.

+

topic_list

+

Array of DiskusageTopicEntity objects

+

Disk usage list of the topics.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 DiskusageTopicEntity

Parameter

+

Type

+

Description

+

size

+

String

+

Disk usage.

+

topic_name

+

String

+

Topic name.

+

topic_partition

+

String

+

Partition.

+

percentage

+

Double

+

Percentage of used disk space.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/diskusage
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "broker_list" : [ {
+    "broker_name" : "broker-0",
+    "data_disk_size" : "66G",
+    "data_disk_use" : "53M",
+    "data_disk_free" : "63G",
+    "data_disk_use_percentage" : "1",
+    "status" : "Success get info",
+    "topic_list" : [ {
+      "size" : "12K",
+      "topic_name" : "topic-test",
+      "topic_partition" : "2",
+      "percentage" : 1.7339533025568183E-5
+    }, {
+      "size" : "12K",
+      "topic_name" : "__consumer_offsets",
+      "topic_partition" : "4",
+      "percentage" : 1.7339533025568183E-5
+    }, {
+      "size" : "12K",
+      "topic_name" : "__consumer_offsets",
+      "topic_partition" : "3",
+      "percentage" : 1.7339533025568183E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "__trace",
+      "topic_partition" : "6",
+      "percentage" : 1.1559688683712121E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "__trace",
+      "topic_partition" : "4",
+      "percentage" : 1.1559688683712121E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "__trace",
+      "topic_partition" : "2",
+      "percentage" : 1.1559688683712121E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "__trace",
+      "topic_partition" : "0",
+      "percentage" : 1.1559688683712121E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "topic-test",
+      "topic_partition" : "0",
+      "percentage" : 1.1559688683712121E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "topic-1568537362",
+      "topic_partition" : "2",
+      "percentage" : 1.1559688683712121E-5
+    }, {
+      "size" : "8.0K",
+      "topic_name" : "__consumer_offsets",
+      "topic_partition" : "7",
+      "percentage" : 1.1559688683712121E-5
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/ShowMaintainWindows.html b/docs/dms/api-ref/ShowMaintainWindows.html new file mode 100644 index 00000000..9d608f01 --- /dev/null +++ b/docs/dms/api-ref/ShowMaintainWindows.html @@ -0,0 +1,133 @@ + + +

Listing Maintenance Time Windows

+

Function

This API is used to query the start time and end time of maintenance time windows.

+
+

URI

GET /v2/instances/maintain-windows

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 1 Response body parameters

Parameter

+

Type

+

Description

+

maintain_windows

+

Array of MaintainWindowsEntity objects

+

List of supported maintenance time windows.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 MaintainWindowsEntity

Parameter

+

Type

+

Description

+

default

+

Boolean

+

Whether the maintenance time window is set to the default time segment.

+

end

+

String

+

End time of the maintenance time window.

+

begin

+

String

+

Start time of the maintenance time window.

+

seq

+

Integer

+

Sequence number.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/instances/maintain-windows
+
+

Example Responses

Status code: 200

+

The consumption of the message is successfully acknowledged.

+
{
+  "maintain_windows" : [ {
+    "default" : false,
+    "seq" : 1,
+    "begin" : "22",
+    "end" : "02"
+  }, {
+    "default" : true,
+    "seq" : 2,
+    "begin" : "02",
+    "end" : "06"
+  }, {
+    "default" : false,
+    "seq" : 3,
+    "begin" : "06",
+    "end" : "10"
+  }, {
+    "default" : false,
+    "seq" : 4,
+    "begin" : "10",
+    "end" : "14"
+  }, {
+    "default" : false,
+    "seq" : 5,
+    "begin" : "14",
+    "end" : "18"
+  }, {
+    "default" : false,
+    "seq" : 6,
+    "begin" : "18",
+    "end" : "22"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The consumption of the message is successfully acknowledged.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dms/api-ref/ShowMessages.html b/docs/dms/api-ref/ShowMessages.html new file mode 100644 index 00000000..22fec607 --- /dev/null +++ b/docs/dms/api-ref/ShowMessages.html @@ -0,0 +1,241 @@ + + +

Querying a Message with a Specified Time Period

+

Function

This API is used to query a message with a specified time period.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+

A topic name must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

start_time

+

No

+

String

+

Query start time as a Unix timestamp. Default value: 0.

+

end_time

+

No

+

String

+

Query end time, as a Unix timestamp. Default value: current system time.

+

limit

+

No

+

Integer

+

Number of messages returned on a page. Default value: 10.

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

partition

+

No

+

String

+

Partition number. The default value is -1, indicating that all partitions are queried.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

messages

+

Array of messages objects

+

Message list.

+

messages_count

+

Integer

+

Total number of messages.

+

offsets_count

+

Integer

+

Total number of pages.

+

offset

+

Integer

+

Current page.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 messages

Parameter

+

Type

+

Description

+

topic

+

String

+

Topic name.

+

partition

+

Integer

+

Partition number.

+

message_offset

+

Integer

+

Message offset.

+

size

+

Integer

+

Message size in bytes.

+

timestamp

+

Long

+

Time when a message is created. The value is a Unix timestamp. The unit is millisecond.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
+
+

Example Responses

Status code: 200

+

The message with the specified time period is queried successfully.

+
{
+  "messages" : [ {
+    "topic" : "mytest",
+    "partition" : 0,
+    "message_offset" : 7,
+    "size" : 6,
+    "timestamp" : 1568125036045
+  } ],
+  "messages_count" : 1,
+  "offsets_count" : 1,
+  "offset" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The message with the specified time period is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Message Query
+
+
+ diff --git a/docs/dms/api-ref/ShowPartitionBeginningMessage.html b/docs/dms/api-ref/ShowPartitionBeginningMessage.html new file mode 100644 index 00000000..9fb3238b --- /dev/null +++ b/docs/dms/api-ref/ShowPartitionBeginningMessage.html @@ -0,0 +1,138 @@ + + +

Querying Offset of the Earliest Message in a Partition

+

Function

This API is used to query the offset of the earliest message in a partition.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/beginning-message

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+

A topic name must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits.

+

partition

+

Yes

+

Integer

+

Partition number.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

topic

+

String

+

Topic name.

+

partition

+

Integer

+

Partition number.

+

offset

+

Integer

+

Offset of the latest message.

+

timestamp

+

Long

+

Time when a message is created. The value is a Unix timestamp. The unit is millisecond.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/beginning-message
+
+

Example Responses

Status code: 200

+

The offset of the earliest message in a partition is queried successfully.

+
{
+  "topic" : "mytest",
+  "partition" : 0,
+  "offset" : 9,
+  "timestamp" : 1568125039164
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The offset of the earliest message in a partition is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Message Query
+
+
+ diff --git a/docs/dms/api-ref/ShowPartitionEndMessage.html b/docs/dms/api-ref/ShowPartitionEndMessage.html new file mode 100644 index 00000000..c89d63ca --- /dev/null +++ b/docs/dms/api-ref/ShowPartitionEndMessage.html @@ -0,0 +1,138 @@ + + +

Querying Offset of the Latest Message in a Partition

+

Function

This API is used to query the offset of the latest message in a partition.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/end-message

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+

A topic name must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits.

+

partition

+

Yes

+

Integer

+

Partition number.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

topic

+

String

+

Topic name.

+

partition

+

Integer

+

Partition number.

+

offset

+

Integer

+

Offset of the latest message.

+

timestamp

+

Long

+

Time when a message is created. The value is a Unix timestamp. The unit is millisecond.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/end-message
+
+

Example Responses

Status code: 200

+

The offset of the latest message in a partition is queried successfully.

+
{
+  "topic" : "mytest",
+  "partition" : 0,
+  "offset" : 9,
+  "timestamp" : 1568125039164
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The offset of the latest message in a partition is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Message Query
+
+
+ diff --git a/docs/dms/api-ref/ShowPartitionMessage.html b/docs/dms/api-ref/ShowPartitionMessage.html new file mode 100644 index 00000000..ef1049ea --- /dev/null +++ b/docs/dms/api-ref/ShowPartitionMessage.html @@ -0,0 +1,206 @@ + + +

Querying a Message with a Specified Offset

+

Function

This API is used to query a message with a specified offset.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/message

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+

A topic name must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits.

+

partition

+

Yes

+

Integer

+

Partition number.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

message_offset

+

Yes

+

String

+

Message offset.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

message

+

Array of ShowPartitionMessageEntity objects

+

Message list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ShowPartitionMessageEntity

Parameter

+

Type

+

Description

+

key

+

String

+

Message key.

+

value

+

String

+

Message content.

+

topic

+

String

+

Topic name.

+

partition

+

Integer

+

Partition number.

+

message_offset

+

Long

+

Message offset.

+

size

+

Integer

+

Message size in bytes.

+

timestamp

+

Long

+

Time when a message is created. The value is a Unix timestamp. The unit is millisecond.

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/message?message_offset={message_offset}
+
+

Example Responses

Status code: 200

+

The message with the specified offset is queried successfully.

+
{
+  "message" : [ {
+    "topic" : "mytest",
+    "partition" : 0,
+    "message_offset" : 7,
+    "key" : null,
+    "value" : "kasjdf",
+    "size" : 6,
+    "timestamp" : 1568125036045
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The message with the specified offset is queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Message Query
+
+
+ diff --git a/docs/dms/api-ref/ShowTopicAccessPolicy.html b/docs/dms/api-ref/ShowTopicAccessPolicy.html new file mode 100644 index 00000000..c7ad143c --- /dev/null +++ b/docs/dms/api-ref/ShowTopicAccessPolicy.html @@ -0,0 +1,167 @@ + + +

Querying User Permissions

+

Function

This API is used to query user permissions.

+

User management is supported only when SASL is enabled for the Kafka instance.

+
+

URI

GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic_name

+

Yes

+

String

+

Topic name.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Topic name.

+

topic_type

+

Integer

+

Topic type.

+

policies

+

Array of PolicyEntity objects

+

Permission list.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 3 PolicyEntity

Parameter

+

Type

+

Description

+

owner

+

Boolean

+

Whether the user is the one selected during topic creation.

+

user_name

+

String

+

Username.

+

access_policy

+

String

+

Permission type.

+

  • all: publish and subscribe permissions.

    +

  • pub: publish permissions.

    +

  • sub: subscribe permissions.

    +
+
+
+
+

Example Requests

Querying user permissions for a topic.

+
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "name" : "topic-test",
+  "policies" : [ {
+    "owner" : false,
+    "user_name" : "xxxa",
+    "access_policy" : "pub"
+  }, {
+    "owner" : false,
+    "user_name" : "root",
+    "access_policy" : "all"
+  } ],
+  "topic_type" : 0
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: User Management
+
+
+ diff --git a/docs/dms/api-ref/UpdateInstance.html b/docs/dms/api-ref/UpdateInstance.html new file mode 100644 index 00000000..5d2903f8 --- /dev/null +++ b/docs/dms/api-ref/UpdateInstance.html @@ -0,0 +1,176 @@ + + +

Modifying Instance Information

+

Function

This API is used to modify the instance information.

+
+

URI

PUT /v2/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

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 (-).

+

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 ".

+
+

maintain_begin

+

No

+

String

+

Time at which the maintenance time window starts. The format is HH:mm:ss.

+

  • 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:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: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:00.

    +
+

maintain_end

+

No

+

String

+

Time at which the maintenance time window ends. The format is HH:mm:ss.

+

  • 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:00, the end time is 02:00: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:00.

    +
+

security_group_id

+

No

+

String

+

Security group ID.

+

retention_policy

+

No

+

String

+

Capacity threshold policy. Options:

+

  • produce_reject: New messages cannot be created.

    +

  • time_base: The earliest messages are deleted.

    +
+
+
+
+

Response Parameters

None

+
+

Example Requests

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The instance information is modified successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dms/api-ref/UpdateInstanceAutoCreateTopic.html b/docs/dms/api-ref/UpdateInstanceAutoCreateTopic.html new file mode 100644 index 00000000..49cca0bc --- /dev/null +++ b/docs/dms/api-ref/UpdateInstanceAutoCreateTopic.html @@ -0,0 +1,99 @@ + + +

Configuring Automatic Topic Creation

+

Function

This API is used to enable or disable automatic topic creation.

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

enable_auto_topic

+

Yes

+

Boolean

+

Whether to enable automatic topic creation.

+
+
+
+

Response Parameters

None

+
+

Example Requests

Enabling automatic topic creation.

+
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/autotopic
+
+{
+  "enable_auto_topic" : true
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The function is enabled or disabled successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html b/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html new file mode 100644 index 00000000..2923c6b0 --- /dev/null +++ b/docs/dms/api-ref/UpdateInstanceCrossVpcIp.html @@ -0,0 +1,183 @@ + + +

Modifying the Private IP Address for Cross-VPC Access

+

Function

This API is used to modify the private IP address for cross-VPC access.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/crossvpc/modify

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

advertised_ip_contents

+

Yes

+

Map<String,String>

+

User-defined advertised_ip_contents key-value pair.

+

The key is the listeners IP address.

+

The value is the advertised.listeners IP address or domain name.

+
NOTE:

Fill in the items that are not modified during IP address change.

+
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

success

+

Boolean

+

Result of the cross-VPC access modification.

+

results

+

Array of results objects

+

Details of the result of the cross-VPC access modification.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 results

Parameter

+

Type

+

Description

+

advertised_ip

+

String

+

advertised.listeners IP address or domain name.

+

success

+

Boolean

+

Status of the cross-VPC access modification.

+

ip

+

String

+

Listeners IP address.

+
+
+
+

Example Requests

Modifying the private IP address for cross-VPC access.

+
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/crossvpc/modify
+
+{
+  "advertised_ip_contents" : {
+    "192.168.245.246" : "192.168.245.247",
+    "192.168.197.36" : "192.168.197.38",
+    "192.168.190.11" : "192.168.190.11"
+  }
+}
+
+

Example Responses

Status code: 200

+

The private IP address for cross-VPC access is modified successfully.

+
{
+  "success" : true,
+  "results" : [ {
+    "advertised_ip" : "192.168.197.36",
+    "success" : true,
+    "ip" : "192.168.197.36"
+  }, {
+    "advertised_ip" : "192.168.190.11",
+    "success" : true,
+    "ip" : "192.168.190.11"
+  }, {
+    "advertised_ip" : "192.168.245.255",
+    "success" : true,
+    "ip" : "192.168.245.246"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The private IP address for cross-VPC access is modified successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/UpdateInstanceTopic.html b/docs/dms/api-ref/UpdateInstanceTopic.html new file mode 100644 index 00000000..cd41d2af --- /dev/null +++ b/docs/dms/api-ref/UpdateInstanceTopic.html @@ -0,0 +1,163 @@ + + +

Modifying Topics of a Kafka Instance

+

Function

This API is used to modify topics of a Kafka instance.

+
+

URI

PUT /v2/{project_id}/instances/{instance_id}/topics

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topics

+

No

+

Array of topics objects

+

Topics that were modified.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 topics

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Topic name, which cannot be modified.

+

retention_time

+

No

+

Integer

+

Aging time in hour.

+

sync_replication

+

No

+

Boolean

+

Whether synchronous replication is enabled.

+

sync_message_flush

+

No

+

Boolean

+

Whether synchronous flushing is enabled.

+

new_partition_numbers

+

No

+

Integer

+

Number of the partitions.

+
+
+
+

Response Parameters

None

+
+

Example Requests

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
+
+{
+  "topics" : [ {
+    "id" : "topic-1284340884",
+    "retention_time" : 70,
+    "sync_replication" : false,
+    "sync_message_flush" : false,
+    "new_partition_numbers" : 6
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The modification is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Topic Management
+
+
+ diff --git a/docs/dms/api-ref/UpdateTopicAccessPolicy.html b/docs/dms/api-ref/UpdateTopicAccessPolicy.html new file mode 100644 index 00000000..c9ef580f --- /dev/null +++ b/docs/dms/api-ref/UpdateTopicAccessPolicy.html @@ -0,0 +1,237 @@ + + +

Granting User Permissions

+

Function

This API is used to grant user permissions.

+

User management is supported only when SASL is enabled for the Kafka instance.

+
+

URI

POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topics

+

Yes

+

Array of AccessPolicyTopicEntity objects

+

Topic list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 AccessPolicyTopicEntity

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Topic name.

+

policies

+

Yes

+

Array of AccessPolicyEntity objects

+

Permission list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 AccessPolicyEntity

Parameter

+

Mandatory

+

Type

+

Description

+

user_name

+

No

+

String

+

Username.

+

access_policy

+

No

+

String

+

Permission type.

+

  • all: publish and subscribe permissions.

    +

  • pub: publish permissions.

    +

  • sub: subscribe permissions.

    +
+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error description.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Requests

Granting user permissions.

+
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/accesspolicy
+
+{
+  "topics" : [ {
+    "name" : "topic-test",
+    "policies" : [ {
+      "user_name" : "root",
+      "access_policy" : "all"
+    } ]
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

The update is successful.

+

400

+

Invalid parameters.

+

403

+

Authentication failed.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: User Management
+
+
+ diff --git a/docs/dms/api-ref/UpdateTopicReplica.html b/docs/dms/api-ref/UpdateTopicReplica.html new file mode 100644 index 00000000..b161fed5 --- /dev/null +++ b/docs/dms/api-ref/UpdateTopicReplica.html @@ -0,0 +1,145 @@ + + +

Reassigning Replicas of a Topic for a Kafka Instance

+

Function

This API is used to reassign replicas of a topic for a Kafka instance.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignment

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

topic

+

Yes

+

String

+

Topic name.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

partitions

+

No

+

Array of partitions objects

+

Assignment of replicas of the partition after the change.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 partitions

Parameter

+

Mandatory

+

Type

+

Description

+

partition

+

No

+

Integer

+

Partition ID.

+

replicas

+

No

+

Array of integers

+

ID of the broker where the replica is expected to reside. The first integer in the array represents the leader replica broker ID. All partitions must have the same number of replicas. The number of replicas cannot be larger than the number of brokers.

+
+
+
+

Response Parameters

None

+
+

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignment
+
+{
+  "partitions" : [ {
+    "partition" : 1,
+    "replicas" : [ 1, 2 ]
+  }, {
+    "partition" : 0,
+    "replicas" : [ 0, 1 ]
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The replicas are reassigned successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dms/api-ref/en-us_topic_0036182510.html b/docs/dms/api-ref/en-us_topic_0036182510.html new file mode 100644 index 00000000..969e184f --- /dev/null +++ b/docs/dms/api-ref/en-us_topic_0036182510.html @@ -0,0 +1,8 @@ + + +

Using APIs

+

Public cloud application programming interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/dms/api-ref/kafka-api-0001.html b/docs/dms/api-ref/kafka-api-0001.html new file mode 100644 index 00000000..2dff5022 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-0001.html @@ -0,0 +1,15 @@ + + + +

Out-of-Date APIs

+ +

+
+ +
+ +
+ diff --git a/docs/dms/api-ref/kafka-api-0002.html b/docs/dms/api-ref/kafka-api-0002.html new file mode 100644 index 00000000..d4de502d --- /dev/null +++ b/docs/dms/api-ref/kafka-api-0002.html @@ -0,0 +1,18 @@ + + +

API V1

+

+
+
+ + +
+
Parent topic: Out-of-Date APIs
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-0034672261.html b/docs/dms/api-ref/kafka-api-0034672261.html new file mode 100644 index 00000000..f1240cdb --- /dev/null +++ b/docs/dms/api-ref/kafka-api-0034672261.html @@ -0,0 +1,325 @@ + + +

Status Code

+

Table 1 lists status codes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Status codes

Status Code

+

Name

+

Description

+

100

+

Continue

+

The server has received the initial part of the request and the client should continue to send the remaining part.

+

101

+

Switching Protocols

+

The requester has asked the server to switch protocols and the server has agreed to do so. The target protocol must be more advanced than the source protocol.

+

For example, the current HTTP protocol is switched to a later version of HTTP.

+

200

+

OK

+

Request sent successfully.

+

201

+

Created

+

The request has been fulfilled, resulting in the creation of a new resource.

+

202

+

Accepted

+

The request has been accepted for processing, but the processing has not been completed.

+

203

+

Non-Authoritative Information

+

The request has been fulfilled.

+

204

+

NoContent

+

The server has successfully processed the request, but is not returning any response body.

+

The status code is returned in response to an HTTP OPTIONS request.

+

205

+

Reset Content

+

The server has fulfilled the request, but the requester is required to reset the content.

+

206

+

Partial Content

+

The server has successfully processed a part of the GET request.

+

300

+

Multiple Choices

+

There are multiple options for the requested resource. For example, this code could be used to present a list of resource characteristics and addresses from which the client such as a browser may choose.

+

301

+

Moved Permanently

+

This and all future requests have been permanently moved to the given URI indicated in this response.

+

302

+

Found

+

The requested resource was temporarily moved.

+

303

+

See Other

+

The response to the request can be found under another URI using a GET or POST method.

+

304

+

Not Modified

+

The requested resource has not been modified. When the server returns this status code, it does not return any resources.

+

305

+

Use Proxy

+

The requested resource is available only through a proxy.

+

306

+

Unused

+

This HTTP status code is no longer used.

+

400

+

BadRequest

+

Invalid request.

+

The client should modify the request instead of re-initiating it.

+

401

+

Unauthorized

+

The authorization information provided by the client is incorrect or invalid.

+

402

+

Payment Required

+

Reserved for future use.

+

403

+

Forbidden

+

The server has received the request and understood it, but the server is refusing to respond to it.

+

The client should modify the request instead of re-initiating it.

+

404

+

NotFound

+

The requested resource cannot be found.

+

The client should modify the request instead of re-initiating it.

+

405

+

MethodNotAllowed

+

A request method is not supported for the requested resource.

+

The client should modify the request instead of re-initiating it.

+

406

+

Not Acceptable

+

The server cannot fulfill the request based on the content characteristics of the request.

+

407

+

Proxy Authentication Required

+

This code is similar to 401, but indicates that the client must first authenticate itself with the proxy.

+

408

+

Request Time-out

+

The server timed out when waiting for the request.

+

The client may re-initiate the request without any modification at any time.

+

409

+

Conflict

+

The request cannot be processed due to a conflict, such as an edit conflict between multiple simultaneous updates or the resource that the client attempts to create already exits.

+

410

+

Gone

+

The requested resource has been deleted permanently and will not be available again.

+

411

+

Length Required

+

The server refused to process the request because the request does not specify the length of its content.

+

412

+

Precondition Failed

+

The server does not meet one of the preconditions that the requester puts on the request.

+

413

+

Request Entity Too Large

+

The server refuses to process a request because the request is too large. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a Retry-After field.

+

414

+

Request-URI Too Large

+

The URI provided was too long for the server to process.

+

415

+

Unsupported Media Type

+

The server does not support the media type in the request.

+

416

+

Requested range not satisfiable

+

The requested range is invalid.

+

417

+

Expectation Failed

+

The server fails to meet the requirements of the Expect request-header field.

+

422

+

UnprocessableEntity

+

The request is well-formed but is unable to be processed due to semantic errors.

+

429

+

TooManyRequests

+

The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, the client should re-initiate requests after the time specified in the Retry-After header of the response expires.

+

500

+

InternalServerError

+

The server is able to receive the request but it could not understand the request.

+

501

+

Not Implemented

+

The server does not support the requested function.

+

502

+

Bad Gateway

+

The server was acting as a gateway or proxy and received an invalid request from a remote server.

+

503

+

ServiceUnavailable

+

The requested service is invalid.

+

The client should modify the request instead of re-initiating it.

+

504

+

ServerTimeout

+

The request cannot be fulfilled within a given time. The response will reach the client only if the request carries the timeout parameter.

+

505

+

HTTP Version not supported

+

The server does not support the HTTP protocol version used in the request.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-0034672268.html b/docs/dms/api-ref/kafka-api-0034672268.html new file mode 100644 index 00000000..a5f8091f --- /dev/null +++ b/docs/dms/api-ref/kafka-api-0034672268.html @@ -0,0 +1,127 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Released On

+

What's New

+

2022-10-30

+

Modified the following content:

+ +

2020-08-11

+

Modified the following content:

+ +

2020-07-29

+

Modified the following content:

+ +

2020-02-20

+

Modified the following content:

+ +

2019-11-08

+

Modified the following content:

+
  • Added APIs for Kafka premium instances in chapter "Instance Management APIs V1."
+

2018-11-07

+

Accepted in OTC 3.2.

+

2018-05-24

+

Added the following content:

+
  • Accepted in OTC 3.1.
  • Added chapter Getting Started with DMS RESTful APIs.
+

2018-04-28

+

Added the following content:

+
  • Added APIs for managing queue tags in chapter "Tag Management APIs V1".
+

2018-03-29

+

Modified the following content:

+
  • Updated Example request in section "Creating a Queue".
  • Modified Response parameters and Example response in section "Creating a Queue".
  • Revised the descriptions of the KAFKA_HA and KAFKA_HT parameters in section "Creating a Queue".
+

2018-01-30

+

Accepted in OTC 3.0.

+

2018-01-19

+

Added the following content:

+
  • Added description of the Kafka queue.
+

2017-11-01

+

Modified the following content:

+
  • Added description of the ack_wait parameter in section "Consuming Messages".
  • Added description of the ack_wait parameter in section "Consuming Dead Letter Messages".
+

2017-10-13

+

Modified the following content:

+
  • Updated description of the available_deadletters parameter in section "Viewing All Consumer Groups of a Specified Queue".
+

2017-08-18

+

Added the following content:

+
  • Added description in section "Acknowledging Consumption of Specified Messages".
+

2017-07-28

+

Added the following content:

+
  • Added description of the queue_mode parameter in section "Creating a Queue".
  • Added parameters of dead letter queues in sections "Creating a Queue", "Viewing All Queues", and "Viewing a Queue".
  • Added sections "Consuming Dead Letter Messages" and "Acknowledging Consumption of Specified Messages".
+

2017-04-27

+

Modified the following content:

+
  • Added description of the time_wait parameter in section "Consuming Messages".
+

2017-02-03

+

Modified the following content:

+
  • Updated description in section "Consuming Messages".
  • Updated description in section "Acknowledging Consumption of Specified Messages".
  • Added section Error Codes.
+
  • Added a note about error messages returned due to incorrect endpoints or URIs.
+

2017-01-13

+

Added the following content:

+
  • Added description of the response parameter produced_messages in section "Viewing All Queues".
  • Added description of the response parameter produced_messages in section "Viewing a Queue".
+

2016-12-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514001.html b/docs/dms/api-ref/kafka-api-180514001.html new file mode 100644 index 00000000..43f263e9 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514001.html @@ -0,0 +1,31 @@ + + +

APIs for Managing Instances

+
+
+ + +
+
Parent topic: API V1
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514002.html b/docs/dms/api-ref/kafka-api-180514002.html new file mode 100644 index 00000000..e4962a87 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514002.html @@ -0,0 +1,435 @@ + + +

Creating an Instance

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Creating an Instance.

+
+

Function

This API is used to create a Kafka instance.

+
+

URI

POST /v1.0/{project_id}/instances

+

Table 1 describes the parameter.

+ +
+ + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+
+
+
+

Request

Request parameters

+

Table 2 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request parameters

Parameter

+

Type

+

Mandatory

+

Description

+

name

+

String

+

Yes

+

Indicates the 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

+

String

+

No

+

Indicates the description of an instance.

+

It is a character string containing not more than 1024 characters.

+
NOTE:

The backslash (\) and quotation mark (") are special characters for JSON packets. When using these characters in a parameter value, add the escape character (\) before these characters, for example, \\ and \".

+
+

engine

+

String

+

Yes

+

Indicates the message engine. Set the value to kafka.

+

engine_version

+

String

+

Yes

+

Indicates the version of the message engine. Value: 1.1.0 or 2.3.0.

+

specification

+

String

+

Yes

+

Indicates the baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. Unit: MB

+

Options:

+
  • 100MB
  • 300MB
  • 600MB
  • 1200MB
+

storage_space

+

Integer

+

Yes

+

Indicates the message storage space.

+

Unit: GB. Value range:

+
  • 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

+

Integer

+

Yes

+

Indicates the maximum number of partitions in a Kafka instance.

+

Options:

+
  • When specification is 100MB: 300
  • When specification is 300MB: 900
  • When specification is 600MB: 1800
  • When specification is 1200 MB: 1800
+

access_user

+

String

+

No

+

This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.

+

Indicates a username. A username consists of 4 to 64 characters and can contain letters, digits, and hyphens (-).

+

password

+

String

+

No

+

This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false.

+

Indicates an instance password.

+

The password must meet the following complexity requirements:

+
  • Must be a string consisting of 8 to 32 characters.
  • Must contain at least three of the following character types:
    • Lowercase letters
    • Uppercase letters
    • Digits
    • Special characters `~!@#$%^&*()-_=+\|[{}];:',<.>/?
    +
+

vpc_id

+

String

+

Yes

+

Indicates the VPC ID.

+

Obtain the value by using either of the following methods:

+
  • Method 1: Log in to VPC console and view the VPC ID in the VPC details.
  • Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the Virtual Private Cloud API Reference.
+

security_group_id

+

String

+

Yes

+

Indicates the security group which the instance belongs to.

+

Obtain the value by using either of the following methods:

+
  • Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
  • Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
+

subnet_id

+

String

+

Yes

+

Indicates the subnet ID.

+

Obtain the value by using either of the following methods:

+
  • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.
  • Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the Virtual Private Cloud API Reference.
+

available_zones

+

Array

+

Yes

+

Indicates the ID of the AZ where brokers reside and which has available resources. The parameter value cannot be an empty array or an empty array. For details on how to obtain the value, see Querying AZ Information. Check whether the AZ has available resources.

+

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. Example parameter settings:

+
  • One AZ: "available_zones": [ "a0865121f83b41cbafce65930a22a6e8" ]
  • Three or more AZs: "available_zones": ["a0865121f83b41cbafce65930a22a6e8","a0865121f83b41cbafce65930a22a6e7","a0865121f83b41cbafce65930a22a6e6"]
+

product_id

+

String

+

Yes

+

Indicates the product ID.

+

For details on how to obtain the ID, see Querying Product Specifications.

+

maintain_begin

+

String

+

No

+

Indicates the time at which a maintenance time window starts.

+

Format: HH:mm:ss

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Windows.
  • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: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 sets the start time to 02:00:00.
+

maintain_end

+

String

+

No

+

Indicates the time at which a maintenance time window ends.

+

Format: HH:mm:ss

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Windows.
  • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
  • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank. In this case, the system automatically sets the end time to 06:00:00.
+

enable_publicip

+

Boolean

+

No

+

Indicates whether to enable public access for an instance.

+
  • true: enable
  • false: disable
+

public_bandwidth

+

String

+

No

+

Indicates the 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.
+

publicip_id

+

String

+

No

+

Indicates the 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).

+

ssl_enable

+

Boolean

+

No

+

Indicates whether to enable SSL-encrypted access.

+
  • true: enable
  • false: disable
+

retention_policy

+

String

+

No

+

Indicates the action to be taken when the memory usage reaches the disk capacity threshold. Options:

+
  • time_base: Automatically delete the earliest messages.
  • produce_reject: Stop producing new messages.
+

enable_auto_topic

+

Boolean

+

No

+

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.

+

storage_spec_code

+

String

+

Yes

+

Indicates storage I/O specification.

+

Options:

+
  • dms.physical.storage.high or dms.physical.storage.ultra when the parameter specification is 100MB
  • dms.physical.storage.high or dms.physical.storage.ultra when the parameter specification is 300MB
  • dms.physical.storage.ultra when the parameter specification is 600MB
  • dms.physical.storage.ultra when the parameter specification is 1200MB
+

tags

+

Array<Object>

+

No

+

Indicates the list of tags.

+

disk_encrypted_enable

+

Boolean

+

No

+

Indicates whether to enable disk encryption.

+
  • true: enable
  • false: disable
+

disk_encrypted_key

+

String

+

No

+

Indicates the ID of the KMS key if disk encryption is enabled.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 tags

Parameter

+

Type

+

Mandatory

+

Description

+

key

+

String

+

No

+

Indicates the tag key. A tag key 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: =*<>\,|/

+

value

+

String

+

No

+

Indicates the value. A tag value 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: =*<>\,|/

+
+
+
POST https://{dms_endpoint}/v1.0/{project_id}/instances
+
+{
+	"name": "kafka-test",
+	"description": "",
+	"engine": "kafka",
+	"engine_version": "2.3.0",
+	"storage_space": 600,
+	"access_user": "",
+	"password": "",
+	"vpc_id": "1e93f86e-13af-46c8-97d6-d40fa62b76c2",
+	"security_group_id": "0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8",
+	"subnet_id": "b5fa806c-35e7-4299-b659-b39398dd4718",
+	"available_zones": ["d5731xxxb44b0"],
+	"product_id": "00300-30308-0--0",
+	"maintain_begin": "22:00",
+	"maintain_end": "02:00",
+	"ssl_enable": false,
+	"enable_publicip": false,
+	"publicip_id": "",
+	"specification": "100MB",
+	"partition_num": "300",
+	"retention_policy": "produce_reject",
+	"storage_spec_code": "dms.physical.storage.ultra"
+}
+
+

Response

Response parameters

+

Table 4 describes the parameters.

+ +
+ + + + + + + + + +
Table 4 Response parameters

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Indicates the instance ID.

+
+
+

Example response

+
{  
+    "instance_id": "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"  
+}
+
+

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

The instance is created successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514003.html b/docs/dms/api-ref/kafka-api-180514003.html new file mode 100644 index 00000000..6a9da74d --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514003.html @@ -0,0 +1,570 @@ + + +

Querying an Instance

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Querying an Instance.

+
+

Function

This API is used to query the details about an instance.

+
+

URI

GET /v1.0/{project_id}/instances/{instance_id}

+

Table 1 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

instance_id

+

String

+

Yes

+

Indicates the instance ID.

+
+
+
+

Request

Request parameters

+

None.

+

Example request

+
GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
+
+

Response

Response parameters

+

Table 2 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Indicates the instance name.

+

engine

+

String

+

Indicates the message engine.

+

engine_version

+

String

+

Indicates the version of the message engine.

+

specification

+

String

+

Indicates the instance specification.

+

storage_space

+

Integer

+

Indicates the message storage space. Unit: GB

+

partition_num

+

String

+

Indicates the total number of partitions in a Kafka instance.

+

used_storage_space

+

Integer

+

Indicates the used message storage space. Unit: GB

+

connect_address

+

String

+

Indicates the IP address of an instance.

+

port

+

Integer

+

Indicates the port number of an instance.

+

status

+

String

+

Indicates the status of an instance. For details, see Instance Status.

+

instance_id

+

String

+

Indicates the instance ID.

+

resource_spec_code

+

String

+

Indicates the resource specifications identifier.

+
  • dms.instance.kafka.cluster.c3.mini: Kafka instance, 100 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.small.2: Kafka instance, 300 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.middle.2: Kafka instance, 600 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.high.2: Kafka instance, 1200 MB/s reference bandwidth
+

type

+

String

+

Indicates the instance type. Value: cluster

+

charging_mode

+

Integer

+

Indicates the billing mode.

+

vpc_id

+

String

+

Indicates the ID of a VPC.

+

vpc_name

+

String

+

Indicates the name of a VPC.

+

created_at

+

String

+

Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

+

product_id

+

String

+

Indicates the product ID.

+

security_group_id

+

String

+

Indicates the security group ID.

+

security_group_name

+

String

+

Indicates the security group name.

+

subnet_id

+

String

+

Indicates the subnet ID.

+

subnet_name

+

String

+

Indicates the subnet name.

+

subnet_cidr

+

String

+

Indicates the subnet CIDR block.

+

available_zones

+

Array

+

Indicates the ID of the AZ to which the instance node belongs. The AZ ID is returned.

+

user_id

+

String

+

Indicates the user ID.

+

user_name

+

String

+

Indicates the username.

+

access_user

+

String

+

Indicates the username of an instance.

+

maintain_begin

+

String

+

Indicates the time at which a maintenance time window starts.

+

Format: HH:mm:ss

+

maintain_end

+

String

+

Indicates the time at which a maintenance time window ends.

+

Format: HH:mm:ss

+

enable_publicip

+

Boolean

+

Indicates whether to enable public access for an instance.

+
  • true: enable
  • false: disable
+

ssl_enable

+

Boolean

+

Indicates whether to enable security authentication.

+
  • true: enable
  • false: disable
+

extend_times

+

Integer

+

Indicates the number of disk expansion times. If it exceeds 20, the disk cannot be expanded.

+

enable_auto_topic

+

Boolean

+

Indicates whether automatic topic creation is enabled.

+
  • true: enabled
  • false: disabled
+

total_storage_space

+

Integer

+

Indicates the message storage space. Unit: GB

+

storage_resource_id

+

String

+

Indicates the storage resource ID.

+

storage_spec_code

+

String

+

Indicates the I/O specification.

+

service_type

+

String

+

Indicates the service type.

+

storage_type

+

String

+

Indicates the storage type.

+

retention_policy

+

String

+

Indicates the message retention policy.

+

kafka_public_status

+

String

+

Indicates whether Kafka public access is enabled.

+

public_bandwidth

+

Integer

+

Indicates the public network bandwidth.

+

public_connect_address

+

String

+

Indicates the instance IP address for public access. This parameter is displayed only when public access is enabled.

+

enable_log_collection

+

Boolean

+

Indicates whether log collection is enabled.

+

cross_vpc_info

+

String

+

Indicates cross-VPC access information.

+

ipv6_enable

+

Boolean

+

Indicates whether IPv6 is enabled.

+

ipv6_connect_addresses

+

Array of strings

+

Indicates the IPv6 connection address.

+

rest_enable

+

Boolean

+

Indicates whether the Kafka REST function is enabled.

+

rest_connect_address

+

String

+

Indicates the Kafka REST connection address.

+

message_query_inst_enable

+

Boolean

+

Indicates whether message query is enabled.

+

vpc_client_plain

+

Boolean

+

Indicates whether intra-VPC plaintext access is enabled.

+

support_features

+

String

+

Indicates the list of features supported by the Kafka instance.

+

trace_enable

+

Boolean

+

Indicates whether message tracing is enabled.

+

pod_connect_address

+

String

+

Indicates the connection address on the tenant side.

+

disk_encrypted

+

Boolean

+

Indicates whether disk encryption is enabled.

+
  • true: enabled
  • false: disabled
+

disk_encrypted_key

+

String

+

Indicates the ID of the KMS key if disk encryption is enabled.

+

kafka_private_connect_address

+

String

+

Indicates the private connection address of a Kafka instance.

+

ces_version

+

String

+

Indicates the Cloud Eye version.

+

tags

+

Array<Object>

+

Indicates the list of tags.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 tags

Parameter

+

Type

+

Description

+

key

+

String

+

Indicates the tag key.

+

value

+

String

+

Indicates the tag value.

+
+
+

Example response

+
{
+    "name": "kafka-test",
+    "engine": "kafka",
+    "port": 9093,
+    "status": "RUNNING",
+    "type": "cluster",
+    "specification": "100MB",
+    "engine_version": "2.3.0",
+    "connect_address": "192.168.1.239,192.168.1.126,192.168.1.176",
+    "instance_id": "8354dde6-8229-4ff4-844d-ab7121be9745",
+    "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
+    "charging_mode": 1,
+    "vpc_id": "aaa5c155-7a9a-4d92-a804-e19cadcbca63",
+    "vpc_name": "vpc-3a7f",
+    "created_at": "1572866120990",
+    "product_id": "00300-30308-0--0",
+    "security_group_id": "3283b880-2256-498c-aa70-154f08f65331",
+    "security_group_name": "Default_All",
+    "subnet_id": "598d6280-a437-4c2f-9870-a4fc80e7ba66",
+    "subnet_name": "subnet-3a7f",
+    "subnet_cidr": "192.168.1.0/24",
+    "available_zones": [
+        "xxx"
+    ],
+    "user_id": "674f286936eb47f28f4fa54b130d4db9",
+    "user_name": "hby-cwx522020",
+    "access_user": "root",
+    "maintain_begin": "22:00:00",
+    "maintain_end": "02:00:00",
+    "storage_space": 492,
+    "total_storage_space": 600,
+    "used_storage_space": 25,
+    "partition_num": "300",
+    "enable_publicip": false,
+    "ssl_enable": true,
+    "storage_resource_id": "3d737481-04d7-4874-a04b-2b3d884eab99",
+    "storage_spec_code": "dms.physical.storage.ultra",
+    "service_type": "advanced",
+    "storage_type": "hec",
+    "retention_policy": "time_base",
+    "kafka_public_status": "closed",
+    "public_boundwidth": 0
+    "disk_encrypted": false
+}
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

Specified instance queried successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514004.html b/docs/dms/api-ref/kafka-api-180514004.html new file mode 100644 index 00000000..f1836ddc --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514004.html @@ -0,0 +1,165 @@ + + +

Modifying an Instance

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Modifying Instance Information.

+
+

Function

This API is used to modify the instance information, including the instance name, description, maintenance window, and security group.

+
+

URI

PUT /v1.0/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

instance_id

+

String

+

Yes

+

Indicates the instance ID.

+
+
+
+

Request

Request parameters

+

Table 2 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request parameters

Parameter

+

Type

+

Mandatory

+

Description

+

name

+

String

+

No

+

Indicates the instance name.

+

An instance name consists of 4 to 64 characters including letters, digits, and hyphens (-) and must start with a letter.

+

description

+

String

+

No

+

Indicates the description of an instance.

+

It is a character string containing not more than 1024 characters.

+
NOTE:

The backslash (\) and quotation mark (") are special characters for JSON packets. When using these characters in a parameter value, add the escape character (\) before these characters, for example, \\ and \".

+
+

maintain_begin

+

String

+

No

+

Indicates the time at which a maintenance time window starts.

+

Format: HH:mm:ss

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Windows.
  • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: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 sets the start time to 02:00:00.
+

maintain_end

+

String

+

No

+

Indicates the time at which a maintenance time window ends.

+

Format: HH:mm:ss

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Windows.
  • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00: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 sets the end time to 06:00:00.
+

security_group_id

+

String

+

No

+

Indicates the security group ID.

+

retention_policy

+

String

+

No

+

Indicates the capacity threshold policy. Options:

+
  • produce_reject: New messages cannot be created.
  • time_base: The earliest messages are deleted.
+
+
+

Example request

+

Example 1:

+
PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
+{  
+    "name": "dms002",  
+    "description": "instance description"  
+}
+

Example 2:

+
PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
+{ 
+     "name": "dms002",   
+     "description": "instance description", 
+     "maintain_begin":"02:00:00", 
+     "maintain_end":"06:00:00" 
+}
+
+

Response

Response parameters

+

None.

+

Example response

+

None.

+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

204

+

The instance is modified successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514005.html b/docs/dms/api-ref/kafka-api-180514005.html new file mode 100644 index 00000000..1a30ee23 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514005.html @@ -0,0 +1,76 @@ + + +

Deleting an Instance

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Deleting an Instance.

+
+

Function

This API is used to delete an instance to release all the resources occupied by it.

+
+

URI

DELETE /v1.0/{project_id}/instances/{instance_id}

+

Table 1 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

instance_id

+

String

+

Yes

+

Indicates the instance ID.

+
+
+
+

Request

Request parameters

+

None.

+

Example request

+
DELETE https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
+
+

Response

Response parameters

+

None.

+

Example response

+

None.

+
+

Status Code

Table 2 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 2 Status code

Status Code

+

Description

+

204

+

The instance is deleted successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514006.html b/docs/dms/api-ref/kafka-api-180514006.html new file mode 100644 index 00000000..e84c71b4 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514006.html @@ -0,0 +1,188 @@ + + +

Restarting or Deleting Instances in Batches

+

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.

+
+

Function

This API is used to restart or delete instances in batches.

+

When an instance is being restarted, message retrieval and creation requests of the client will be rejected.

+

Deleting an instance will delete the data in the instance without any backup. Exercise caution when performing this operation.

+
+

URI

POST /v1.0/{project_id}/instances/action

+

Table 1 describes the parameters.

+ +
+ + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+
+
+
+

Request

Request parameters

+

Table 2 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request parameters

Parameter

+

Type

+

Mandatory

+

Description

+

action

+

String

+

Yes

+

Indicates the operation to be performed on instances. The value of this parameter can be restart or delete.

+

instances

+

Array

+

No

+

Indicates the list of instance IDs.

+

allFailure

+

String

+

No

+

When set to kafka, indicates all Kafka instances that fail to be created are to be deleted.

+
+
+

Example request

+

Restarting instances in batches:

+
POST https://{dms_endpoint}/v1.0/{project_id}/instances/action
+{ 
+    "action" : "restart", 
+    "instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"] 
+}
+

Deleting instances in batches:

+
POST https://{dms_endpoint}/v1.0/{project_id}/instances/action
+{ 
+    "action" : "delete", 
+    "instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"] 
+}
+

Deleting all instances that fail to be created:

+
POST https://{dms_endpoint}/v1.0/{project_id}/instances/action
+{ 
+    "action" : "delete", 
+    "allFailure" : "kafka"
+}
+
+

Response

Response parameters

+

When action is set to delete, allFailure is set to kafka, and an empty response is returned, the instances are deleted successfully. Table 3 describes the parameters.

+ +
+ + + + + + + + + +
Table 3 Response parameters

Parameter

+

Type

+

Description

+

results

+

Array

+

Indicates the result of instance modification.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 results parameter description

Parameter

+

Type

+

Description

+

instance

+

String

+

Indicates the instance ID.

+

result

+

String

+

Indicates an operation result, which can be success or failed

+
+
+

Example response

+
{ 
+    "results": [ 
+        { 
+            "result": "success", 
+            "instance": "afc90a2a-a02c-4cba-94d5-58dfa9ad1e0d" 
+        }, 
+        { 
+            "result": "success", 
+            "instance": "67fc5f8d-3986-4f02-bb75-4075a23112de" 
+        } 
+    ] 
+}
+
+

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

The instances are restarted or deleted successfully.

+

204

+

Successfully deleting an instance failed to be created.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514007.html b/docs/dms/api-ref/kafka-api-180514007.html new file mode 100644 index 00000000..16181827 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514007.html @@ -0,0 +1,632 @@ + + +

Querying All Instances

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Listing All Instances.

+
+

Function

This API is used to query the instances of a tenant by set conditions.

+
+

URI

GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}

+

Table 1 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

engine

+

String

+

No

+

Indicates the message engine. Value: kafka

+

name

+

String

+

No

+

Indicates the instance name.

+

id

+

String

+

No

+

Indicates the instance ID.

+

status

+

String

+

No

+

Indicates the instance status. For details, see Instance Status.

+

includeFailure

+

String

+

No

+

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 not true, the number is not returned.

+

exactMatchName

+

String

+

No

+

Indicates whether to search for the instance that precisely matches a specified instance name.

+

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.

+
+
+
+

Request

Request parameters

+

None.

+

Example request

+
GET https://{dms_endpoint}/v1.0/{project_id}/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false
+
+

Response

Response parameters

+

Table 2 describes the parameters.

+ +
+ + + + + + + + + + + + + +
Table 2 Response parameters

Parameter

+

Type

+

Description

+

instances

+

Array

+

Indicates instance details.

+

instance_num

+

Integer

+

Indicates the number of instances.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 instance parameter description

Parameter

+

Type

+

Description

+

name

+

String

+

Indicates the instance name.

+

engine

+

String

+

Indicates the message engine.

+

engine_version

+

String

+

Indicates the engine version.

+

specification

+

String

+

Indicates the specifications of an instance.

+

storage_space

+

Integer

+

Indicates the message storage space. Unit: GB

+

partition_num

+

String

+

Indicates the maximum number of topics in a Kafka instance.

+

used_storage_space

+

Integer

+

Indicates the used message storage space. Unit: GB

+

connect_address

+

String

+

Indicates the IP address of an instance.

+

port

+

Integer

+

Indicates the port number of an instance.

+

status

+

String

+

Indicates the status of an instance. For details, see Instance Status.

+

instance_id

+

String

+

Indicates the instance ID.

+

resource_spec_code

+

String

+

Indicates the resource specifications identifier.

+
  • dms.instance.kafka.cluster.c3.mini: Kafka instance, 100 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.small.2: Kafka instance, 300 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.middle.2: Kafka instance, 600 MB reference bandwidth
  • dms.instance.kafka.cluster.c3.high.2: Kafka instance, 1200 MB reference bandwidth
+

charging_mode

+

Integer

+

Billing mode.

+

vpc_id

+

String

+

Indicates the ID of a VPC.

+

vpc_name

+

String

+

Indicates the name of a VPC.

+

created_at

+

String

+

Indicates the time when an instance is created.

+

The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

+

user_id

+

String

+

Indicates the user ID.

+

user_name

+

String

+

Indicates the username.

+

maintain_begin

+

String

+

Indicates the time at which a maintenance time window starts.

+

Format: HH:mm:ss

+

maintain_end

+

String

+

Time at which the maintenance time window ends.

+

Format: HH:mm:ss

+

enable_publicip

+

Boolean

+

Indicates whether to enable public access for an instance.

+
  • true: enable
  • false: disable
+

ssl_enable

+

Boolean

+

Indicates whether to enable security authentication.

+
  • true: enable
  • false: disable
+

extend_times

+

Integer

+

Indicates the number of disk expansion times. If it exceeds 20, the disk cannot be expanded.

+

enable_auto_topic

+

Boolean

+

Indicates whether automatic topic creation is enabled.

+
  • true: enabled
  • false: disabled
+

type

+

String

+

Indicates the instance type. Value: cluster.

+

product_id

+

String

+

Indicates the product ID.

+

security_group_id

+

String

+

Indicates the security group ID.

+

security_group_name

+

String

+

Indicates the security group name.

+

subnet_id

+

String

+

Indicates the subnet ID.

+

available_zones

+

Array

+

Indicates the AZ to which the instance node belongs. The AZ ID is returned.

+

total_storage_space

+

Integer

+

Indicates the message storage space. Unit: GB

+

public_connect_address

+

String

+

Indicates the instance IP address for public access. This parameter is displayed only when public access is enabled.

+

storage_resource_id

+

String

+

Indicates the storage resource ID.

+

storage_spec_code

+

String

+

Indicates the I/O specification.

+

service_type

+

String

+

Indicates the service type.

+

storage_type

+

String

+

Indicates the storage type.

+

retention_policy

+

String

+

Indicates the message retention policy.

+

kafka_public_status

+

String

+

Indicates whether Kafka public access is enabled.

+

public_bandwidth

+

Integer

+

Indicates the public network bandwidth.

+

enable_log_collection

+

Boolean

+

Indicates whether log collection is enabled.

+

cross_vpc_info

+

String

+

Indicates cross-VPC access information.

+

ipv6_enable

+

Boolean

+

Indicates whether IPv6 is enabled.

+

ipv6_connect_addresses

+

Array of strings

+

Indicates the IPv6 connection address.

+

rest_enable

+

Boolean

+

Indicates whether the Kafka REST function is enabled.

+

rest_connect_address

+

String

+

Indicates the Kafka REST address.

+

message_query_inst_enable

+

Boolean

+

Indicates whether message query is enabled.

+

vpc_client_plain

+

Boolean

+

Indicates whether intra-VPC plaintext access is enabled.

+

support_features

+

String

+

Indicates the list of features supported by the Kafka instance.

+

trace_enable

+

Boolean

+

Indicates whether message tracing is enabled.

+

pod_connect_address

+

String

+

Indicates the connection address on the tenant side.

+

disk_encrypted

+

Boolean

+

Indicates whether disk encryption is enabled.

+

disk_encrypted_key

+

String

+

Indicates the ID of the KMS key if disk encryption is enabled.

+

public_resource_id

+

String

+

Indicates the public network resource ID.

+

This parameter is returned only when public access is enabled for the instance.

+

kafka_private_connect_address

+

String

+

Indicates the private connection address of a Kafka instance.

+

ces_version

+

String

+

Indicates the Cloud Eye version.

+

tags

+

Array<Object>

+

Indicates the list of tags.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 tags

Parameter

+

Type

+

Description

+

key

+

String

+

Indicates the tag key.

+

value

+

String

+

Indicates the tag value.

+
+
+

Example response

+
{
+    "instances": [
+        {
+            "name": "kafka-lxy-test",
+            "engine": "kafka",
+            "port": 9093,
+            "status": "RUNNING",
+            "type": "cluster",
+            "specification": "100MB",
+            "engine_version": "2.3.0",
+            "connect_address": "192.168.1.239,192.168.1.126,192.168.1.176",
+            "instance_id": "8354dde6-8229-4ff4-844d-ab7121be9745",
+            "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
+            "charging_mode": 1,
+            "vpc_id": "aaa5c155-7a9a-4d92-a804-e19cadcbca63",
+            "vpc_name": "vpc-3a7f",
+            "created_at": "1572866120990",
+            "product_id": "00300-30308-0--0",
+            "security_group_id": "3283b880-2256-498c-aa70-154f08f65331",
+            "security_group_name": "Default_All",
+            "subnet_id": "598d6280-a437-4c2f-9870-a4fc80e7ba66",
+            "available_zones": [
+                "xxx"
+            ],
+            "user_id": "674f286936eb47f28f4fa54b130d4db9",
+            "user_name": "hby-cwx522020",
+            "access_user": "root",
+            "maintain_begin": "22:00:00",
+            "maintain_end": "02:00:00",
+            "storage_space": 492,
+            "total_storage_space": 600,
+            "used_storage_space": 25,
+            "partition_num": "300",
+            "enable_publicip": false,
+            "ssl_enable": true,
+            "storage_resource_id": "3d737481-04d7-4874-a04b-2b3d884eab99",
+            "storage_spec_code": "dms.physical.storage.ultra",
+            "service_type": "advanced",
+            "storage_type": "hec",
+            "retention_policy": "time_base",
+            "kafka_public_status": "closed",
+            "public_boundwidth": 0
+	    "disk_encrypted": false
+        }   
+    ],
+    "instance_num": 1}
+
+

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

All instances are queried successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514008.html b/docs/dms/api-ref/kafka-api-180514008.html new file mode 100644 index 00000000..d1a01f2e --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514008.html @@ -0,0 +1,142 @@ + + +

Querying AZ Information

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Listing AZ Information.

+
+

Function

This API is used to query the AZ ID.

+
+

URI

GET /v1.0/availableZones

+
+

Request

Request parameters

+

None.

+

Example request

+
GET https://{dms_endpoint}/v1.0/availableZones
+
+

Response

Response parameters

+

Table 1 and Table 2 describe the parameters.

+ +
+ + + + + + + + + + + + + +
Table 1 Response parameters

Parameter

+

Type

+

Description

+

region_id

+

String

+

Indicates the region ID.

+

available_zones

+

Array

+

Indicates details of AZs. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 available_zones parameter description

Parameter

+

Type

+

Description

+

soldOut

+

Boolean

+

Indicates whether resources are sold out.

+

id

+

String

+

Indicates the ID of an AZ.

+

code

+

String

+

Indicates the code of an AZ.

+

name

+

String

+

Indicates the name of an AZ.

+

port

+

String

+

Indicates the port number of an AZ.

+

resource_availability

+

String

+

Indicates whether an AZ has available resources.

+
  • true: The AZ has available resources.
  • false: Resources of the AZ have been sold out.
+
+
+

Example response

+
{  
+    regionId: "XXXX",  
+    available_zones:[  
+       {  
+            "id":"1d7b939b382c4c3bb3481a8ca10da768",  
+            "name":"az10.dc1",  
+            "code":"az10.dc1",  
+            "port":"8002", 
+            "resource_availability": "true" 
+        },    
+        {  
+            "id":"1d7b939b382c4c3bb3481a8ca10da769",  
+            "name":"az10.dc2",  
+            "code":"az10.dc2",  
+            "port":"8002", 
+            "resource_availability": "true" 
+        }  
+    ]  
+}
+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

200

+

The AZ information is successfully queried.

+
+
+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514009.html b/docs/dms/api-ref/kafka-api-180514009.html new file mode 100644 index 00000000..7f55b6b4 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514009.html @@ -0,0 +1,369 @@ + + +

Querying Product Specifications

+

This API is out-of-date and may not be maintained in the future.

+
+

Function

This API is used to query the product specifications to configure the product ID.

+
+

URI

GET /v1.0/products?engine={engine}

+

Table 1 describes the parameter.

+ +
+ + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

engine

+

String

+

Yes

+

Indicates the message engine.

+
+
+
+

Request

Request parameters

+

None.

+

Example request

+
GET https://{dms_endpoint}/v1.0/products?engine={engine}
+
+

Response

Response parameters

+

Table 2 describes the response parameters.

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Indicates the message engine, which is kafka.

+

version

+

String

+

Indicates the version of the message engine. Currently, only 1.1.0 and 2.3.0 are supported.

+

values

+

Array

+

Indicates product specifications. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 values parameter description

Parameter

+

Type

+

Description

+

detail

+

Array

+

Indicates the details of specifications. For details, see Table 4.

+

name

+

String

+

Indicates the instance type.

+

unavailable_zones

+

Array

+

Indicates AZs where resources are sold out.

+

available_zones

+

Array

+

Indicates AZs where there are available resources.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 detail parameter description

Parameter

+

Type

+

Description

+

tps

+

String

+

Indicates the maximum number of messages per unit time.

+

storage

+

String

+

Indicates the message storage space.

+

partition_num

+

String

+

Indicates the maximum number of topics in a Kafka instance.

+

product_id

+

String

+

Indicates the product ID.

+

spec_code

+

String

+

Indicates the specification ID.

+

io

+

Array

+

Indicates the I/O information. For details, see Table 5.

+

bandwidth

+

String

+

Indicates the bandwidth of a Kafka instance.

+

available_zones

+

Array

+

Indicates AZs where there are available resources.

+

ecs_flavor_id

+

String

+

Indicates the flavors of the corresponding ECS.

+

arch_type

+

String

+

Indicates the instance architecture type. Currently, only x86 is supported.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 io parameter description

Parameter

+

Type

+

Description

+

io_type

+

String

+

Indicates the I/O type.

+

storage_spec_code

+

String

+

Indicates the I/O specification.

+

available_zones

+

Array

+

Indicates AZs where there are available I/O resources.

+

unavailable_zones

+

Array of strings

+

Indicates AZs where I/O resources are sold out.

+

volume_type

+

String

+

Indicates the disk type.

+
+
+

Example response

+
{
+	"Hourly": [{
+		"name": "kafka",
+		"version": "2.3.0",
+		"values": [{
+			"detail": [{
+				"tps": "50000",
+				"storage": "600",
+				"partition_num": "300",
+				"product_id": "00300-30308-0--0",
+				"spec_code": "dms.instance.kafka.cluster.c3.mini",
+				"io": [{
+					"io_type": "high",
+					"storage_spec_code": "dms.physical.storage.high",
+					"available_zones": ["XXX",
+					"XXX"],
+					"volume_type": "SAS"
+				},
+				{
+					"io_type": "ultra",
+					"storage_spec_code": "dms.physical.storage.ultra",
+					"available_zones": ["XXX",
+					"XXX"],
+					"volume_type": "SSD"
+				}],
+				"bandwidth": "100MB",
+				"unavailable_zones": ["XXX"],
+				"available_zones": ["XXX"],
+				"ecs_flavor_id": "c4.large.2",
+				"arch_type": "X86"
+			},
+			{
+				"tps": "100000",
+				"storage": "1200",
+				"partition_num": "900",
+				"product_id": "00300-30310-0--0",
+				"spec_code": "dms.instance.kafka.cluster.c3.small.2",
+				"io": [{
+					"io_type": "high",
+					"storage_spec_code": "dms.physical.storage.high",
+					"available_zones": ["XXX",
+					"XXX"],
+					"volume_type": "SAS"
+				},
+				{
+					"io_type": "ultra",
+					"storage_spec_code": "dms.physical.storage.ultra",
+					"available_zones": ["XXX",
+					"XXX"],
+					"volume_type": "SSD"
+				}],
+				"bandwidth": "300MB",
+				"unavailable_zones": ["XXX"],
+				"available_zones": ["XXX"],
+				"ecs_flavor_id": "c4.xlarge.2",
+				"arch_type": "X86"
+			},
+			{
+				"tps": "200000",
+				"storage": "2400",
+				"partition_num": "1800",
+				"product_id": "00300-30312-0--0",
+				"spec_code": "dms.instance.kafka.cluster.c3.middle.2",
+				"io": [{
+					"io_type": "ultra",
+					"storage_spec_code": "dms.physical.storage.ultra",
+					"available_zones": ["XXX",
+					"XXX"],
+					"volume_type": "SSD"
+				}],
+				"bandwidth": "600MB",
+				"unavailable_zones": ["XXX"],
+				"available_zones": ["XXX"],
+				"ecs_flavor_id": "c4.2xlarge.2",
+				"arch_type": "X86"
+			},
+			{
+				"tps": "300000",
+				"storage": "4800",
+				"partition_num": "1800",
+				"product_id": "00300-30314-0--0",
+				"spec_code": "dms.instance.kafka.cluster.c3.high.2",
+				"io": [{
+					"io_type": "ultra",
+					"storage_spec_code": "dms.physical.storage.ultra",
+					"available_zones": ["XXX",
+					"XXX"],
+					"volume_type": "SSD"
+				}],
+				"bandwidth": "1200MB",
+				"unavailable_zones": ["XXX"],
+				"available_zones": ["XXX"],
+				"ecs_flavor_id": "c4.2xlarge.2",
+				"arch_type": "X86"
+			}],
+			"name": "cluster",
+			"unavailable_zones": ["XXX"],
+			"available_zones": ["XXX"]
+		}]
+	}]
+}
+
+

Status Code

Table 6 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 6 Status code

Status Code

+

Description

+

200

+

Product specifications queried successfully.

+
+
+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514010.html b/docs/dms/api-ref/kafka-api-180514010.html new file mode 100644 index 00000000..16a59250 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514010.html @@ -0,0 +1,140 @@ + + +

Querying Maintenance Time Windows

+

This API is out-of-date and may not be maintained in the future. Please use the API described in Listing Maintenance Time Windows.

+
+

Function

This API is used to query the start and end time of the maintenance window.

+
+

URI

GET /v1.0/instances/maintain-windows

+
+

Request

Request parameters

+

None.

+

Example request

+
GET https://{dms_endpoint}/v1.0/instances/maintain-windows
+
+

Response

Response parameters

+

Table 1 and Table 2 describe the response parameters.

+ +
+ + + + + + + + + +
Table 1 Response parameters

Parameter

+

Type

+

Description

+

maintain_windows

+

Array

+

Indicates a list of supported maintenance time windows.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 maintain_windows parameter description

Parameter

+

Type

+

Description

+

seq

+

Integer

+

Indicates the sequential number of a maintenance time window.

+

begin

+

String

+

Indicates the time at which a maintenance time window starts.

+

end

+

String

+

Indicates the time at which a maintenance time window ends.

+

default

+

Boolean

+

Indicates whether a maintenance time window is set to the default time segment.

+
+
+

+

Example response

+
{
+	"maintain_windows": [{
+		"default": false,
+		"seq": 1,
+		"begin": "22:00:00",
+		"end": "02:00:00"
+	},
+	{
+		"default": true,
+		"seq": 2,
+		"begin": "02:00:00",
+		"end": "06:00:00"
+	},
+	{
+		"default": false,
+		"seq": 3,
+		"begin": "06:00:00",
+		"end": "10:00:00"
+	},
+	{
+		"default": false,
+		"seq": 4,
+		"begin": "10:00:00",
+		"end": "14:00:00"
+	},
+	{
+		"default": false,
+		"seq": 5,
+		"begin": "14:00:00",
+		"end": "18:00:00"
+	},
+	{
+		"default": false,
+		"seq": 6,
+		"begin": "18:00:00",
+		"end": "22:00:00"
+	}]
+}
+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

200

+

The maintenance time windows are queried successfully.

+
+
+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180514011.html b/docs/dms/api-ref/kafka-api-180514011.html new file mode 100644 index 00000000..efe320c4 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514011.html @@ -0,0 +1,19 @@ + + + +

Appendix

+ +

+
+ +
+ +
+ diff --git a/docs/dms/api-ref/kafka-api-180514012.html b/docs/dms/api-ref/kafka-api-180514012.html new file mode 100644 index 00000000..d960ebd3 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180514012.html @@ -0,0 +1,80 @@ + + +

Instance Status

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Instance status description

Status

+

Description

+

CREATING

+

The instance is being created.

+

CREATEFAILED

+

The instance fails to be created.

+

RUNNING

+

The instance is running properly. Instances in this state can provide services.

+

ERROR

+

The instance is not running properly.

+

RESTARTING

+

The instance is being restarted.

+

EXTENDING

+

The instance specifications are being changed.

+

EXTENDEDFAILED

+

The instance specifications failed to be changed.

+

DELETING

+

The instance is being deleted.

+

DELETED

+

The instance has been deleted.

+

FROZEN

+

The instance has been frozen due to insufficient account balance. You can unfreeze the instance by topping up your account in My Order.

+

UPGRADING

+

The instance is being upgraded.

+

ROLLBACK

+

The instance is being rolled back.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180614001.html b/docs/dms/api-ref/kafka-api-180614001.html new file mode 100644 index 00000000..d748129c --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180614001.html @@ -0,0 +1,177 @@ + + +

Creating a Topic in a Kafka Instance

+

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.

+
+

Function

This API is used to create a topic in a Kafka instance.

+
+

URI

POST /v1.0/{project_id}/instances/{instance_id}/topics

+

Table 1 describes the parameters.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

instance_id

+

String

+

Yes

+

Indicates the instance ID.

+
+
+
+

Request

Request parameters

+

Table 2 describes the parameter.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request parameters

Parameter

+

Type

+

Mandatory

+

Description

+

id

+

String

+

Yes

+

Indicates the name of a topic. A topic name consists of 4 to 64 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), and digits.

+

partition

+

Integer

+

No

+

Indicates the number of topic partitions, which is used to set the number of concurrently consumed messages.

+

Value range: 1–100. Default value: 3.

+

replication

+

Integer

+

No

+

Indicates the number of replicas, which is configured to ensure data reliability.

+

Value range: 1–3. Default value: 3.

+

sync_replication

+

Boolean

+

No

+

Indicates whether to enable synchronous replication. After this function is enabled, the acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

+

By default, synchronous replication is disabled.

+

retention_time

+

Integer

+

No

+

Indicates the retention period of a message. Its default value is 72.

+

Value range: 1–720. Unit: hour.

+

sync_message_flush

+

Boolean

+

No

+

Indicates whether to enable synchronous flushing. Default value: false. Synchronous flushing compromises performance.

+
+
+

Example request

+
POST https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics
+{
+  "id" : "haha", 
+  "partition" : 3, 
+  "replication" : 3, 
+  "sync_replication " : true, 
+  "retention_time" : 10, 
+  "sync_message_flush" : true
+}
+
+

Response

Response parameters

+

Table 3 describes the parameter.

+ +
+ + + + + + + + + +
Table 3 Response parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Indicates the name of a topic.

+
+
+

Example response

+
{  
+"id": "haha"
+}
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

The topic is created successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180614002.html b/docs/dms/api-ref/kafka-api-180614002.html new file mode 100644 index 00000000..1e148c60 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180614002.html @@ -0,0 +1,212 @@ + + +

Querying a Topic in a Kafka Instance

+

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.

+
+

Function

This API is used to query details about a topic in a Kafka instance.

+
+

URI

GET /v1.0/{project_id}/instances/{instance_id}/topics

+

Table 1 describes the parameter.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

instance_id

+

String

+

Yes

+

Indicates the instance ID.

+
+
+
+

Request

Request parameters

+

None.

+

Example request

+
GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics
+
+

Response

Response parameters

+

Table 2 describes the response parameter.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response parameter

Parameter

+

Type

+

Description

+

total

+

Integer

+

Indicates the total number of topics.

+

size

+

Integer

+

Indicates the maximum number of records to be displayed on a page.

+

remain_partitions

+

Integer

+

Indicates the number of remaining partitions.

+

max_partitions

+

Integer

+

Indicates the total number of partitions.

+

topics

+

Array

+

Indicates the list of topics.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Parameter description

Parameter

+

Type

+

Description

+

policiesOnly

+

Boolean

+

Whether this policy is the default policy.

+

id

+

String

+

Indicates the topic name.

+

replication

+

Integer

+

Indicates the number of replicas, which is configured to ensure data reliability.

+

partition

+

Integer

+

Indicates the number of topic partitions, which is used to set the number of concurrently consumed messages.

+

retention_time

+

Integer

+

Indicates the retention period of a message.

+

sync_replication

+

Boolean

+

Indicates whether to enable synchronous replication. After this function is enabled, the acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

+

By default, synchronous replication is disabled.

+

sync_message_flush

+

Boolean

+

Indicates whether to enable synchronous flushing. Synchronous flushing compromises performance.

+

external_configs

+

Object

+

Indicates the extended configuration.

+

topic_type

+

Integer

+

Indicates the topic type.

+
+
+

Example response

+
{
+ "count": 1,
+ "topics": [
+  {
+   "id": "topic-test",
+   "replication": 3,
+   "partition": 4,
+   "retention_time": 72,
+   "sync_replication": "false",
+   "sync_message_flush": "false"
+  }
+ ]
+}
+

+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

The information is queried successfully.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-180614003.html b/docs/dms/api-ref/kafka-api-180614003.html new file mode 100644 index 00000000..d474bab0 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-180614003.html @@ -0,0 +1,156 @@ + + +

Deleting Topics in a Kafka Instance in Batches

+

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.

+
+

Function

This API is used to delete topics in a Kafka instance in batches.

+
+

URI

POST /v1.0/{project_id}/instances/{instance_id}/topics/delete

+

Table 1 describes the parameter.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Indicates the ID of a project.

+

instance_id

+

String

+

Yes

+

Indicates the instance ID.

+
+
+
+

Request

Request parameters

+

Table 2 describes the parameter.

+ +
+ + + + + + + + + + + +
Table 2 Request parameter

Parameter

+

Type

+

Mandatory

+

Description

+

topics

+

Array

+

Yes

+

Indicates the list of topics to be deleted.

+
+
+

Example request

+
POST https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics/delete
+{
+  "topics" : ["hah", "aabb"]
+ }
+
+

Response

Response parameters

+

Table 3 describes the parameter.

+ +
+ + + + + + + + + +
Table 3 Response parameters

Parameter

+

Type

+

Description

+

topics

+

Array

+

Indicates the list of topics.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 topics parameter description

Parameter

+

Type

+

Description

+

id

+

String

+

Indicates the topic name.

+

success

+

Boolean

+

Indicates whether the topics are deleted.

+
+
+

Example response

+
{
+  "topics" : [{
+      "id" : "haha",
+      "success" : true
+    }, {
+      "id" : "aabb",
+      "success" : true
+    }
+  ]
+}
+
+

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Status Code.

+ +
+ + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

The topics are successfully deleted.

+
+
+
+
+
+
+
Parent topic: APIs for Managing Instances
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-190605002.html b/docs/dms/api-ref/kafka-api-190605002.html new file mode 100644 index 00000000..3036f1a3 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-190605002.html @@ -0,0 +1,23 @@ + + + +

Other APIs

+ +

+
+ +
+ + +
+
Parent topic: API V1
+
+
+ diff --git a/docs/dms/api-ref/kafka-api-200707001.html b/docs/dms/api-ref/kafka-api-200707001.html new file mode 100644 index 00000000..57d538a1 --- /dev/null +++ b/docs/dms/api-ref/kafka-api-200707001.html @@ -0,0 +1,28 @@ + + +

APIs V2 (Recommended)

+

+
+
+ +
+ diff --git a/docs/dms/api-ref/public_sys-resources/ExpandCollapse.js b/docs/dms/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..116ddaab --- /dev/null +++ b/docs/dms/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/dms/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/dms/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/dms/api-ref/public_sys-resources/commonltr.css b/docs/dms/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/dms/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/dms/api-ref/public_sys-resources/commonltr_print.css b/docs/dms/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/dms/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/dms/api-ref/public_sys-resources/commonrtl.css b/docs/dms/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..f261da75 --- /dev/null +++ b/docs/dms/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/dms/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/dms/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/dms/api-ref/public_sys-resources/delta.gif b/docs/dms/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/deltaend.gif b/docs/dms/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/dms/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dms/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-caution.gif b/docs/dms/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-danger.gif b/docs/dms/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-huawei.gif b/docs/dms/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-note.gif b/docs/dms/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-notice.gif b/docs/dms/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-tip.gif b/docs/dms/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/icon-warning.gif b/docs/dms/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/dms/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/dms/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/dms/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/dms/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/dms/api-ref/public_sys-resources/popup.js b/docs/dms/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..a550862e --- /dev/null +++ b/docs/dms/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/dms/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/dms/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/dms/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/dms/api-ref/topic_300000000.html b/docs/dms/api-ref/topic_300000000.html new file mode 100644 index 00000000..096d839e --- /dev/null +++ b/docs/dms/api-ref/topic_300000000.html @@ -0,0 +1,26 @@ + + +

Lifecycle Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000001.html b/docs/dms/api-ref/topic_300000001.html new file mode 100644 index 00000000..2ca11774 --- /dev/null +++ b/docs/dms/api-ref/topic_300000001.html @@ -0,0 +1,42 @@ + + +

Instance Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000003.html b/docs/dms/api-ref/topic_300000003.html new file mode 100644 index 00000000..69c4484b --- /dev/null +++ b/docs/dms/api-ref/topic_300000003.html @@ -0,0 +1,18 @@ + + +

Specification Modification Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000004.html b/docs/dms/api-ref/topic_300000004.html new file mode 100644 index 00000000..4f8a8c9c --- /dev/null +++ b/docs/dms/api-ref/topic_300000004.html @@ -0,0 +1,26 @@ + + +

Topic Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000005.html b/docs/dms/api-ref/topic_300000005.html new file mode 100644 index 00000000..d87f4f8f --- /dev/null +++ b/docs/dms/api-ref/topic_300000005.html @@ -0,0 +1,26 @@ + + +

User Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000006.html b/docs/dms/api-ref/topic_300000006.html new file mode 100644 index 00000000..2377c16b --- /dev/null +++ b/docs/dms/api-ref/topic_300000006.html @@ -0,0 +1,24 @@ + + +

Message Query

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000007.html b/docs/dms/api-ref/topic_300000007.html new file mode 100644 index 00000000..e6616475 --- /dev/null +++ b/docs/dms/api-ref/topic_300000007.html @@ -0,0 +1,20 @@ + + +

Background Task Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000008.html b/docs/dms/api-ref/topic_300000008.html new file mode 100644 index 00000000..5ead3049 --- /dev/null +++ b/docs/dms/api-ref/topic_300000008.html @@ -0,0 +1,20 @@ + + +

Tag Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dms/api-ref/topic_300000009.html b/docs/dms/api-ref/topic_300000009.html new file mode 100644 index 00000000..02b805b1 --- /dev/null +++ b/docs/dms/api-ref/topic_300000009.html @@ -0,0 +1,22 @@ + + +

Other APIs

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+