doc-exports/docs/dis/api-ref/CLASS.TXT.json
gtema 6bc123a554 Reimplementation of docs/doc-exports#263
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-11 12:03:08 +00:00

578 lines
21 KiB
JSON

[
{
"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. For the endpoints of all services, see Regions and Endpoints.",
"product_code":"dis",
"title":"Endpoints",
"uri":"dis_02_0513.html",
"doc_type":"api",
"p_code":"1",
"code":"4"
},
{
"desc":"For more constraints, see API description.",
"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.When creating a stream, specify a stre",
"product_code":"dis",
"title":"Creating Streams",
"uri":"dis_02_0016_01.html",
"doc_type":"api",
"p_code":"14",
"code":"15"
},
{
"desc":"This API is used to query all streams created by the current tenant.During the query, specify the stream from which the stream list is returned and the maximum number of ",
"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 specified streams.DELETE /v2/{project_id}/streams/{stream_name}NoneDeleting Specified StreamsNoneSee Error Codes.",
"product_code":"dis",
"title":"Deleting Specified Streams",
"uri":"DeleteStream.html",
"doc_type":"api",
"p_code":"14",
"code":"17"
},
{
"desc":"This API is used to query details about a specified stream.GET /v2/{project_id}/streams/{stream_name}Status code: 200Querying Stream DetailsStatus code: 200Normal respons",
"product_code":"dis",
"title":"Querying Stream Details",
"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.PUT /v2/{project_id}/streams/{stream_name}NoneChanging Partition QuantityNoneSee Error Codes.",
"product_code":"dis",
"title":"Changing Partition Quantity",
"uri":"UpdatePartitionCount.html",
"doc_type":"api",
"p_code":"14",
"code":"19"
},
{
"desc":"This API is used to update the information about specified streams.PUT /v3/{project_id}/streams/{stream_name}NoneUpdating Lifecycles of StreamsPUT https://{Endpoint}/v3/{",
"product_code":"dis",
"title":"Updating Stream Information",
"uri":"UpdateStream.html",
"doc_type":"api",
"p_code":"14",
"code":"20"
},
{
"desc":"This API is used to add permission policies to specified streams.POST /v2/{project_id}/streams/{stream_name}/policiesNoneAdding Permission Policies for TenantsPOST https:",
"product_code":"dis",
"title":"Adding Permission Policies",
"uri":"CreatePolicies.html",
"doc_type":"api",
"p_code":"14",
"code":"21"
},
{
"desc":"This API is used to query permission policies of specified streams.GET /v2/{project_id}/streams/{stream_name}/policiesStatus code: 200Querying Permission PoliciesStatus c",
"product_code":"dis",
"title":"Querying Permission Policies",
"uri":"ListPolicies.html",
"doc_type":"api",
"p_code":"14",
"code":"22"
},
{
"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":"23"
},
{
"desc":"This API is used to create consumption apps.POST /v2/{project_id}/appsNoneCreating Consumption AppsNoneSee Error Codes.",
"product_code":"dis",
"title":"Creating Consumption Apps",
"uri":"CreateApp.html",
"doc_type":"api",
"p_code":"23",
"code":"24"
},
{
"desc":"This API is used to query apps.GET /v2/{project_id}/appsStatus code: 200Querying AppsStatus code: 200Normal response.See Error Codes.",
"product_code":"dis",
"title":"Querying Apps",
"uri":"ListApp.html",
"doc_type":"api",
"p_code":"23",
"code":"25"
},
{
"desc":"This API is used to delete apps.DELETE /v2/{project_id}/apps/{app_name}NoneDeleting AppsNoneSee Error Codes.",
"product_code":"dis",
"title":"Deleting Apps",
"uri":"DeleteApp.html",
"doc_type":"api",
"p_code":"23",
"code":"26"
},
{
"desc":"This API is used to query app details.GET /v2/{project_id}/apps/{app_name}Status code: 200Querying App DetailsStatus code: 200Normal response.See Error Codes.",
"product_code":"dis",
"title":"Querying App Details",
"uri":"ShowApp.html",
"doc_type":"api",
"p_code":"23",
"code":"27"
},
{
"desc":"This API is used to query the consumption status of apps.GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}Status code: 200Querying App Consumption StatusStatus c",
"product_code":"dis",
"title":"Querying App Consumption Status",
"uri":"ShowConsumerState.html",
"doc_type":"api",
"p_code":"23",
"code":"28"
},
{
"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":"29"
},
{
"desc":"This API is used to submit checkpoints.POST /v2/{project_id}/checkpointsNoneSubmitting CheckpointsNoneSee Error Codes.",
"product_code":"dis",
"title":"Submitting Checkpoints",
"uri":"dis_02_0403.html",
"doc_type":"api",
"p_code":"29",
"code":"30"
},
{
"desc":"This API is used to query checkpoint details.GET /v2/{project_id}/checkpointsStatus code: 204Querying Checkpoint DetailsStatus code: 204Normal response.See Error Codes.",
"product_code":"dis",
"title":"Querying Checkpoint Details",
"uri":"ShowCheckpoint.html",
"doc_type":"api",
"p_code":"29",
"code":"31"
},
{
"desc":"This API is used to delete checkpoints.DELETE /v2/{project_id}/checkpointsNoneDeleting CheckpointsNoneSee Error Codes.",
"product_code":"dis",
"title":"Deleting Checkpoints",
"uri":"DeleteCheckpoint.html",
"doc_type":"api",
"p_code":"29",
"code":"32"
},
{
"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":"33"
},
{
"desc":"This API is used to upload data to DIS streams.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":"33",
"code":"34"
},
{
"desc":"This API is used to download data from DIS streams.GET /v2/{project_id}/recordsStatus code: 200Downloading DataStatus code: 200Normal response.See Error Codes.",
"product_code":"dis",
"title":"Downloading Data",
"uri":"dis_02_0019.html",
"doc_type":"api",
"p_code":"33",
"code":"35"
},
{
"desc":"This API is used to obtain data cursors.GET /v2/{project_id}/cursorsStatus code: 200Obtaining Data CursorsStatus code: 200Normal response.See Error Codes.",
"product_code":"dis",
"title":"Obtaining Data Cursors",
"uri":"dis_02_0020.html",
"doc_type":"api",
"p_code":"33",
"code":"36"
},
{
"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":"37"
},
{
"desc":"This API is used to add OBS dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding OBS Dump TasksPOST https://{Endpoint}/v2/{project_id}/streams/",
"product_code":"dis",
"title":"Adding OBS Dump Tasks",
"uri":"dis_02_0410.html",
"doc_type":"api",
"p_code":"37",
"code":"38"
},
{
"desc":"This API is used to query dump tasks.GET /v2/{project_id}/streams/{stream_name}/transfer-tasksStatus code: 200Querying Dump TasksStatus code: 200Normal response.See Error",
"product_code":"dis",
"title":"Querying Dump Tasks",
"uri":"ListTransferTasks.html",
"doc_type":"api",
"p_code":"37",
"code":"39"
},
{
"desc":"This API is used to delete dump tasks.DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}NoneDeleting Dump TasksNoneSee Error Codes.",
"product_code":"dis",
"title":"Deleting Dump Tasks",
"uri":"DeleteTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"40"
},
{
"desc":"This API is used to query dump task details.GET /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}Status code: 200Querying Dump Task DetailsStatus code: 20",
"product_code":"dis",
"title":"Querying Dump Task Details",
"uri":"ShowTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"41"
},
{
"desc":"This API is used to start dump tasks in batches.POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/actionNoneStarting Dump Tasks in BatchesNoneSee Error Codes.",
"product_code":"dis",
"title":"Starting Dump Tasks in Batches",
"uri":"BatchStartTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"42"
},
{
"desc":"This API is used to pause dump tasks in batches.POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/actionNonePausing Dump Tasks in BatchesNoneSee Error Codes.",
"product_code":"dis",
"title":"Pausing Dump Tasks in Batches",
"uri":"BatchStopTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"43"
},
{
"desc":"This API is used to add DWS dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding DWS Dump TasksNoneSee Error Codes.",
"product_code":"dis",
"title":"Adding DWS Dump Tasks",
"uri":"CreateDwsTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"44"
},
{
"desc":"This API is used to add MRS dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding MRS Dump TasksNoneSee Error Codes.",
"product_code":"dis",
"title":"Adding MRS Dump Tasks",
"uri":"CreateMrsTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"45"
},
{
"desc":"This API is used to add DLI dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneNoneNoneSee Error Codes.",
"product_code":"dis",
"title":"Adding DLI Dump Tasks",
"uri":"CreateDliTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"46"
},
{
"desc":"This API is used to add CloudTable dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding CloudTable HBase Dump TasksPOST https://{Endpoint}/v2/{",
"product_code":"dis",
"title":"Adding CloudTable Dump Tasks",
"uri":"CreateCloudTableTransferTask.html",
"doc_type":"api",
"p_code":"37",
"code":"47"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dis",
"title":"Monitoring Management",
"uri":"topic_300000005.html",
"doc_type":"api",
"p_code":"13",
"code":"48"
},
{
"desc":"This API is used to query the monitoring data of specified streams.GET /v2/{project_id}/streams/{stream_name}/metricsStatus code: 200Querying Stream Monitoring DataNoneSe",
"product_code":"dis",
"title":"Querying Stream Monitoring Data",
"uri":"ShowStreamMetrics.html",
"doc_type":"api",
"p_code":"48",
"code":"49"
},
{
"desc":"This API is used to query the monitoring data of a specified partition of a stream.GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metricsStatus code",
"product_code":"dis",
"title":"Querying Partition Monitoring Data",
"uri":"ShowPartitionMetrics.html",
"doc_type":"api",
"p_code":"48",
"code":"50"
},
{
"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":"51"
},
{
"desc":"This API is used to add tags to specified streams.POST /v2/{project_id}/stream/{stream_id}/tagsNoneAdding Tags for Specified StreamsNoneSee Error Codes.",
"product_code":"dis",
"title":"Adding Tags for Specified Streams",
"uri":"CreateTag.html",
"doc_type":"api",
"p_code":"51",
"code":"52"
},
{
"desc":"This API is used to query tags of specified streams.GET /v2/{project_id}/stream/{stream_id}/tagsStatus code: 200This API is used to query tags of specified streams.Status",
"product_code":"dis",
"title":"Querying Tags of Specified Streams",
"uri":"ShowStreamTags.html",
"doc_type":"api",
"p_code":"51",
"code":"53"
},
{
"desc":"This API is used to delete tags of specified streams.DELETE /v2/{project_id}/stream/{stream_id}/tags/{key}NoneDeleting Tags of Specified StreamsNoneSee Error Codes.",
"product_code":"dis",
"title":"Deleting Tags of Specified Streams",
"uri":"DeleteTag.html",
"doc_type":"api",
"p_code":"51",
"code":"54"
},
{
"desc":"This API is used to add resource tags (such as stream tags) in batches. The API is idempotent. When you are creating tags, if there are duplicate keys in the request body",
"product_code":"dis",
"title":"Adding Resource Tags in Batches",
"uri":"BatchCreateTags.html",
"doc_type":"api",
"p_code":"51",
"code":"55"
},
{
"desc":"This API is used to query all tags of specified regions.GET /v2/{project_id}/stream/tagsStatus code: 200Querying Tags of Specified RegionsStatus code: 200Response body of",
"product_code":"dis",
"title":"Querying Tags of Specified Regions",
"uri":"ListTags.html",
"doc_type":"api",
"p_code":"51",
"code":"56"
},
{
"desc":"This API is used to filter resources (streams) by tag.POST /v2/{project_id}/stream/resource_instances/actionStatus code: 200Resource (stream) filtering by tag and record ",
"product_code":"dis",
"title":"Using Tags to Filter Resources (Streams)",
"uri":"ListResourcesByTags.html",
"doc_type":"api",
"p_code":"51",
"code":"57"
},
{
"desc":"This API is used to delete resource tags (stream tags) in batches. This API is idempotent. If the deleted tag does not exist, the deletion is considered successful by def",
"product_code":"dis",
"title":"Deleting Resource Tags in Batches",
"uri":"BatchDeleteTags.html",
"doc_type":"api",
"p_code":"51",
"code":"58"
},
{
"desc":"This chapter describes fine-grained permissions management for your DIS. If your cloud account does not need individual IAM users, then you may skip over this chapter.By ",
"product_code":"dis",
"title":"Permissions Policies and Supported Actions",
"uri":"en-us_topic_0000001079240698.html",
"doc_type":"api",
"p_code":"",
"code":"59"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dis",
"title":"Appendix",
"uri":"dis_02_0500.html",
"doc_type":"api",
"p_code":"",
"code":"60"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"dis",
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"p_code":"60",
"code":"61"
},
{
"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":"60",
"code":"62"
},
{
"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":"60",
"code":"63"
},
{
"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":"64"
}
]