diff --git a/docs/dms_rocketmq/api-ref/ALL_META.TXT.json b/docs/dms_rocketmq/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..41a9b7074 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ALL_META.TXT.json @@ -0,0 +1,1544 @@ +[ + { + "dockw":"API Reference" + }, + { + "uri":"hrm-api-using.html", + "node_id":"hrm-api-using.xml", + "product_code":"hrm", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"Using APIs", + "githuburl":"" + }, + { + "uri":"hrm-api-0007.html", + "node_id":"hrm-api-0007.xml", + "product_code":"hrm", + "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)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"APIs V2 (Recommended)", + "githuburl":"" + }, + { + "uri":"topic_300000000.html", + "node_id":"topic_300000000.xml", + "product_code":"hrm", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Lifecycle Management", + "githuburl":"" + }, + { + "uri":"ListInstances.html", + "node_id":"listinstances.xml", + "product_code":"hrm", + "code":"4", + "des":"This API is used to query the instances of an account by the specified conditions.GET /v2/{project_id}/instancesNoneStatus code: 200Querying the list of all instancesStat", + "doc_type":"api", + "kw":"Querying the Instance List,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Instance List", + "githuburl":"" + }, + { + "uri":"CreatePostPaidInstanceForRocketMq.html", + "node_id":"createpostpaidinstanceforrocketmq.xml", + "product_code":"hrm", + "code":"5", + "des":"This API is used to create an instance.POST /v2/{project_id}/rocketmq/instancesStatus code: 200Creating a RocketMQ instance with the 4 vCPUs | 16 GB × 2 brokers and 1200 ", + "doc_type":"api", + "kw":"Creating an Instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Creating an Instance", + "githuburl":"" + }, + { + "uri":"ShowInstance.html", + "node_id":"showinstance.xml", + "product_code":"hrm", + "code":"6", + "des":"This API is used to query the details about a specified instance.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Querying details of a specified instanceS", + "doc_type":"api", + "kw":"Querying an Instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying an Instance", + "githuburl":"" + }, + { + "uri":"DeleteInstance.html", + "node_id":"deleteinstance.xml", + "product_code":"hrm", + "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}NoneStatus code: 204Specified instance d", + "doc_type":"api", + "kw":"Deleting an Instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting an Instance", + "githuburl":"" + }, + { + "uri":"UpdateInstance.html", + "node_id":"updateinstance.xml", + "product_code":"hrm", + "code":"8", + "des":"This API is used to modify instance information.PUT /v2/{project_id}/instances/{instance_id}Status code: 204Instance information modified successfully.NoneModifying the n", + "doc_type":"api", + "kw":"Modifying Instance Information,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Modifying Instance Information", + "githuburl":"" + }, + { + "uri":"BatchDeleteInstances.html", + "node_id":"batchdeleteinstances.xml", + "product_code":"hrm", + "code":"9", + "des":"This API is used to delete instances in batches. Data in the instances will be deleted without any backup. Exercise caution when performing this operation.POST /v2/{proje", + "doc_type":"api", + "kw":"Batch Deleting Instances,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Batch Deleting Instances", + "githuburl":"" + }, + { + "uri":"topic_300000001.html", + "node_id":"topic_300000001.xml", + "product_code":"hrm", + "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":"Consumer Group Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Consumer Group Management", + "githuburl":"" + }, + { + "uri":"ListInstanceConsumerGroups.html", + "node_id":"listinstanceconsumergroups.xml", + "product_code":"hrm", + "code":"11", + "des":"This API is used to query the consumer group list.GET /v2/{project_id}/instances/{instance_id}/groupsNoneStatus code: 200Querying the consumer group list of a RocketMQ in", + "doc_type":"api", + "kw":"Querying the Consumer Group List,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Consumer Group List", + "githuburl":"" + }, + { + "uri":"CreateConsumerGroupOrBatchDeleteConsumerGroup.html", + "node_id":"createconsumergrouporbatchdeleteconsumergroup.xml", + "product_code":"hrm", + "code":"12", + "des":"This API is used to create a consumer group or batch deleting consumer groups.POST /v2/{project_id}/instances/{instance_id}/groupsStatus code: 200Creating a consumer grou", + "doc_type":"api", + "kw":"Creating a Consumer Group or Batch Deleting Consumer Groups,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Creating a Consumer Group or Batch Deleting Consumer Groups", + "githuburl":"" + }, + { + "uri":"BatchUpdateConsumerGroup.html", + "node_id":"batchupdateconsumergroup.xml", + "product_code":"hrm", + "code":"13", + "des":"This API is used to modify consumer groups in batches.PUT /v2/{project_id}/instances/{instance_id}/groupsStatus code: 200Batch modifying parameters of consumer groups, wi", + "doc_type":"api", + "kw":"Batch Modifying Consumer Groups,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Batch Modifying Consumer Groups", + "githuburl":"" + }, + { + "uri":"DeleteConsumerGroup.html", + "node_id":"deleteconsumergroup.xml", + "product_code":"hrm", + "code":"14", + "des":"This API is used to delete a specified consumer group.DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}NoneStatus code: 204The specified consumer group is de", + "doc_type":"api", + "kw":"Deleting a Consumer Group,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting a Consumer Group", + "githuburl":"" + }, + { + "uri":"ShowGroup.html", + "node_id":"showgroup.xml", + "product_code":"hrm", + "code":"15", + "des":"This API is used to query details about a specified consumer group.GET /v2/{project_id}/instances/{instance_id}/groups/{group}NoneStatus code: 200Querying details about a", + "doc_type":"api", + "kw":"Querying a Consumer Group,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying a Consumer Group", + "githuburl":"" + }, + { + "uri":"UpdateConsumerGroup.html", + "node_id":"updateconsumergroup.xml", + "product_code":"hrm", + "code":"16", + "des":"This API is used to modify parameters of a specified consumer group.PUT /v2/{project_id}/instances/{instance_id}/groups/{group}Status code: 204The specified consumer grou", + "doc_type":"api", + "kw":"Modifying a Consumer Group,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Modifying a Consumer Group", + "githuburl":"" + }, + { + "uri":"ShowConsumerListOrDetails.html", + "node_id":"showconsumerlistordetails.xml", + "product_code":"hrm", + "code":"17", + "des":"This API is used to query the consumer group list or details.GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topicsNoneStatus code: 200Topic list of the consu", + "doc_type":"api", + "kw":"Querying the Consumer Group List or Details,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Consumer Group List or Details", + "githuburl":"" + }, + { + "uri":"ResetConsumeOffsetForRocketMq.html", + "node_id":"resetconsumeoffsetforrocketmq.xml", + "product_code":"hrm", + "code":"18", + "des":"This API is used to reset the consumer offset.POST /v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/reset-message-offsetStatus code: 200Resetting consumer", + "doc_type":"api", + "kw":"Resetting the Consumer Offset,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Resetting the Consumer Offset", + "githuburl":"" + }, + { + "uri":"ShowConsumerConnectionsForRocketMq.html", + "node_id":"showconsumerconnectionsforrocketmq.xml", + "product_code":"hrm", + "code":"19", + "des":"This API is used to query the consumer list of a consumer group.GET /v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/clientsNoneStatus code: 200Querying t", + "doc_type":"api", + "kw":"Querying the Consumer List,Consumer Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Consumer List", + "githuburl":"" + }, + { + "uri":"topic_300000002.html", + "node_id":"topic_300000002.xml", + "product_code":"hrm", + "code":"20", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Topic Management", + "githuburl":"" + }, + { + "uri":"CreateTopicOrBatchDeleteTopic.html", + "node_id":"createtopicorbatchdeletetopic.xml", + "product_code":"hrm", + "code":"21", + "des":"This API is used to create a topic or delete topics in batches.POST /v2/{project_id}/instances/{instance_id}/topicsStatus code: 200Creating topics for a RocketMQ 5.x inst", + "doc_type":"api", + "kw":"Creating a Topic or Deleting Topics in Batches,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Creating a Topic or Deleting Topics in Batches", + "githuburl":"" + }, + { + "uri":"ListRocketInstanceTopics.html", + "node_id":"listrocketinstancetopics.xml", + "product_code":"hrm", + "code":"22", + "des":"This API is used to query the topic list of a RocketMQ instance.GET /v2/{project_id}/instances/{instance_id}/topicsNoneStatus code: 200Querying a list of 10 topics of a s", + "doc_type":"api", + "kw":"Querying the Topic List,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Topic List", + "githuburl":"" + }, + { + "uri":"DeleteTopic.html", + "node_id":"deletetopic.xml", + "product_code":"hrm", + "code":"23", + "des":"This API is used to delete a specified topic.DELETE /v2/{project_id}/instances/{instance_id}/topics/{topic}NoneStatus code: 204The specified topic is deleted.NoneDeleting", + "doc_type":"api", + "kw":"Deleting a Topic,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting a Topic", + "githuburl":"" + }, + { + "uri":"ShowOneTopic.html", + "node_id":"showonetopic.xml", + "product_code":"hrm", + "code":"24", + "des":"This API is used to query a topic.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}NoneStatus code: 200Querying details about a specified topicStatus code: 200T", + "doc_type":"api", + "kw":"Querying a Topic,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying a Topic", + "githuburl":"" + }, + { + "uri":"UpdateTopic.html", + "node_id":"updatetopic.xml", + "product_code":"hrm", + "code":"25", + "des":"This API is used to modify a topic.PUT /v2/{project_id}/instances/{instance_id}/topics/{topic}Status code: 204The topic is modified.NoneChanging a specified topic's total", + "doc_type":"api", + "kw":"Modifying a Topic,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Modifying a Topic", + "githuburl":"" + }, + { + "uri":"ListConsumerGroupOfTopic.html", + "node_id":"listconsumergroupoftopic.xml", + "product_code":"hrm", + "code":"26", + "des":"This API is used to query the topic consumer group list.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/groupsNoneStatus code: 200Querying the consumer group ", + "doc_type":"api", + "kw":"Querying the Topic Consumer Group List,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Topic Consumer Group List", + "githuburl":"" + }, + { + "uri":"ShowTopicStatus.html", + "node_id":"showtopicstatus.xml", + "product_code":"hrm", + "code":"27", + "des":"This API is used to query the number of messages in a topic.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/statusNoneStatus code: 200Querying the number of m", + "doc_type":"api", + "kw":"Querying the Number of Messages in a Topic,Topic Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Number of Messages in a Topic", + "githuburl":"" + }, + { + "uri":"topic_300000011.html", + "node_id":"topic_300000011.xml", + "product_code":"hrm", + "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":"Managing Messages", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Managing Messages", + "githuburl":"" + }, + { + "uri":"ListMessagesForRocketMq.html", + "node_id":"listmessagesforrocketmq.xml", + "product_code":"hrm", + "code":"29", + "des":"This API is used to query messages.GET /v2/{project_id}/rocketmq/instances/{instance_id}/messagesNoneStatus code: 200This API is used to query messages.Status code: 200Me", + "doc_type":"api", + "kw":"Querying Messages,Managing Messages,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Messages", + "githuburl":"" + }, + { + "uri":"SendMessageForRocketMq.html", + "node_id":"sendmessageforrocketmq.xml", + "product_code":"hrm", + "code":"30", + "des":"This API is used to send messages.POST /v2/{project_id}/rocketmq/instances/{instance_id}/messagesStatus code: 200Sending messagesStatus code: 200Queried.See Error Codes.", + "doc_type":"api", + "kw":"Sending Messages,Managing Messages,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Sending Messages", + "githuburl":"" + }, + { + "uri":"ListMessageTraceForRocketMq.html", + "node_id":"listmessagetraceforrocketmq.xml", + "product_code":"hrm", + "code":"31", + "des":"This API is used to query the message trace.GET /v2/{project_id}/rocketmq/instances/{instance_id}/traceNoneStatus code: 200Querying the message trace of a RocketMQ instan", + "doc_type":"api", + "kw":"Querying the Message Trace,Managing Messages,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Message Trace", + "githuburl":"" + }, + { + "uri":"SendDlqMessageForRocketMq.html", + "node_id":"senddlqmessageforrocketmq.xml", + "product_code":"hrm", + "code":"32", + "des":"This API is used to resend dead letter messages.POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/deadletter-resendStatus code: 200Resending dead letter mes", + "doc_type":"api", + "kw":"Resending Dead Letter Messages,Managing Messages,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Resending Dead Letter Messages", + "githuburl":"" + }, + { + "uri":"ValidateConsumedMessageForRocketMq.html", + "node_id":"validateconsumedmessageforrocketmq.xml", + "product_code":"hrm", + "code":"33", + "des":"This API is used to verify consumption.POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/resendStatus code: 200Verifying consumptionStatus code: 200Consumpt", + "doc_type":"api", + "kw":"Verifying Consumption,Managing Messages,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Verifying Consumption", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "node_id":"topic_300000003.xml", + "product_code":"hrm", + "code":"34", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"User Management", + "githuburl":"" + }, + { + "uri":"CreateUser.html", + "node_id":"createuser.xml", + "product_code":"hrm", + "code":"35", + "des":"This API is used to create a user.POST /v2/{project_id}/instances/{instance_id}/usersStatus code: 200Creating a non-administrator user with permissions to publish and sub", + "doc_type":"api", + "kw":"Creating a User,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Creating a User", + "githuburl":"" + }, + { + "uri":"ListUser.html", + "node_id":"listuser.xml", + "product_code":"hrm", + "code":"36", + "des":"This API is used to query the user list.GET /v2/{project_id}/instances/{instance_id}/usersNoneStatus code: 200Querying the user listStatus code: 200Query result.See Error", + "doc_type":"api", + "kw":"Querying the User List,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the User List", + "githuburl":"" + }, + { + "uri":"UpdateUser.html", + "node_id":"updateuser.xml", + "product_code":"hrm", + "code":"37", + "des":"This API is used to modify user parameters.PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}Status code: 200Granting user_name permissions to publish and sub", + "doc_type":"api", + "kw":"Modifying User Parameters,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Modifying User Parameters", + "githuburl":"" + }, + { + "uri":"ShowUser.html", + "node_id":"showuser.xml", + "product_code":"hrm", + "code":"38", + "des":"This API is used to query user details.GET /v2/{project_id}/instances/{instance_id}/users/{user_name}NoneStatus code: 200Querying user detailsStatus code: 200User details", + "doc_type":"api", + "kw":"Querying User Details,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying User Details", + "githuburl":"" + }, + { + "uri":"DeleteUser.html", + "node_id":"deleteuser.xml", + "product_code":"hrm", + "code":"39", + "des":"This API is used to delete a user.DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name}NoneStatus code: 200Deleting a specified userStatus code: 200The deleti", + "doc_type":"api", + "kw":"Deleting a User,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting a User", + "githuburl":"" + }, + { + "uri":"ListTopicAccessPolicy.html", + "node_id":"listtopicaccesspolicy.xml", + "product_code":"hrm", + "code":"40", + "des":"This API is used to query the list of users that have been granted permissions for a topic.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/accesspolicyNoneSta", + "doc_type":"api", + "kw":"Querying Users Granted Permissions for a Topic,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Users Granted Permissions for a Topic", + "githuburl":"" + }, + { + "uri":"ListConsumeGroupAccessPolicyForRocketMq.html", + "node_id":"listconsumegroupaccesspolicyforrocketmq.xml", + "product_code":"hrm", + "code":"41", + "des":"This API is used to query the list of users granted permissions for a consumer group.GET /v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/accesspolicyNone", + "doc_type":"api", + "kw":"Querying Users Granted Permissions for a Consumer Group,User Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Users Granted Permissions for a Consumer Group", + "githuburl":"" + }, + { + "uri":"topic_300000004.html", + "node_id":"topic_300000004.xml", + "product_code":"hrm", + "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":"Metadata Migration", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Metadata Migration", + "githuburl":"" + }, + { + "uri":"CreateRocketMqMigrationTask.html", + "node_id":"createrocketmqmigrationtask.xml", + "product_code":"hrm", + "code":"43", + "des":"This API is used to create a metadata migration task.POST /v2/{project_id}/instances/{instance_id}/metadataStatus code: 200Creating a metadata migration task to migrate t", + "doc_type":"api", + "kw":"Creating a Metadata Migration Task,Metadata Migration,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Creating a Metadata Migration Task", + "githuburl":"" + }, + { + "uri":"ListRocketMqMigrationTask.html", + "node_id":"listrocketmqmigrationtask.xml", + "product_code":"hrm", + "code":"44", + "des":"This API is used to query all migration tasks or a specified migration task of an instance.GET /v2/{project_id}/instances/{instance_id}/metadataNoneStatus code: 200Queryi", + "doc_type":"api", + "kw":"Querying All Migration Tasks or a Specified Migration Task of an Instance,Metadata Migration,API Ref", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying All Migration Tasks or a Specified Migration Task of an Instance", + "githuburl":"" + }, + { + "uri":"BatchDeleteRocketMqMigrationTask.html", + "node_id":"batchdeleterocketmqmigrationtask.xml", + "product_code":"hrm", + "code":"45", + "des":"This API is used to delete metadata migration tasks in batches.POST /v2/{project_id}/instances/{instance_id}/metadata/batch-deleteStatus code: 200Deleting metadata migrat", + "doc_type":"api", + "kw":"Deleting Metadata Migration Tasks in Batches,Metadata Migration,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting Metadata Migration Tasks in Batches", + "githuburl":"" + }, + { + "uri":"topic_300000010.html", + "node_id":"topic_300000010.xml", + "product_code":"hrm", + "code":"46", + "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":"Managing Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Managing Parameters", + "githuburl":"" + }, + { + "uri":"ShowRocketMqConfigs.html", + "node_id":"showrocketmqconfigs.xml", + "product_code":"hrm", + "code":"47", + "des":"This API is used to query RocketMQ configurations. Configuration details will be returned.GET /v2/{project_id}/rocketmq/instances/{instance_id}/configsNoneStatus code: 20", + "doc_type":"api", + "kw":"Querying RocketMQ Configurations,Managing Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying RocketMQ Configurations", + "githuburl":"" + }, + { + "uri":"UpdateRocketMqConfigs.html", + "node_id":"updaterocketmqconfigs.xml", + "product_code":"hrm", + "code":"48", + "des":"This API is used to modify RocketMQ configurations.PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configsStatus code: 204Successful.NoneModifying RocketMQ configur", + "doc_type":"api", + "kw":"Modifying RocketMQ Configurations,Managing Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Modifying RocketMQ Configurations", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "node_id":"topic_300000005.xml", + "product_code":"hrm", + "code":"49", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"BatchCreateOrDeleteRocketmqTag.html", + "node_id":"batchcreateordeleterocketmqtag.xml", + "product_code":"hrm", + "code":"50", + "des":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/rocketmq/{instance_id}/tags/actionStatus code: 204Tags are successfully added or deleted.", + "doc_type":"api", + "kw":"Adding or Deleting Instance Tags in Batches,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Adding or Deleting Instance Tags in Batches", + "githuburl":"" + }, + { + "uri":"ShowRocketmqTags.html", + "node_id":"showrocketmqtags.xml", + "product_code":"hrm", + "code":"51", + "des":"This API is used to query instance tags.GET /v2/{project_id}/rocketmq/{instance_id}/tagsNoneStatus code: 200Querying instance tagsStatus code: 200Instance tags queried su", + "doc_type":"api", + "kw":"Querying Instance Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Instance Tags", + "githuburl":"" + }, + { + "uri":"ShowRocketmqProjectTags.html", + "node_id":"showrocketmqprojecttags.xml", + "product_code":"hrm", + "code":"52", + "des":"This API is used to query tags of a project.GET /v2/{project_id}/rocketmq/tagsNoneStatus code: 200Querying project tagsStatus code: 200The project tags are queried succes", + "doc_type":"api", + "kw":"Querying Project Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Project Tags", + "githuburl":"" + }, + { + "uri":"topic_300000008.html", + "node_id":"topic_300000008.xml", + "product_code":"hrm", + "code":"53", + "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 Diagnosis", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Instance Diagnosis", + "githuburl":"" + }, + { + "uri":"CreateDiagnosisTaskForRocketMq.html", + "node_id":"creatediagnosistaskforrocketmq.xml", + "product_code":"hrm", + "code":"54", + "des":"This API is used to create an instance diagnosis task.POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosisStatus code: 200Creating an instance diagnosis taskS", + "doc_type":"api", + "kw":"Creating an Instance Diagnosis Task,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Creating an Instance Diagnosis Task", + "githuburl":"" + }, + { + "uri":"ListDiagnosisReportsForRocketMq.html", + "node_id":"listdiagnosisreportsforrocketmq.xml", + "product_code":"hrm", + "code":"55", + "des":"This API is used to query an instance diagnosis report list.GET /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosisNoneStatus code: 200Querying an instance diagno", + "doc_type":"api", + "kw":"Querying an Instance Diagnosis Report List,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying an Instance Diagnosis Report List", + "githuburl":"" + }, + { + "uri":"BatchDeleteDiagnosisRecordsForRocketMq.html", + "node_id":"batchdeletediagnosisrecordsforrocketmq.xml", + "product_code":"hrm", + "code":"56", + "des":"This API is used to delete diagnosis reports of an instance in batches.POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis/batch-deleteStatus code: 200Deleti", + "doc_type":"api", + "kw":"Deleting Instance Diagnosis Reports in Batches,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting Instance Diagnosis Reports in Batches", + "githuburl":"" + }, + { + "uri":"ShowDiagnosisReportForRocketMq.html", + "node_id":"showdiagnosisreportforrocketmq.xml", + "product_code":"hrm", + "code":"57", + "des":"This API is used to query an instance diagnosis report.GET /v2/{project_id}/rocketmq/diagnosis/{report_id}NoneStatus code: 200Querying an instance diagnosis reportStatus ", + "doc_type":"api", + "kw":"Querying an Instance Diagnosis Report,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying an Instance Diagnosis Report", + "githuburl":"" + }, + { + "uri":"ShowDiagnosisStackForRocketMq.html", + "node_id":"showdiagnosisstackforrocketmq.xml", + "product_code":"hrm", + "code":"58", + "des":"This API is used to query stack information.GET /v2/{project_id}/rocketmq/diagnosis/stack/{stack_id}NoneStatus code: 200Querying stack informationStatus code: 200successS", + "doc_type":"api", + "kw":"Querying Stack Information,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Stack Information", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "node_id":"topic_300000006.xml", + "product_code":"hrm", + "code":"59", + "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":"Managing Specification Changes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Managing Specification Changes", + "githuburl":"" + }, + { + "uri":"ShowEngineInstanceExtendProductInfoForRocketMq.html", + "node_id":"showengineinstanceextendproductinfoforrocketmq.xml", + "product_code":"hrm", + "code":"60", + "des":"This API is used to query the product information for instance specification modification.GET /v2/{project_id}/rocketmq/instances/{instance_id}/extendNoneStatus code: 200", + "doc_type":"api", + "kw":"Querying Product Information for Instance Specification Modification,Managing Specification Changes,", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Product Information for Instance Specification Modification", + "githuburl":"" + }, + { + "uri":"ResizeInstanceForRocketMq.html", + "node_id":"resizeinstanceforrocketmq.xml", + "product_code":"hrm", + "code":"61", + "des":"This API is used to change instance specifications.POST /v2/{project_id}/rocketmq/instances/{instance_id}/extendStatus code: 200Increasing an instance flavorPOST https://", + "doc_type":"api", + "kw":"Changing Instance Specifications,Managing Specification Changes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Changing Instance Specifications", + "githuburl":"" + }, + { + "uri":"topic_300000009.html", + "node_id":"topic_300000009.xml", + "product_code":"hrm", + "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":"Background Task Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Background Task Management", + "githuburl":"" + }, + { + "uri":"DeleteScheduledTask.html", + "node_id":"deletescheduledtask.xml", + "product_code":"hrm", + "code":"63", + "des":"This API is used to delete specified records in scheduled task management.DELETE /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}NoneStatus code: 204Sch", + "doc_type":"api", + "kw":"Deleting Specified Records in Scheduled Task Management,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Deleting Specified Records in Scheduled Task Management", + "githuburl":"" + }, + { + "uri":"UpdateScheduledTask.html", + "node_id":"updatescheduledtask.xml", + "product_code":"hrm", + "code":"64", + "des":"This API is used to modify specified records in scheduled task management.PUT /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}NoneStatus code: 204Schedu", + "doc_type":"api", + "kw":"Modifying Specified Records in Scheduled Task Management,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Modifying Specified Records in Scheduled Task Management", + "githuburl":"" + }, + { + "uri":"ListScheduledTasks.html", + "node_id":"listscheduledtasks.xml", + "product_code":"hrm", + "code":"65", + "des":"This API is used to query the scheduled task list of an instance.GET /v2/{project_id}/instances/{instance_id}/scheduled-tasksNoneStatus code: 200Querying scheduled tasks ", + "doc_type":"api", + "kw":"Querying the Scheduled Task List of an Instance,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying the Scheduled Task List of an Instance", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "node_id":"topic_300000007.xml", + "product_code":"hrm", + "code":"66", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Other APIs", + "githuburl":"" + }, + { + "uri":"ListAvailableZones.html", + "node_id":"listavailablezones.xml", + "product_code":"hrm", + "code":"67", + "des":"This API is used to query the AZ ID for creating an instance.GET /v2/available-zonesNoneStatus code: 200Querying AZ informationStatus code: 200AZ information queried succ", + "doc_type":"api", + "kw":"Querying AZ Information,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying AZ Information", + "githuburl":"" + }, + { + "uri":"ShowQuotas.html", + "node_id":"showquotas.xml", + "product_code":"hrm", + "code":"68", + "des":"This API is used to query the maximum number of instances that a tenant can create, the number of created instances, and the maximum number of tags that can be created fo", + "doc_type":"api", + "kw":"Querying Tenant Quotas,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Tenant Quotas", + "githuburl":"" + }, + { + "uri":"ListEngineProducts.html", + "node_id":"listengineproducts.xml", + "product_code":"hrm", + "code":"69", + "des":"This API is used to query the flavor list of an engine.GET /v2/{engine}/productsNoneStatus code: 200Status code: 200SuccessfulSee Error Codes.", + "doc_type":"api", + "kw":"Querying Flavor List,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Flavor List", + "githuburl":"" + }, + { + "uri":"ShowCesHierarchy.html", + "node_id":"showceshierarchy.xml", + "product_code":"hrm", + "code":"70", + "des":"This API is used to query instance monitoring dimensions.GET /v2/{project_id}/instances/{instance_id}/ces-hierarchyNoneStatus code: 200Status code: 200Queried.See Error C", + "doc_type":"api", + "kw":"Querying Instance Monitoring Dimensions,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Querying Instance Monitoring Dimensions", + "githuburl":"" + }, + { + "uri":"ListConfigFeatures.html", + "node_id":"listconfigfeatures.xml", + "product_code":"hrm", + "code":"71", + "des":"This API is used to obtain the feature switch list.GET /v2/config/featuresNoneStatus code: 200Status code: 200Queried.See Error Codes.", + "doc_type":"api", + "kw":"Obtaining the Feature Switch List,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteRocketmqTag;BatchDeleteInstances;BatchUpdateConsumerGroup;CreateConsumerGroupOrBatchDeleteConsumerGroup;CreateRocketMqMigrationTask;CreateTopicOrBatchDeleteTopic;CreateUser;DeleteConsumerGroup;DeleteInstance;DeleteTopic;DeleteUser;ListAvailableZones;ListConsumerGroupOfTopic;ListEngineProducts;ListInstanceConsumerGroups;ListInstances;ListRocketInstanceTopics;ListRocketMqMigrationTask;ListTopicAccessPolicy;ListUser;ShowConsumerListOrDetails;ShowGroup;ShowInstance;ShowOneTopic;ShowRocketMqConfigs;ShowRocketmqProjectTags;ShowRocketmqTags;ShowTopicStatus;ShowUser;UpdateConsumerGroup;UpdateInstance;UpdateRocketMqConfigs;UpdateTopic;UpdateUser;CreatePostPaidInstanceForRocketMq;ResetConsumeOffsetForRocketMq;ShowConsumerConnectionsForRocketMq;ListMessagesForRocketMq;SendMessageForRocketMq;ListMessageTraceForRocketMq;SendDlqMessageForRocketMq;ValidateConsumedMessageForRocketMq;ListConsumeGroupAccessPolicyForRocketMq;BatchDeleteRocketMqMigrationTask;CreateDiagnosisTaskForRocketMq;ListDiagnosisReportsForRocketMq;BatchDeleteDiagnosisRecordsForRocketMq;ShowDiagnosisReportForRocketMq;ShowDiagnosisStackForRocketMq;ShowEngineInstanceExtendProductInfoForRocketMq;ResizeInstanceForRocketMq;DeleteScheduledTask;UpdateScheduledTask;ListScheduledTasks;ShowQuotas;ShowCesHierarchy;ListConfigFeatures", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Obtaining the Feature Switch List", + "githuburl":"" + }, + { + "uri":"hrm-api-0008.html", + "node_id":"hrm-api-0008.xml", + "product_code":"hrm", + "code":"72", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"hrm-api-0009.html", + "node_id":"hrm-api-0009.xml", + "product_code":"hrm", + "code":"73", + "des":"Table 1 lists status codes.", + "doc_type":"api", + "kw":"Status Code,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"Status Code", + "githuburl":"" + }, + { + "uri":"ErrorCode.html", + "node_id":"errorcode_1.xml", + "product_code":"hrm", + "code":"74", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"hrm-api-0010.html", + "node_id":"hrm-api-0010.xml", + "product_code":"hrm", + "code":"75", + "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 Statuses,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"Instance Statuses", + "githuburl":"" + }, + { + "uri":"hrm-api-0011.html", + "node_id":"hrm-api-0011.xml", + "product_code":"hrm", + "code":"76", + "des":"A project ID is required for some URLs when an API is called. Obtain a project ID using either of the following methods:Obtaining a Project ID by Calling an APIObtaining ", + "doc_type":"api", + "kw":"Obtaining a Project ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"hrm-api-0014.html", + "node_id":"hrm-api-0014.xml", + "product_code":"hrm", + "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":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"hrm", + "opensource":"true", + "operation_id":"CreatePostPaidInstanceV1;ShowInstanceV1;ListInstancesV1;UpdateInstanceV1;DeleteInstanceV1;ListAvailableZonesV1;ShowQuotasV1;ShowCesHierarchyV1;ListProductsV1;ShowInstanceWithEngine;ListInstanceGroups;UpdateInstanceGroup;UpdateInstanceConsumerGroup;DeleteInstanceConsumerGroup;ShowInstanceNodes;RestartInstance;ListEngineProducts;ShowRocketMQProductCores;BatchDeleteDiagnosisReport;DeleteRocketMqMigrationTask" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/dms_rocketmq/api-ref/BatchCreateOrDeleteRocketmqTag.html b/docs/dms_rocketmq/api-ref/BatchCreateOrDeleteRocketmqTag.html new file mode 100644 index 000000000..73485d889 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/BatchCreateOrDeleteRocketmqTag.html @@ -0,0 +1,183 @@ + + +

Adding or Deleting Instance Tags in Batches

+

Function

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

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Operation. Only lowercase letters are supported.

+
  • create: Tags are created.

    +
  • delete: Tags are deleted.

    +
+

tags

+

Yes

+

Array of TagEntity objects

+

Definition

+

Tag list.

+

Constraints

+

A maximum of 20 tags can be added to a RocketMQ instance.

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key.

+
  • Must be specified.

    +
  • Must be unique for the same instance.

    +
  • Can contain 1 to 128 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+

value

+

Yes

+

String

+

Tag value.

+
  • Can contain 0 to 255 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+
+
+
+

Response Parameters

Status code: 204

+

Tags are successfully added or deleted.

+

None

+
+

Example Requests

Creating instance tags with tag keys key1 and key2 and tag values value1 and value2

+
POST https://{endpoint}/v2/{project_id}/rocketmq/{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.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/BatchDeleteDiagnosisRecordsForRocketMq.html b/docs/dms_rocketmq/api-ref/BatchDeleteDiagnosisRecordsForRocketMq.html new file mode 100644 index 000000000..758f0652d --- /dev/null +++ b/docs/dms_rocketmq/api-ref/BatchDeleteDiagnosisRecordsForRocketMq.html @@ -0,0 +1,150 @@ + + +

Deleting Instance Diagnosis Reports in Batches

+

Function

This API is used to delete diagnosis reports of an instance in batches.

+
+

URI

POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis/batch-delete

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

report_id_list

+

No

+

Array of strings

+

Definition:

+

Diagnosis report ID list.

+

Constraints:

+

N/A

+

Range:

+

N/A

+

Default Value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

report_id_list

+

Array of strings

+

Definition

+

Diagnosis report ID list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Deleting diagnosis reports of an instance in batches

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis/batch-delete
+
+{
+  "report_id_list" : [ "a68bb70a-ac92-4047-b8a6-30612b521624" ]
+}
+
+

Example Responses

Status code: 200

+

success

+
{
+  "report_id_list" : [ "a68bb70a-ac92-4047-b8a6-30612b521624" ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

success

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/BatchDeleteInstances.html b/docs/dms_rocketmq/api-ref/BatchDeleteInstances.html new file mode 100644 index 000000000..272dbc7df --- /dev/null +++ b/docs/dms_rocketmq/api-ref/BatchDeleteInstances.html @@ -0,0 +1,240 @@ + + +

Batch Deleting Instances

+

Function

This API is used to delete instances in batches. Data in the instances will be deleted 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

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

instances

+

No

+

Array of strings

+

Definition

+

List of instance IDs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

action

+

Yes

+

String

+

Definition

+

Operation to be performed on instances. Value: delete.

+

Constraints

+

N/A

+

Range

+
  • delete

    +
+

Default Value

+

N/A

+

all_failure

+

No

+

String

+

Definition

+

When set to reliability, this parameter indicates that all RocketMQ instances that fail to be created will be deleted.

+

Constraints

+

N/A

+

Range

+
  • reliability

    +
+

Default Value

+

N/A

+

force_delete

+

No

+

Boolean

+

Definition

+

Whether to forcibly delete.

+

Constraints

+

N/A

+

Range

+
  • true: Yes, forcibly deleted instances are not moved to the recycle bin.

    +
  • false: No, instances will be moved to the recycle bin after the recycle bin function is enabled.

    +
+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

results

+

Array of results objects

+

Definition

+

Result of instance modification.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

result

+

String

+

Definition

+

Operation result.

+

Constraints

+

N/A

+

Range

+
  • success

    +
  • failed

    +
+

Default Value

+

N/A

+

instance

+

String

+

Instance ID.

+
+
+

Status code: 204

+

RocketMQ instance creation failures deleted.

+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Instances deleted.

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

Status Codes

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

Status Code

+

Description

+

200

+

Instances deleted.

+

204

+

RocketMQ instance creation failures deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/BatchDeleteRocketMqMigrationTask.html b/docs/dms_rocketmq/api-ref/BatchDeleteRocketMqMigrationTask.html new file mode 100644 index 000000000..21afdf015 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/BatchDeleteRocketMqMigrationTask.html @@ -0,0 +1,150 @@ + + +

Deleting Metadata Migration Tasks in Batches

+

Function

This API is used to delete metadata migration tasks in batches.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

task_ids

+

Yes

+

Array of strings

+

Definition

+

Tasks to be deleted.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

success_task_list

+

Array of strings

+

Definition

+

List of tasks that are successfully deleted.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Deleting metadata migration tasks in batches

+
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/metadata/batch-delete
+
+{
+  "task_ids" : [ "1b8f2c93-8057-4bdd-9be5-5b6883737099", "fa89699b-61b9-497d-b1ac-972623f3c0ce" ]
+}
+
+

Example Responses

Status code: 200

+

Metadata migration tasks deleted in batches.

+
{
+  "success_task_list" : [ "1b8f2c93-8057-4bdd-9be5-5b6883737099", "fa89699b-61b9-497d-b1ac-972623f3c0ce" ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Metadata migration tasks deleted in batches.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/BatchUpdateConsumerGroup.html b/docs/dms_rocketmq/api-ref/BatchUpdateConsumerGroup.html new file mode 100644 index 000000000..b7ddc7a05 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/BatchUpdateConsumerGroup.html @@ -0,0 +1,232 @@ + + +

Batch Modifying Consumer Groups

+

Function

This API is used to modify consumer groups in batches.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

groups

+

No

+

Array of BatchUpdateConsumerGroup objects

+

Definition

+

Consumer group list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BatchUpdateConsumerGroup

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Consumer group name. Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (|), hyphens (-), and underscores (_).

+

broadcast

+

No

+

Boolean

+

Whether to broadcast.

+

retry_max_time

+

No

+

Integer

+

Maximum number of retries. The value ranges from 1 to 16.

+

enabled

+

No

+

Boolean

+

Whether consumption is allowed.

+

consume_orderly

+

No

+

Boolean

+

Definition

+

Whether to enable orderly consumption (mandatory only for RocketMQ 5.x instances).

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

group_desc

+

No

+

String

+

Consumer group description. 0 to 200 characters.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

Task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Batch modifying parameters of consumer groups, with max. retries of group1 changed to 16.

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups
+
+{
+  "groups" : [ {
+    "enabled" : true,
+    "broadcast" : false,
+    "name" : "group1",
+    "retry_max_time" : 16
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Consumer groups modified successfully.

+
{
+  "job_id" : "8abfa7b27da211df017da340427b0979"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumer groups modified successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/CLASS.TXT.json b/docs/dms_rocketmq/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..e08cbde9b --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CLASS.TXT.json @@ -0,0 +1,695 @@ +[ + { + "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":"hrm", + "title":"Using APIs", + "uri":"hrm-api-using.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":"hrm", + "title":"APIs V2 (Recommended)", + "uri":"hrm-api-0007.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":"hrm", + "title":"Lifecycle Management", + "uri":"topic_300000000.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to query the instances of an account by the specified conditions.GET /v2/{project_id}/instancesNoneStatus code: 200Querying the list of all instancesStat", + "product_code":"hrm", + "title":"Querying the Instance List", + "uri":"ListInstances.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to create an instance.POST /v2/{project_id}/rocketmq/instancesStatus code: 200Creating a RocketMQ instance with the 4 vCPUs | 16 GB × 2 brokers and 1200 ", + "product_code":"hrm", + "title":"Creating an Instance", + "uri":"CreatePostPaidInstanceForRocketMq.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: 200Querying details of a specified instanceS", + "product_code":"hrm", + "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}NoneStatus code: 204Specified instance d", + "product_code":"hrm", + "title":"Deleting an Instance", + "uri":"DeleteInstance.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API is used to modify instance information.PUT /v2/{project_id}/instances/{instance_id}Status code: 204Instance information modified successfully.NoneModifying the n", + "product_code":"hrm", + "title":"Modifying Instance Information", + "uri":"UpdateInstance.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"This API is used to delete instances in batches. Data in the instances will be deleted without any backup. Exercise caution when performing this operation.POST /v2/{proje", + "product_code":"hrm", + "title":"Batch Deleting Instances", + "uri":"BatchDeleteInstances.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":"hrm", + "title":"Consumer Group Management", + "uri":"topic_300000001.html", + "doc_type":"api", + "p_code":"2", + "code":"10" + }, + { + "desc":"This API is used to query the consumer group list.GET /v2/{project_id}/instances/{instance_id}/groupsNoneStatus code: 200Querying the consumer group list of a RocketMQ in", + "product_code":"hrm", + "title":"Querying the Consumer Group List", + "uri":"ListInstanceConsumerGroups.html", + "doc_type":"api", + "p_code":"10", + "code":"11" + }, + { + "desc":"This API is used to create a consumer group or batch deleting consumer groups.POST /v2/{project_id}/instances/{instance_id}/groupsStatus code: 200Creating a consumer grou", + "product_code":"hrm", + "title":"Creating a Consumer Group or Batch Deleting Consumer Groups", + "uri":"CreateConsumerGroupOrBatchDeleteConsumerGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"12" + }, + { + "desc":"This API is used to modify consumer groups in batches.PUT /v2/{project_id}/instances/{instance_id}/groupsStatus code: 200Batch modifying parameters of consumer groups, wi", + "product_code":"hrm", + "title":"Batch Modifying Consumer Groups", + "uri":"BatchUpdateConsumerGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"13" + }, + { + "desc":"This API is used to delete a specified consumer group.DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}NoneStatus code: 204The specified consumer group is de", + "product_code":"hrm", + "title":"Deleting a Consumer Group", + "uri":"DeleteConsumerGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"14" + }, + { + "desc":"This API is used to query details about a specified consumer group.GET /v2/{project_id}/instances/{instance_id}/groups/{group}NoneStatus code: 200Querying details about a", + "product_code":"hrm", + "title":"Querying a Consumer Group", + "uri":"ShowGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"15" + }, + { + "desc":"This API is used to modify parameters of a specified consumer group.PUT /v2/{project_id}/instances/{instance_id}/groups/{group}Status code: 204The specified consumer grou", + "product_code":"hrm", + "title":"Modifying a Consumer Group", + "uri":"UpdateConsumerGroup.html", + "doc_type":"api", + "p_code":"10", + "code":"16" + }, + { + "desc":"This API is used to query the consumer group list or details.GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topicsNoneStatus code: 200Topic list of the consu", + "product_code":"hrm", + "title":"Querying the Consumer Group List or Details", + "uri":"ShowConsumerListOrDetails.html", + "doc_type":"api", + "p_code":"10", + "code":"17" + }, + { + "desc":"This API is used to reset the consumer offset.POST /v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/reset-message-offsetStatus code: 200Resetting consumer", + "product_code":"hrm", + "title":"Resetting the Consumer Offset", + "uri":"ResetConsumeOffsetForRocketMq.html", + "doc_type":"api", + "p_code":"10", + "code":"18" + }, + { + "desc":"This API is used to query the consumer list of a consumer group.GET /v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/clientsNoneStatus code: 200Querying t", + "product_code":"hrm", + "title":"Querying the Consumer List", + "uri":"ShowConsumerConnectionsForRocketMq.html", + "doc_type":"api", + "p_code":"10", + "code":"19" + }, + { + "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":"hrm", + "title":"Topic Management", + "uri":"topic_300000002.html", + "doc_type":"api", + "p_code":"2", + "code":"20" + }, + { + "desc":"This API is used to create a topic or delete topics in batches.POST /v2/{project_id}/instances/{instance_id}/topicsStatus code: 200Creating topics for a RocketMQ 5.x inst", + "product_code":"hrm", + "title":"Creating a Topic or Deleting Topics in Batches", + "uri":"CreateTopicOrBatchDeleteTopic.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to query the topic list of a RocketMQ instance.GET /v2/{project_id}/instances/{instance_id}/topicsNoneStatus code: 200Querying a list of 10 topics of a s", + "product_code":"hrm", + "title":"Querying the Topic List", + "uri":"ListRocketInstanceTopics.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to delete a specified topic.DELETE /v2/{project_id}/instances/{instance_id}/topics/{topic}NoneStatus code: 204The specified topic is deleted.NoneDeleting", + "product_code":"hrm", + "title":"Deleting a Topic", + "uri":"DeleteTopic.html", + "doc_type":"api", + "p_code":"20", + "code":"23" + }, + { + "desc":"This API is used to query a topic.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}NoneStatus code: 200Querying details about a specified topicStatus code: 200T", + "product_code":"hrm", + "title":"Querying a Topic", + "uri":"ShowOneTopic.html", + "doc_type":"api", + "p_code":"20", + "code":"24" + }, + { + "desc":"This API is used to modify a topic.PUT /v2/{project_id}/instances/{instance_id}/topics/{topic}Status code: 204The topic is modified.NoneChanging a specified topic's total", + "product_code":"hrm", + "title":"Modifying a Topic", + "uri":"UpdateTopic.html", + "doc_type":"api", + "p_code":"20", + "code":"25" + }, + { + "desc":"This API is used to query the topic consumer group list.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/groupsNoneStatus code: 200Querying the consumer group ", + "product_code":"hrm", + "title":"Querying the Topic Consumer Group List", + "uri":"ListConsumerGroupOfTopic.html", + "doc_type":"api", + "p_code":"20", + "code":"26" + }, + { + "desc":"This API is used to query the number of messages in a topic.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/statusNoneStatus code: 200Querying the number of m", + "product_code":"hrm", + "title":"Querying the Number of Messages in a Topic", + "uri":"ShowTopicStatus.html", + "doc_type":"api", + "p_code":"20", + "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":"hrm", + "title":"Managing Messages", + "uri":"topic_300000011.html", + "doc_type":"api", + "p_code":"2", + "code":"28" + }, + { + "desc":"This API is used to query messages.GET /v2/{project_id}/rocketmq/instances/{instance_id}/messagesNoneStatus code: 200This API is used to query messages.Status code: 200Me", + "product_code":"hrm", + "title":"Querying Messages", + "uri":"ListMessagesForRocketMq.html", + "doc_type":"api", + "p_code":"28", + "code":"29" + }, + { + "desc":"This API is used to send messages.POST /v2/{project_id}/rocketmq/instances/{instance_id}/messagesStatus code: 200Sending messagesStatus code: 200Queried.See Error Codes.", + "product_code":"hrm", + "title":"Sending Messages", + "uri":"SendMessageForRocketMq.html", + "doc_type":"api", + "p_code":"28", + "code":"30" + }, + { + "desc":"This API is used to query the message trace.GET /v2/{project_id}/rocketmq/instances/{instance_id}/traceNoneStatus code: 200Querying the message trace of a RocketMQ instan", + "product_code":"hrm", + "title":"Querying the Message Trace", + "uri":"ListMessageTraceForRocketMq.html", + "doc_type":"api", + "p_code":"28", + "code":"31" + }, + { + "desc":"This API is used to resend dead letter messages.POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/deadletter-resendStatus code: 200Resending dead letter mes", + "product_code":"hrm", + "title":"Resending Dead Letter Messages", + "uri":"SendDlqMessageForRocketMq.html", + "doc_type":"api", + "p_code":"28", + "code":"32" + }, + { + "desc":"This API is used to verify consumption.POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/resendStatus code: 200Verifying consumptionStatus code: 200Consumpt", + "product_code":"hrm", + "title":"Verifying Consumption", + "uri":"ValidateConsumedMessageForRocketMq.html", + "doc_type":"api", + "p_code":"28", + "code":"33" + }, + { + "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":"hrm", + "title":"User Management", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"2", + "code":"34" + }, + { + "desc":"This API is used to create a user.POST /v2/{project_id}/instances/{instance_id}/usersStatus code: 200Creating a non-administrator user with permissions to publish and sub", + "product_code":"hrm", + "title":"Creating a User", + "uri":"CreateUser.html", + "doc_type":"api", + "p_code":"34", + "code":"35" + }, + { + "desc":"This API is used to query the user list.GET /v2/{project_id}/instances/{instance_id}/usersNoneStatus code: 200Querying the user listStatus code: 200Query result.See Error", + "product_code":"hrm", + "title":"Querying the User List", + "uri":"ListUser.html", + "doc_type":"api", + "p_code":"34", + "code":"36" + }, + { + "desc":"This API is used to modify user parameters.PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}Status code: 200Granting user_name permissions to publish and sub", + "product_code":"hrm", + "title":"Modifying User Parameters", + "uri":"UpdateUser.html", + "doc_type":"api", + "p_code":"34", + "code":"37" + }, + { + "desc":"This API is used to query user details.GET /v2/{project_id}/instances/{instance_id}/users/{user_name}NoneStatus code: 200Querying user detailsStatus code: 200User details", + "product_code":"hrm", + "title":"Querying User Details", + "uri":"ShowUser.html", + "doc_type":"api", + "p_code":"34", + "code":"38" + }, + { + "desc":"This API is used to delete a user.DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name}NoneStatus code: 200Deleting a specified userStatus code: 200The deleti", + "product_code":"hrm", + "title":"Deleting a User", + "uri":"DeleteUser.html", + "doc_type":"api", + "p_code":"34", + "code":"39" + }, + { + "desc":"This API is used to query the list of users that have been granted permissions for a topic.GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/accesspolicyNoneSta", + "product_code":"hrm", + "title":"Querying Users Granted Permissions for a Topic", + "uri":"ListTopicAccessPolicy.html", + "doc_type":"api", + "p_code":"34", + "code":"40" + }, + { + "desc":"This API is used to query the list of users granted permissions for a consumer group.GET /v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/accesspolicyNone", + "product_code":"hrm", + "title":"Querying Users Granted Permissions for a Consumer Group", + "uri":"ListConsumeGroupAccessPolicyForRocketMq.html", + "doc_type":"api", + "p_code":"34", + "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":"hrm", + "title":"Metadata Migration", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"2", + "code":"42" + }, + { + "desc":"This API is used to create a metadata migration task.POST /v2/{project_id}/instances/{instance_id}/metadataStatus code: 200Creating a metadata migration task to migrate t", + "product_code":"hrm", + "title":"Creating a Metadata Migration Task", + "uri":"CreateRocketMqMigrationTask.html", + "doc_type":"api", + "p_code":"42", + "code":"43" + }, + { + "desc":"This API is used to query all migration tasks or a specified migration task of an instance.GET /v2/{project_id}/instances/{instance_id}/metadataNoneStatus code: 200Queryi", + "product_code":"hrm", + "title":"Querying All Migration Tasks or a Specified Migration Task of an Instance", + "uri":"ListRocketMqMigrationTask.html", + "doc_type":"api", + "p_code":"42", + "code":"44" + }, + { + "desc":"This API is used to delete metadata migration tasks in batches.POST /v2/{project_id}/instances/{instance_id}/metadata/batch-deleteStatus code: 200Deleting metadata migrat", + "product_code":"hrm", + "title":"Deleting Metadata Migration Tasks in Batches", + "uri":"BatchDeleteRocketMqMigrationTask.html", + "doc_type":"api", + "p_code":"42", + "code":"45" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"hrm", + "title":"Managing Parameters", + "uri":"topic_300000010.html", + "doc_type":"api", + "p_code":"2", + "code":"46" + }, + { + "desc":"This API is used to query RocketMQ configurations. Configuration details will be returned.GET /v2/{project_id}/rocketmq/instances/{instance_id}/configsNoneStatus code: 20", + "product_code":"hrm", + "title":"Querying RocketMQ Configurations", + "uri":"ShowRocketMqConfigs.html", + "doc_type":"api", + "p_code":"46", + "code":"47" + }, + { + "desc":"This API is used to modify RocketMQ configurations.PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configsStatus code: 204Successful.NoneModifying RocketMQ configur", + "product_code":"hrm", + "title":"Modifying RocketMQ Configurations", + "uri":"UpdateRocketMqConfigs.html", + "doc_type":"api", + "p_code":"46", + "code":"48" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"hrm", + "title":"Tag Management", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"2", + "code":"49" + }, + { + "desc":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/rocketmq/{instance_id}/tags/actionStatus code: 204Tags are successfully added or deleted.", + "product_code":"hrm", + "title":"Adding or Deleting Instance Tags in Batches", + "uri":"BatchCreateOrDeleteRocketmqTag.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "desc":"This API is used to query instance tags.GET /v2/{project_id}/rocketmq/{instance_id}/tagsNoneStatus code: 200Querying instance tagsStatus code: 200Instance tags queried su", + "product_code":"hrm", + "title":"Querying Instance Tags", + "uri":"ShowRocketmqTags.html", + "doc_type":"api", + "p_code":"49", + "code":"51" + }, + { + "desc":"This API is used to query tags of a project.GET /v2/{project_id}/rocketmq/tagsNoneStatus code: 200Querying project tagsStatus code: 200The project tags are queried succes", + "product_code":"hrm", + "title":"Querying Project Tags", + "uri":"ShowRocketmqProjectTags.html", + "doc_type":"api", + "p_code":"49", + "code":"52" + }, + { + "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":"hrm", + "title":"Instance Diagnosis", + "uri":"topic_300000008.html", + "doc_type":"api", + "p_code":"2", + "code":"53" + }, + { + "desc":"This API is used to create an instance diagnosis task.POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosisStatus code: 200Creating an instance diagnosis taskS", + "product_code":"hrm", + "title":"Creating an Instance Diagnosis Task", + "uri":"CreateDiagnosisTaskForRocketMq.html", + "doc_type":"api", + "p_code":"53", + "code":"54" + }, + { + "desc":"This API is used to query an instance diagnosis report list.GET /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosisNoneStatus code: 200Querying an instance diagno", + "product_code":"hrm", + "title":"Querying an Instance Diagnosis Report List", + "uri":"ListDiagnosisReportsForRocketMq.html", + "doc_type":"api", + "p_code":"53", + "code":"55" + }, + { + "desc":"This API is used to delete diagnosis reports of an instance in batches.POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis/batch-deleteStatus code: 200Deleti", + "product_code":"hrm", + "title":"Deleting Instance Diagnosis Reports in Batches", + "uri":"BatchDeleteDiagnosisRecordsForRocketMq.html", + "doc_type":"api", + "p_code":"53", + "code":"56" + }, + { + "desc":"This API is used to query an instance diagnosis report.GET /v2/{project_id}/rocketmq/diagnosis/{report_id}NoneStatus code: 200Querying an instance diagnosis reportStatus ", + "product_code":"hrm", + "title":"Querying an Instance Diagnosis Report", + "uri":"ShowDiagnosisReportForRocketMq.html", + "doc_type":"api", + "p_code":"53", + "code":"57" + }, + { + "desc":"This API is used to query stack information.GET /v2/{project_id}/rocketmq/diagnosis/stack/{stack_id}NoneStatus code: 200Querying stack informationStatus code: 200successS", + "product_code":"hrm", + "title":"Querying Stack Information", + "uri":"ShowDiagnosisStackForRocketMq.html", + "doc_type":"api", + "p_code":"53", + "code":"58" + }, + { + "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":"hrm", + "title":"Managing Specification Changes", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"2", + "code":"59" + }, + { + "desc":"This API is used to query the product information for instance specification modification.GET /v2/{project_id}/rocketmq/instances/{instance_id}/extendNoneStatus code: 200", + "product_code":"hrm", + "title":"Querying Product Information for Instance Specification Modification", + "uri":"ShowEngineInstanceExtendProductInfoForRocketMq.html", + "doc_type":"api", + "p_code":"59", + "code":"60" + }, + { + "desc":"This API is used to change instance specifications.POST /v2/{project_id}/rocketmq/instances/{instance_id}/extendStatus code: 200Increasing an instance flavorPOST https://", + "product_code":"hrm", + "title":"Changing Instance Specifications", + "uri":"ResizeInstanceForRocketMq.html", + "doc_type":"api", + "p_code":"59", + "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":"hrm", + "title":"Background Task Management", + "uri":"topic_300000009.html", + "doc_type":"api", + "p_code":"2", + "code":"62" + }, + { + "desc":"This API is used to delete specified records in scheduled task management.DELETE /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}NoneStatus code: 204Sch", + "product_code":"hrm", + "title":"Deleting Specified Records in Scheduled Task Management", + "uri":"DeleteScheduledTask.html", + "doc_type":"api", + "p_code":"62", + "code":"63" + }, + { + "desc":"This API is used to modify specified records in scheduled task management.PUT /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}NoneStatus code: 204Schedu", + "product_code":"hrm", + "title":"Modifying Specified Records in Scheduled Task Management", + "uri":"UpdateScheduledTask.html", + "doc_type":"api", + "p_code":"62", + "code":"64" + }, + { + "desc":"This API is used to query the scheduled task list of an instance.GET /v2/{project_id}/instances/{instance_id}/scheduled-tasksNoneStatus code: 200Querying scheduled tasks ", + "product_code":"hrm", + "title":"Querying the Scheduled Task List of an Instance", + "uri":"ListScheduledTasks.html", + "doc_type":"api", + "p_code":"62", + "code":"65" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"hrm", + "title":"Other APIs", + "uri":"topic_300000007.html", + "doc_type":"api", + "p_code":"2", + "code":"66" + }, + { + "desc":"This API is used to query the AZ ID for creating an instance.GET /v2/available-zonesNoneStatus code: 200Querying AZ informationStatus code: 200AZ information queried succ", + "product_code":"hrm", + "title":"Querying AZ Information", + "uri":"ListAvailableZones.html", + "doc_type":"api", + "p_code":"66", + "code":"67" + }, + { + "desc":"This API is used to query the maximum number of instances that a tenant can create, the number of created instances, and the maximum number of tags that can be created fo", + "product_code":"hrm", + "title":"Querying Tenant Quotas", + "uri":"ShowQuotas.html", + "doc_type":"api", + "p_code":"66", + "code":"68" + }, + { + "desc":"This API is used to query the flavor list of an engine.GET /v2/{engine}/productsNoneStatus code: 200Status code: 200SuccessfulSee Error Codes.", + "product_code":"hrm", + "title":"Querying Flavor List", + "uri":"ListEngineProducts.html", + "doc_type":"api", + "p_code":"66", + "code":"69" + }, + { + "desc":"This API is used to query instance monitoring dimensions.GET /v2/{project_id}/instances/{instance_id}/ces-hierarchyNoneStatus code: 200Status code: 200Queried.See Error C", + "product_code":"hrm", + "title":"Querying Instance Monitoring Dimensions", + "uri":"ShowCesHierarchy.html", + "doc_type":"api", + "p_code":"66", + "code":"70" + }, + { + "desc":"This API is used to obtain the feature switch list.GET /v2/config/featuresNoneStatus code: 200Status code: 200Queried.See Error Codes.", + "product_code":"hrm", + "title":"Obtaining the Feature Switch List", + "uri":"ListConfigFeatures.html", + "doc_type":"api", + "p_code":"66", + "code":"71" + }, + { + "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":"hrm", + "title":"Appendix", + "uri":"hrm-api-0008.html", + "doc_type":"api", + "p_code":"", + "code":"72" + }, + { + "desc":"Table 1 lists status codes.", + "product_code":"hrm", + "title":"Status Code", + "uri":"hrm-api-0009.html", + "doc_type":"api", + "p_code":"72", + "code":"73" + }, + { + "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":"hrm", + "title":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"72", + "code":"74" + }, + { + "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":"hrm", + "title":"Instance Statuses", + "uri":"hrm-api-0010.html", + "doc_type":"api", + "p_code":"72", + "code":"75" + }, + { + "desc":"A project ID is required for some URLs when an API is called. Obtain a project ID using either of the following methods:Obtaining a Project ID by Calling an APIObtaining ", + "product_code":"hrm", + "title":"Obtaining a Project ID", + "uri":"hrm-api-0011.html", + "doc_type":"api", + "p_code":"72", + "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":"hrm", + "title":"Change History", + "uri":"hrm-api-0014.html", + "doc_type":"api", + "p_code":"", + "code":"77" + } +] \ No newline at end of file diff --git a/docs/dms_rocketmq/api-ref/CreateConsumerGroupOrBatchDeleteConsumerGroup.html b/docs/dms_rocketmq/api-ref/CreateConsumerGroupOrBatchDeleteConsumerGroup.html new file mode 100644 index 000000000..e6c040853 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CreateConsumerGroupOrBatchDeleteConsumerGroup.html @@ -0,0 +1,269 @@ + + +

Creating a Consumer Group or Batch Deleting Consumer Groups

+

Function

This API is used to create a consumer group or batch deleting consumer groups.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

No

+

String

+

This parameter is used to delete consumer groups in batches. If it is not set, a consumer group will be created. delete: Delete consumer groups in batches.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

job_id

+

No

+

String

+

Definition

+

List of consumer groups to be deleted.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

No

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (|), hyphens (-), and underscores (_).

+

Mandatory for consumer group creation.

+

Range

+

N/A

+

Default Value

+

N/A

+

broadcast

+

No

+

Boolean

+

Whether to broadcast.

+

retry_max_time

+

No

+

Integer

+

Maximum number of retries (1 to 16 characters).

+

enabled

+

No

+

Boolean

+

Whether consumption is allowed.

+

consume_orderly

+

No

+

Boolean

+

Definition

+

Whether orderly consumption is enabled.

+

Constraints

+

This parameter is required only for RocketMQ 5.x instances.

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

group_desc

+

No

+

String

+

Consumer group description (0 to 200 characters).

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

ID of the consumer group deletion task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Name of the created consumer group.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

A consumer group is created or multiple consumer groups are deleted in batches.

+ +
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

A consumer group is created or multiple consumer groups are deleted in batches.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/CreateDiagnosisTaskForRocketMq.html b/docs/dms_rocketmq/api-ref/CreateDiagnosisTaskForRocketMq.html new file mode 100644 index 000000000..eb2b22112 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CreateDiagnosisTaskForRocketMq.html @@ -0,0 +1,167 @@ + + +

Creating an Instance Diagnosis Task

+

Function

This API is used to create an instance diagnosis task.

+
+

URI

POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

group_name

+

Yes

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

node_id_list

+

No

+

Array of strings

+

Definition

+

Node ID list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

report_id

+

String

+

Definition

+

Report ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Creating an instance diagnosis task

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis
+
+{
+  "group_name" : "test",
+  "node_id_list" : [ ]
+}
+
+

Example Responses

Status code: 200

+

success

+
{
+  "report_id" : "b00a070e-75e0-4463-b53e-fbc29dcff951"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

success

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/CreatePostPaidInstanceForRocketMq.html b/docs/dms_rocketmq/api-ref/CreatePostPaidInstanceForRocketMq.html new file mode 100644 index 000000000..1244d7b0c --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CreatePostPaidInstanceForRocketMq.html @@ -0,0 +1,475 @@ + + +

Creating an Instance

+

Function

This API is used to create an instance.

+
+

URI

POST /v2/{project_id}/rocketmq/instances

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Instance name.

+

Constraints

+

An instance name starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-).

+

Range

+

N/A

+

Default Value

+

N/A

+

description

+

No

+

String

+

Definition

+

Description of an instance.

+

Constraints

+

0–1024 characters.

+

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

+

Range

+

N/A

+

Default Value

+

N/A

+

engine

+

Yes

+

String

+

Definition

+

Message engine type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ message engine.

    +
  • reliability: RocketMQ message engine alias.

    +
+

Default Value

+

N/A

+

engine_version

+

Yes

+

String

+

Definition

+

Message engine version.

+

Constraints

+

N/A

+

Range

+
  • 5.x

    +
+

Default Value

+

N/A

+

storage_space

+

Yes

+

Integer

+

Definition

+

Storage space, in GB.

+

Range

+

Different instance specifications support different storage configurations.

+
  • RocketMQ 5.x single-node storage range: 100–30000

    +
  • RocketMQ 5.x cluster storage range: 200–60000

    +
+

vpc_id

+

Yes

+

String

+

Definition

+

VPC ID. You can call the API for querying VPCs to obtain the VPC ID. The VPC ID is in the response body. For details, see Virtual Private Cloud API Reference.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_id

+

Yes

+

String

+

Definition

+

Subnet information. You can call the API for querying subnets to obtain the subnet ID. The subnet ID is in the response body. For details, see Virtual Private Cloud API Reference.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

security_group_id

+

Yes

+

String

+

Definition

+

Security group to which the instance belongs. You can call the API for querying security groups to obtain the security group ID. The security group ID is in the response body. For details, see Virtual Private Cloud API Reference.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zones

+

Yes

+

Array of strings

+

Definition

+

ID of the AZ where instance brokers reside and which has available resources. Obtain the AZ ID by referring to Querying AZ Information.

+

Constraints

+

The parameter value cannot be empty or null. Check whether resources exist in the AZs.

+

A RocketMQ instance can be deployed in 1 AZ or at least 3 AZs. When specifying AZs for brokers, use commas (,) to separate multiple AZs.

+

Range

+

N/A

+

Default Value

+

N/A

+

product_id

+

Yes

+

String

+

Definition

+

RocketMQ instance flavors.

+

Constraints

+

N/A

+

Range

+

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

+
  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

    +
  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

    +
  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

    +
  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

    +
+

Default Value

+

N/A

+

ssl_enable

+

No

+

Boolean

+

Definition

+

Whether to enable SSL-encrypted access.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

false

+

storage_spec_code

+

Yes

+

String

+

Definition

+

Storage I/O flavor.

+

Constraints

+

N/A

+

Range

+
  • dms.physical.storage.high.v2: high I/O disk

    +
  • dms.physical.storage.ultra.v2: ultra-high I/O disk

    +
  • dms.physical.storage.general: general-purpose SSD

    +
  • dms.physical.storage.extreme: extreme SSD

    +
+

Default Value

+

N/A

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID. This parameter is mandatory for an enterprise project account.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

enable_acl

+

No

+

Boolean

+

Definition

+

Whether to enable access control.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

proxy_enable

+

No

+

Boolean

+

Definition

+

Whether to enable the proxy function.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

false

+

enable_publicip

+

No

+

Boolean

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

false

+

publicip_id

+

No

+

String

+

Definition

+

ID of the EIP bound to the instance.

+

Constraints

+

Use commas (,) to separate multiple EIP IDs.

+

This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_num

+

Yes

+

Integer

+

Definition

+

Number of brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

arch_type

+

No

+

String

+

Definition

+

Architecture type.

+

Constraints

+

N/A

+

Range

+
  • X86: complex instruction set compute.

    +
  • ARM: simplified instruction set compute.

    +
+

Default Value

+

N/A

+

tls_mode

+

No

+

String

+

Definition

+

Security protocol used by an instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Definition

+

Instance ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Creating a RocketMQ instance with the 4 vCPUs | 16 GB × 2 brokers and 1200 GB storage space.

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances
+
+{
+  "name" : "reliability-1751840557",
+  "description" : "",
+  "engine" : "reliability",
+  "engine_version" : "5.x",
+  "storage_space" : 1200,
+  "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
+  "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
+  "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
+  "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
+  "product_id" : "c6.4u16g.cluster.x86",
+  "enterprise_project_id" : "0",
+  "ssl_enable" : false,
+  "storage_spec_code" : "dms.physical.storage.ultra.v2",
+  "enable_publicip" : false,
+  "publicip_id" : "",
+  "broker_num" : 2
+}
+
+

Example Responses

Status code: 200

+

Instance created.

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

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance created.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/CreateRocketMqMigrationTask.html b/docs/dms_rocketmq/api-ref/CreateRocketMqMigrationTask.html new file mode 100644 index 000000000..bafc31534 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CreateRocketMqMigrationTask.html @@ -0,0 +1,900 @@ + + +

Creating a Metadata Migration Task

+

Function

This API is used to create a metadata migration task.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

overwrite

+

Yes

+

String

+

Definition

+

true: Configurations in the metadata file with the same name as the uploaded file will be overwritten. false: An error is reported when a topic or group already exists.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

Yes

+

String

+

Definition

+

Migration task name. For details about the naming rules, see the API for creating an instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

Yes

+

String

+

Definition

+

Migration task type. The value can be rocketmq or rabbitToRocket.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

topic_config_table

+

No

+

Map<String,MigrationRocketMqTopicConfig>

+

Definition

+

RocketMQ instance topic metadata. The topic name is the key and the topic configuration is the value. This parameter is mandatory for rocketmq migration tasks (from self-built RocketMQ instances to DMS for RocketMQ).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subscription_group_table

+

No

+

Map<String,MigrationRocketMqSubscriptionGroup>

+

Definition

+

RocketMQ consumer group metadata. The consumer group name is the key and the configuration is the value. This parameter is mandatory for rocketmq migration tasks (from self-built RocketMQ instances to DMS for RocketMQ).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

vhosts

+

No

+

Array of MigrationRabbitVhostMetadata objects

+

Definition

+

RabbitMQ virtual host metadata list. This parameter is mandatory for rabbitToRocket migration tasks (from self-built RabbitMQ instances to DMS for RocketMQ).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queues

+

No

+

Array of MigrationRabbitQueueMetadata objects

+

Definition

+

RabbitMQ queue metadata list. This parameter is mandatory for rabbitToRocket migration tasks (from self-built RabbitMQ instances to DMS for RocketMQ).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

exchanges

+

No

+

Array of MigrationRabbitExchangeMetadata objects

+

Definition

+

RabbitMQ exchange metadata list. This parameter is mandatory for rabbitToRocket migration tasks (from self-built RabbitMQ instances to DMS for RocketMQ).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

bindings

+

No

+

Array of MigrationRabbitBindingMetadata objects

+

Definition

+

RabbitMQ binding metadata list. This parameter is mandatory for rabbitToRocket migration tasks (from self-built RabbitMQ instances to DMS for RocketMQ).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MigrationRocketMqTopicConfig

Parameter

+

Mandatory

+

Type

+

Description

+

topic_name

+

No

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

order

+

No

+

Boolean

+

Definition

+

Whether messages are ordered.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false" No

    +
+

Default Value

+

false

+

perm

+

No

+

Integer

+

Definition

+

Topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

6

+

read_queue_nums

+

No

+

Integer

+

Definition

+

Number of read queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

16

+

write_queue_nums

+

No

+

Integer

+

Definition

+

Number of write queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

16

+

topic_filter_type

+

No

+

String

+

Definition

+

Topic filtering type.

+

Constraints

+

N/A

+

Range

+
  • SINGLE_TAG: single tag

    +
    • MULTI_TAG: multiple tags

      +
    +

    Default Value

    +
+

N/A

+

topic_sys_flag

+

No

+

Integer

+

Definition

+

Topic system flag.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 MigrationRocketMqSubscriptionGroup

Parameter

+

Mandatory

+

Type

+

Description

+

group_name

+

No

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consume_broadcast_enable

+

No

+

Boolean

+

Definition

+

Whether to allow broadcast.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

consume_enable

+

No

+

Boolean

+

Definition

+

Whether to enable consumption.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

true

+

consume_from_min_enable

+

No

+

Boolean

+

Definition

+

Whether to enable consumption from the earliest offset.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

true

+

notify_consumer_ids_changed_enable

+

No

+

Boolean

+

Definition

+

Whether to notify consumer ID changes.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

true

+

retry_max_times

+

No

+

Integer

+

Definition

+

Maximum number of consumption retries.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

16

+

retry_queue_nums

+

No

+

Integer

+

Definition

+

Maximum number of consumption retries.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

1

+

which_broker_when_consume_slow

+

No

+

Long

+

Definition

+

ID of the broker selected for slow consumption

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

1

+
+
+ +
+ + + + + + + + + + + +
Table 6 MigrationRabbitVhostMetadata

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Virtual host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 MigrationRabbitQueueMetadata

Parameter

+

Mandatory

+

Type

+

Description

+

vhost

+

No

+

String

+

Definition

+

Virtual host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

No

+

String

+

Definition

+

Queue name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

durable

+

No

+

Boolean

+

Definition

+

Whether to enable data persistence.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 MigrationRabbitExchangeMetadata

Parameter

+

Mandatory

+

Type

+

Description

+

vhost

+

No

+

String

+

Definition

+

Virtual host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

No

+

String

+

Definition

+

Exchange name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

No

+

String

+

Definition

+

Exchange type.

+

Constraints

+

N/A

+

Range

+
  • topic: Fuzzy match by routing key is supported.

    +
  • direct: Messages are routed in exact match by routing key.

    +
  • fanout: broadcast mode. Messages are sent to all bound queues, regardless of routing keys.

    +
  • headers: Routing is based on the key-value pair in the message header (headers) instead of on the routing key.

    +
+

Default Value

+

N/A

+

durable

+

No

+

Boolean

+

Definition

+

Whether to enable data persistence.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 MigrationRabbitBindingMetadata

Parameter

+

Mandatory

+

Type

+

Description

+

vhost

+

No

+

String

+

Definition

+

Virtual host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

source

+

No

+

String

+

Definition

+

Message source.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

destination

+

No

+

String

+

Definition

+

Message target.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

destination_type

+

No

+

String

+

Definition

+

Target type.

+

Constraints

+

N/A

+

Range

+
  • exchange

    +
  • queue

    +
+

Default Value

+

N/A

+

routing_key

+

No

+

String

+

Definition

+

Routing key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

task_id

+

String

+

Definition

+

Task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Successful

+
{
+  "task_id" : "6cf4dcd3-8471-4139-8b5b-8a3a71f704c7"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Successful

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/CreateTopicOrBatchDeleteTopic.html b/docs/dms_rocketmq/api-ref/CreateTopicOrBatchDeleteTopic.html new file mode 100644 index 000000000..96cfe4fa9 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CreateTopicOrBatchDeleteTopic.html @@ -0,0 +1,250 @@ + + +

Creating a Topic or Deleting Topics in Batches

+

Function

This API is used to create a topic or delete topics in batches.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

No

+

String

+

Definition

+

This parameter is used to delete topics in batches. If it is not set, a topic will be created.

+

Constraints

+

N/A

+

Range

+
  • delete: batch deletion

    +
  • Left blank: topic creation

    +
+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Topic name.

+

Constraints

+

Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (|), hyphens (-), and underscores (_).

+

Mandatory for topic creation.

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_num

+

No

+

Number

+

Total number of queues. The range is 1–50.

+

message_type

+

No

+

String

+

Message type (This parameter is mandatory only for RocketMQ 5.x instances).

+

Options:

+
  • NORMAL (normal messages)

    +
  • FIFO (ordered messages)

    +
  • DELAY (scheduled messages)

    +
  • TRANSACTION (transactional messages)

    +
+

topics

+

No

+

Array of strings

+

Definition

+

Topic list. This parameter is used when topics are deleted in batches.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

job_id

+

String

+

Definition

+

ID of the topic deletion task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Topic created.

+ +
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Topic created.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/CreateUser.html b/docs/dms_rocketmq/api-ref/CreateUser.html new file mode 100644 index 000000000..75cd4c30a --- /dev/null +++ b/docs/dms_rocketmq/api-ref/CreateUser.html @@ -0,0 +1,587 @@ + + +

Creating a User

+

Function

This API is used to create a user.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

access_key

+

No

+

String

+

Definition

+

Username.

+

Constraints

+

Starts with a letter, consists of 7 to 64 characters, and contains only letters, digits, hyphens (-), and underscores (_).

+

Range

+

N/A

+

Default value

+

N/A

+

secret_key

+

Yes

+

String

+

Definition

+

Key. If the key is empty, the key is not updated and the old key is still used.

+

Constraints

+

8 to 32 characters.

+

Contain at least three of the following character types:

+
  • Uppercase letters

    +
  • Lowercase letters

    +
  • Digits

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

    +
+

Cannot be the username or the username spelled backwards.

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

No

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

admin

+

No

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

default_topic_perm

+

No

+

String

+

Definition

+

Default topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permissions.

    +
  • SUB: subscribe permissions.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

default_group_perm

+

No

+

String

+

Definition

+

Default consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

topic_perms

+

No

+

Array of topic_perms objects

+

Definition

+

Special topic permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_perms

+

No

+

Array of group_perms objects

+

Definition

+

Special consumer group permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 topic_perms

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

perm

+

No

+

String

+

Definition

+

Topic permission.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permissions.

    +
  • SUB: subscribe permissions.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 group_perms

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

perm

+

No

+

String

+

Definition

+

Consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

access_key

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

secret_key

+

String

+

Definition

+

Key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

admin

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

default_topic_perm

+

String

+

Definition

+

Default topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

default_group_perm

+

String

+

Definition

+

Default consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

topic_perms

+

Array of topic_perms objects

+

Definition

+

Special topic permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_perms

+

Array of group_perms objects

+

Definition

+

Special consumer group permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 topic_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 group_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Creating a non-administrator user with permissions to publish and subscribe to topic1 and group1

+
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
+
+{
+  "access_key" : "user_name",
+  "secret_key" : "Abcd1234!",
+  "white_remote_address" : "",
+  "admin" : false,
+  "default_topic_perm" : "DENY",
+  "default_group_perm" : "DENY",
+  "topic_perms" : [ {
+    "name" : "topic1",
+    "perm" : "PUB|SUB"
+  } ],
+  "group_perms" : [ {
+    "name" : "group1",
+    "perm" : "PUB|SUB"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

The creation is successful.

+
{
+  "access_key" : "test_01",
+  "admin" : false,
+  "default_group_perm" : "DENY",
+  "default_topic_perm" : "SUB",
+  "group_perms" : [ ],
+  "secret_key" : "Abcd1234!",
+  "topic_perms" : [ ],
+  "white_remote_address" : ""
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The creation is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/DeleteConsumerGroup.html b/docs/dms_rocketmq/api-ref/DeleteConsumerGroup.html new file mode 100644 index 000000000..a0f786e3a --- /dev/null +++ b/docs/dms_rocketmq/api-ref/DeleteConsumerGroup.html @@ -0,0 +1,105 @@ + + +

Deleting a Consumer Group

+

Function

This API is used to delete a specified consumer group.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 204

+

The specified consumer group is deleted.

+

None

+
+

Example Requests

Deleting a specified consumer group

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

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The specified consumer group is deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/DeleteInstance.html b/docs/dms_rocketmq/api-ref/DeleteInstance.html new file mode 100644 index 000000000..d69051596 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/DeleteInstance.html @@ -0,0 +1,89 @@ + + +

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

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 204

+

Specified instance deleted successfully.

+

None

+
+

Example Requests

Deleting an instance

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

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Specified instance deleted successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/DeleteScheduledTask.html b/docs/dms_rocketmq/api-ref/DeleteScheduledTask.html new file mode 100644 index 000000000..edf09d9b2 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/DeleteScheduledTask.html @@ -0,0 +1,104 @@ + + +

Deleting Specified Records in Scheduled Task Management

+

Function

This API is used to delete specified records in scheduled task management.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

task_id

+

Yes

+

String

+

Definition

+

Scheduled task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 204

+

Scheduled task deleted.

+

None

+
+

Example Requests

/v2/{project_id}/instances/{instance_id}/scheduled-tasks/ff80808288ae8b6a0188ae91f6fc000d
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Scheduled task deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/DeleteTopic.html b/docs/dms_rocketmq/api-ref/DeleteTopic.html new file mode 100644 index 000000000..d8b9ca80a --- /dev/null +++ b/docs/dms_rocketmq/api-ref/DeleteTopic.html @@ -0,0 +1,105 @@ + + +

Deleting a Topic

+

Function

This API is used to delete a specified topic.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/topics/{topic}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 204

+

The specified topic is deleted.

+

None

+
+

Example Requests

Deleting a specified topic

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

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The specified topic is deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/DeleteUser.html b/docs/dms_rocketmq/api-ref/DeleteUser.html new file mode 100644 index 000000000..5d7b6ad6a --- /dev/null +++ b/docs/dms_rocketmq/api-ref/DeleteUser.html @@ -0,0 +1,133 @@ + + +

Deleting a User

+

Function

This API is used to delete a user.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_name

+

Yes

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

message

+

String

+

Definition

+

Information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Deleting a specified user

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

Example Responses

Status code: 200

+

The deletion is successful.

+
{
+  "message" : "delete user success."
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The deletion is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ErrorCode.html b/docs/dms_rocketmq/api-ref/ErrorCode.html new file mode 100644 index 000000000..d98bfde49 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ErrorCode.html @@ -0,0 +1,2253 @@ + + +

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

+

Invalid password format.

+

The password does not meet the complexity requirements.

+

Check whether the password meets the 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.

    +
+

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

+

Insufficient IPs in the selected subnet.

+

Too few IP addresses in the selected subnet.

+

Select another subnet with sufficient IP addresses.

+

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

+

The number of partitions created for a topic in a Kafka instance must be within the range of 1-200.

+

Check the number of partitions of the topic.

+

400

+

DMS.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 scale 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 scale 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.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.00400133

+

Sink task quota for connector invalid.

+

Invalid connector task quota.

+

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

+

Timestamp is invalid.

+

Timestamp is invalid.

+

Enter a correct timestamp.

+

400

+

DMS.00400500

+

Invalid disk space.

+

Invalid disk space.

+

Check the disk space.

+

400

+

DMS.00400800

+

Invalid request parameter. Check the request parameter.

+

Invalid request parameter.

+

Check the request parameters.

+

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

+

Failed to create the Smart Connect task.

+

Failed to create the Smart Connect task.

+

Contact technical support.

+

400

+

DMS.00400868

+

Failed to stop the Smart Connect task.

+

Failed to stop the Smart Connect task.

+

Try again later.

+

400

+

DMS.00400869

+

Failed to start the Smart Connect task.

+

Failed to start the Smart Connect task.

+

Try again later.

+

400

+

DMS.00400870

+

Failed to verify the Smart Connect task.

+

Failed to verify the Smart Connect task.

+

Try again later.

+

400

+

DMS.00400872

+

Failed to restart the Smart Connect task.

+

Failed to restart the Smart Connect task.

+

Try again later.

+

400

+

DMS.00400873

+

Failed to modify the Smart Connect task.

+

Failed to modify the Smart Connect task.

+

Contact technical support.

+

400

+

DMS.00400874

+

The topic has been used in another Smart Connect task.

+

The topic has been used in another Smart Connect task.

+

Check the topic and try again.

+

400

+

DMS.00400876

+

The topic does not exist.

+

The topic does not exist.

+

Check the topic and try again.

+

400

+

DMS.00400882

+

The topic offset cannot be deleted: The topic is subscribed by the current consumer group.

+

The topic offset cannot be deleted: The topic is subscribed by the current consumer group.

+

Cancel the subscription relationship between the topic and the consumer group.

+

400

+

DMS.00400970

+

Invalid RabbitMQ plugin name.

+

Invalid plugin name

+

Check the plugin list.

+

400

+

DMS.00400971

+

The instance ssl is off.

+

The instance ssl is off.

+

View the instance details and check whether SSL is enabled.

+

400

+

DMS.00400973

+

The topic consumer group is queried too frequently.

+

The topic consumer group is queried too frequently.

+

Ensure that there is only one request per instance at any time.

+

400

+

DMS.00400975

+

Failed to query topics.

+

Failed to query topics.

+

Check whether the topic exists.

+

400

+

DMS.00500033

+

Failed to access EPS to update the project

+

Failed to access EPS to update the project

+

Contact technical support.

+

400

+

DMS.00500960

+

Invalid user AK/SK.

+

Invalid user AK/SK.

+

Correct the user AK/SK and try again.

+

400

+

DMS.00500978

+

Consumer group name exists.

+

Consumer group name exists.

+

Please check the consumer group name.

+

400

+

DMS.00500980

+

Partition reassigning.

+

Partition reassigning.

+

Please check partition reassignment.

+

400

+

DMS.00500982

+

Insufficient broker disk.

+

Insufficient broker disk.

+

Check target broker disk capacity.

+

400

+

DMS.00500986

+

Your account has been restricted.

+

Your account is suspended.

+

Contact the billing center.

+

400

+

DMS.00500987

+

Balance is not enough

+

Insufficient balance.

+

Top up your account and try again later.

+

400

+

DMS.10240002

+

The number of queried queues exceeds the upper limit.

+

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.

+

400

+

DMS.111400860

+

Instance partition is not enough. Total partition is over the partition limitation.

+

Instance partition is not enough. Total partition is over the partition limitation.

+

Check whether the partition quantity is exceeded.

+

400

+

DMS.40001016

+

Invalid Kafka config for connector.

+

Invalid Kafka config for connector.

+

Check the configuration based on the error message and fix it.

+

400

+

DMS.40050005

+

Requested topic already exists.

+

Requested topic already exists.

+

Please check the requested topic.

+

400

+

DMS.40050015

+

Consumer group exists.

+

Consumer group exists.

+

Please check the consumer group.

+

400

+

DMS.50050004

+

The consumer group is offline.

+

The consumer group is offline.

+

Start the consumer instance in the consumer group.

+

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

+

Authorization denied.

+

Action does not allow to be performed.

+

Please check your permissions.

+

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

+

Connector does not exist.

+

Connector does not exist.

+

Check the connector.

+

404

+

DMS.00404026

+

The dumping task does not exist.

+

The dumping task does not exist.

+

Check the dumping task.

+

404

+

DMS.00404027

+

Connector already exists.

+

Connector already exists.

+

Check the connector.

+

404

+

DMS.00404029

+

The dumping task quota has been reached.

+

The dumping task quota has been reached.

+

Check the dumping task quota.

+

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.

+

408

+

DMS.111501024

+

Query timed out

+

Message query timeout

+

Please query later

+

500

+

111500032

+

Create order failed.

+

Create order failed.

+

Please contact technical support.

+

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

+

Failed to update topics.

+

Failed to update topics.

+

Contact technical support.

+

500

+

DMS.00501000

+

Failed to create agency, may be you do not have the agency permission.

+

Failed to create agency

+

check whether the current user has the agency permission.

+

500

+

DMS.00501001

+

Failed to get agency roleId.

+

Failed to get agency roleId.

+

Retry the request later.

+

500

+

DMS.00501002

+

Failed to query agency roleId.

+

Failed to query the role ID based on the role name.

+

Check whether the role name in the request is correct.

+

500

+

DMS.00501003

+

Failed to grant role to agency.

+

Failed to grant role to agency.

+

Try again later, or contact technical support

+

500

+

DMS.00501010

+

The product specification does not exist.

+

The product specification does not exist.

+

Contact technical support.

+

500

+

DMS.00501012

+

Smart Connect tasks exist.

+

Smart Connect tasks exist.

+

Delete all Smart Connect tasks.

+

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.

+

501

+

DMS.00501118

+

Insufficient CPU quota.

+

Insufficient CPU quota.

+

Apply for CPU quota.

+

501

+

DMS.111501026

+

Maximum bytes per query reached.

+

Maximum bytes per query reached.

+

Shorten the time range to ensure that the number of queried bytes does not exceed the limit, or use other methods to query data.

+

503

+

DMS.111501025

+

Query Busy. Please try again later.

+

Message query busy

+

Please query later

+
+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListAvailableZones.html b/docs/dms_rocketmq/api-ref/ListAvailableZones.html new file mode 100644 index 000000000..1150e5184 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListAvailableZones.html @@ -0,0 +1,187 @@ + + +

Querying 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

+

Definition

+

Region ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zones

+

Array of ListAvailableZonesElements objects

+

Definition

+

Array of AZs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 ListAvailableZonesElements

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

AZ ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

code

+

String

+

Definition

+

AZ code.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

AZ name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

port

+

String

+

Definition

+

AZ port.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_availability

+

String

+

Definition

+

Whether the AZ has available resources.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying AZ information

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

Example Responses

Status code: 200

+

AZ information queried successfully.

+
{
+  "region_id" : "xxx",
+  "available_zones" : [ {
+    "id" : "8c90c2a4e2594c0782faa6b205afeca7",
+    "code" : "xxx",
+    "name" : "AZ 1",
+    "port" : "8002",
+    "resource_availability" : "true"
+  }, {
+    "id" : "d539378ec1314c85b76fefa3f7071458",
+    "code" : "xxx",
+    "name" : "AZ 2",
+    "port" : "8003",
+    "resource_availability" : "true",
+    "default_az" : false
+  }, {
+    "id" : "9f1c5806706d4c1fb0eb72f0a9b18c77",
+    "code" : "xxx",
+    "name" : "AZ 3",
+    "port" : "443",
+    "resource_availability" : "true"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

AZ information queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListConfigFeatures.html b/docs/dms_rocketmq/api-ref/ListConfigFeatures.html new file mode 100644 index 000000000..a4fb5b523 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListConfigFeatures.html @@ -0,0 +1,129 @@ + + +

Obtaining the Feature Switch List

+

Function

This API is used to obtain the feature switch list.

+
+

URI

GET /v2/config/features

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

features

+

Array of ListConfigFeatures objects

+

Definition

+

Feature list.

+

totalRecord

+

Integer

+

Definition

+

Total number of features.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 2 ListConfigFeatures

Parameter

+

Type

+

Description

+

featureId

+

String

+

Definition

+

Feature ID.

+

Range

+

N/A

+

status

+

Integer

+

Definition

+

Status.

+

Constraints

+

N/A

+

Range

+
  • true: feature enabled

    +
  • false: feature disabled

    +
+

description

+

String

+

Definition

+

Feature description.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{endpoint}/v2/config/features
+
+

Example Responses

Status code: 200

+

Queried.

+
{
+  "features" : [ {
+    "featureId" : "rocketmq_cross_vpc",
+    "status" : 0,
+    "description" : "rocketmq cross vpc switch"
+  }, {
+    "featureId" : "pdp5_auth_enable",
+    "status" : 1,
+    "description" : "pdp5 check permission enable"
+  } ],
+  "totalRecord" : 2
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListConsumeGroupAccessPolicyForRocketMq.html b/docs/dms_rocketmq/api-ref/ListConsumeGroupAccessPolicyForRocketMq.html new file mode 100644 index 000000000..cae192201 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListConsumeGroupAccessPolicyForRocketMq.html @@ -0,0 +1,288 @@ + + +

Querying Users Granted Permissions for a Consumer Group

+

Function

This API is used to query the list of users granted permissions for a consumer group.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Definition

+

Consumer group.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Offset, which is the position where the query starts. The value must be no less than 0.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

policies

+

Array of policies objects

+

Definition

+

User list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total

+

Number

+

Definition

+

Total number of users.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Name of the topic or consumer group.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 policies

Parameter

+

Type

+

Description

+

access_key

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

admin

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

User permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the list of users granted permissions for a consumer group

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

Example Responses

Status code: 200

+

List of users granted permissions for a consumer group queried.

+
{
+  "policies" : [ {
+    "access_key" : "test_01",
+    "white_remote_address" : "",
+    "admin" : false,
+    "perm" : ""
+  } ],
+  "total" : 1,
+  "name" : "test"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

List of users granted permissions for a consumer group queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListConsumerGroupOfTopic.html b/docs/dms_rocketmq/api-ref/ListConsumerGroupOfTopic.html new file mode 100644 index 000000000..64912d322 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListConsumerGroupOfTopic.html @@ -0,0 +1,179 @@ + + +

Querying the Topic Consumer Group List

+

Function

This API is used to query the topic consumer group list.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Maximum number of records returned in a query.

+

Constraints

+

N/A

+

Range

+

1–50

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

groups

+

Array of strings

+

Definition

+

Consumer group list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the consumer group list of a specified topic

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

Example Responses

Status code: 200

+

Topic consumer group list queried successfully.

+
{
+  "groups" : [ "CID_JODIE_1", "test_consumer" ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Topic consumer group list queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListDiagnosisReportsForRocketMq.html b/docs/dms_rocketmq/api-ref/ListDiagnosisReportsForRocketMq.html new file mode 100644 index 000000000..027ff5345 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListDiagnosisReportsForRocketMq.html @@ -0,0 +1,301 @@ + + +

Querying an Instance Diagnosis Report List

+

Function

This API is used to query an instance diagnosis report list.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

diagnosis_report_list

+

Array of DiagnosisReportResp objects

+

Definition

+

Diagnosis report list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_num

+

AnyType

+

Definition

+

Number of reports.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 DiagnosisReportResp

Parameter

+

Type

+

Description

+

report_id

+

String

+

Definition

+

Report ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consumer_nums

+

Integer

+

Definition

+

Number of consumers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

status

+

String

+

Definition

+

Status.

+

Constraints

+

N/A

+

Range

+
  • diagnosing

    +
  • failed

    +
  • deleted (manually)

    +
  • finished

    +
  • normal: No problems found.

    +
  • abnormal: Problems found.

    +
+

Default Value

+

N/A

+

created_at

+

String

+

Definition

+

Creation time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

abnormal_item_sum

+

Integer

+

Definition

+

Number of abnormal items.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

faulted_node_sum

+

Integer

+

Definition

+

Number of abnormal nodes.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying an instance diagnosis report list

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

Example Responses

Status code: 200

+

success

+
{
+  "diagnosis_report_list" : {
+    "report_id" : "b00a070e-75e0-4463-b53e-fbc29dcff951",
+    "status" : "finished",
+    "group_name" : "test",
+    "created_at" : "2025-05-28 11:25:58.477",
+    "abnormal_item_sum" : 0,
+    "faulted_node_sum" : 0
+  },
+  "total_num" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

success

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListEngineProducts.html b/docs/dms_rocketmq/api-ref/ListEngineProducts.html new file mode 100644 index 000000000..283a5b7ea --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListEngineProducts.html @@ -0,0 +1,752 @@ + + +

Querying Flavor List

+

Function

This API is used to query the flavor list of an engine.

+
+

URI

GET /v2/{engine}/products

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

Parameter

+

Mandatory

+

Type

+

Description

+

engine

+

Yes

+

String

+

Definition

+

Message engine type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ message engine.

    +
  • reliability: RocketMQ message engine alias.

    +
+

Default Value

+

rocketmq

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

Parameter

+

Mandatory

+

Type

+

Description

+

product_id

+

No

+

String

+

Definition

+

RocketMQ instance flavors.

+

Constraints

+

N/A

+

Range

+

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

+
  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

    +
  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

    +
  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

    +
  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

    +
+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine

+

String

+

Definition

+

Engine type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ message engine.

    +
  • reliability: RocketMQ message engine alias.

    +
+

Default Value

+

N/A

+

versions

+

Array of strings

+

Definition

+

Supported versions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

products

+

Array of ProductEntity objects

+

Definition

+

Instance details.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ProductEntity

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Product type.

+

Constraints

+

N/A

+

Range

+
  • single.basic: 5.x single-node basic edition.

    +
  • cluster.basic: 5.x cluster basic edition

    +
+

Default Value

+

N/A

+

product_id

+

String

+

Definition

+

RocketMQ instance flavors. This API is shared with other engines, so product flavors of other RocketMQ versions may be returned.

+

Constraints

+

N/A

+

Range

+

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

+
  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

    +
  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

    +
  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

    +
  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

    +
+

Default Value

+

N/A

+

ecs_flavor_id

+

String

+

Definition

+

ID of an ECS flavor. The specifications list of ECS can be referred. DMS can be adapted with general computing-plus C6 series and later. RocketMQ 5.x CPU/memory ratio is 1:4.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

billing_code

+

String

+

Definition

+

CBC flavor code.

+

Constraints

+

N/A

+

Range

+
  • dms.rocketmq.basic.single.tps: single-node RocketMQ 5.x basic edition.

    +
  • dms.rocketmq.basic.cluster.tps: cluster RocketMQ 5.x basic edition.

    +
+

Default Value

+

N/A

+

arch_types

+

Array of strings

+

Definition

+

Supported architectures.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

charging_mode

+

Array of strings

+

Definition

+

Billing mode.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

ios

+

Array of IOSEntity objects

+

Definition

+

Supported I/O types.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

support_features

+

Array of strings

+

Definition

+

Supported feature list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

properties

+

properties object

+

Definition

+

Product features.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

qingtian_incompatible

+

Boolean

+

Definition

+

Whether the instance is a QingTian one.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 IOSEntity

Parameter

+

Type

+

Description

+

available_zones

+

Array of strings

+

Definition

+

AZ list. For RocketMQ 5.x basic edition: Select one AZ for a single-node instance and one or two AZs for a cluster one.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

unavailable_zones

+

Array of strings

+

Definition

+

Unavailable AZ list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

io_spec

+

String

+

Definition

+

Storage flavor code.

+

Constraints

+

N/A

+

Range

+
  • dms.physical.storage.high.v2: high I/O disk

    +
  • dms.physical.storage.ultra.v2: ultra-high I/O disk

    +
  • dms.physical.storage.general: general-purpose SSD

    +
  • dms.physical.storage.extreme: extreme SSD

    +
+

Default Value

+

N/A

+

type

+

String

+

Definition

+

Service type to which storage belongs.

+

Constraints

+

N/A

+

Range

+

evs

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 properties

Parameter

+

Type

+

Description

+

max_topic

+

String

+

Definition

+

Maximum number of topics.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_num

+

String

+

Definition

+

Broker quantity.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

core

+

String

+

Definition

+

Number of billing cores of an entire instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_consumer

+

String

+

Definition

+

Maximum number of consumers in an instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

rcu

+

String

+

Definition

+

Traffic unit, rcu × max_tpc_per_rcu = Maximum flavor TPS.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_storage

+

String

+

Definition

+

Maximum storage space, in GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_storage_per_node

+

String

+

Definition

+

Maximum storage space of each node, in GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

product_alias

+

String

+

Definition

+

Alias of product_id.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_tps_per_rcu

+

String

+

Definition

+

Maximum TPS of each RCU.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine_versions

+

String

+

Definition

+

Message engine version.

+

Constraints

+

N/A

+

Range

+
  • 5.x

    +
+

Default Value

+

N/A

+

min_storage

+

String

+

Definition

+

Minimum storage space, in GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

min_storage_per_node

+

String

+

Definition

+

Minimum storage per node. Unit: GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_broker

+

String

+

Definition

+

Maximum number of brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_topic_per_broker

+

String

+

Definition

+

Maximum number of topics that can be created on each broker.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_consumer_per_broker

+

String

+

Definition

+

Maximum number of consumers on each broker.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

min_broker

+

String

+

Definition

+

Minimum number of brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

GET https://{endpoint}/v2/reliability/products?product_id=rocketmq.b1.large.1
+
+

Example Responses

Status code: 200

+

Successful

+
{
+  "total" : 1,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "engine" : "rocketmq",
+  "versions" : [ "5.x" ],
+  "products" : [ {
+    "type" : "single.basic",
+    "product_id" : "rocketmq.b1.large.1",
+    "ecs_flavor_id" : "c6.large.2",
+    "billing_code" : "dms.rocketmq.basic.single.tps",
+    "arch_types" : [ "X86" ],
+    "charging_mode" : [ "monthly", "hourly" ],
+    "ios" : [ {
+      "io_spec" : "dms.physical.storage.high.v2",
+      "available_zones" : [ "cn-southwest-xxa", "cn-southwest-xxb" ],
+      "type" : "evs",
+      "unavailable_zones" : [ "cn-southwest-xxc" ]
+    }, {
+      "io_spec" : "dms.physical.storage.ultra.v2",
+      "available_zones" : [ "cn-southwest-xxa", "cn-southwest-xxb" ],
+      "type" : "evs",
+      "unavailable_zones" : [ "cn-southwest-xxc" ]
+    } ],
+    "support_features" : [ ],
+    "properties" : {
+      "max_topic" : 50,
+      "broker_num" : 1,
+      "core" : 1,
+      "max_consumer" : 500,
+      "rcu" : 1,
+      "max_storage" : 30000,
+      "max_storage_per_node" : 90000,
+      "min_storage" : 100,
+      "product_alias" : "rocketmq.b1.large.1",
+      "max_tps_per_rcu" : 500,
+      "engine_versions" : "5.x",
+      "min_storage_per_node" : 300
+    },
+    "qingtian_incompatible" : false
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Successful

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListInstanceConsumerGroups.html b/docs/dms_rocketmq/api-ref/ListInstanceConsumerGroups.html new file mode 100644 index 000000000..b64d2bee4 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListInstanceConsumerGroups.html @@ -0,0 +1,425 @@ + + +

Querying the Consumer Group List

+

Function

This API is used to query the consumer group list.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

group

+

No

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number of consumer groups.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

groups

+

Array of ConsumerGroup objects

+

Definition

+

Consumer group list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max

+

Integer

+

Definition

+

Maximum number of consumer groups that can be created.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

remaining

+

Integer

+

Definition

+

Remaining number of consumer groups that can be created.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ConsumerGroup

Parameter

+

Type

+

Description

+

enabled

+

Boolean

+

Definition

+

Whether consumption is allowed.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

broadcast

+

Boolean

+

Definition

+

Whether to enable broadcast.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

brokers

+

Array of strings

+

Definition

+

List of associated brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_desc

+

String

+

Definition

+

Consumer group description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

retry_max_time

+

Integer

+

Definition

+

Maximum number of retries.

+

Constraints

+

N/A

+

Range

+

1–16

+

Default Value

+

N/A

+

created_at

+

Long

+

Definition

+

Creation time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

permissions

+

Array of strings

+

Definition

+

Permission set.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consume_orderly

+

Boolean

+

Definition

+

Whether orderly consumption is enabled.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

group_online

+

Boolean

+

Definition

+

Whether the consumer group is online.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the consumer group list of a RocketMQ instance

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

Example Responses

Status code: 200

+

Consumer groups queried successfully.

+
{
+  "total" : 1,
+  "groups" : [ {
+    "name" : "group-1",
+    "enabled" : true,
+    "broadcast" : false,
+    "brokers" : [ "broker-0" ],
+    "permissions" : [ ],
+    "retry_max_time" : 16,
+    "consume_orderly" : false,
+    "group_online" : false,
+    "group_desc" : "test",
+    "created_at" : 1709087952686
+  } ],
+  "max" : 4000,
+  "remaining" : 3999,
+  "next_offset" : -1,
+  "previous_offset" : -1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumer groups queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListInstances.html b/docs/dms_rocketmq/api-ref/ListInstances.html new file mode 100644 index 000000000..f66bbe037 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListInstances.html @@ -0,0 +1,1213 @@ + + +

Querying the Instance List

+

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

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

engine

+

Yes

+

String

+

Definition

+

Message engine type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ engine.

    +
  • reliability: RocketMQ engine alias.

    +
+

Default Value

+

N/A

+

name

+

No

+

String

+

Definition

+

Instance name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

instance_id

+

No

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

status

+

No

+

String

+

Definition

+

Instance status.

+

Constraints

+

N/A

+

Range

+

For details, see Instance Status.

+

Default Value

+

N/A

+

include_failure

+

No

+

String

+

Definition

+

Whether to return the number of instances that fail to be created.

+

Constraints

+

N/A

+

Range

+
  • 'true': yes

    +
  • 'false': no

    +
+

Default value

+

N/A

+

exact_match_name

+

No

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+
  • 'true': yes

    +
  • 'false': no

    +
+

Default value

+

'false'

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Maximum number of instances that can be returned in a query.

+

Constraints

+

N/A

+

Range

+

1–50

+

Default value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instances

+

Array of InstanceDetail objects

+

Definition

+

Instance list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_num

+

Integer

+

Definition

+

Number of instances.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 InstanceDetail

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Instance name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine

+

String

+

Definition

+

Message engine.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ message engine.

    +
  • reliability: RocketMQ message engine alias.

    +
+

Default Value

+

N/A

+

status

+

String

+

Definition

+

Status.

+

Constraints

+

N/A

+

Range

+

For details, see Instance Status.

+

Default Value

+

N/A

+

description

+

String

+

Definition

+

Message description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

String

+

Definition

+

Instance type.

+

Constraints

+

N/A

+

Range

+
  • single.basic: 5.x single-node basic edition

    +
  • cluster.basic: 5.x cluster basic edition

    +
+

Default Value

+

N/A

+

specification

+

String

+

Definition

+

Instance specification.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine_version

+

String

+

Definition

+

Instance version.

+

Constraints

+

N/A

+

Range

+
  • 5.x

    +
+

Default Value

+

N/A

+

instance_id

+

String

+

Definition

+

Instance ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

arch_type

+

String

+

Definition

+

Architecture type.

+

Range

+
  • X86

    +
  • ARM

    +
+

charging_mode

+

Integer

+

Definition

+

Billing mode.

+

Constraints

+

N/A

+

Range

+

1 indicates pay-per-use.

+

Default Value

+

N/A

+

vpc_id

+

String

+

Definition

+

VPC ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

vpc_name

+

String

+

Definition

+

VPC name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

created_at

+

String

+

Definition

+

Time when creation is complete.

+

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.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

product_id

+

String

+

Definition

+

RocketMQ instance flavors.

+

Constraints

+

N/A

+

Range

+

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

+
  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

    +
  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

    +
  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

    +
  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

    +
+

Default Value

+

N/A

+

security_group_id

+

String

+

Definition

+

Security group ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

security_group_name

+

String

+

Definition

+

Security group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_id

+

String

+

Definition

+

Subnet ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_cidr

+

String

+

Definition

+

Subnet route.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zones

+

Array of strings

+

Definition

+

List of AZ IDs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zone_names

+

Array of strings

+

Definition

+

List of AZ names.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_id

+

String

+

Definition

+

User ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_name

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

maintain_begin

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

maintain_end

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

storage_space

+

Integer

+

Definition

+

Storage space, in GB.

+

Constraints

+

N/A

+

Range

+

Different instance specifications support different storage configurations.

+
  • RocketMQ 5.x single-node storage range: 100–30000

    +
  • RocketMQ 5.x cluster storage range: 200–60000

    +
+

Default Value

+

N/A

+

used_storage_space

+

Integer

+

Definition

+

Used message storage space, in GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

enable_publicip

+

Boolean

+

Definition

+

Whether to enable public access.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

publicip_id

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

publicip_address

+

String

+

Definition

+

Public IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

ssl_enable

+

Boolean

+

Definition

+

Whether SSL is enabled.

+

Range

+
  • true: yes

    +
  • false: no

    +
+

cross_vpc_info

+

String

+

Definition

+

Cross-VPC access information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

storage_resource_id

+

String

+

Definition

+

Storage resource ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

storage_spec_code

+

String

+

Definition

+

Storage specification code.

+

Constraints

+

N/A

+

Range

+
  • dms.physical.storage.high.v2: high I/O disk

    +
  • dms.physical.storage.ultra.v2: ultra-high I/O disk

    +
  • dms.physical.storage.general: general-purpose SSD

    +
  • dms.physical.storage.extreme: extreme SSD

    +
+

Default Value

+

N/A

+

service_type

+

String

+

Definition

+

Service type.

+

Constraints

+

N/A

+

Range

+
  • advanced: Service type.

    +
+

Default Value

+

N/A

+

storage_type

+

String

+

Definition

+

Storage type.

+

Constraints

+

N/A

+

Range

+
  • hec: Storage type.

    +
+

Default Value

+

N/A

+

disk_encrypted

+

Boolean

+

Definition

+

Whether disk encryption is enabled.

+

Range

+
  • true: yes

    +
  • false: no

    +
+

enable_acl

+

Boolean

+

Definition

+

Whether to enable access control.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

broker_num

+

Integer

+

Definition

+

Number of brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dns_enable

+

Boolean

+

Definition

+

Whether to enable domain name access to an instance.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

namesrv_address

+

String

+

Definition

+

Metadata address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

namesrv_domain_name

+

String

+

Definition

+

Metadata domain name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_address

+

String

+

Definition

+

Service data address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_namesrv_address

+

String

+

Definition

+

Public network metadata address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_namesrv_domain_name

+

String

+

Definition

+

Public metadata domain name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_broker_address

+

String

+

Definition

+

Public network service data address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

grpc_address

+

String

+

Definition

+

gRPC connection address (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

grpc_domain_name

+

String

+

Definition

+

gRPC connection domain name (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_grpc_address

+

String

+

Definition

+

Public gRPC connection address (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_grpc_domain_name

+

String

+

Definition

+

Public gRPC domain name (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

enterprise_project_id

+

String

+

Definition

+

Enterprise project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tags

+

Array of TagEntity objects

+

Definition

+

Tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_storage_space

+

Integer

+

Definition

+

Total storage space.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_spec_code

+

String

+

Definition

+

Resource specification.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

produce_portion

+

Integer

+

Definition

+

Production TPS proportion.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consume_portion

+

Integer

+

Definition

+

Consumption TPS proportion.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dr_enable

+

Boolean

+

Definition

+

Whether the instance has disaster recovery (DR).

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

config_ssl_need_restart_process

+

Boolean

+

Definition

+

Whether a restart is required to configure SSL.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

tls_mode

+

String

+

Definition

+

Security protocol used by an instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+
  • Must be specified.

    +
  • Must be unique for the same instance.

    +
  • Can contain 1 to 128 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+

value

+

String

+

Tag value.

+
  • Can contain 0 to 255 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+
+
+
+

Example Requests

Querying the list of all instances

+
GET https://{endpoint}/v2/{project_id}/instances?engine=reliability
+
+

Example Responses

Status code: 200

+

Instance list queried successfully.

+
{
+  "instances" : [ {
+    "name" : "reliability-ztest",
+    "engine" : "reliability",
+    "status" : "RUNNING",
+    "description" : "",
+    "type" : "cluster.basic",
+    "specification" : "rocketmq.b2.large.4, 2000 tps",
+    "engine_version" : "5.x",
+    "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
+    "resource_spec_code" : "",
+    "charging_mode" : 1,
+    "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
+    "vpc_name" : "vpc-1101840",
+    "created_at" : "1636699753874",
+    "product_id" : "rocketmq.b2.large.4",
+    "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
+    "security_group_name" : "Sys-default",
+    "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
+    "subnet_cidr" : "192.168.0.0/24",
+    "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
+    "available_zone_names" : [ "AZ1" ],
+    "user_id" : "0b01fbb53600d4671fa8c00673c71260",
+    "user_name" : "",
+    "maintain_begin" : "02:00:00",
+    "maintain_end" : "06:00:00",
+    "storage_space" : 600,
+    "total_storage_space" : 1200,
+    "used_storage_space" : 28,
+    "enable_publicip" : false,
+    "arch_type" : "X86",
+    "ssl_enable" : false,
+    "cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}",
+    "storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2",
+    "storage_spec_code" : "dms.physical.storage.ultra.v2",
+    "service_type" : "advanced",
+    "storage_type" : "hec",
+    "disk_encrypted" : false,
+    "enable_acl" : true,
+    "broker_num" : 1,
+    "dr_enable" : false,
+    "namesrv_address" : "***",
+    "config_ssl_need_restart_process" : false,
+    "broker_address" : "***",
+    "public_namesrv_address" : "***",
+    "public_broker_address" : "***",
+    "grpc_address" : "***",
+    "public_grpc_address" : "***"
+  } ],
+  "instance_num" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance list queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListMessageTraceForRocketMq.html b/docs/dms_rocketmq/api-ref/ListMessageTraceForRocketMq.html new file mode 100644 index 000000000..2492f8f49 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListMessageTraceForRocketMq.html @@ -0,0 +1,559 @@ + + +

Querying the Message Trace

+

Function

This API is used to query the message trace.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

msg_id

+

Yes

+

String

+

Definition

+

Message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

trace

+

Array of trace objects

+

Definition

+

Message trace list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 trace

Parameter

+

Type

+

Description

+

success

+

Boolean

+

Definition

+

Successful or not.

+

Constraints

+

N/A

+

Range

+
  • true: successful

    +
  • false: failed

    +
+

Default Value

+

N/A

+

trace_type

+

String

+

Definition

+

Trace type.

+

Constraints

+

N/A

+

Range

+
  • Pub: The producer successfully sends messages.

    +
  • SubBefore: The consumer is ready to consume messages.

    +
  • SubAfter: The consumer finishes consuming messages.

    +
  • EndTransaction: Transactional messages are committed or rolled back.

    +
  • Receive: The service side receives messages.

    +
  • Ack: The consumer manually acknowledges consumption.

    +
+

Default Value

+

N/A

+

timestamp

+

Number

+

Definition

+

Time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_name

+

String

+

Definition

+

Producer group or consumer group.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cost_time

+

Number

+

Definition

+

Duration.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

request_id

+

String

+

Definition

+

Request ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consume_status

+

Number

+

Definition

+

Consumption status.

+

Constraints

+

N/A

+

Range

+
  • 0: Successful

    +
  • 1: Timeout

    +
  • 2: Exception

    +
  • 3: Null

    +
  • 5: Failed

    +
+

Default Value

+

N/A

+

topic

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

msg_id

+

String

+

Definition

+

Message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

offset_msg_id

+

String

+

Definition

+

Offset message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tags

+

String

+

Definition

+

Message tag.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

keys

+

String

+

Definition

+

Message keys.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

store_host

+

String

+

Definition

+

IP address of the host that stores the message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

client_host

+

String

+

Definition

+

IP address of the host that generates the message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

retry_times

+

Integer

+

Definition

+

Number of retry times.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

body_length

+

Number

+

Definition

+

Message body length.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

msg_type

+

String

+

Definition

+

Message type.

+

Constraints

+

N/A

+

Range

+
  • Normal_Msg: normal message

    +
  • Trans_Msg_Half: half message

    +
  • Trans_msg_Commit: delivered message

    +
  • Delay_Msg: delayed message

    +
  • Order_Msg: ordered message

    +
+

Default Value

+

N/A

+

transaction_state

+

String

+

Definition

+

Transaction status.

+

Constraints

+

N/A

+

Range

+
  • COMMIT_MESSAGE

    +
  • ROLLBACK_MESSAGE

    +
  • UNKNOW

    +
+

Default Value

+

N/A

+

transaction_id

+

String

+

Definition

+

Transaction ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

from_transaction_check

+

Boolean

+

Definition

+

Whether the response is a transaction check response.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the message trace of a RocketMQ instance

+
GET https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/trace?msg_id={msg_id}
+
+

Example Responses

Status code: 200

+

Queried.

+
{
+  "total" : 1,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "trace" : [ {
+    "success" : true,
+    "trace_type" : "Pub",
+    "timestamp" : 1634822858013,
+    "group_name" : "ProducerGroupName",
+    "cost_time" : 47,
+    "request_id" : "644F0069C829287CBBF26B9A54390000",
+    "consume_status" : 0,
+    "topic" : "aaaaa",
+    "msg_id" : "7F000001561018B4AAC26B9A0D1D0004",
+    "offset_msg_id" : "C0A8011700002774000000000000BE12",
+    "tags" : "TagA",
+    "keys" : "OrderID188",
+    "store_host" : "192.168.0.1:10101",
+    "client_host" : "127.0.0.1",
+    "retry_times" : 0,
+    "body_length" : 11,
+    "msg_type" : "Normal_Msg",
+    "transaction_state" : null,
+    "transaction_id" : null,
+    "from_transaction_check" : false
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListMessagesForRocketMq.html b/docs/dms_rocketmq/api-ref/ListMessagesForRocketMq.html new file mode 100644 index 000000000..257863b73 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListMessagesForRocketMq.html @@ -0,0 +1,542 @@ + + +

Querying Messages

+

Function

This API is used to query messages.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queue

+

No

+

String

+

Definition

+

Queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

offset

+

No

+

Integer

+

Definition

+

Offset.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default Value

+

N/A

+

key

+

No

+

String

+

Definition

+

Message key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

start_time

+

No

+

String

+

Definition

+

Start time.

+

Constraints

+

Mandatory when msg_id is not used for query.

+

Range

+

N/A

+

Default Value

+

N/A

+

end_time

+

No

+

String

+

Definition

+

End time.

+

Constraints

+

Mandatory when msg_id is not used for query.

+

Range

+

N/A

+

Default Value

+

N/A

+

msg_id

+

No

+

String

+

Definition

+

Message ID.

+

Constraints

+

Mandatory when a time range is not used for query.

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

messages

+

Array of Message objects

+

Definition

+

Message list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total

+

Number

+

Definition

+

Total number of messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Message

Parameter

+

Type

+

Description

+

msg_id

+

String

+

Definition

+

Message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

String

+

Definition

+

Instance ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

store_timestamp

+

Number

+

Definition

+

Time when the message is stored.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

born_timestamp

+

Number

+

Definition

+

Time when the message is generated.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

reconsume_times

+

Integer

+

Number of retry times.

+

body

+

String

+

Definition

+

Message body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

body_crc

+

Number

+

Definition

+

Message body checksum.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

store_size

+

Number

+

Definition

+

Storage size.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

property_list

+

Array of property_list objects

+

Definition

+

Message attribute list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

born_host

+

String

+

Definition

+

IP address of the host that generates the message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

store_host

+

String

+

Definition

+

IP address of the host that stores the message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_id

+

Integer

+

Definition

+

Queue ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_offset

+

Integer

+

Definition

+

Offset in the queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 property_list

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Attribute name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

value

+

String

+

Definition

+

Attribute value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

This API is used to query messages.

+
GET https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/messages?topic={topic}&&msg_id=C0A807C9000027740000000000000030
+
+

Example Responses

Status code: 200

+

Messages queried.

+
{
+  "messages" : [ {
+    "msg_id" : "C0A807C9000027740000000000000030",
+    "instance_id" : "11c45539-xxxx-xxxx-xxxx-812c41f61f30",
+    "topic" : "topic-test",
+    "store_timestamp" : 1648888166319,
+    "born_timestamp" : 1648888166275,
+    "reconsume_times" : 0,
+    "body" : "xxxx",
+    "body_crc" : 1932557065,
+    "store_size" : 175,
+    "property_list" : [ {
+      "name" : "KEYS",
+      "value" : ""
+    }, {
+      "name" : "UNIQ_KEY",
+      "value" : "7F00000123DC6E0BE85808B037820000"
+    }, {
+      "name" : "CLUSTER",
+      "value" : "DmsCluster"
+    }, {
+      "name" : "TAGS",
+      "value" : ""
+    } ],
+    "born_host" : "192.168.0.66:50098",
+    "store_host" : "192.168.7.201:10100",
+    "queue_id" : 2,
+    "queue_offset" : 0
+  } ],
+  "total" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Messages queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListRocketInstanceTopics.html b/docs/dms_rocketmq/api-ref/ListRocketInstanceTopics.html new file mode 100644 index 000000000..3ff43e636 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListRocketInstanceTopics.html @@ -0,0 +1,416 @@ + + +

Querying the Topic List

+

Function

This API is used to query the topic list of a RocketMQ instance.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

1–50

+

Default value

+

N/A

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Integer

+

Definition

+

Total number of topics.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max

+

Integer

+

Definition

+

Maximum number of topics that can be created.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

remaining

+

Integer

+

Definition

+

Remaining number of topics that can be created.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topics

+

Array of Topic objects

+

Definition

+

Remaining number of topics that can be created.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Topic

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_read_queue_num

+

Number

+

Definition

+

Total number of read queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_write_queue_num

+

Number

+

Definition

+

Total number of write queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

permission

+

String

+

Definition

+

Permission.

+

Constraints

+

N/A

+

Range

+
  • sub: subscribe permissions.

    +
  • pub: publish permissions.

    +
  • all: subscribe and publish permissions.

    +
+

Default Value

+

N/A

+

brokers

+

Array of brokers objects

+

Definition

+

Associated broker.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

message_type

+

String

+

Definition

+

Message type (available only for RocketMQ 5.x instances).

+

Constraints

+

N/A

+

Range

+
  • NORMAL: normal messages.

    +
  • FIFO: ordered messages.

    +
  • DELAY: scheduled messages.

    +
  • TRANSACTION: transactional messages.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 brokers

Parameter

+

Type

+

Description

+

broker_name

+

String

+

Definition

+

Broker name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

read_queue_num

+

Number

+

Definition

+

Number of read queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

write_queue_num

+

Number

+

Definition

+

Number of write queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying a list of 10 topics of a specified RocketMQ instance from offset=0

+
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "total" : 3,
+  "max" : 2000,
+  "remaining" : 1997,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "topics" : [ {
+    "name" : "topic-1",
+    "total_read_queue_num" : 3,
+    "total_write_queue_num" : 3,
+    "permission" : "all",
+    "brokers" : [ ],
+    "message_type" : "NORMAL"
+  }, {
+    "name" : "topic-2",
+    "total_read_queue_num" : 3,
+    "total_write_queue_num" : 3,
+    "permission" : "all",
+    "brokers" : [ ],
+    "message_type" : "NORMAL"
+  }, {
+    "name" : "topic-3",
+    "total_read_queue_num" : 3,
+    "total_write_queue_num" : 3,
+    "permission" : "all",
+    "brokers" : [ ],
+    "message_type" : "NORMAL"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListRocketMqMigrationTask.html b/docs/dms_rocketmq/api-ref/ListRocketMqMigrationTask.html new file mode 100644 index 000000000..2fd730bbf --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListRocketMqMigrationTask.html @@ -0,0 +1,327 @@ + + +

Querying All Migration Tasks or a Specified Migration Task of an Instance

+

Function

This API is used to query all migration tasks or a specified migration task of an instance.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Definition

+

Task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

No

+

String

+

Definition

+

Query type.

+

Constraints

+

N/A

+

Range

+
  • vhost: virtual host

    +
  • exchange

    +
  • queue

    +
  • all

    +
+

Default Value

+

N/A

+

offset

+

No

+

Integer

+

Definition

+

Current page, starting from 1.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Current page size.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

No

+

String

+

Definition

+

Virtual host name.

+

Constraints

+
  • When the vhost list is queried, this field can be left empty.

    +
  • When the exchange list is queried, set this field to the name of the vhost to which the exchange belongs.

    +
  • When the queue list is queried, set this field to vhost of the queue's exchange-queue's exchange, for example, vhost1-exchange1.

    +
+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Integer

+

Definition

+

Total number of metadata migration tasks.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

task

+

Array of MetadataTask objects

+

Definition

+

List of metadata migration tasks.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MetadataTask

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

ID of a metadata migration task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Name of a metadata migration task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

start_date

+

String

+

Definition

+

Start time of a metadata migration task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

status

+

String

+

Definition

+

Status of a metadata migration task.

+

Constraints

+

N/A

+

Range

+
  • creating

    +
  • starting: The migration is in progress.

    +
  • failed

    +
  • finished

    +
+

Default Value

+

N/A

+

type

+

String

+

Definition

+

Metadata migration type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: from RocketMQ to RocketMQ.

    +
  • rabbitToRocket: from RabbitMQ to RocketMQ.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying all migration tasks of a RocketMQ instance

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

Example Responses

Status code: 200

+

Returned status code.

+
{
+  "total" : 1,
+  "task" : [ {
+    "id" : "6cf4dcd3-8471-4139-8b5b-8a3a71f704c7",
+    "name" : "task-932331847",
+    "start_date" : "2023-03-13 19:43:32.12",
+    "status" : "finished",
+    "type" : "rabbitToRocket"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Returned status code.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListScheduledTasks.html b/docs/dms_rocketmq/api-ref/ListScheduledTasks.html new file mode 100644 index 000000000..a3db396d5 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListScheduledTasks.html @@ -0,0 +1,364 @@ + + +

Querying the Scheduled Task List of an Instance

+

Function

This API is used to query the scheduled task list of an instance.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

start

+

No

+

String

+

Definition

+

No. of the scheduled task to start the query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of scheduled tasks to be queried.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

begin_time

+

No

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

end_time

+

No

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_count

+

String

+

Definition

+

Total number of tasks.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

jobs

+

Array of ScheduledTaskEntity objects

+

Definition

+

Task list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ScheduledTaskEntity

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Task name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_name

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_id

+

String

+

Definition

+

User ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

params

+

String

+

Definition

+

Task parameter.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

status

+

String

+

Definition

+

Task status.

+

Constraints

+

N/A

+

Range

+
  • CREATED: The scheduled task is created.

    +
  • SUCCESS: The scheduled task is successful.

    +
  • FAILED: The scheduled task fails.

    +
  • DELETED: The scheduled task is deleted.

    +
  • EXECUTING: The scheduled task is being executed.

    +
  • CANCELLED: The scheduled task is canceled.

    +
+

Default Value

+

N/A

+

created_at

+

String

+

Definition

+

Creation time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

updated_at

+

String

+

Definition

+

Update time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

schedule_at

+

String

+

Definition

+

Time when a scheduled task is executed.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying scheduled tasks from 1970.01.01.000000 to 2024.01.01.000000 in pages

+
/v2/{{project_id}}/instances/{instance_id}/schedule-tasks?start=0&limit=10&beginTime=19700101000000&endTime=20240101000000
+
+

Example Responses

Status code: 200

+

Instance's scheduled task list queried.

+
{
+  "job_count" : 2,
+  "jobs" : [ {
+    "id" : "ff808082889e267601889e2df7be0013",
+    "name" : "jobName",
+    "user_name" : "paas_dms_03",
+    "user_id" : "0b01fbb53600d4671fa8c00673c71260",
+    "params" : "{\"reassignment_topics\":\"[topic-1]\"}",
+    "status" : "SUCCESS",
+    "created_at" : "2023-06-09T03:23:12.702Z",
+    "updated_at" : "2023-06-09T03:35:00.067Z",
+    "schedule_at" : "2023-06-08T05:08:26.000Z"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance's scheduled task list queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListTopicAccessPolicy.html b/docs/dms_rocketmq/api-ref/ListTopicAccessPolicy.html new file mode 100644 index 000000000..99ecc4c78 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListTopicAccessPolicy.html @@ -0,0 +1,288 @@ + + +

Querying Users Granted Permissions for a Topic

+

Function

This API is used to query the list of users that have been granted permissions for a topic.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Offset, which is the position where the query starts. The value must be no less than 0.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

policies

+

Array of policies objects

+

Definition

+

User list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total

+

Number

+

Definition

+

Total number of users.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Name of the topic or consumer group.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 policies

Parameter

+

Type

+

Description

+

access_key

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

admin

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

User permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the list of users granted permissions for a topic

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

Example Responses

Status code: 200

+

List of users granted permissions for a topic queried successfully.

+
{
+  "policies" : [ {
+    "access_key" : "dms_test",
+    "white_remote_address" : "192.168.1.1",
+    "admin" : true,
+    "perm" : "PUB|SUB"
+  } ],
+  "total" : 0,
+  "name" : "test"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

List of users granted permissions for a topic queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ListUser.html b/docs/dms_rocketmq/api-ref/ListUser.html new file mode 100644 index 000000000..aa51d1465 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ListUser.html @@ -0,0 +1,391 @@ + + +

Querying the User List

+

Function

This API is used to query the user list.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Number of records to query.

+

offset

+

No

+

Integer

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

users

+

Array of UserResp objects

+

Definition

+

User list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total

+

Number

+

Definition

+

Total number of users.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 UserResp

Parameter

+

Type

+

Description

+

access_key

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

secret_key

+

String

+

Definition

+

Key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

admin

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

default_topic_perm

+

String

+

Definition

+

Default topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

default_group_perm

+

String

+

Definition

+

Default consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

topic_perms

+

Array of topic_perms objects

+

Definition

+

Special topic permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_perms

+

Array of group_perms objects

+

Definition

+

Special consumer group permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 topic_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 group_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the user list

+
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users?offset=0&limit=10
+
+

Example Responses

Status code: 200

+

Query result.

+
{
+  "users" : [ {
+    "access_key" : "test_01",
+    "admin" : false,
+    "default_group_perm" : "DENY",
+    "default_topic_perm" : "SUB",
+    "group_perms" : [ ],
+    "secret_key" : "Abcd1234!",
+    "topic_perms" : [ ],
+    "white_remote_address" : ""
+  } ],
+  "total" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query result.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/PARAMETERS.txt b/docs/dms_rocketmq/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/dms_rocketmq/api-ref/ResetConsumeOffsetForRocketMq.html b/docs/dms_rocketmq/api-ref/ResetConsumeOffsetForRocketMq.html new file mode 100644 index 000000000..f1f0923e0 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ResetConsumeOffsetForRocketMq.html @@ -0,0 +1,241 @@ + + +

Resetting the Consumer Offset

+

Function

This API is used to reset the consumer offset.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

Yes

+

String

+

Definition

+

Topic to be reset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

timestamp

+

Yes

+

String

+

Definition

+

Reset time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

queues

+

Array of queues objects

+

Definition

+

Queues to be reset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 queues

Parameter

+

Type

+

Description

+

broker_name

+

String

+

Definition

+

Broker where the queue is located.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_id

+

Integer

+

Definition

+

Queue ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

timestamp_offset

+

Long

+

Definition

+

Resets consumer offset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Resetting consumer offset of topic_01 to the specified time

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/reset-message-offset
+
+{
+  "topic" : "topic_01",
+  "timestamp" : 1662652800000
+}
+
+

Example Responses

Status code: 200

+

Consumer offset reset.

+
{
+  "queues" : [ {
+    "broker_name" : "broker-1",
+    "queue_id" : 0,
+    "timestamp_offset" : 0
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumer offset reset.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ResizeInstanceForRocketMq.html b/docs/dms_rocketmq/api-ref/ResizeInstanceForRocketMq.html new file mode 100644 index 000000000..d0e37d254 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ResizeInstanceForRocketMq.html @@ -0,0 +1,214 @@ + + +

Changing Instance Specifications

+

Function

This API is used to change instance specifications.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

oper_type

+

Yes

+

String

+

Definition

+

Change type.

+

Constraints

+

N/A

+

Range

+
  • storage: Expand the storage without changing the broker quantity.

    +
  • horizontal: Scale up the RocketMQ 5.x instance specification.

    +
+

Default Value

+

N/A

+

new_storage_space

+

No

+

Integer

+

Definition

+

New storage specification

+

Constraints

+

This parameter is valid and mandatory when oper_type is set to storage.

+
  • If oper_type is set to storage, the storage space of each broker must be expanded by at least 100 GB.

    +
  • If oper_type is set to horizontal, the storage space of each broker remains unchanged.

    +
+

Range

+

N/A

+

Default Value

+

N/A

+

new_product_id

+

No

+

String

+

Definition

+

New product ID

+

Constraints

+
  • For RocketMQ 5.x: this parameter is valid and mandatory if oper_type is set to horizontal. Specification changes are only for cluster instances.

    +
+

Range

+

N/A

+

Default Value

+

N/A

+

publicip_id

+

No

+

String

+

Definition

+

ID of the EIP bound to the instance. Use commas (,) to separate multiple EIP IDs.

+

Constraints

+

This parameter is mandatory when oper_type is horizontal and public access is enabled.

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

ID of the specification modification task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Instance specifications changed.

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

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance specifications changed.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/SendDlqMessageForRocketMq.html b/docs/dms_rocketmq/api-ref/SendDlqMessageForRocketMq.html new file mode 100644 index 000000000..b77d0c786 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/SendDlqMessageForRocketMq.html @@ -0,0 +1,225 @@ + + +

Resending Dead Letter Messages

+

Function

This API is used to resend dead letter messages.

+
+

URI

POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/deadletter-resend

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

No

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

msg_id_list

+

No

+

Array of strings

+

Definition

+

Message list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

resend_results

+

Array of resend_results objects

+

Definition

+

Result of resending a dead letter message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 resend_results

Parameter

+

Type

+

Description

+

msg_id

+

String

+

Definition

+

Message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

error_code

+

String

+

Definition

+

Error code.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

error_message

+

String

+

Definition

+

Error message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Resending dead letter messages

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/messages/deadletter-resend
+
+{
+  "topic" : "%DLQ%group1",
+  "msg_id_list" : [ "id1" ]
+}
+
+

Example Responses

Status code: 200

+

Dead letter messages resent.

+
{
+  "resend_results" : [ {
+    "msg_id" : "C0A8149E0000277600000000000B6835",
+    "error_code" : "DMS.00000000",
+    "error_message" : "Success."
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Dead letter messages resent.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/SendMessageForRocketMq.html b/docs/dms_rocketmq/api-ref/SendMessageForRocketMq.html new file mode 100644 index 000000000..92039c6dc --- /dev/null +++ b/docs/dms_rocketmq/api-ref/SendMessageForRocketMq.html @@ -0,0 +1,360 @@ + + +

Sending Messages

+

Function

This API is used to send messages.

+
+

URI

POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

body

+

Yes

+

String

+

Definition

+

Message content.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

property_list

+

No

+

Array of SendMessageProperties objects

+

Definition

+

Feature list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 SendMessageProperties

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Feature name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

value

+

No

+

String

+

Definition

+

Feature value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

topic

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

body

+

String

+

Definition

+

Message content.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

property_list

+

Array of SendMessageProperties objects

+

Definition

+

Feature list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

msg_id

+

String

+

Definition

+

Message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_id

+

Number

+

Definition

+

Queue ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_offset

+

Number

+

Definition

+

Queue offset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_name

+

String

+

Definition

+

Broker name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 SendMessageProperties

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Feature name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

value

+

String

+

Definition

+

Feature value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Sending messages

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/messages?topic={topic}
+
+{
+  "topic" : "aaaaaaaaaaaa",
+  "body" : "test",
+  "property_list" : [ ]
+}
+
+

Example Responses

Status code: 200

+

Queried.

+
{
+  "topic" : "aaaaaaaaaaaa",
+  "body" : "test",
+  "property_list" : [ ],
+  "msg_id" : "644F0E2A315323EAB33D8F4733110009",
+  "queue_id" : 0,
+  "queue_offset" : 0,
+  "broker_name" : "broker-0"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowCesHierarchy.html b/docs/dms_rocketmq/api-ref/ShowCesHierarchy.html new file mode 100644 index 000000000..1b8211a79 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowCesHierarchy.html @@ -0,0 +1,643 @@ + + +

Querying Instance Monitoring Dimensions

+

Function

This API is used to query 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

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

dimensions

+

Array of dimensions objects

+

Definition

+

Monitoring dimensions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_ids

+

Array of instance_ids objects

+

Definition

+

Instance information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

nodes

+

Array of nodes objects

+

Definition

+

Node information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topics

+

Array of topics objects

+

Definition

+

Queue information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dlq

+

Array of dlq objects

+

Definition

+

Dead letter queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

groups

+

Array of groups objects

+

Definition

+

Consumer group information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Monitoring dimension name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

metrics

+

Array of strings

+

Definition

+

Metric name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

key_name

+

Array of strings

+

Definition

+

Key used for monitoring query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dim_router

+

Array of strings

+

Definition

+

Monitoring dimension route.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

children

+

Array of children objects

+

Definition

+

List of secondary dimensions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Secondary dimension name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

metrics

+

Array of strings

+

Definition

+

List of monitoring metric names.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

key_name

+

Array of strings

+

Definition

+

Key used for monitoring query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dim_router

+

Array of strings

+

Definition

+

Monitoring dimension route.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Instance ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Node name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 7 topics

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 8 dlq

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Dead letter queue name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topics

+

Array of topics objects

+

Definition

+

Topic subscription information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 10 topics

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

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

Example Responses

Status code: 200

+

Queried.

+
{
+  "dimensions" : [ {
+    "name" : "reliablemq_instance_id",
+    "metrics" : [ "instance_produce_msg", "instance_consume_msg" ],
+    "key_name" : [ "instance_ids" ],
+    "dim_router" : [ "reliablemq_instance_id" ]
+  }, {
+    "name" : "reliablemq_broker",
+    "metrics" : [ "broker_produce_msg", "broker_consume_msg", "broker_produce_rate", "broker_consume_rate", "broker_total_bytes_in_rate", "broker_total_bytes_out_rate", "broker_cpu_core_load", "broker_disk_usage", "broker_memory_usage" ],
+    "key_name" : [ "nodes" ],
+    "dim_router" : [ "reliablemq_instance_id", "reliablemq_broker" ]
+  }, {
+    "name" : "reliablemq_topics",
+    "metrics" : [ "topic_produce_msg", "topic_consume_msg", "topic_produce_rate", "topic_consume_rate" ],
+    "key_name" : [ "topics" ],
+    "dim_router" : [ "reliablemq_instance_id", "reliablemq_topics" ]
+  }, {
+    "name" : "reliablemq_groups",
+    "metrics" : [ "group_consume_msg", "group_accumulation" ],
+    "key_name" : [ "groups" ],
+    "dim_router" : [ "reliablemq_instance_id", "reliablemq_groups" ],
+    "children" : [ {
+      "name" : "reliablemq_groups_topics",
+      "metrics" : [ "group_topic_consume_msg", "group_topic_consume_rate", "group_topic_accumulation" ],
+      "key_name" : [ "groups", "topics" ],
+      "dim_router" : [ "reliablemq_instance_id", "reliablemq_groups", "reliablemq_groups_topics" ]
+    } ]
+  }, {
+    "name" : "reliablemq_dlq_topics",
+    "metrics" : [ "dlq_accumulation" ],
+    "key_name" : [ "dlq" ],
+    "dim_router" : [ "reliablemq_instance_id", "reliablemq_dlq_topics" ]
+  } ],
+  "instance_ids" : [ {
+    "name" : "af82f7a9-5636-4898-85e4-200fe0fab361"
+  } ],
+  "nodes" : [ ],
+  "topics" : [ {
+    "name" : "dingshi"
+  }, {
+    "name" : "lala"
+  }, {
+    "name" : "shunxu"
+  } ],
+  "dlq" : [ {
+    "name" : "DLQ_group-1"
+  }, {
+    "name" : "DLQ_group-1000"
+  }, {
+    "name" : "DLQ_group-2"
+  }, {
+    "name" : "DLQ_group-3"
+  }, {
+    "name" : "DLQ_group-4"
+  }, {
+    "name" : "DLQ_group-5"
+  }, {
+    "name" : "DLQ_group-6"
+  }, {
+    "name" : "DLQ_group-7"
+  }, {
+    "name" : "DLQ_group-8"
+  }, {
+    "name" : "DLQ_group-9"
+  }, {
+    "name" : "DLQ_group-dingshi"
+  }, {
+    "name" : "DLQ_group-shunxu"
+  }, {
+    "name" : "DLQ_group101010"
+  } ],
+  "groups" : [ {
+    "name" : "group-shunxu",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-7",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-dingshi",
+    "topics" : [ {
+      "name" : "dingshi"
+    } ]
+  }, {
+    "name" : "group-6",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-9",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-8",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-3",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-2",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-5",
+    "topics" : [ {
+      "name" : "dingshi"
+    }, {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-4",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group101010",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-1000",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  }, {
+    "name" : "group-1",
+    "topics" : [ {
+      "name" : "shunxu"
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowConsumerConnectionsForRocketMq.html b/docs/dms_rocketmq/api-ref/ShowConsumerConnectionsForRocketMq.html new file mode 100644 index 000000000..5dbd5639f --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowConsumerConnectionsForRocketMq.html @@ -0,0 +1,430 @@ + + +

Querying the Consumer List

+

Function

This API is used to query the consumer list of a consumer group.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

1–50

+

Default Value

+

N/A

+

offset

+

No

+

Integer

+

Definition

+

Offset, which is the position where the query starts. The value must be no less than 0.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

is_detail

+

No

+

Boolean

+

Definition

+

Indicates whether to query the consumer details. The value true indicates that the detailed consumer list is queried. Otherwise, a simple consumer list is queried.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

group_name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

online

+

Boolean

+

Definition

+

Whether the consumer group is online.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

subscription_consistency

+

Boolean

+

Definition

+

Whether subscriptions are consistent.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

total

+

Integer

+

Definition

+

Total number of consumers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

clients

+

Array of ClientData objects

+

Definition

+

Consumer subscription detail list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ClientData

Parameter

+

Type

+

Description

+

language

+

String

+

Definition

+

Client language.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

version

+

String

+

Definition

+

Client version.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

client_id

+

String

+

Definition

+

Client ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

client_addr

+

String

+

Definition

+

Client address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subscriptions

+

Array of Subscription objects

+

Definition

+

Subscription list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Subscription

Parameter

+

Type

+

Description

+

topic

+

String

+

Definition

+

Name of the subscribed topic.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

String

+

Definition

+

Subscription type.

+

Constraints

+

N/A

+

Range

+
  • TAG: tag-based subscription.

    +
  • SQL92: message-attribute-based subscription.

    +
+

Default Value

+

N/A

+

expression

+

String

+

Subscription tag.

+
+
+
+

Example Requests

Querying the list of 10 consumers of a consumer group from offset=0

+
GET https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/groups/{group}/clients?offset=0&limit=10&is_detail=true
+
+

Example Responses

Status code: 200

+

Consumer subscription details queried.

+
{
+  "group_name" : "test",
+  "online" : true,
+  "subscription_consistency" : true,
+  "total" : 1,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "clients" : [ {
+    "client_id" : "192.168.0.1@consumer1",
+    "language" : "JAVA",
+    "version" : "V4_8_0",
+    "client_addr" : "192.168.0.1:65233",
+    "subscriptions" : [ {
+      "topic" : "topicA",
+      "type" : "TAG",
+      "expression" : "tagA"
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumer subscription details queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowConsumerListOrDetails.html b/docs/dms_rocketmq/api-ref/ShowConsumerListOrDetails.html new file mode 100644 index 000000000..0e24683f5 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowConsumerListOrDetails.html @@ -0,0 +1,421 @@ + + +

Querying the Consumer Group List or Details

+

Function

This API is used to query the consumer group list or details.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

topic

+

No

+

String

+

Definition

+

Topic to be queried. If this parameter is not specified, the entire topic list is queried. If this parameter is specified, details of the topic are queried.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Maximum number of topics that can be returned in a query.

+

Constraints

+

N/A

+

Range

+

1–50

+

Default value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

topics

+

Array of strings

+

Definition

+

Topic list. This parameter is displayed only when you query the topic consumption list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total

+

Integer

+

Definition

+

Total number of topics. This parameter is displayed only when you query the topic consumption list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

lag

+

Long

+

Definition

+

Total number of accumulated messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_offset

+

Long

+

Definition

+

Total number of messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consumer_offset

+

Long

+

Definition

+

Number of consumed messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

brokers

+

Array of Brokers objects

+

Definition

+

Associated brokers of topics. This parameter is displayed only when you query the topic consumption details.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Brokers

Parameter

+

Type

+

Description

+

broker_name

+

String

+

Definition

+

Names of the associated brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

queues

+

Array of Queue objects

+

Definition

+

Queue details of the associated brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Queue

Parameter

+

Type

+

Description

+

id

+

Integer

+

Definition

+

Queue ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

lag

+

Long

+

Definition

+

Total number of accumulated messages in the queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_offset

+

Long

+

Definition

+

Total number of messages in the queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consumer_offset

+

Long

+

Definition

+

Number of consumed messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

last_message_time

+

Long

+

Definition

+

Time (UNIX, in millisecond) when the latest consumed message was stored.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Consumer group list or details queried successfully.

+ +
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumer group list or details queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowDiagnosisReportForRocketMq.html b/docs/dms_rocketmq/api-ref/ShowDiagnosisReportForRocketMq.html new file mode 100644 index 000000000..42f0423c5 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowDiagnosisReportForRocketMq.html @@ -0,0 +1,544 @@ + + +

Querying an Instance Diagnosis Report

+

Function

This API is used to query an instance diagnosis report.

+
+

URI

GET /v2/{project_id}/rocketmq/diagnosis/{report_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

report_id

+

Yes

+

String

+

Definition

+

Report ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

report_id

+

String

+

Definition

+

Report ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consumer_nums

+

Integer

+

Definition

+

Number of consumers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

status

+

String

+

Definition

+

Status.

+

Constraints

+

N/A

+

Range

+
  • diagnosing

    +
  • failed

    +
  • deleted (manually)

    +
  • finished

    +
  • normal: No problems found.

    +
  • abnormal: Problems found.

    +
+

Default Value

+

N/A

+

created_at

+

Long

+

Definition

+

Generation time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

abnormal_item_sum

+

Integer

+

Definition

+

Number of abnormal items.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

faulted_node_sum

+

Integer

+

Definition

+

Number of abnormal nodes.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

online

+

Boolean

+

Definition

+

Online or not.

+

Range

+
  • True: online

    +
  • False: not online

    +
+

message_accumulation

+

Integer

+

Definition

+

Number of stacked messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subscription_consistency

+

Boolean

+

Definition

+

Subscription consistency.

+

Constraints

+

N/A

+

Range

+
  • True: The subscription relationship is consistent.

    +
  • False: The subscription relationship is inconsistent.

    +
+

Default Value

+

N/A

+

duplicate_client_id

+

Boolean

+

Definition

+

Whether there are duplicate client IDs.

+

Constraints

+

N/A

+

Range

+
  • True: Yes

    +
  • False: No

    +
+

Default Value

+

N/A

+

different_consumer_type

+

Boolean

+

Definition

+

Whether there are inconsistent consumption types.

+

Constraints

+

N/A

+

Range

+
  • True: Yes

    +
  • False: No

    +
+

Default Value

+

N/A

+

subscriptions

+

Array of SubscriptionEntity objects

+

Definition

+

Subscriber list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

diagnosis_node_report_list

+

Array of DiagnosisNodeReportEntity objects

+

Definition

+

Diagnosis node report list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 SubscriptionEntity

Parameter

+

Type

+

Description

+

topic_name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consumers_in_tags

+

Array of ConsumersInTagEntity objects

+

Definition

+

Consumer tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 ConsumersInTagEntity

Parameter

+

Type

+

Description

+

consumers

+

Array of strings

+

Definition

+

Consumer list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tag_name

+

String

+

Definition

+

Tag name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 DiagnosisNodeReportEntity

Parameter

+

Type

+

Description

+

node_id

+

String

+

Definition

+

Node ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

is_faulted

+

Boolean

+

Definition

+

Whether a node is faulty.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

abnormal_item_sum

+

Integer

+

Definition

+

Total number of exceptions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

message_accumulation

+

Integer

+

Definition

+

Number of stacked messages.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dead_lock

+

Boolean

+

Definition

+

Whether a deadlock occurs.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

deadlock_thread

+

String

+

Definition

+

Deadlock thread.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

stack_id

+

String

+

Definition

+

Thread ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

is_pop

+

Boolean

+

Definition

+

Whether pop consumption is used.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

consume_type

+

String

+

Definition

+

Consumption type.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying an instance diagnosis report

+
GET https://{endpoint}/v2/{project_id}/rocketmq/diagnosis/{report_id}
+
+

Example Responses

Status code: 200

+

success

+
{
+  "report_id" : "3019dd35-361c-4631-a8d8-3578c0a7d102",
+  "group_name" : "test",
+  "consumer_nums" : 0,
+  "status" : "finished",
+  "creat_at" : 1748402725731,
+  "abnormal_item_sum" : 1,
+  "faulted_node_sum" : 0,
+  "online" : false,
+  "message_accumulation" : 0,
+  "subscription_consistency" : true,
+  "subscriptions" : [ ],
+  "diagnosis_node_report_list" : [ ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

success

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowDiagnosisStackForRocketMq.html b/docs/dms_rocketmq/api-ref/ShowDiagnosisStackForRocketMq.html new file mode 100644 index 000000000..ff2b7e233 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowDiagnosisStackForRocketMq.html @@ -0,0 +1,132 @@ + + +

Querying Stack Information

+

Function

This API is used to query stack information.

+
+

URI

GET /v2/{project_id}/rocketmq/diagnosis/stack/{stack_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

stack_id

+

Yes

+

String

+

Definition

+

Stack ID. It is obtained from the API for querying an instance diagnosis report.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

thread_name

+

String

+

Definition

+

Thread name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

stack

+

String

+

Definition

+

Stack information of the client.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying stack information

+
GET https://{endpoint}/v2/{project_id}/rocketmq/diagnosis/stack/{stack_id}
+
+

Example Responses

Status code: 200

+

success

+
{
+  "thread_name" : "name",
+  "stack" : "xxxxxxxxxxxxxxxx"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

success

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowEngineInstanceExtendProductInfoForRocketMq.html b/docs/dms_rocketmq/api-ref/ShowEngineInstanceExtendProductInfoForRocketMq.html new file mode 100644 index 000000000..8e7bd985c --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowEngineInstanceExtendProductInfoForRocketMq.html @@ -0,0 +1,788 @@ + + +

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}/rocketmq/instances/{instance_id}/extend

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Definition

+

Product type. advanced: premium edition.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

advanced

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine

+

String

+

Definition

+

Message engine type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ message engine.

    +
  • reliability: RocketMQ message engine alias.

    +
+

Default Value

+

N/A

+

versions

+

Array of strings

+

Definition

+

Versions supported by the message engine.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

products

+

Array of RocketMQExtendProductInfoEntity objects

+

Definition

+

Product information for specification modification.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RocketMQExtendProductInfoEntity

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Instance type.

+

Constraints

+

N/A

+

Range

+
  • single.basic: 5.x single-node basic edition.

    +
  • cluster.basic: 5.x cluster basic edition

    +
+

Default Value

+

N/A

+

product_id

+

String

+

Definition

+

RocketMQ instance flavors.

+

Constraints

+

N/A

+

Range

+

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

+
  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

    +
  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

    +
  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

    +
  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

    +
+

Default Value

+

N/A

+

ecs_flavor_id

+

String

+

Definition

+

ID of an ECS flavor. The specifications list of ECS can be referred. DMS can be adapted with general computing-plus C6 series and later. RocketMQ 5.x CPU/memory ratio is 1:4.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

billing_code

+

String

+

Definition

+

Billing mode.

+

Constraints

+

N/A

+

Range

+
  • dms.rocketmq.basic.single.tps: single-node RocketMQ 5.x basic edition.

    +
  • dms.rocketmq.basic.cluster.tps: cluster RocketMQ 5.x basic edition.

    +
+

Default Value

+

N/A

+

arch_types

+

Array of strings

+

Definition

+

Supported CPU architectures.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

charging_mode

+

Array of strings

+

Definition

+

Supported billing modes.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

ios

+

Array of RocketMQExtendProductIosEntity objects

+

Definition

+

Disk I/O object information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

properties

+

RocketMQExtendProductPropertiesEntity object

+

Definition

+

Key-value pair of a feature.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zones

+

Array of strings

+

Definition

+

AZ list. For RocketMQ 5.x basic edition: Select one AZ for a single-node instance and one or two AZs for a cluster one.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

unavailable_zones

+

Array of strings

+

Definition

+

Unavailable AZ list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

support_features

+

Array of RocketMQProductSupportFeaturesEntity objects

+

Definition

+

Supported feature list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

qingtian_incompatible

+

Boolean

+

Definition

+

Whether the instance is a QingTian one.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 RocketMQExtendProductIosEntity

Parameter

+

Type

+

Description

+

io_spec

+

String

+

Definition

+

Storage I/O flavor.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zones

+

Array of strings

+

Definition

+

AZ list. For RocketMQ 5.x basic edition: Select one AZ for a single-node instance and one or two AZs for a cluster one.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

String

+

Definition

+

I/O type.

+

Constraints

+

N/A

+

Range

+
  • evs: Disk type.

    +
+

Default Value

+

N/A

+

unavailable_zones

+

Array of strings

+

Definition

+

Unavailable AZ list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 RocketMQExtendProductPropertiesEntity

Parameter

+

Type

+

Description

+

engine_versions

+

String

+

Definition

+

Message engine version.

+

Constraints

+

N/A

+

Range

+
  • 5.x

    +
+

Default Value

+

N/A

+

max_storage_per_node

+

String

+

Definition

+

Maximum storage space of each broker. Unit: GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

min_storage_per_node

+

String

+

Definition

+

Minimum storage per node. Unit: GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

product_alias

+

String

+

Definition

+

Alias of product_id.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

feature

+

String

+

Definition

+

Feature switch of the specification. (This field is displayed only for RocketMQ 5.x.)

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_topic

+

String

+

Definition

+

Maximum number of topics in an instance (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_num

+

String

+

Definition

+

Number of brokers (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

core

+

String

+

Definition

+

Number of billing cores in an instance (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_consumer

+

String

+

Definition

+

Maximum number of consumers in an instance (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

rcu

+

String

+

Definition

+

Traffic unit, rcu × max_tpc_per_rcu = Maximum flavor TPS (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_storage

+

String

+

Definition

+

Maximum storage space (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

min_storage

+

String

+

Definition

+

Minimum storage space (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_tps_per_rcu

+

String

+

Definition

+

Maximum TPS per RCU (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 RocketMQProductSupportFeaturesEntity

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Feature name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

properties

+

Map<String,String>

+

Definition

+

Key-value pair of a feature.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying an instance scaling list

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

Example Responses

Status code: 200

+

Product information for instance specification modification queried.

+
{
+  "total" : 1,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "engine" : "rocketmq",
+  "versions" : [ "5.x" ],
+  "products" : [ {
+    "type" : "single.basic",
+    "product_id" : "rocketmq.b1.large.1",
+    "ecs_flavor_id" : "c6.large.2",
+    "arch_types" : [ "X86" ],
+    "ios" : [ {
+      "io_spec" : "dms.physical.storage.high.v2",
+      "available_zones" : [ "xxx" ],
+      "type" : "evs",
+      "unavailable_zones" : [ "xxx" ]
+    }, {
+      "io_spec" : "dms.physical.storage.ultra.v2",
+      "available_zones" : [ ],
+      "type" : "evs",
+      "unavailable_zones" : [ "xxx" ]
+    } ],
+    "support_features" : [ ],
+    "billing_code" : "dms.rocketmq.basic.single.tps",
+    "charging_mode" : [ "monthly", "hourly" ],
+    "properties" : {
+      "broker_num" : 1,
+      "core" : 1,
+      "engine_versions" : "5.x",
+      "max_consumer" : 500,
+      "max_storage" : "30000",
+      "max_storage_per_node" : "30000",
+      "max_topic" : 50,
+      "max_tps_per_rcu" : 500,
+      "min_storage" : 100,
+      "min_storage_per_node" : 100,
+      "product_alias" : "rocketmq.b1.large.1",
+      "rcu" : 1,
+      "max_topic_per_broker" : 50
+    },
+    "available_zones" : [ "xxx" ],
+    "unavailable_zones" : [ "xxx" ],
+    "qingtian_incompatible" : false
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Product information for instance specification modification queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowGroup.html b/docs/dms_rocketmq/api-ref/ShowGroup.html new file mode 100644 index 000000000..39935d8b8 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowGroup.html @@ -0,0 +1,260 @@ + + +

Querying a Consumer Group

+

Function

This API is used to query details about a specified consumer group.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

enabled

+

Boolean

+

Definition

+

Whether consumption is allowed.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

broadcast

+

Boolean

+

Definition

+

Whether to enable broadcast.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_desc

+

String

+

Definition

+

Consumer group description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

created_at

+

Long

+

Definition

+

Creation time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

retry_max_time

+

Integer

+

Definition

+

Maximum number of retries.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

permissions

+

Array of strings

+

Definition

+

Permission.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consume_orderly

+

Boolean

+

Definition

+

Whether to enable orderly consumption.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

group_online

+

Boolean

+

Definition

+

Whether a consumer group is online.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying details about a specified consumer group

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

Example Responses

Status code: 200

+

Consumer group queried successfully.

+
{
+  "name" : "test",
+  "group_desc" : "group_description",
+  "enabled" : true,
+  "broadcast" : true,
+  "permissions" : [ ],
+  "retry_max_time" : 10,
+  "consume_orderly" : false,
+  "created_at" : 1768549443385
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumer group queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowInstance.html b/docs/dms_rocketmq/api-ref/ShowInstance.html new file mode 100644 index 000000000..fc939f21f --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowInstance.html @@ -0,0 +1,1090 @@ + + +

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

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Instance name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine

+

String

+

Definition

+

Message engine type.

+

Constraints

+

N/A

+

Range

+
  • rocketmq: RocketMQ message engine.

    +
  • reliability: RocketMQ message engine alias.

    +
+

Default Value

+

N/A

+

status

+

String

+

Definition

+

Message status.

+

Constraints

+

N/A

+

Range

+

For details, see Instance Status.

+

Default Value

+

N/A

+

description

+

String

+

Definition

+

Message description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

String

+

Definition

+

Message description.

+

Constraints

+

N/A

+

Range

+
  • single.basic: 5.x single-node basic edition.

    +
  • cluster.basic: 5.x cluster basic edition

    +
+

Default Value

+

N/A

+

specification

+

String

+

Definition

+

Instance specification.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

engine_version

+

String

+

Definition

+

Instance version.

+

Constraints

+

N/A

+

Range

+
  • 5.x

    +
+

Default Value

+

N/A

+

instance_id

+

String

+

Definition

+

Instance ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

charging_mode

+

Integer

+

Definition

+

Billing mode.

+

Constraints

+

N/A

+

Range

+

1 indicates pay-per-use.

+

Default Value

+

N/A

+

vpc_id

+

String

+

Definition

+

VPC ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

vpc_name

+

String

+

Definition

+

VPC name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

created_at

+

String

+

Definition

+

Time when creation is complete.

+

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.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

product_id

+

String

+

Definition

+

RocketMQ instance flavors.

+

Constraints

+

N/A

+

Range

+

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

+
  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

    +
  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

    +
  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

    +
  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

    +
+

Default Value

+

N/A

+

security_group_id

+

String

+

Definition

+

Security group ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

security_group_name

+

String

+

Definition

+

Security group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_id

+

String

+

Definition

+

Subnet ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_name

+

String

+

Definition

+

Subnet name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_cidr

+

String

+

Definition

+

Subnet route.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zones

+

Array of strings

+

Definition

+

List of AZ IDs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

available_zone_names

+

Array of strings

+

Definition

+

List of AZ names.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_id

+

String

+

Definition

+

User ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_name

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

maintain_begin

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

maintain_end

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

storage_space

+

Integer

+

Definition

+

Storage space, in GB.

+

Constraints

+

N/A

+

Range

+

Different instance specifications support different storage configurations.

+
  • RocketMQ 5.x single-node storage range: 100–30000

    +
  • RocketMQ 5.x cluster storage range: 200–60000

    +
+

Default Value

+

N/A

+

used_storage_space

+

Integer

+

Definition

+

Used message storage space, in GB.

+

Constraints

+

N/A

+

Range

+

Different instance specifications support different storage configurations.

+
  • RocketMQ 5.x single-node storage range: 100–30000

    +
  • RocketMQ 5.x cluster storage range: 200–60000

    +
+

Default Value

+

N/A

+

enable_publicip

+

Boolean

+

Definition

+

Whether to enable public access.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

publicip_id

+

String

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

publicip_address

+

String

+

Definition

+

Public IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

ssl_enable

+

Boolean

+

Definition

+

Whether SSL is enabled.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

cross_vpc_info

+

String

+

Definition

+

Cross-VPC access information.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

storage_resource_id

+

String

+

Definition

+

Storage resource ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

storage_spec_code

+

String

+

Definition

+

Storage specification code.

+

Constraints

+

N/A

+

Range

+
  • dms.physical.storage.high.v2: high I/O disk

    +
  • dms.physical.storage.ultra.v2: ultra-high I/O disk

    +
  • dms.physical.storage.general: general-purpose SSD

    +
  • dms.physical.storage.extreme: extreme SSD

    +
+

Default Value

+

N/A

+

service_type

+

String

+

Definition

+

Service type.

+

Constraints

+

N/A

+

Range

+
  • advanced: Service type.

    +
+

Default Value

+

N/A

+

storage_type

+

String

+

Definition

+

Storage type.

+

Constraints

+

N/A

+

Range

+
  • hec: Storage type.

    +
+

Default Value

+

N/A

+

ipv6_enable

+

Boolean

+

Definition

+

Whether IPv6 is enabled.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

disk_encrypted

+

Boolean

+

Definition

+

Whether disk encryption is enabled.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

enable_acl

+

Boolean

+

Definition

+

Whether to enable access control.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

broker_num

+

Integer

+

Definition

+

Number of brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dns_enable

+

Boolean

+

Definition

+

Whether to enable domain name access to an instance.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

namesrv_address

+

String

+

Definition

+

Metadata address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

namesrv_domain_name

+

String

+

Definition

+

Metadata domain name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_address

+

String

+

Definition

+

Service data address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_namesrv_address

+

String

+

Definition

+

Public network metadata address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_namesrv_domain_name

+

String

+

Definition

+

Public metadata domain name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_broker_address

+

String

+

Definition

+

Public network service data address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

grpc_address

+

String

+

Definition

+

gRPC connection address (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

grpc_domain_name

+

String

+

Definition

+

gRPC connection domain name (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_grpc_address

+

String

+

Definition

+

Public gRPC connection address (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_grpc_domain_name

+

String

+

Definition

+

Public gRPC domain name (displayed only for RocketMQ 5.x).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

enterprise_project_id

+

String

+

Definition

+

Enterprise project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tags

+

Array of TagEntity objects

+

Definition

+

Tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_storage_space

+

Integer

+

Definition

+

Total storage space.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_spec_code

+

String

+

Definition

+

Resource specification.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

produce_portion

+

Integer

+

Definition

+

Production TPS proportion.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

consume_portion

+

Integer

+

Definition

+

Consumption TPS proportion.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

dr_enable

+

Boolean

+

Definition

+

Whether the instance has disaster recovery (DR).

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

config_ssl_need_restart_process

+

Boolean

+

Definition

+

Whether a restart is required to configure SSL.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

tls_mode

+

String

+

Definition

+

Security protocol used by an instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

arch_type

+

String

+

Definition

+

Architecture type.

+

Constraints

+

N/A

+

Range

+
  • X86

    +
  • ARM

    +
+

Default Value

+

N/A

+

auto_volume_expand_enable

+

Boolean

+

Definition

+

Whether to enable automatic disk capacity expansion.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

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

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+
  • Must be specified.

    +
  • Must be unique for the same instance.

    +
  • Can contain 1 to 128 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+

value

+

String

+

Tag value.

+
  • Can contain 0 to 255 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+
+
+
+

Example Requests

Querying details of a specified instance

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

Example Responses

Status code: 200

+

Instance queried successfully.

+
{
+  "name" : "reliability-test",
+  "engine" : "reliability",
+  "status" : "RUNNING",
+  "description" : "",
+  "type" : "cluster.basic",
+  "specification" : "rocketmq.b2.large.4, 2000 tps",
+  "engine_version" : "5.x",
+  "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
+  "resource_spec_code" : "",
+  "charging_mode" : 1,
+  "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
+  "vpc_name" : "vpc-1101840",
+  "created_at" : "1636699753874",
+  "product_id" : "rocketmq.b2.large.4",
+  "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
+  "security_group_name" : "Sys-default",
+  "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
+  "subnet_name" : "subnet-boce",
+  "subnet_cidr" : "192.168.64.0/18",
+  "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
+  "available_zone_names" : [ "AZ3" ],
+  "user_id" : "0b01fbb53600d4671fa8c00673c71260",
+  "user_name" : "",
+  "maintain_begin" : "02:00:00",
+  "maintain_end" : "06:00:00",
+  "dns_enable" : false,
+  "storage_space" : 558,
+  "total_storage_space" : 1200,
+  "used_storage_space" : 28,
+  "enable_publicip" : true,
+  "publicip_id" : "7e6b7beb-ef13-4805-878d-285890b17a12,87827295-84e1-4118-9ab3-a90dd8c9dace,91306a18-5781-4529-b739-5aeec10ec4e6,a68e8f0e-a24f-4521-910e-39696a56fcdf,bb1cd147-a7af-46ca-9548-99fec4034ba2",
+  "publicip_address" : "***",
+  "ssl_enable" : false,
+  "cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}",
+  "storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2",
+  "storage_spec_code" : "dms.physical.storage.ultra.v2",
+  "service_type" : "advanced",
+  "storage_type" : "hec",
+  "disk_encrypted" : false,
+  "enable_acl" : false,
+  "dr_enable" : false,
+  "config_ssl_need_restart_process" : false,
+  "broker_num" : 1,
+  "namesrv_address" : "***",
+  "broker_address" : "***",
+  "public_namesrv_address" : "***",
+  "public_broker_address" : "***",
+  "grpc_address" : "***",
+  "public_grpc_address" : "***"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowOneTopic.html b/docs/dms_rocketmq/api-ref/ShowOneTopic.html new file mode 100644 index 000000000..8bfe94e01 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowOneTopic.html @@ -0,0 +1,266 @@ + + +

Querying a Topic

+

Function

This API is used to query a topic.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

Yes

+

String

+

Topic name.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_read_queue_num

+

Number

+

Definition

+

Total number of read queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

total_write_queue_num

+

Number

+

Definition

+

Total number of write queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

permission

+

String

+

Definition

+

Permission.

+

Constraints

+

N/A

+

Range

+
  • sub: subscribe permissions.

    +
  • pub: publish permissions.

    +
  • all: subscribe and publish permissions.

    +
+

Default Value

+

N/A

+

brokers

+

Array of brokers objects

+

Definition

+

Associated broker.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

message_type

+

String

+

Definition

+

Message type (available only for RocketMQ 5.x instances).

+

Constraints

+

N/A

+

Range

+
  • NORMAL: normal messages.

    +
  • FIFO: ordered messages.

    +
  • DELAY: scheduled messages.

    +
  • TRANSACTION: transactional messages.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 3 brokers

Parameter

+

Type

+

Description

+

broker_name

+

String

+

Definition

+

Broker name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

read_queue_num

+

Number

+

Definition

+

Number of read queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

write_queue_num

+

Number

+

Definition

+

Number of write queues.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying details about a specified topic

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

Example Responses

Status code: 200

+

Topic queried successfully.

+
{
+  "name" : "topic",
+  "total_read_queue_num" : 3,
+  "total_write_queue_num" : 3,
+  "permission" : "all",
+  "brokers" : [ {
+    "broker_name" : "broker-0",
+    "read_queue_num" : 3,
+    "write_queue_num" : 3
+  } ],
+  "message_type" : "NORMAL"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Topic queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowQuotas.html b/docs/dms_rocketmq/api-ref/ShowQuotas.html new file mode 100644 index 000000000..ef5f10bc6 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowQuotas.html @@ -0,0 +1,241 @@ + + +

Querying Tenant Quotas

+

Function

This API is used to query the maximum number of instances that a tenant can create, the number of created instances, and the maximum number of tags that can be created for each instance.

+
+

URI

GET /v2/{project_id}/quotas

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

includeTagsQuota

+

No

+

String

+

Definition

+

Whether a tag quota flag is included.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

true

+

onlyQuota

+

No

+

String

+

Definition

+

Queries a specified quota engine.

+

Constraints

+

N/A

+

Range

+
  • reliability: RocketMQ message engine alias.

    +
  • kafka: Kafka message engine alias.

    +
+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

quotas

+

quotas object

+

Definition

+

Quota information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 4 quotas

Parameter

+

Type

+

Description

+

resources

+

Array of QuotaResourceEntity objects

+

Definition

+

Quota list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 QuotaResourceEntity

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Supports kafkaInstance, rocketmqInstance, and tags.

+
  • kafkaInstance: Kafka instance quotas

    +
  • rocketmqInstance: RocketMQ instance quotas

    +
  • tags: Tag quotas

    +
  • kafkaInstancePublic: Kafka public network quotas (deprecated).

    +
+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

quota

+

Integer

+

Definition

+

The maximum number of instances that a tenant can create, or the maximum number of tags that can be created for each instance.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

used

+

Integer

+

Definition

+

Number of created instances.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

GET https://{endpoint}/v2/{project_id}/quotas?includeTagsQuota=false&onlyQuota=reliability
+
+

Example Responses

Status code: 200

+

Successful

+
{
+  "quotas" : {
+    "resources" : [ {
+      "type" : "rocketmqInstance",
+      "quota" : 100,
+      "used" : 17
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Successful

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowRocketMqConfigs.html b/docs/dms_rocketmq/api-ref/ShowRocketMqConfigs.html new file mode 100644 index 000000000..9e8beff37 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowRocketMqConfigs.html @@ -0,0 +1,314 @@ + + +

Querying RocketMQ Configurations

+

Function

This API is used to query RocketMQ configurations. Configuration details will be returned.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

offset

+

No

+

Integer

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

rocketmq_configs

+

Array of RocketMQConfigResp objects

+

Definition

+

RocketMQ configuration.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RocketMQConfigResp

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

RocketMQ configuration name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

value

+

String

+

Definition

+

RocketMQ configuration current value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

config_type

+

String

+

Definition

+

RocketMQ configuration type.

+

Constraints

+

N/A

+

Range

+
  • dynamic

    +
  • static

    +
+

Default Value

+

N/A

+

default_value

+

String

+

Definition

+

RocketMQ configuration default value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

valid_values

+

String

+

Definition

+

RocketMQ configuration value range.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

value_type

+

String

+

Definition

+

RocketMQ configuration value type.

+

Constraints

+

N/A

+

Range

+
  • integer

    +
  • boolean

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

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

Example Responses

Status code: 200

+

Successful.

+
{
+  "total" : 1,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "rocketmq_configs" : [ {
+    "name" : "fileReservedTime",
+    "value" : 48,
+    "config_type" : "dynamic",
+    "default_value" : 48,
+    "valid_values" : "1~720",
+    "value_type" : "integer"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowRocketmqProjectTags.html b/docs/dms_rocketmq/api-ref/ShowRocketmqProjectTags.html new file mode 100644 index 000000000..68c9de874 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowRocketmqProjectTags.html @@ -0,0 +1,238 @@ + + +

Querying Project Tags

+

Function

This API is used to query tags of a project.

+
+

URI

GET /v2/{project_id}/rocketmq/tags

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Offset where the query starts.

+

Constraints

+

N/A

+

Range

+

≥ 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tags

+

Array of TagMultyValueEntity objects

+

Definition

+

Tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 TagMultyValueEntity

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

values

+

Array of strings

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying project tags

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

Example Responses

Status code: 200

+

The project tags are queried successfully.

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

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The project tags are queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowRocketmqTags.html b/docs/dms_rocketmq/api-ref/ShowRocketmqTags.html new file mode 100644 index 000000000..a55a99b3b --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowRocketmqTags.html @@ -0,0 +1,250 @@ + + +

Querying Instance Tags

+

Function

This API is used to query instance tags.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Number of records to query.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

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

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total

+

Number

+

Definition

+

Total number.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

next_offset

+

Integer

+

Definition

+

Offset of the next page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

previous_offset

+

Integer

+

Definition

+

Offset of the previous page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tags

+

Array of TagEntity objects

+

Definition

+

Tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 TagEntity

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+
  • Must be specified.

    +
  • Must be unique for the same instance.

    +
  • Can contain 1 to 128 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+

value

+

String

+

Tag value.

+
  • Can contain 0 to 255 characters.

    +
  • Can contain letters, digits, spaces, and special characters _.:=+-@

    +
  • Cannot start or end with a space.

    +
+
+
+
+

Example Requests

Querying instance tags

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

Example Responses

Status code: 200

+

Instance tags queried successfully.

+
{
+  "total" : 1,
+  "next_offset" : -1,
+  "previous_offset" : -1,
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance tags queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowTopicStatus.html b/docs/dms_rocketmq/api-ref/ShowTopicStatus.html new file mode 100644 index 000000000..5a8352c93 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowTopicStatus.html @@ -0,0 +1,272 @@ + + +

Querying the Number of Messages in a Topic

+

Function

This API is used to query the number of messages in a topic.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

max_offset

+

Integer

+

Definition

+

Maximum offset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

min_offset

+

Integer

+

Definition

+

Minimum offset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

brokers

+

Array of brokers objects

+

Definition

+

Broker.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 brokers

Parameter

+

Type

+

Description

+

queues

+

Array of queues objects

+

Definition

+

Queue list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

broker_name

+

String

+

Definition

+

Node name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 queues

Parameter

+

Type

+

Description

+

id

+

Integer

+

Definition

+

Queue ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

min_offset

+

Integer

+

Definition

+

Minimum offset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

max_offset

+

Integer

+

Definition

+

Maximum offset.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

last_message_time

+

Long

+

Definition

+

Time of the last message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying the number of messages in a specified topic

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

Example Responses

Status code: 200

+

Successful

+

Successful.

+
{
+  "brokers" : [ ],
+  "min_offset" : 0,
+  "max_offset" : 2
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Successful

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ShowUser.html b/docs/dms_rocketmq/api-ref/ShowUser.html new file mode 100644 index 000000000..da18c2e1e --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ShowUser.html @@ -0,0 +1,332 @@ + + +

Querying User Details

+

Function

This API is used to query user details.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_name

+

Yes

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

access_key

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

secret_key

+

String

+

Definition

+

Key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

admin

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

default_topic_perm

+

String

+

Definition

+

Default topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

default_group_perm

+

String

+

Definition

+

Default consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

topic_perms

+

Array of topic_perms objects

+

Definition

+

Special topic permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_perms

+

Array of group_perms objects

+

Definition

+

Special consumer group permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 topic_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 group_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Querying user details

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

Example Responses

Status code: 200

+

User details queried successfully.

+
{
+  "access_key" : "test_01",
+  "admin" : false,
+  "default_group_perm" : "DENY",
+  "default_topic_perm" : "SUB",
+  "group_perms" : [ ],
+  "secret_key" : "Abcd1234!",
+  "topic_perms" : [ ],
+  "white_remote_address" : ""
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

User details queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/UpdateConsumerGroup.html b/docs/dms_rocketmq/api-ref/UpdateConsumerGroup.html new file mode 100644 index 000000000..13055ba4b --- /dev/null +++ b/docs/dms_rocketmq/api-ref/UpdateConsumerGroup.html @@ -0,0 +1,169 @@ + + +

Modifying a Consumer Group

+

Function

This API is used to modify parameters of a specified consumer group.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group

+

Yes

+

String

+

Consumer group name.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

enabled

+

Yes

+

Boolean

+

Whether a message can be consumed.

+

broadcast

+

Yes

+

Boolean

+

Whether to broadcast.

+

brokers

+

No

+

Array of strings

+

Definition

+

List of associated brokers.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

No

+

String

+

Consumer group whose parameters are to be modified. (The consumer group name cannot be modified.)

+

retry_max_time

+

Yes

+

Integer

+

Maximum number of retries. Value range: 1 to 16.

+
+
+
+

Response Parameters

Status code: 204

+

The specified consumer group is modified.

+

None

+
+

Example Requests

Changing consumer-group-test's max. retries to 16

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}
+
+{
+  "enabled" : true,
+  "retry_max_time" : 16,
+  "broadcast" : true
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The specified consumer group is modified.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/UpdateInstance.html b/docs/dms_rocketmq/api-ref/UpdateInstance.html new file mode 100644 index 000000000..c2c7abe5d --- /dev/null +++ b/docs/dms_rocketmq/api-ref/UpdateInstance.html @@ -0,0 +1,226 @@ + + +

Modifying Instance Information

+

Function

This API is used to modify instance information.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Instance name.

+

Constraints

+

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

+

Range

+

N/A

+

Default Value

+

N/A

+

description

+

No

+

String

+

Definition

+

Description of an instance.

+

Constraints

+

0–1024 characters.

+

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

+

Range

+

N/A

+

Default Value

+

N/A

+

security_group_id

+

No

+

String

+

Definition

+

Security group ID.

+

You can call the API for querying security groups to obtain the security group ID. The security group ID is in the response body. For details, see Virtual Private Cloud API Reference.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

enable_acl

+

No

+

Boolean

+

Definition

+

Whether to enable ACL.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

enable_publicip

+

No

+

Boolean

+

Definition

+

Whether to enable public access.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

publicip_id

+

No

+

String

+

Definition

+

ID of the EIP bound to the instance.

+

Constraints

+

Use commas (,) to separate multiple EIP IDs.

+

This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).

+

Range

+

N/A

+

Default Value

+

N/A

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 204

+

Instance information modified successfully.

+

None

+
+

Example Requests

Modifying the name and description of a RocketMQ instance

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}
+
+{
+  "name" : "rocketmq001",
+  "description" : "RocketMQ description"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Instance information modified successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/UpdateRocketMqConfigs.html b/docs/dms_rocketmq/api-ref/UpdateRocketMqConfigs.html new file mode 100644 index 000000000..eff51102a --- /dev/null +++ b/docs/dms_rocketmq/api-ref/UpdateRocketMqConfigs.html @@ -0,0 +1,171 @@ + + +

Modifying RocketMQ Configurations

+

Function

This API is used to modify RocketMQ configurations.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

rocketmq_configs

+

Yes

+

Array of RocketMQConfigReq objects

+

Definition

+

RocketMQ configuration.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 RocketMQConfigReq

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

RocketMQ configuration name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

value

+

Yes

+

String

+

Definition

+

RocketMQ configuration target value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 204

+

Successful.

+

None

+
+

Example Requests

Modifying RocketMQ configurations with file retention period changed to 72 hours.

+
PUT  https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/configs
+
+{
+  "rocketmq_configs" : [ {
+    "name" : "fileReservedTime",
+    "value" : 72
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/UpdateScheduledTask.html b/docs/dms_rocketmq/api-ref/UpdateScheduledTask.html new file mode 100644 index 000000000..9f4bb7029 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/UpdateScheduledTask.html @@ -0,0 +1,155 @@ + + +

Modifying Specified Records in Scheduled Task Management

+

Function

This API is used to modify specified records in scheduled task management.

+
+

URI

PUT /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

task_id

+

Yes

+

String

+

Definition

+

Scheduled task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

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

Parameter

+

Mandatory

+

Type

+

Description

+

execute_at

+

No

+

String

+

Definition

+

Modifies the execution time of a scheduled task.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

status

+

No

+

String

+

Definition

+

Modifies the status of a scheduled task.

+

Constraints

+

N/A

+

Range

+
  • CANCELLED

    +
+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 204

+

Scheduled task modified.

+

None

+
+

Example Requests

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Scheduled task modified.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/UpdateTopic.html b/docs/dms_rocketmq/api-ref/UpdateTopic.html new file mode 100644 index 000000000..a83b56b47 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/UpdateTopic.html @@ -0,0 +1,138 @@ + + +

Modifying a Topic

+

Function

This API is used to modify a topic.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

Yes

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

topic_desc

+

No

+

String

+

Definition:

+

Topic description.

+

Constraints:

+

N/A

+

Range:

+

N/A

+

Default Value:

+

N/A

+
+
+
+

Response Parameters

Status code: 204

+

The topic is modified.

+

None

+
+

Example Requests

Changing a specified topic's total read queues to 3 and total write queues to 3

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}
+
+{
+  "topic_desc" : "topic_description"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

The topic is modified.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/UpdateUser.html b/docs/dms_rocketmq/api-ref/UpdateUser.html new file mode 100644 index 000000000..77bd5d9a8 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/UpdateUser.html @@ -0,0 +1,603 @@ + + +

Modifying User Parameters

+

Function

This API is used to modify user parameters.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_name

+

Yes

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

access_key

+

No

+

String

+

Definition

+

Username.

+

Constraints

+

Starts with a letter, consists of 7 to 64 characters, and contains only letters, digits, hyphens (-), and underscores (_).

+

Range

+

N/A

+

Default value

+

N/A

+

secret_key

+

Yes

+

String

+

Definition

+

Key. If the key is empty, the key is not updated and the old key is still used.

+

Constraints

+

8 to 32 characters.

+

Contain at least three of the following character types:

+
  • Uppercase letters

    +
  • Lowercase letters

    +
  • Digits

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

    +
+

Cannot be the username or the username spelled backwards.

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

No

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

admin

+

No

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

default_topic_perm

+

No

+

String

+

Definition

+

Default topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permissions.

    +
  • SUB: subscribe permissions.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

default_group_perm

+

No

+

String

+

Definition

+

Default consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

topic_perms

+

No

+

Array of topic_perms objects

+

Definition

+

Special topic permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_perms

+

No

+

Array of group_perms objects

+

Definition

+

Special consumer group permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 topic_perms

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

perm

+

No

+

String

+

Definition

+

Topic permission.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permissions.

    +
  • SUB: subscribe permissions.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 group_perms

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default value

+

N/A

+

perm

+

No

+

String

+

Definition

+

Consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

access_key

+

String

+

Definition

+

Username.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

secret_key

+

String

+

Definition

+

Key.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

white_remote_address

+

String

+

Definition

+

IP address whitelist.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

admin

+

Boolean

+

Definition

+

Whether the user is an administrator.

+

Constraints

+

N/A

+

Range

+
  • true: Yes

    +
  • false: No

    +
+

Default Value

+

N/A

+

default_topic_perm

+

String

+

Definition

+

Default topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

default_group_perm

+

String

+

Definition

+

Default consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+

topic_perms

+

Array of topic_perms objects

+

Definition

+

Special topic permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

group_perms

+

Array of group_perms objects

+

Definition

+

Special consumer group permissions.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 topic_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Topic name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Topic permissions.

+

Constraints

+

N/A

+

Range

+
  • PUB: publish permission.

    +
  • SUB: subscribe permission.

    +
  • PUB|SUB: subscribe and publish permissions.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 group_perms

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Consumer group name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm

+

String

+

Definition

+

Consumer group permissions.

+

Constraints

+

N/A

+

Range

+
  • SUB: subscribe permission.

    +
  • DENY: no permission.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Granting user_name permissions to publish and subscribe to topic1 and group1

+
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}
+
+{
+  "access_key" : "user_name",
+  "secret_key" : "Abcd1234!",
+  "white_remote_address" : "",
+  "admin" : false,
+  "default_topic_perm" : "DENY",
+  "default_group_perm" : "DENY",
+  "topic_perms" : [ {
+    "name" : "topic1",
+    "perm" : "PUB|SUB"
+  } ],
+  "group_perms" : [ {
+    "name" : "group1",
+    "perm" : "PUB|SUB"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

The modification is successful.

+
{
+  "access_key" : "test_01",
+  "admin" : false,
+  "default_group_perm" : "DENY",
+  "default_topic_perm" : "SUB",
+  "group_perms" : [ ],
+  "secret_key" : "Abcd1234!",
+  "topic_perms" : [ ],
+  "white_remote_address" : ""
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The modification is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/ValidateConsumedMessageForRocketMq.html b/docs/dms_rocketmq/api-ref/ValidateConsumedMessageForRocketMq.html new file mode 100644 index 000000000..4523592a2 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/ValidateConsumedMessageForRocketMq.html @@ -0,0 +1,258 @@ + + +

Verifying Consumption

+

Function

This API is used to verify consumption.

+
+

URI

POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/resend

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

group

+

Yes

+

String

+

Definition

+

Group ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

topic

+

No

+

String

+

Definition

+

Topic to which a message belongs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

client_id

+

Yes

+

String

+

Definition

+

Client ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

msg_id_list

+

No

+

Array of strings

+

Definition

+

Message list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

resend_results

+

Array of resend_results objects

+

Definition

+

Consumption verification result.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 resend_results

Parameter

+

Type

+

Description

+

msg_id

+

String

+

Definition

+

Message ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

error_code

+

String

+

Definition

+

Error code.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

error_message

+

String

+

Definition

+

Error message.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Verifying consumption

+
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/messages/resend
+
+{
+  "group" : "GID_test",
+  "client_id" : "192.168.0.1",
+  "msg_id_list" : [ "id1" ]
+}
+
+

Example Responses

Status code: 200

+

Consumption verified.

+
{
+  "resend_results" : [ {
+    "msg_id" : "C0A8149E0000277600000000000B6835",
+    "error_code" : "DMS.00000000",
+    "error_message" : "Success."
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Consumption verified.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/en-us_image_0000002394290998.png b/docs/dms_rocketmq/api-ref/en-us_image_0000002394290998.png new file mode 100644 index 000000000..30490a80d Binary files /dev/null and b/docs/dms_rocketmq/api-ref/en-us_image_0000002394290998.png differ diff --git a/docs/dms_rocketmq/api-ref/hrm-api-0007.html b/docs/dms_rocketmq/api-ref/hrm-api-0007.html new file mode 100644 index 000000000..44796eff8 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-0007.html @@ -0,0 +1,34 @@ + + +

APIs V2 (Recommended)

+

+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/hrm-api-0008.html b/docs/dms_rocketmq/api-ref/hrm-api-0008.html new file mode 100644 index 000000000..524f84daa --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-0008.html @@ -0,0 +1,21 @@ + + + +

Appendix

+ +

+
+ +
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/hrm-api-0009.html b/docs/dms_rocketmq/api-ref/hrm-api-0009.html new file mode 100644 index 000000000..77b625904 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-0009.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 exists.

+

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.

+
+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/hrm-api-0010.html b/docs/dms_rocketmq/api-ref/hrm-api-0010.html new file mode 100644 index 000000000..a368728ce --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-0010.html @@ -0,0 +1,55 @@ + + +

Instance Statuses

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

Status

+

Description

+

CREATING

+

The instance is being 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.

+
+
+
+
+ +
+ diff --git a/docs/dms_rocketmq/api-ref/hrm-api-0011.html b/docs/dms_rocketmq/api-ref/hrm-api-0011.html new file mode 100644 index 000000000..347d481ea --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-0011.html @@ -0,0 +1,53 @@ + + +

Obtaining a Project ID

+

Scenario

A project ID is required for some URLs when an API is called. Obtain a project ID using either of the following methods:

+ +
+

Obtaining a Project ID by Calling an API

You can obtain a project ID by calling the IAM API used to query projects based on specified criteria.

+

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects, where {Endpoint} indicates the IAM endpoint. You can obtain the IAM endpoint from Regions and Endpoints.

+

The following is an example response. The value of id in the projects section is the project ID:

+
{
+    "projects": [
+        {
+            "domain_id": "65382450e8f64ac0870cd180d14e684b",
+            "is_domain": false,
+            "parent_id": "65382450e8f64ac0870cd180d14e684b",
+            "name": "xxx-xxx-xxx",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
+            },
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}
+
+

Obtaining a Project ID on the Console

A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.

+

The following procedure describes how to obtain a project ID:

+
  1. Log in to the management console.
  2. Click the username and choose My Credentials from the drop-down list.

    On the API Credentials page, view project IDs in the project list.

    +
    Figure 1 Viewing a project ID
    +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dms_rocketmq/api-ref/hrm-api-0014.html b/docs/dms_rocketmq/api-ref/hrm-api-0014.html new file mode 100644 index 000000000..62bc9afc2 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-0014.html @@ -0,0 +1,20 @@ + + +

Change History

+
+
+ + + + + + + +

Release On

+

Description

+

2025-08-01

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/dms_rocketmq/api-ref/hrm-api-using.html b/docs/dms_rocketmq/api-ref/hrm-api-using.html new file mode 100644 index 000000000..413c907dc --- /dev/null +++ b/docs/dms_rocketmq/api-ref/hrm-api-using.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_rocketmq/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/dms_rocketmq/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/dms_rocketmq/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/delta.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/deltaend.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..379428032 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..6aaaa11c2 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-caution.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-danger.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-huawei.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-note.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-notice.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-tip.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/icon-warning.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/imageclose.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/imageclose.gif new file mode 100644 index 000000000..3a3344af4 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/imageclose.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/imageclosehover.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/imageclosehover.gif new file mode 100644 index 000000000..8699d5e36 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/imageclosehover.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/imagemax.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/imagemax.gif new file mode 100644 index 000000000..99c07dc25 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/imagemax.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/imagemaxhover.gif b/docs/dms_rocketmq/api-ref/public_sys-resources/imagemaxhover.gif new file mode 100644 index 000000000..d01d77d6e Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/macFFBgHack.png b/docs/dms_rocketmq/api-ref/public_sys-resources/macFFBgHack.png new file mode 100644 index 000000000..ec811470c Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/macFFBgHack.png differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/dms_rocketmq/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/dms_rocketmq/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/dms_rocketmq/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/dms_rocketmq/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/dms_rocketmq/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/dms_rocketmq/api-ref/topic_300000000.html b/docs/dms_rocketmq/api-ref/topic_300000000.html new file mode 100644 index 000000000..044080e9b --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000000.html @@ -0,0 +1,26 @@ + + +

Lifecycle Management

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000001.html b/docs/dms_rocketmq/api-ref/topic_300000001.html new file mode 100644 index 000000000..5eb4b7b4a --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000001.html @@ -0,0 +1,32 @@ + + +

Consumer Group Management

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000002.html b/docs/dms_rocketmq/api-ref/topic_300000002.html new file mode 100644 index 000000000..7f4062365 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000002.html @@ -0,0 +1,28 @@ + + +

Topic Management

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000003.html b/docs/dms_rocketmq/api-ref/topic_300000003.html new file mode 100644 index 000000000..a779bd643 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000003.html @@ -0,0 +1,28 @@ + + +

User Management

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000004.html b/docs/dms_rocketmq/api-ref/topic_300000004.html new file mode 100644 index 000000000..87aa46ab0 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000004.html @@ -0,0 +1,20 @@ + + +

Metadata Migration

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000005.html b/docs/dms_rocketmq/api-ref/topic_300000005.html new file mode 100644 index 000000000..4763aff22 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000005.html @@ -0,0 +1,20 @@ + + +

Tag Management

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000006.html b/docs/dms_rocketmq/api-ref/topic_300000006.html new file mode 100644 index 000000000..c6c75a249 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000006.html @@ -0,0 +1,18 @@ + + +

Managing Specification Changes

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000007.html b/docs/dms_rocketmq/api-ref/topic_300000007.html new file mode 100644 index 000000000..c7f627a54 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000007.html @@ -0,0 +1,24 @@ + + +

Other APIs

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000008.html b/docs/dms_rocketmq/api-ref/topic_300000008.html new file mode 100644 index 000000000..3c000ec9e --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000008.html @@ -0,0 +1,24 @@ + + +

Instance Diagnosis

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000009.html b/docs/dms_rocketmq/api-ref/topic_300000009.html new file mode 100644 index 000000000..d47e3ab61 --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000009.html @@ -0,0 +1,20 @@ + + +

Background Task Management

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000010.html b/docs/dms_rocketmq/api-ref/topic_300000010.html new file mode 100644 index 000000000..223d842ff --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000010.html @@ -0,0 +1,18 @@ + + +

Managing Parameters

+

+
+
+ + + +
+ diff --git a/docs/dms_rocketmq/api-ref/topic_300000011.html b/docs/dms_rocketmq/api-ref/topic_300000011.html new file mode 100644 index 000000000..d448959eb --- /dev/null +++ b/docs/dms_rocketmq/api-ref/topic_300000011.html @@ -0,0 +1,24 @@ + + +

Managing Messages

+

+
+
+ + + +
+