lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dms/api-ref/ALL_META.TXT.json
Chen, Junjie f5b629cc78 DMS API 20240722 version 
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-09-06 09:17:23 +00:00

1955 lines
60 KiB
JSON
Raw Blame History

[
{
"dockw":"API Reference"
},
{
"uri":"en-us_topic_0036182510.html",
"node_id":"en-us_topic_0036182510.xml",
"product_code":"dms",
"code":"1",
"des":"Public cloud application programming interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ",
"doc_type":"api",
"kw":"Using APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms",
"opensource":"true"
}
],
"title":"Using APIs",
"githuburl":""
},
{
"uri":"kafka-api-200707001.html",
"node_id":"kafka-api-200707001.xml",
"product_code":"kafka",
"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":"kafka",
"opensource":"true"
}
],
"title":"APIs V2 (Recommended)",
"githuburl":""
},
{
"uri":"topic_300000000.html",
"node_id":"topic_300000000.xml",
"product_code":"dms",
"code":"3",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Lifecycle Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Lifecycle Management",
"githuburl":""
},
{
"uri":"CreateInstanceByEngine.html",
"node_id":"createinstancebyengine.xml",
"product_code":"dms",
"code":"4",
"des":"This API is used to create an instance.Pay-per-use and yearly/monthly billing modes are supported.POST /v2/{engine}/{project_id}/instancesStatus code: 200Creating a pay-p",
"doc_type":"api",
"kw":"Creating an Instance,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateInstanceByEngine"
}
],
"title":"Creating an Instance",
"githuburl":""
},
{
"uri":"ListInstances.html",
"node_id":"listinstances.xml",
"product_code":"dms",
"code":"5",
"des":"This API is used to query the instances of an account by the specified conditions.GET /v2/{project_id}/instancesNoneStatus code: 200Querying the instance listStatus code:",
"doc_type":"api",
"kw":"Listing All Instances,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListInstances"
}
],
"title":"Listing All Instances",
"githuburl":""
},
{
"uri":"ShowInstance.html",
"node_id":"showinstance.xml",
"product_code":"dms",
"code":"6",
"des":"This API is used to query the details about a specified instance.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Querying an instanceStatus code: 200Speci",
"doc_type":"api",
"kw":"Querying an Instance,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowInstance"
}
],
"title":"Querying an Instance",
"githuburl":""
},
{
"uri":"DeleteInstance.html",
"node_id":"deleteinstance.xml",
"product_code":"dms",
"code":"7",
"des":"This API is used to delete an instance to release all the resources occupied by it.DELETE /v2/{project_id}/instances/{instance_id}NoneNoneDeleting an instanceNoneSee Erro",
"doc_type":"api",
"kw":"Deleting an Instance,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"DeleteInstance"
}
],
"title":"Deleting an Instance",
"githuburl":""
},
{
"uri":"UpdateInstance.html",
"node_id":"updateinstance.xml",
"product_code":"dms",
"code":"8",
"des":"This API is used to modify the instance information.PUT /v2/{project_id}/instances/{instance_id}NoneModifying the name and description of an instance.PUT https://{endpoin",
"doc_type":"api",
"kw":"Modifying Instance Information,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"UpdateInstance"
}
],
"title":"Modifying Instance Information",
"githuburl":""
},
{
"uri":"BatchRestartOrDeleteInstances.html",
"node_id":"batchrestartordeleteinstances.xml",
"product_code":"dms",
"code":"9",
"des":"This API is used to restart or delete instances in batches.When an instance is being restarted, message retrieval and creation requests of the client will be rejected.Del",
"doc_type":"api",
"kw":"Batch Restarting or Deleting Instances,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"BatchRestartOrDeleteInstances"
}
],
"title":"Batch Restarting or Deleting Instances",
"githuburl":""
},
{
"uri":"ShowInstanceConfigs.html",
"node_id":"showinstanceconfigs.xml",
"product_code":"dms",
"code":"10",
"des":"This API is used to obtain instance configurations.GET /v2/{project_id}/instances/{instance_id}/configsNoneStatus code: 200Status code: 200Configuration obtained.See Erro",
"doc_type":"api",
"kw":"Obtaining Instance Configurations,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowInstanceConfigs"
}
],
"title":"Obtaining Instance Configurations",
"githuburl":""
},
{
"uri":"ModifyInstanceConfigs.html",
"node_id":"modifyinstanceconfigs.xml",
"product_code":"dms",
"code":"11",
"des":"This API is used to modify instance configurations.PUT /v2/{project_id}/instances/{instance_id}/configsStatus code: 200Modifying the threshold for idle connection timeout",
"doc_type":"api",
"kw":"Modifying Instance Configurations,Lifecycle Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ModifyInstanceConfigs"
}
],
"title":"Modifying Instance Configurations",
"githuburl":""
},
{
"uri":"topic_300000001.html",
"node_id":"topic_300000001.xml",
"product_code":"dms",
"code":"12",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Instance Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Instance Management",
"githuburl":""
},
{
"uri":"ResetPassword.html",
"node_id":"resetpassword.xml",
"product_code":"dms",
"code":"13",
"des":"This API is used to reset the password for an instance with SSL enabled.POST /v2/{project_id}/instances/{instance_id}/passwordNoneResetting a passwordNoneSee Error Codes.",
"doc_type":"api",
"kw":"Resetting the Password,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ResetPassword"
}
],
"title":"Resetting the Password",
"githuburl":""
},
{
"uri":"UpdateInstanceAutoCreateTopic.html",
"node_id":"updateinstanceautocreatetopic.xml",
"product_code":"dms",
"code":"14",
"des":"This API is used to enable or disable automatic topic creation.POST /v2/{project_id}/instances/{instance_id}/autotopicNoneEnabling automatic topic creation.NoneSee Error ",
"doc_type":"api",
"kw":"Configuring Automatic Topic Creation,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"UpdateInstanceAutoCreateTopic"
}
],
"title":"Configuring Automatic Topic Creation",
"githuburl":""
},
{
"uri":"UpdateInstanceCrossVpcIp.html",
"node_id":"updateinstancecrossvpcip.xml",
"product_code":"dms",
"code":"15",
"des":"This API is used to modify the private IP address for cross-VPC access.POST /v2/{project_id}/instances/{instance_id}/crossvpc/modifyStatus code: 200Modifying the private ",
"doc_type":"api",
"kw":"Modifying the Private IP Address for Cross-VPC Access,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"UpdateInstanceCrossVpcIp"
}
],
"title":"Modifying the Private IP Address for Cross-VPC Access",
"githuburl":""
},
{
"uri":"ShowCluster.html",
"node_id":"showcluster.xml",
"product_code":"dms",
"code":"16",
"des":"This API is used to query Kafka cluster metadata.GET /v2/{project_id}/instances/{instance_id}/management/clusterNoneStatus code: 200Status code: 200Kafka cluster metadata",
"doc_type":"api",
"kw":"Querying Kafka Cluster Metadata,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowCluster"
}
],
"title":"Querying Kafka Cluster Metadata",
"githuburl":""
},
{
"uri":"ShowGroups.html",
"node_id":"showgroups.xml",
"product_code":"dms",
"code":"17",
"des":"This API is used to query consumer group details.GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}NoneStatus code: 200Status code: 200The consumer gr",
"doc_type":"api",
"kw":"Querying Consumer Group Details,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowGroups"
}
],
"title":"Querying Consumer Group Details",
"githuburl":""
},
{
"uri":"ResetMessageOffset.html",
"node_id":"resetmessageoffset.xml",
"product_code":"dms",
"code":"18",
"des":"Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset.After a client is stopped, the ",
"doc_type":"api",
"kw":"Resetting Consumer Group Offset to the Specified Position,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ResetMessageOffset"
}
],
"title":"Resetting Consumer Group Offset to the Specified Position",
"githuburl":""
},
{
"uri":"ShowCoordinators.html",
"node_id":"showcoordinators.xml",
"product_code":"dms",
"code":"19",
"des":"This API is used to query coordinator details of a Kafka instance.GET /v2/{project_id}/instances/{instance_id}/management/coordinatorsNoneStatus code: 200Status code: 200",
"doc_type":"api",
"kw":"Querying Coordinator Details of a Kafka Instance,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowCoordinators"
}
],
"title":"Querying Coordinator Details of a Kafka Instance",
"githuburl":""
},
{
"uri":"UpdateTopicReplica.html",
"node_id":"updatetopicreplica.xml",
"product_code":"dms",
"code":"20",
"des":"This API is used to reassign replicas of a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignmentNoneRea",
"doc_type":"api",
"kw":"Reassigning Replicas of a Topic for a Kafka Instance,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"UpdateTopicReplica"
}
],
"title":"Reassigning Replicas of a Topic for a Kafka Instance",
"githuburl":""
},
{
"uri":"ShowKafkaTopicPartitionDiskusage.html",
"node_id":"showkafkatopicpartitiondiskusage.xml",
"product_code":"dms",
"code":"21",
"des":"This API is used to query the broker disk usage of topics.GET /v2/{project_id}/instances/{instance_id}/topics/diskusageNoneStatus code: 200Querying the disk usage status ",
"doc_type":"api",
"kw":"Querying the Disk Usage Status of Topics,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowKafkaTopicPartitionDiskusage"
}
],
"title":"Querying the Disk Usage Status of Topics",
"githuburl":""
},
{
"uri":"ListInstanceConsumerGroups.html",
"node_id":"listinstanceconsumergroups.xml",
"product_code":"dms",
"code":"22",
"des":"This API is used to query all consumer groups.GET /v2/{project_id}/instances/{instance_id}/groupsNoneStatus code: 200Querying the consumer group listStatus code: 200All c",
"doc_type":"api",
"kw":"Querying All Consumer Groups,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListInstanceConsumerGroups"
}
],
"title":"Querying All Consumer Groups",
"githuburl":""
},
{
"uri":"ShowGroup.html",
"node_id":"showgroup.xml",
"product_code":"dms",
"code":"23",
"des":"This API is used to query a specific consumer group.GET /v2/{project_id}/instances/{instance_id}/groups/{group}NoneStatus code: 200Status code: 200A specific consumer gro",
"doc_type":"api",
"kw":"Querying a Specific Consumer Group,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowGroup"
}
],
"title":"Querying a Specific Consumer Group",
"githuburl":""
},
{
"uri":"DeleteGroup.html",
"node_id":"deletegroup.xml",
"product_code":"dms",
"code":"24",
"des":"This API is used to delete a consumer group from a Kafka instance.DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}NoneNoneNoneSee Error Codes.",
"doc_type":"api",
"kw":"Deleting a Consumer Group from a Kafka Instance,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"DeleteGroup"
}
],
"title":"Deleting a Consumer Group from a Kafka Instance",
"githuburl":""
},
{
"uri":"BatchDeleteGroup.html",
"node_id":"batchdeletegroup.xml",
"product_code":"dms",
"code":"25",
"des":"This API is used to delete multiple consumer groups of a Kafka instance in batches.POST /v2/{project_id}/instances/{instance_id}/groups/batch-deleteStatus code: 200Batch ",
"doc_type":"api",
"kw":"Deleting Consumer Groups of a Kafka Instance in Batches,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"BatchDeleteGroup"
}
],
"title":"Deleting Consumer Groups of a Kafka Instance in Batches",
"githuburl":""
},
{
"uri":"CreateKafkaConsumerGroup.html",
"node_id":"createkafkaconsumergroup.xml",
"product_code":"dms",
"code":"26",
"des":"This API is used to create a consumer group.POST /v2/{project_id}/kafka/instances/{instance_id}/groupStatus code: 200Status code: 400Creating a consumer group named testS",
"doc_type":"api",
"kw":"Creating a Consumer Group,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateKafkaConsumerGroup"
}
],
"title":"Creating a Consumer Group",
"githuburl":""
},
{
"uri":"CreateReassignmentTask.html",
"node_id":"createreassignmenttask.xml",
"product_code":"dms",
"code":"27",
"des":"This API is used to submit a partition rebalancing task to a Kafka instance or calculate estimated rebalancing time.POST /v2/kafka/{project_id}/instances/{instance_id}/re",
"doc_type":"api",
"kw":"Initiating Partition Reassigning for a Kafka Instance,Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateReassignmentTask"
}
],
"title":"Initiating Partition Reassigning for a Kafka Instance",
"githuburl":""
},
{
"uri":"topic_300000011.html",
"node_id":"topic_300000011.xml",
"product_code":"dms",
"code":"28",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Smart Connect",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Smart Connect",
"githuburl":""
},
{
"uri":"CreateConnector.html",
"node_id":"createconnector.xml",
"product_code":"dms",
"code":"29",
"des":"This API is used to enable Smart Connect so you can create a connector.POST /v2/{project_id}/instances/{instance_id}/connectorStatus code: 200To enable Smart Connect for ",
"doc_type":"api",
"kw":"Enabling Smart Connect (Pay-per-Use Instance),Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateConnector"
}
],
"title":"Enabling Smart Connect (Pay-per-Use Instance)",
"githuburl":""
},
{
"uri":"DeleteConnector.html",
"node_id":"deleteconnector.xml",
"product_code":"dms",
"code":"30",
"des":"This API is used to disable Smart Connect for a pay-per-use instance.POST /v2/{project_id}/kafka/instances/{instance_id}/delete-connectorNoneStatus code: 200Status code: ",
"doc_type":"api",
"kw":"Disabling Smart Connect (Pay-per-Use Instance),Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"DeleteConnector"
}
],
"title":"Disabling Smart Connect (Pay-per-Use Instance)",
"githuburl":""
},
{
"uri":"CreateConnectorTask.html",
"node_id":"createconnectortask.xml",
"product_code":"dms",
"code":"31",
"des":"This API is used to create a Smart Connect task.POST /v2/{project_id}/instances/{instance_id}/connector/tasksStatus code: 200Creating a dumping task that starts immediate",
"doc_type":"api",
"kw":"Creating a Smart Connect Task,Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateConnectorTask"
}
],
"title":"Creating a Smart Connect Task",
"githuburl":""
},
{
"uri":"ListConnectorTasks.html",
"node_id":"listconnectortasks.xml",
"product_code":"dms",
"code":"32",
"des":"This API is used to query Smart Connect tasks.GET /v2/{project_id}/instances/{instance_id}/connector/tasksNoneStatus code: 200NoneStatus code: 200Successful.See Error Cod",
"doc_type":"api",
"kw":"Querying Smart Connect Tasks,Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListConnectorTasks"
}
],
"title":"Querying Smart Connect Tasks",
"githuburl":""
},
{
"uri":"ShowConnectorTask.html",
"node_id":"showconnectortask.xml",
"product_code":"dms",
"code":"33",
"des":"This API is used to query Smart Connect task details.GET /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}NoneStatus code: 200NoneStatus code: 200Success",
"doc_type":"api",
"kw":"Querying Smart Connect Task Details,Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowConnectorTask"
}
],
"title":"Querying Smart Connect Task Details",
"githuburl":""
},
{
"uri":"DeleteConnectorTask.html",
"node_id":"deleteconnectortask.xml",
"product_code":"dms",
"code":"34",
"des":"This API is used to delete a Smart Connect task.DELETE /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}NoneNoneNoneSee Error Codes.",
"doc_type":"api",
"kw":"Deleting a Smart Connect Task,Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"DeleteConnectorTask"
}
],
"title":"Deleting a Smart Connect Task",
"githuburl":""
},
{
"uri":"PauseConnectorTask.html",
"node_id":"pauseconnectortask.xml",
"product_code":"dms",
"code":"35",
"des":"This API is used to pause a Smart Connect task.PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pauseNoneNoneNoneSee Error Codes.",
"doc_type":"api",
"kw":"Pausing a Smart Connect Task,Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"PauseConnectorTask"
}
],
"title":"Pausing a Smart Connect Task",
"githuburl":""
},
{
"uri":"ResumeConnectorTask.html",
"node_id":"resumeconnectortask.xml",
"product_code":"dms",
"code":"36",
"des":"This API is used to restart a Smart Connect task.PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resumeNoneNoneNoneSee Error Codes.",
"doc_type":"api",
"kw":"Restarting a Smart Connect Task,Smart Connect,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ResumeConnectorTask"
}
],
"title":"Restarting a Smart Connect Task",
"githuburl":""
},
{
"uri":"RestartConnectorTask.html",
"node_id":"restartconnectortask.xml",
"product_code":"dms",
"code":"37",
"des":"This API is used to start a Smart Connect task or restart a paused or running Smart Connect task. Note that the sync progress will reset and the task will restart.PUT /v2",
"doc_type":"api",
"kw":"Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task,Smart Connect,API",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"RestartConnectorTask"
}
],
"title":"Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task",
"githuburl":""
},
{
"uri":"topic_300000003.html",
"node_id":"topic_300000003.xml",
"product_code":"dms",
"code":"38",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Specification Modification Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Specification Modification Management",
"githuburl":""
},
{
"uri":"ResizeEngineInstance.html",
"node_id":"resizeengineinstance.xml",
"product_code":"dms",
"code":"39",
"des":"This API is used to modify instance specifications.POST /v2/{engine}/{project_id}/instances/{instance_id}/extendStatus code: 200Expanding the storage space (pay-per-use)P",
"doc_type":"api",
"kw":"Increasing Instance Specifications,Specification Modification Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ResizeEngineInstance"
}
],
"title":"Increasing Instance Specifications",
"githuburl":""
},
{
"uri":"ShowEngineInstanceExtendProductInfo.html",
"node_id":"showengineinstanceextendproductinfo.xml",
"product_code":"dms",
"code":"40",
"des":"This API is used to query the product information for instance specification modification.GET /v2/{engine}/{project_id}/instances/{instance_id}/extendNoneStatus code: 200",
"doc_type":"api",
"kw":"Querying Product Information for Instance Specification Modification,Specification Modification Mana",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowEngineInstanceExtendProductInfo"
}
],
"title":"Querying Product Information for Instance Specification Modification",
"githuburl":""
},
{
"uri":"topic_300000004.html",
"node_id":"topic_300000004.xml",
"product_code":"dms",
"code":"41",
"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",
"prodname":"dms"
}
],
"title":"Topic Management",
"githuburl":""
},
{
"uri":"CreateInstanceTopic.html",
"node_id":"createinstancetopic.xml",
"product_code":"dms",
"code":"42",
"des":"This API is used to create a topic for a Kafka instance.POST /v2/{project_id}/instances/{instance_id}/topicsStatus code: 200Creating a topic named test01Status code: 200S",
"doc_type":"api",
"kw":"Creating a Topic for a Kafka Instance,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateInstanceTopic"
}
],
"title":"Creating a Topic for a Kafka Instance",
"githuburl":""
},
{
"uri":"ListInstanceTopics.html",
"node_id":"listinstancetopics.xml",
"product_code":"dms",
"code":"43",
"des":"This API is used to query details about topics of a Kafka instance.GET /v2/{project_id}/instances/{instance_id}/topicsNoneStatus code: 200Querying the topic listStatus co",
"doc_type":"api",
"kw":"Listing Topics of a Kafka Instance,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListInstanceTopics"
}
],
"title":"Listing Topics of a Kafka Instance",
"githuburl":""
},
{
"uri":"UpdateInstanceTopic.html",
"node_id":"updateinstancetopic.xml",
"product_code":"dms",
"code":"44",
"des":"This API is used to modify topics of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/topicsNoneModifying parameters of topic-1284340884. Specifically, chang",
"doc_type":"api",
"kw":"Modifying Topics of a Kafka Instance,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"UpdateInstanceTopic"
}
],
"title":"Modifying Topics of a Kafka Instance",
"githuburl":""
},
{
"uri":"BatchDeleteInstanceTopic.html",
"node_id":"batchdeleteinstancetopic.xml",
"product_code":"dms",
"code":"45",
"des":"This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is re",
"doc_type":"api",
"kw":"Batch Deleting Topics of a Kafka Instance,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"BatchDeleteInstanceTopic"
}
],
"title":"Batch Deleting Topics of a Kafka Instance",
"githuburl":""
},
{
"uri":"ListTopicPartitions.html",
"node_id":"listtopicpartitions.xml",
"product_code":"dms",
"code":"46",
"des":"This API is used to query the partition list of a topic.GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/partitionsNoneStatus code: 200Querying the parti",
"doc_type":"api",
"kw":"Querying the Partition List of a Topic,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListTopicPartitions"
}
],
"title":"Querying the Partition List of a Topic",
"githuburl":""
},
{
"uri":"ListTopicProducers.html",
"node_id":"listtopicproducers.xml",
"product_code":"dms",
"code":"47",
"des":"This API is used to query the current producer list of a topic.GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producersNoneStatus code: 200Querying the",
"doc_type":"api",
"kw":"Querying the Current Producer List of a Topic,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListTopicProducers"
}
],
"title":"Querying the Current Producer List of a Topic",
"githuburl":""
},
{
"uri":"ShowInstanceTopicDetail.html",
"node_id":"showinstancetopicdetail.xml",
"product_code":"dms",
"code":"48",
"des":"This API is used to query topic details of a Kafka instance. (Up to 1s for each instance call)GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}NoneSt",
"doc_type":"api",
"kw":"Querying Topic Details,Topic Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowInstanceTopicDetail"
}
],
"title":"Querying Topic Details",
"githuburl":""
},
{
"uri":"topic_300000005.html",
"node_id":"topic_300000005.xml",
"product_code":"dms",
"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":"User Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"User Management",
"githuburl":""
},
{
"uri":"ShowInstanceUsers.html",
"node_id":"showinstanceusers.xml",
"product_code":"dms",
"code":"50",
"des":"This API is used to query the user list.User management is supported only when SASL is enabled for the Kafka instance.GET /v2/{project_id}/instances/{instance_id}/usersNo",
"doc_type":"api",
"kw":"Querying the User List,User Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowInstanceUsers"
}
],
"title":"Querying the User List",
"githuburl":""
},
{
"uri":"CreateInstanceUser.html",
"node_id":"createinstanceuser.xml",
"product_code":"dms",
"code":"51",
"des":"This API is used to create a user for a Kafka instance for which SASL is enabled.POST /v2/{project_id}/instances/{instance_id}/usersStatus code: 400Status code: 403Creati",
"doc_type":"api",
"kw":"Creating a User,User Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"CreateInstanceUser"
}
],
"title":"Creating a User",
"githuburl":""
},
{
"uri":"BatchDeleteInstanceUsers.html",
"node_id":"batchdeleteinstanceusers.xml",
"product_code":"dms",
"code":"52",
"des":"This API is used to delete multiple users of a Kafka instance.PUT /v2/{project_id}/instances/{instance_id}/usersNoneDeleting users in batches.NoneSee Error Codes.",
"doc_type":"api",
"kw":"Deleting Users in Batches,User Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"BatchDeleteInstanceUsers"
}
],
"title":"Deleting Users in Batches",
"githuburl":""
},
{
"uri":"ResetUserPasswrod.html",
"node_id":"resetuserpasswrod.xml",
"product_code":"dms",
"code":"53",
"des":"This API is used to reset a user password.PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}NoneResetting a user password.NoneSee Error Codes.",
"doc_type":"api",
"kw":"Resetting a User Password,User Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ResetUserPasswrod"
}
],
"title":"Resetting a User Password",
"githuburl":""
},
{
"uri":"ShowTopicAccessPolicy.html",
"node_id":"showtopicaccesspolicy.xml",
"product_code":"dms",
"code":"54",
"des":"This API is used to query user permissions.User management is supported only when SASL is enabled for the Kafka instance.GET /v1/{project_id}/instances/{instance_id}/topi",
"doc_type":"api",
"kw":"Querying User Permissions,User Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowTopicAccessPolicy"
}
],
"title":"Querying User Permissions",
"githuburl":""
},
{
"uri":"UpdateTopicAccessPolicy.html",
"node_id":"updatetopicaccesspolicy.xml",
"product_code":"dms",
"code":"55",
"des":"This API is used to grant user permissions.User management is supported only when SASL is enabled for the Kafka instance.POST /v1/{project_id}/instances/{instance_id}/top",
"doc_type":"api",
"kw":"Granting User Permissions,User Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"UpdateTopicAccessPolicy"
}
],
"title":"Granting User Permissions",
"githuburl":""
},
{
"uri":"topic_300000006.html",
"node_id":"topic_300000006.xml",
"product_code":"dms",
"code":"56",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Message Query",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Message Query",
"githuburl":""
},
{
"uri":"ShowInstanceMessages.html",
"node_id":"showinstancemessages.xml",
"product_code":"dms",
"code":"57",
"des":"This API is used to query the offset and content of a message.This API queries the message offset based on the timestamp and then queries the message content based on the",
"doc_type":"api",
"kw":"Querying Messages,Message Query,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowInstanceMessages"
}
],
"title":"Querying Messages",
"githuburl":""
},
{
"uri":"ShowPartitionMessage.html",
"node_id":"showpartitionmessage.xml",
"product_code":"dms",
"code":"58",
"des":"This API is used to query a message with a specified offset.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/messageNoneStatu",
"doc_type":"api",
"kw":"Querying a Message with a Specified Offset,Message Query,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowPartitionMessage"
}
],
"title":"Querying a Message with a Specified Offset",
"githuburl":""
},
{
"uri":"ShowMessages.html",
"node_id":"showmessages.xml",
"product_code":"dms",
"code":"59",
"des":"This API is used to query a message with a specified time period.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messagesNoneStatus code: 200Status",
"doc_type":"api",
"kw":"Querying a Message with a Specified Time Period,Message Query,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowMessages"
}
],
"title":"Querying a Message with a Specified Time Period",
"githuburl":""
},
{
"uri":"ShowPartitionBeginningMessage.html",
"node_id":"showpartitionbeginningmessage.xml",
"product_code":"dms",
"code":"60",
"des":"This API is used to query the offset of the earliest message in a partition.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/",
"doc_type":"api",
"kw":"Querying Offset of the Earliest Message in a Partition,Message Query,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowPartitionBeginningMessage"
}
],
"title":"Querying Offset of the Earliest Message in a Partition",
"githuburl":""
},
{
"uri":"ShowPartitionEndMessage.html",
"node_id":"showpartitionendmessage.xml",
"product_code":"dms",
"code":"61",
"des":"This API is used to query the offset of the latest message in a partition.GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/en",
"doc_type":"api",
"kw":"Querying Offset of the Latest Message in a Partition,Message Query,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowPartitionEndMessage"
}
],
"title":"Querying Offset of the Latest Message in a Partition",
"githuburl":""
},
{
"uri":"topic_300000007.html",
"node_id":"topic_300000007.xml",
"product_code":"dms",
"code":"62",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Background Task Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Background Task Management",
"githuburl":""
},
{
"uri":"ListBackgroundTasks.html",
"node_id":"listbackgroundtasks.xml",
"product_code":"dms",
"code":"63",
"des":"This API is used to list background tasks of an instance.GET /v2/{project_id}/instances/{instance_id}/tasksNoneStatus code: 200Status code: 200Background tasks are listed",
"doc_type":"api",
"kw":"Listing Background Tasks,Background Task Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListBackgroundTasks"
}
],
"title":"Listing Background Tasks",
"githuburl":""
},
{
"uri":"ShowBackgroundTask.html",
"node_id":"showbackgroundtask.xml",
"product_code":"dms",
"code":"64",
"des":"This API is used to query a specified background task.GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneStatus code: 200Status code: 200The query is success",
"doc_type":"api",
"kw":"Querying a Background Task,Background Task Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowBackgroundTask"
}
],
"title":"Querying a Background Task",
"githuburl":""
},
{
"uri":"DeleteBackgroundTask.html",
"node_id":"deletebackgroundtask.xml",
"product_code":"dms",
"code":"65",
"des":"This API is used to delete a specified background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneNoneDeleting a specified background taskNoneSee ",
"doc_type":"api",
"kw":"Deleting a Background Task,Background Task Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"DeleteBackgroundTask"
}
],
"title":"Deleting a Background Task",
"githuburl":""
},
{
"uri":"topic_300000008.html",
"node_id":"topic_300000008.xml",
"product_code":"dms",
"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":"Tag Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Tag Management",
"githuburl":""
},
{
"uri":"BatchCreateOrDeleteKafkaTag.html",
"node_id":"batchcreateordeletekafkatag.xml",
"product_code":"dms",
"code":"67",
"des":"This API is used to add or delete instance tags in batches.POST /v2/{project_id}/kafka/{instance_id}/tags/actionNoneCreating instance tags with tag keys key1 and key2 and",
"doc_type":"api",
"kw":"Batch Adding or Deleting Tags,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"BatchCreateOrDeleteKafkaTag"
}
],
"title":"Batch Adding or Deleting Tags",
"githuburl":""
},
{
"uri":"ShowKafkaTags.html",
"node_id":"showkafkatags.xml",
"product_code":"dms",
"code":"68",
"des":"This API is used to query instance tags.GET /v2/{project_id}/kafka/{instance_id}/tagsNoneStatus code: 200Status code: 200The instance tags are listed successfully.See Err",
"doc_type":"api",
"kw":"Listing Tags of an Instance,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowKafkaTags"
}
],
"title":"Listing Tags of an Instance",
"githuburl":""
},
{
"uri":"ShowKafkaProjectTags.html",
"node_id":"showkafkaprojecttags.xml",
"product_code":"dms",
"code":"69",
"des":"This API is used to query project tags.GET /v2/{project_id}/kafka/tagsNoneStatus code: 200Status code: 200The project tags are listed successfully.See Error Codes.",
"doc_type":"api",
"kw":"Listing Tags of a Project,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowKafkaProjectTags"
}
],
"title":"Listing Tags of a Project",
"githuburl":""
},
{
"uri":"topic_300000009.html",
"node_id":"topic_300000009.xml",
"product_code":"dms",
"code":"70",
"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",
"prodname":"dms"
}
],
"title":"Other APIs",
"githuburl":""
},
{
"uri":"ShowMaintainWindows.html",
"node_id":"showmaintainwindows.xml",
"product_code":"dms",
"code":"71",
"des":"This API is used to query the start time and end time of maintenance time windows.GET /v2/instances/maintain-windowsNoneStatus code: 200Status code: 200Query succeeded.Se",
"doc_type":"api",
"kw":"Listing Maintenance Time Windows,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowMaintainWindows"
}
],
"title":"Listing Maintenance Time Windows",
"githuburl":""
},
{
"uri":"ListAvailableZones.html",
"node_id":"listavailablezones.xml",
"product_code":"dms",
"code":"72",
"des":"This API is used to query the AZ ID for creating an instance.GET /v2/available-zonesNoneStatus code: 200Status code: 200The AZ information is queried successfully.The ins",
"doc_type":"api",
"kw":"Listing AZ Information,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListAvailableZones"
}
],
"title":"Listing AZ Information",
"githuburl":""
},
{
"uri":"ListEngineProducts.html",
"node_id":"listengineproducts.xml",
"product_code":"dms",
"code":"73",
"des":"This API is used to query the product specifications list.GET /v2/{engine}/productsNoneStatus code: 200Status code: 200The product specifications are listed successfully.",
"doc_type":"api",
"kw":"Querying Product Specifications List,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ListEngineProducts"
}
],
"title":"Querying Product Specifications List",
"githuburl":""
},
{
"uri":"ShowCesHierarchy.html",
"node_id":"showceshierarchy.xml",
"product_code":"dms",
"code":"74",
"des":"This API is used to query Kafka instance monitoring dimensions.GET /v2/{project_id}/instances/{instance_id}/ces-hierarchyNoneStatus code: 200Status code: 200Query succeed",
"doc_type":"api",
"kw":"Querying Kafka Instance Monitoring Dimensions,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"dms",
"operation_id":"ShowCesHierarchy"
}
],
"title":"Querying Kafka Instance Monitoring Dimensions",
"githuburl":""
},
{
"uri":"api-grant-policy.html",
"node_id":"api-grant-policy.xml",
"product_code":"kafka",
"code":"75",
"des":"This chapter describes fine-grained permissions management for your Kafka instances. If your account does not need individual IAM users, then you may skip over this chapt",
"doc_type":"api",
"kw":"Permissions and Supported Actions,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Permissions and Supported Actions",
"githuburl":""
},
{
"uri":"kafka-api-0001.html",
"node_id":"kafka-api-0001.xml",
"product_code":"kafka",
"code":"76",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Out-of-Date APIs",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Out-of-Date APIs",
"githuburl":""
},
{
"uri":"kafka-api-0002.html",
"node_id":"kafka-api-0002.xml",
"product_code":"kafka",
"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":"API V1",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"API V1",
"githuburl":""
},
{
"uri":"kafka-api-180514001.html",
"node_id":"kafka-api-180514001.xml",
"product_code":"kafka",
"code":"78",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"APIs for Managing Instances",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"APIs for Managing Instances",
"githuburl":""
},
{
"uri":"kafka-api-180514002.html",
"node_id":"kafka-api-180514002.xml",
"product_code":"kafka",
"code":"79",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Creating an Instance.This API is used to create a Kafka instance.POST /v1",
"doc_type":"api",
"kw":"Creating an Instance,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Creating an Instance",
"githuburl":""
},
{
"uri":"kafka-api-180514003.html",
"node_id":"kafka-api-180514003.xml",
"product_code":"kafka",
"code":"80",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Querying an Instance.This API is used to query the details about an insta",
"doc_type":"api",
"kw":"Querying an Instance,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Querying an Instance",
"githuburl":""
},
{
"uri":"kafka-api-180514004.html",
"node_id":"kafka-api-180514004.xml",
"product_code":"kafka",
"code":"81",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Modifying Instance Information.This API is used to modify the instance in",
"doc_type":"api",
"kw":"Modifying an Instance,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Modifying an Instance",
"githuburl":""
},
{
"uri":"kafka-api-180514005.html",
"node_id":"kafka-api-180514005.xml",
"product_code":"kafka",
"code":"82",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Deleting an Instance.This API is used to delete an instance to release al",
"doc_type":"api",
"kw":"Deleting an Instance,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Deleting an Instance",
"githuburl":""
},
{
"uri":"kafka-api-180514006.html",
"node_id":"kafka-api-180514006.xml",
"product_code":"kafka",
"code":"83",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Batch Restarting or Deleting Instances.This API is used to restart or del",
"doc_type":"api",
"kw":"Restarting or Deleting Instances in Batches,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Restarting or Deleting Instances in Batches",
"githuburl":""
},
{
"uri":"kafka-api-180514007.html",
"node_id":"kafka-api-180514007.xml",
"product_code":"kafka",
"code":"84",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing All Instances.This API is used to query the instances of a tenant",
"doc_type":"api",
"kw":"Querying All Instances,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Querying All Instances",
"githuburl":""
},
{
"uri":"kafka-api-180614001.html",
"node_id":"kafka-api-180614001.xml",
"product_code":"kafka",
"code":"85",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Creating a Topic for a Kafka Instance.This API is used to create a topic ",
"doc_type":"api",
"kw":"Creating a Topic in a Kafka Instance,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Creating a Topic in a Kafka Instance",
"githuburl":""
},
{
"uri":"kafka-api-180614002.html",
"node_id":"kafka-api-180614002.xml",
"product_code":"kafka",
"code":"86",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing Topics of a Kafka Instance.This API is used to query details abou",
"doc_type":"api",
"kw":"Querying a Topic in a Kafka Instance,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Querying a Topic in a Kafka Instance",
"githuburl":""
},
{
"uri":"kafka-api-180614003.html",
"node_id":"kafka-api-180614003.xml",
"product_code":"kafka",
"code":"87",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Batch Deleting Topics of a Kafka Instance.This API is used to delete topi",
"doc_type":"api",
"kw":"Deleting Topics in a Kafka Instance in Batches,APIs for Managing Instances,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Deleting Topics in a Kafka Instance in Batches",
"githuburl":""
},
{
"uri":"kafka-api-190605002.html",
"node_id":"kafka-api-190605002.xml",
"product_code":"kafka",
"code":"88",
"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",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Other APIs",
"githuburl":""
},
{
"uri":"kafka-api-180514008.html",
"node_id":"kafka-api-180514008.xml",
"product_code":"kafka",
"code":"89",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing AZ Information.This API is used to query the AZ ID.GET /v1.0/avai",
"doc_type":"api",
"kw":"Querying AZ Information,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Querying AZ Information",
"githuburl":""
},
{
"uri":"kafka-api-180514009.html",
"node_id":"kafka-api-180514009.xml",
"product_code":"kafka",
"code":"90",
"des":"This API is out-of-date and may not be maintained in the future.This API is used to query the product specifications to configure the product ID.GET /v1.0/products?engine",
"doc_type":"api",
"kw":"Querying Product Specifications,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Querying Product Specifications",
"githuburl":""
},
{
"uri":"kafka-api-180514010.html",
"node_id":"kafka-api-180514010.xml",
"product_code":"kafka",
"code":"91",
"des":"This API is out-of-date and may not be maintained in the future. Please use the API described in Listing Maintenance Time Windows.This API is used to query the start and ",
"doc_type":"api",
"kw":"Querying Maintenance Time Windows,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Querying Maintenance Time Windows",
"githuburl":""
},
{
"uri":"kafka-api-0003.html",
"node_id":"kafka-api-0003.xml",
"product_code":"kafka",
"code":"92",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"API V2",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka"
}
],
"title":"API V2",
"githuburl":""
},
{
"uri":"CreatePostPaidInstance.html",
"node_id":"createpostpaidinstance.xml",
"product_code":"dms",
"code":"93",
"des":"This API is used to create a Kafka instance.This API is out-of-date and may not be maintained in the future. Please use the API described in Creating an Instance.POST /v2",
"doc_type":"api",
"kw":"Creating an Instance,API V2,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dms"
}
],
"title":"Creating an Instance",
"githuburl":""
},
{
"uri":"CreatePartition.html",
"node_id":"createpartition.xml",
"product_code":"kafka",
"code":"94",
"des":"This API is used to add partitions to a topic for a Kafka instance.This API is out-of-date and may not be maintained in the future. Please use the API described in Modify",
"doc_type":"api",
"kw":"Adding Partitions to a Topic for a Kafka Instance,API V2,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Adding Partitions to a Topic for a Kafka Instance",
"githuburl":""
},
{
"uri":"kafka-api-180514011.html",
"node_id":"kafka-api-180514011.xml",
"product_code":"kafka",
"code":"95",
"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":"kafka",
"opensource":"true"
}
],
"title":"Appendix",
"githuburl":""
},
{
"uri":"kafka-api-0034672261.html",
"node_id":"kafka-api-0034672261.xml",
"product_code":"kafka",
"code":"96",
"des":"Table 1 lists status codes.",
"doc_type":"api",
"kw":"Status Code,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Status Code",
"githuburl":""
},
{
"uri":"ErrorCode.html",
"node_id":"errorcode_1.xml",
"product_code":"kafka",
"code":"97",
"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":[
{
"opensource":"true",
"documenttype":"api",
"prodname":"kafka"
}
],
"title":"Error Codes",
"githuburl":""
},
{
"uri":"kafka-api-180514012.html",
"node_id":"kafka-api-180514012.xml",
"product_code":"kafka",
"code":"98",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Instance Status,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"kafka",
"opensource":"true"
}
],
"title":"Instance Status",
"githuburl":""
},
{
"uri":"kafka-api-0036212547.html",
"node_id":"kafka-api-0036212547.xml",
"product_code":"kafka",
"code":"99",
"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":"kafka",
"opensource":"true"
}
],
"title":"Obtaining a Project ID",
"githuburl":""
},
{
"uri":"kafka-api-0034672268.html",
"node_id":"kafka-api-0034672268.xml",
"product_code":"kafka",
"code":"100",
"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":"kafka",
"opensource":"true"
}
],
"title":"Change History",
"githuburl":""
}
]
View Git Blame Copy Permalink