[ { "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":"dis", "title":"Before You Start", "uri":"dis_02_0511.html", "doc_type":"api", "p_code":"", "code":"1" }, { "desc":"Welcome to Data Ingestion Service API Reference. Data Ingestion Service (DIS) provides efficient collection, transmission, and distribution capabilities for real-time IoT", "product_code":"dis", "title":"Overview", "uri":"dis_02_0600.html", "doc_type":"api", "p_code":"1", "code":"2" }, { "desc":"DIS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", "product_code":"dis", "title":"API Calling", "uri":"dis_02_0512.html", "doc_type":"api", "p_code":"1", "code":"3" }, { "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. The DIS endpoint is in the format of dis.{region_id}.{Domain name", "product_code":"dis", "title":"Endpoints", "uri":"dis_02_0513.html", "doc_type":"api", "p_code":"1", "code":"4" }, { "desc":"For details, see the description of each API.", "product_code":"dis", "title":"Constraints", "uri":"dis_02_0514.html", "doc_type":"api", "p_code":"1", "code":"5" }, { "desc":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p", "product_code":"dis", "title":"Concepts", "uri":"dis_02_0515.html", "doc_type":"api", "p_code":"1", "code":"6" }, { "desc":"DIS provides self-developed APIs that comply with RESTful API design specifications. You can use DIS functions listed in API Description by calling these APIs.", "product_code":"dis", "title":"API Overview", "uri":"dis_02_0200.html", "doc_type":"api", "p_code":"", "code":"7" }, { "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":"dis", "title":"Calling APIs", "uri":"dis_02_0516.html", "doc_type":"api", "p_code":"", "code":"8" }, { "desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ", "product_code":"dis", "title":"Making an API Request", "uri":"dis_02_0400.html", "doc_type":"api", "p_code":"8", "code":"9" }, { "desc":"Requests for calling an API can be authenticated using either of the following methods:Token-based authentication: Requests are authenticated using a token.AK/SK-based au", "product_code":"dis", "title":"Authentication", "uri":"dis_02_0517.html", "doc_type":"api", "p_code":"8", "code":"10" }, { "desc":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", "product_code":"dis", "title":"Response", "uri":"dis_02_0518.html", "doc_type":"api", "p_code":"8", "code":"11" }, { "desc":"DIS provides efficient collection, transmission, and distribution capabilities for real-time data and provides a variety of APIs to help you quickly build real-time data ", "product_code":"dis", "title":"Application Example", "uri":"dis_02_0003.html", "doc_type":"api", "p_code":"", "code":"12" }, { "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":"dis", "title":"API Description", "uri":"dis_02_0015.html", "doc_type":"api", "p_code":"", "code":"13" }, { "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":"dis", "title":"Stream Management", "uri":"topic_300000000.html", "doc_type":"api", "p_code":"13", "code":"14" }, { "desc":"This API is used to create a stream.When creating a stream, specify a stream type (common or advanced) and the number of partitions.A maximum of 10 advanced stream partit", "product_code":"dis", "title":"Creating a Stream", "uri":"dis_02_0016_01.html", "doc_type":"api", "p_code":"14", "code":"15" }, { "desc":"This API is used to query all the streams created by the current tenant.During query, you need to specify the stream from which the stream list is returned and the maximu", "product_code":"dis", "title":"Querying Streams", "uri":"dis_02_0024.html", "doc_type":"api", "p_code":"14", "code":"16" }, { "desc":"This API is used to delete a specified stream.For details, see Calling APIs.DELETE /v2/{project_id}/streams/{stream_name}NoneDeleting a StreamNoneSee Error Codes.", "product_code":"dis", "title":"Deleting a Stream", "uri":"DeleteStream.html", "doc_type":"api", "p_code":"14", "code":"17" }, { "desc":"This API is used to query details about a specified stream.For details, see Calling APIs.GET /v2/{project_id}/streams/{stream_name}Status code: 200Querying Details of a S", "product_code":"dis", "title":"Querying Details of a Stream", "uri":"dis_02_0025.html", "doc_type":"api", "p_code":"14", "code":"18" }, { "desc":"This API is used to change the number of partitions in a specific stream.For details, see Calling APIs.PUT /v2/{project_id}/streams/{stream_name}NoneChanging Partition Qu", "product_code":"dis", "title":"Changing Partition Quantity", "uri":"UpdatePartitionCount.html", "doc_type":"api", "p_code":"14", "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":"dis", "title":"App Management", "uri":"topic_300000001.html", "doc_type":"api", "p_code":"13", "code":"20" }, { "desc":"This API is used to create a consumption app.For details, see Calling APIs.POST /v2/{project_id}/appsNoneCreating a Consumption AppNoneSee Error Codes.", "product_code":"dis", "title":"Creating a Consumption App", "uri":"CreateApp.html", "doc_type":"api", "p_code":"20", "code":"21" }, { "desc":"This API is used to query apps.For details, see Calling APIs.GET /v2/{project_id}/appsStatus code: 200Querying AppsStatus code: 200Normal responseSee Error Codes.", "product_code":"dis", "title":"Querying Apps", "uri":"ListApp.html", "doc_type":"api", "p_code":"20", "code":"22" }, { "desc":"This API is used to delete an app.For details, see Calling APIs.DELETE /v2/{project_id}/apps/{app_name}NoneDeleting an AppNoneSee Error Codes.", "product_code":"dis", "title":"Deleting an App", "uri":"DeleteApp.html", "doc_type":"api", "p_code":"20", "code":"23" }, { "desc":"This API is used to query app details.For details, see Calling APIs.GET /v2/{project_id}/apps/{app_name}Status code: 200Querying App DetailsStatus code: 200Normal respons", "product_code":"dis", "title":"Querying App Details", "uri":"ShowApp.html", "doc_type":"api", "p_code":"20", "code":"24" }, { "desc":"This API is used to query the consumption status of an app.For details, see Calling APIs.GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}Status code: 200Queryin", "product_code":"dis", "title":"Querying App Consumption Status", "uri":"ShowConsumerState.html", "doc_type":"api", "p_code":"20", "code":"25" }, { "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":"dis", "title":"Checkpoint Management", "uri":"topic_300000002.html", "doc_type":"api", "p_code":"13", "code":"26" }, { "desc":"This API is used to submit checkpoints.For details, see Calling APIs.POST /v2/{project_id}/checkpointsNoneSubmitting CheckpointsNoneSee Error Codes.", "product_code":"dis", "title":"Submitting Checkpoints", "uri":"dis_02_0403.html", "doc_type":"api", "p_code":"26", "code":"27" }, { "desc":"This API is used to query checkpoint details.For details, see Calling APIs.GET /v2/{project_id}/checkpointsStatus code: 200Querying Checkpoint DetailsStatus code: 200Norm", "product_code":"dis", "title":"Querying Checkpoint Details", "uri":"ShowCheckpoint.html", "doc_type":"api", "p_code":"26", "code":"28" }, { "desc":"This API is used to delete a checkpoint.For details, see Calling APIs.DELETE /v2/{project_id}/checkpointsNoneDeleting a CheckpointNoneSee Error Codes.", "product_code":"dis", "title":"Deleting a Checkpoint", "uri":"DeleteCheckpoint.html", "doc_type":"api", "p_code":"26", "code":"29" }, { "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":"dis", "title":"Data Management", "uri":"topic_300000003.html", "doc_type":"api", "p_code":"13", "code":"30" }, { "desc":"This API is used to upload data to DIS streams.For details, see Calling APIs.POST /v2/{project_id}/recordsStatus code: 200Uploading DataNoneSee Error Codes.", "product_code":"dis", "title":"Uploading Data", "uri":"dis_02_0018.html", "doc_type":"api", "p_code":"30", "code":"31" }, { "desc":"This API is used to download data from DIS streams.For details, see Calling APIs.GET /v2/{project_id}/recordsStatus code: 200Downloading DataStatus code: 200Normal respon", "product_code":"dis", "title":"Downloading Data", "uri":"dis_02_0019.html", "doc_type":"api", "p_code":"30", "code":"32" }, { "desc":"This API is used to obtain data cursors.For details, see Calling APIs.GET /v2/{project_id}/cursorsStatus code: 200Obtaining Data CursorsStatus code: 200Normal responseSee", "product_code":"dis", "title":"Obtaining Data Cursors", "uri":"dis_02_0020.html", "doc_type":"api", "p_code":"30", "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":"dis", "title":"Dump Task Management", "uri":"topic_300000004.html", "doc_type":"api", "p_code":"13", "code":"34" }, { "desc":"This API is used to add OBS dump tasks.For details, see Calling APIs.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding OBS Dump TasksPOST https://{Endp", "product_code":"dis", "title":"Adding OBS Dump Tasks", "uri":"dis_02_0410.html", "doc_type":"api", "p_code":"34", "code":"35" }, { "desc":"This API is used to query dump tasks.For details, see Calling APIs.GET /v2/{project_id}/streams/{stream_name}/transfer-tasksStatus code: 200Querying Dump TasksStatus code", "product_code":"dis", "title":"Querying Dump Tasks", "uri":"ListTransferTasks.html", "doc_type":"api", "p_code":"34", "code":"36" }, { "desc":"This API is used to delete a dump task.For details, see Calling APIs.DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}NoneDeleting a Dump TaskNoneS", "product_code":"dis", "title":"Deleting a Dump Task", "uri":"DeleteTransferTask.html", "doc_type":"api", "p_code":"34", "code":"37" }, { "desc":"This API is used to query details of a dump task.For details, see Calling APIs.GET /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}Status code: 200Queryi", "product_code":"dis", "title":"Querying Dump Task Details", "uri":"ShowTransferTask.html", "doc_type":"api", "p_code":"34", "code":"38" }, { "desc":"This API is used to start dump tasks.For details, see Calling APIs.POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/actionNoneStarting Dump TasksNoneSee Error C", "product_code":"dis", "title":"Starting Dump Tasks", "uri":"BatchStartTransferTask.html", "doc_type":"api", "p_code":"34", "code":"39" }, { "desc":"This API is used to pause dump tasks.For details, see Calling APIs.POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/actionNonePausing Dump TasksNoneSee Error Co", "product_code":"dis", "title":"Pausing Dump Tasks", "uri":"BatchStopTransferTask.html", "doc_type":"api", "p_code":"34", "code":"40" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dis", "title":"Monitoring Management", "uri":"topic_300000005.html", "doc_type":"api", "p_code":"13", "code":"41" }, { "desc":"This API is used to query the monitoring data of a specified stream.For details, see Calling APIs.GET /v2/{project_id}/streams/{stream_name}/metricsStatus code: 200Queryi", "product_code":"dis", "title":"Querying Stream Monitoring Data", "uri":"ShowStreamMetrics.html", "doc_type":"api", "p_code":"41", "code":"42" }, { "desc":"This API is used to query the monitoring data of a specified partition of a stream.For details, see Calling APIs.GET /v2/{project_id}/streams/{stream_name}/partitions/{pa", "product_code":"dis", "title":"Querying Partition Monitoring Data", "uri":"ShowPartitionMetrics.html", "doc_type":"api", "p_code":"41", "code":"43" }, { "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":"dis", "title":"Tag Management", "uri":"topic_300000006.html", "doc_type":"api", "p_code":"13", "code":"44" }, { "desc":"This API is used to add tags to a specified stream.For details, see Calling APIs.POST /v2/{project_id}/stream/{stream_id}/tagsNoneAdding Tags to a Specified StreamNoneSee", "product_code":"dis", "title":"Adding Tags to a Specified Stream", "uri":"CreateTag.html", "doc_type":"api", "p_code":"44", "code":"45" }, { "desc":"This API is used to query tags of a specified stream.For details, see Calling APIs.GET /v2/{project_id}/stream/{stream_id}/tagsStatus code: 200Querying Tags of a Specifie", "product_code":"dis", "title":"Querying Tags of a Specified Stream", "uri":"ShowStreamTags.html", "doc_type":"api", "p_code":"44", "code":"46" }, { "desc":"This API is used to delete tags of a specified stream.For details, see Calling APIs.DELETE /v2/{project_id}/stream/{stream_id}/tags/{key}NoneDeleting Tags of a Specified ", "product_code":"dis", "title":"Deleting Tags of a Specified Stream", "uri":"DeleteTag.html", "doc_type":"api", "p_code":"44", "code":"47" }, { "desc":"This API is used to add resource tags (such as stream tags) in batches. This API is idempotent. When you are creating tags, if there are duplicate keys in the request bod", "product_code":"dis", "title":"Adding Resource Tags", "uri":"BatchCreateTags.html", "doc_type":"api", "p_code":"44", "code":"48" }, { "desc":"This API is used to query all tags of a specified region.For details, see Calling APIs.GET /v2/{project_id}/stream/tagsStatus code: 200Querying All Tags of a Specified Re", "product_code":"dis", "title":"Querying All Tags of a Specified Region", "uri":"ListTags.html", "doc_type":"api", "p_code":"44", "code":"49" }, { "desc":"This API is used to filter resources (streams) by tag.For details, see Calling APIs.POST /v2/{project_id}/stream/resource_instances/actionStatus code: 200Resource (stream", "product_code":"dis", "title":"Using Tags to Filter Resources (Streams)", "uri":"ListResourcesByTags.html", "doc_type":"api", "p_code":"44", "code":"50" }, { "desc":"This API is used to delete resource tags (stream tags). This API is idempotent. If the deleted tag does not exist, the deletion is considered successful by default. The t", "product_code":"dis", "title":"Deleting Resource Tags", "uri":"BatchDeleteTags.html", "doc_type":"api", "p_code":"44", "code":"51" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dis", "title":"Appendix", "uri":"dis_02_0500.html", "doc_type":"api", "p_code":"", "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":"dis", "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", "p_code":"52", "code":"53" }, { "desc":"A status code is an HTTPS response issued by DIS to indicate whether an API request has been successfully completed.", "product_code":"dis", "title":"Status Codes", "uri":"dis_02_0022.html", "doc_type":"api", "p_code":"52", "code":"54" }, { "desc":"This section describes how to obtain a project ID on the console or by calling an API.", "product_code":"dis", "title":"Obtaining a Project ID", "uri":"dis_02_0501.html", "doc_type":"api", "p_code":"52", "code":"55" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dis", "title":"Change History", "uri":"dis_02_0023.html", "doc_type":"api", "p_code":"", "code":"56" } ]