diff --git a/docs/dis/api-ref/ALL_META.TXT.json b/docs/dis/api-ref/ALL_META.TXT.json
new file mode 100644
index 000000000..31bde217f
--- /dev/null
+++ b/docs/dis/api-ref/ALL_META.TXT.json
@@ -0,0 +1,642 @@
+[
+ {
+ "uri":"dis_02_0511.html",
+ "product_code":"dis",
+ "code":"1",
+ "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":"Before You Start",
+ "title":"Before You Start",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0600.html",
+ "product_code":"dis",
+ "code":"2",
+ "des":"Welcome to Data Ingestion Service API Reference. Data Ingestion Service (DIS) provides efficient collection, transmission, and distribution capabilities for real-time IoT",
+ "doc_type":"api",
+ "kw":"Overview,Before You Start,API Reference",
+ "title":"Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0512.html",
+ "product_code":"dis",
+ "code":"3",
+ "des":"DIS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.",
+ "doc_type":"api",
+ "kw":"API Calling,Before You Start,API Reference",
+ "title":"API Calling",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0513.html",
+ "product_code":"dis",
+ "code":"4",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"Endpoints,Before You Start,API Reference",
+ "title":"Endpoints",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0514.html",
+ "product_code":"dis",
+ "code":"5",
+ "des":"For more constraints, see API description.",
+ "doc_type":"api",
+ "kw":"Constraints,Before You Start,API Reference",
+ "title":"Constraints",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0515.html",
+ "product_code":"dis",
+ "code":"6",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Concepts,Before You Start,API Reference",
+ "title":"Concepts",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0200.html",
+ "product_code":"dis",
+ "code":"7",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"API Overview,API Reference",
+ "title":"API Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0516.html",
+ "product_code":"dis",
+ "code":"8",
+ "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":"Calling APIs",
+ "title":"Calling APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0400.html",
+ "product_code":"dis",
+ "code":"9",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"Making an API Request,Calling APIs,API Reference",
+ "title":"Making an API Request",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0517.html",
+ "product_code":"dis",
+ "code":"10",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Authentication,Calling APIs,API Reference",
+ "title":"Authentication",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0518.html",
+ "product_code":"dis",
+ "code":"11",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"Response,Calling APIs,API Reference",
+ "title":"Response",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0003.html",
+ "product_code":"dis",
+ "code":"12",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"Application Example,API Reference",
+ "title":"Application Example",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0015.html",
+ "product_code":"dis",
+ "code":"13",
+ "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 Description",
+ "title":"API Description",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000000.html",
+ "product_code":"dis",
+ "code":"14",
+ "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":"Stream Management",
+ "title":"Stream Management",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0016_01.html",
+ "product_code":"dis",
+ "code":"15",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Creating Streams,Stream Management,API Reference",
+ "title":"Creating Streams",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0024.html",
+ "product_code":"dis",
+ "code":"16",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"Querying Streams,Stream Management,API Reference",
+ "title":"Querying Streams",
+ "githuburl":""
+ },
+ {
+ "uri":"DeleteStream.html",
+ "product_code":"dis",
+ "code":"17",
+ "des":"This API is used to delete specified streams.DELETE /v2/{project_id}/streams/{stream_name}NoneDeleting Specified StreamsNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Deleting Specified Streams,Stream Management,API Reference",
+ "title":"Deleting Specified Streams",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0025.html",
+ "product_code":"dis",
+ "code":"18",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Stream Details,Stream Management,API Reference",
+ "title":"Querying Stream Details",
+ "githuburl":""
+ },
+ {
+ "uri":"UpdatePartitionCount.html",
+ "product_code":"dis",
+ "code":"19",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"Changing Partition Quantity,Stream Management,API Reference",
+ "title":"Changing Partition Quantity",
+ "githuburl":""
+ },
+ {
+ "uri":"UpdateStream.html",
+ "product_code":"dis",
+ "code":"20",
+ "des":"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/{",
+ "doc_type":"api",
+ "kw":"Updating Stream Information,Stream Management,API Reference",
+ "title":"Updating Stream Information",
+ "githuburl":""
+ },
+ {
+ "uri":"CreatePolicies.html",
+ "product_code":"dis",
+ "code":"21",
+ "des":"This API is used to add permission policies to specified streams.POST /v2/{project_id}/streams/{stream_name}/policiesNoneAdding Permission Policies for TenantsPOST https:",
+ "doc_type":"api",
+ "kw":"Adding Permission Policies,Stream Management,API Reference",
+ "title":"Adding Permission Policies",
+ "githuburl":""
+ },
+ {
+ "uri":"ListPolicies.html",
+ "product_code":"dis",
+ "code":"22",
+ "des":"This API is used to query permission policies of specified streams.GET /v2/{project_id}/streams/{stream_name}/policiesStatus code: 200Querying Permission PoliciesStatus c",
+ "doc_type":"api",
+ "kw":"Querying Permission Policies,Stream Management,API Reference",
+ "title":"Querying Permission Policies",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000001.html",
+ "product_code":"dis",
+ "code":"23",
+ "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":"App Management",
+ "title":"App Management",
+ "githuburl":""
+ },
+ {
+ "uri":"CreateApp.html",
+ "product_code":"dis",
+ "code":"24",
+ "des":"This API is used to create consumption apps.POST /v2/{project_id}/appsNoneCreating Consumption AppsNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Creating Consumption Apps,App Management,API Reference",
+ "title":"Creating Consumption Apps",
+ "githuburl":""
+ },
+ {
+ "uri":"ListApp.html",
+ "product_code":"dis",
+ "code":"25",
+ "des":"This API is used to query apps.GET /v2/{project_id}/appsStatus code: 200Querying AppsStatus code: 200Normal response.See Error Codes.",
+ "doc_type":"api",
+ "kw":"Querying Apps,App Management,API Reference",
+ "title":"Querying Apps",
+ "githuburl":""
+ },
+ {
+ "uri":"DeleteApp.html",
+ "product_code":"dis",
+ "code":"26",
+ "des":"This API is used to delete apps.DELETE /v2/{project_id}/apps/{app_name}NoneDeleting AppsNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Deleting Apps,App Management,API Reference",
+ "title":"Deleting Apps",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowApp.html",
+ "product_code":"dis",
+ "code":"27",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"Querying App Details,App Management,API Reference",
+ "title":"Querying App Details",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowConsumerState.html",
+ "product_code":"dis",
+ "code":"28",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying App Consumption Status,App Management,API Reference",
+ "title":"Querying App Consumption Status",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000002.html",
+ "product_code":"dis",
+ "code":"29",
+ "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":"Checkpoint Management",
+ "title":"Checkpoint Management",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0403.html",
+ "product_code":"dis",
+ "code":"30",
+ "des":"This API is used to submit checkpoints.POST /v2/{project_id}/checkpointsNoneSubmitting CheckpointsNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Submitting Checkpoints,Checkpoint Management,API Reference",
+ "title":"Submitting Checkpoints",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowCheckpoint.html",
+ "product_code":"dis",
+ "code":"31",
+ "des":"This API is used to query checkpoint details.GET /v2/{project_id}/checkpointsStatus code: 204Querying Checkpoint DetailsStatus code: 204Normal response.See Error Codes.",
+ "doc_type":"api",
+ "kw":"Querying Checkpoint Details,Checkpoint Management,API Reference",
+ "title":"Querying Checkpoint Details",
+ "githuburl":""
+ },
+ {
+ "uri":"DeleteCheckpoint.html",
+ "product_code":"dis",
+ "code":"32",
+ "des":"This API is used to delete checkpoints.DELETE /v2/{project_id}/checkpointsNoneDeleting CheckpointsNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Deleting Checkpoints,Checkpoint Management,API Reference",
+ "title":"Deleting Checkpoints",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000003.html",
+ "product_code":"dis",
+ "code":"33",
+ "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":"Data Management",
+ "title":"Data Management",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0018.html",
+ "product_code":"dis",
+ "code":"34",
+ "des":"This API is used to upload data to DIS streams.POST /v2/{project_id}/recordsStatus code: 200Uploading DataNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Uploading Data,Data Management,API Reference",
+ "title":"Uploading Data",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0019.html",
+ "product_code":"dis",
+ "code":"35",
+ "des":"This API is used to download data from DIS streams.GET /v2/{project_id}/recordsStatus code: 200Downloading DataStatus code: 200Normal response.See Error Codes.",
+ "doc_type":"api",
+ "kw":"Downloading Data,Data Management,API Reference",
+ "title":"Downloading Data",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0020.html",
+ "product_code":"dis",
+ "code":"36",
+ "des":"This API is used to obtain data cursors.GET /v2/{project_id}/cursorsStatus code: 200Obtaining Data CursorsStatus code: 200Normal response.See Error Codes.",
+ "doc_type":"api",
+ "kw":"Obtaining Data Cursors,Data Management,API Reference",
+ "title":"Obtaining Data Cursors",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000004.html",
+ "product_code":"dis",
+ "code":"37",
+ "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":"Dump Task Management",
+ "title":"Dump Task Management",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0410.html",
+ "product_code":"dis",
+ "code":"38",
+ "des":"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/",
+ "doc_type":"api",
+ "kw":"Adding OBS Dump Tasks,Dump Task Management,API Reference",
+ "title":"Adding OBS Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"ListTransferTasks.html",
+ "product_code":"dis",
+ "code":"39",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Dump Tasks,Dump Task Management,API Reference",
+ "title":"Querying Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"DeleteTransferTask.html",
+ "product_code":"dis",
+ "code":"40",
+ "des":"This API is used to delete dump tasks.DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}NoneDeleting Dump TasksNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Deleting Dump Tasks,Dump Task Management,API Reference",
+ "title":"Deleting Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowTransferTask.html",
+ "product_code":"dis",
+ "code":"41",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Dump Task Details,Dump Task Management,API Reference",
+ "title":"Querying Dump Task Details",
+ "githuburl":""
+ },
+ {
+ "uri":"BatchStartTransferTask.html",
+ "product_code":"dis",
+ "code":"42",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"Starting Dump Tasks in Batches,Dump Task Management,API Reference",
+ "title":"Starting Dump Tasks in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"BatchStopTransferTask.html",
+ "product_code":"dis",
+ "code":"43",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"Pausing Dump Tasks in Batches,Dump Task Management,API Reference",
+ "title":"Pausing Dump Tasks in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"CreateDwsTransferTask.html",
+ "product_code":"dis",
+ "code":"44",
+ "des":"This API is used to add DWS dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding DWS Dump TasksNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Adding DWS Dump Tasks,Dump Task Management,API Reference",
+ "title":"Adding DWS Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"CreateMrsTransferTask.html",
+ "product_code":"dis",
+ "code":"45",
+ "des":"This API is used to add MRS dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneAdding MRS Dump TasksNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Adding MRS Dump Tasks,Dump Task Management,API Reference",
+ "title":"Adding MRS Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"CreateDliTransferTask.html",
+ "product_code":"dis",
+ "code":"46",
+ "des":"This API is used to add DLI dump tasks.POST /v2/{project_id}/streams/{stream_name}/transfer-tasksNoneNoneNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Adding DLI Dump Tasks,Dump Task Management,API Reference",
+ "title":"Adding DLI Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"CreateCloudTableTransferTask.html",
+ "product_code":"dis",
+ "code":"47",
+ "des":"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/{",
+ "doc_type":"api",
+ "kw":"Adding CloudTable Dump Tasks,Dump Task Management,API Reference",
+ "title":"Adding CloudTable Dump Tasks",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000005.html",
+ "product_code":"dis",
+ "code":"48",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Monitoring Management",
+ "title":"Monitoring Management",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowStreamMetrics.html",
+ "product_code":"dis",
+ "code":"49",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Stream Monitoring Data,Monitoring Management,API Reference",
+ "title":"Querying Stream Monitoring Data",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowPartitionMetrics.html",
+ "product_code":"dis",
+ "code":"50",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Partition Monitoring Data,Monitoring Management,API Reference",
+ "title":"Querying Partition Monitoring Data",
+ "githuburl":""
+ },
+ {
+ "uri":"topic_300000006.html",
+ "product_code":"dis",
+ "code":"51",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Tag Management",
+ "title":"Tag Management",
+ "githuburl":""
+ },
+ {
+ "uri":"CreateTag.html",
+ "product_code":"dis",
+ "code":"52",
+ "des":"This API is used to add tags to specified streams.POST /v2/{project_id}/stream/{stream_id}/tagsNoneAdding Tags for Specified StreamsNoneSee Error Codes.",
+ "doc_type":"api",
+ "kw":"Adding Tags for Specified Streams,Tag Management,API Reference",
+ "title":"Adding Tags for Specified Streams",
+ "githuburl":""
+ },
+ {
+ "uri":"ShowStreamTags.html",
+ "product_code":"dis",
+ "code":"53",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Tags of Specified Streams,Tag Management,API Reference",
+ "title":"Querying Tags of Specified Streams",
+ "githuburl":""
+ },
+ {
+ "uri":"DeleteTag.html",
+ "product_code":"dis",
+ "code":"54",
+ "des":"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.",
+ "doc_type":"api",
+ "kw":"Deleting Tags of Specified Streams,Tag Management,API Reference",
+ "title":"Deleting Tags of Specified Streams",
+ "githuburl":""
+ },
+ {
+ "uri":"BatchCreateTags.html",
+ "product_code":"dis",
+ "code":"55",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Adding Resource Tags in Batches,Tag Management,API Reference",
+ "title":"Adding Resource Tags in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"ListTags.html",
+ "product_code":"dis",
+ "code":"56",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Querying Tags of Specified Regions,Tag Management,API Reference",
+ "title":"Querying Tags of Specified Regions",
+ "githuburl":""
+ },
+ {
+ "uri":"ListResourcesByTags.html",
+ "product_code":"dis",
+ "code":"57",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"Using Tags to Filter Resources (Streams),Tag Management,API Reference",
+ "title":"Using Tags to Filter Resources (Streams)",
+ "githuburl":""
+ },
+ {
+ "uri":"BatchDeleteTags.html",
+ "product_code":"dis",
+ "code":"58",
+ "des":"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",
+ "doc_type":"api",
+ "kw":"Deleting Resource Tags in Batches,Tag Management,API Reference",
+ "title":"Deleting Resource Tags in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0000001079240698.html",
+ "product_code":"dis",
+ "code":"59",
+ "des":"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 ",
+ "doc_type":"api",
+ "kw":"Permissions Policies and Supported Actions,API Reference",
+ "title":"Permissions Policies and Supported Actions",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0500.html",
+ "product_code":"dis",
+ "code":"60",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Appendix",
+ "title":"Appendix",
+ "githuburl":""
+ },
+ {
+ "uri":"ErrorCode.html",
+ "product_code":"dis",
+ "code":"61",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Error Codes,Appendix,API Reference",
+ "title":"Error Codes",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0022.html",
+ "product_code":"dis",
+ "code":"62",
+ "des":"A status code is an HTTPS response issued by DIS to indicate whether an API request has been successfully completed.",
+ "doc_type":"api",
+ "kw":"Status Codes,Appendix,API Reference",
+ "title":"Status Codes",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0501.html",
+ "product_code":"dis",
+ "code":"63",
+ "des":"This section describes how to obtain a project ID on the console or by calling an API.",
+ "doc_type":"api",
+ "kw":"Obtaining a Project ID,Appendix,API Reference",
+ "title":"Obtaining a Project ID",
+ "githuburl":""
+ },
+ {
+ "uri":"dis_02_0023.html",
+ "product_code":"dis",
+ "code":"64",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Change History,API Reference",
+ "title":"Change History",
+ "githuburl":""
+ }
+]
\ No newline at end of file
diff --git a/docs/dis/api-ref/BatchCreateTags.html b/docs/dis/api-ref/BatchCreateTags.html
new file mode 100644
index 000000000..4f7f47840
--- /dev/null
+++ b/docs/dis/api-ref/BatchCreateTags.html
@@ -0,0 +1,187 @@
+
+
+
Adding Resource Tags in Batches
+
Function
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, an error is reported. During tag creation, duplicate keys are not allowed. If a key exists in the database, its value will be overwritten.
+
+
URI
POST /v2/{project_id}/stream/{stream_id}/tags/action
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_id
+
+
Yes
+
+
String
+
+
Stream ID.
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
action
+
+
Yes
+
+
String
+
+
Operation to be performed. The value can be create only.
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 default. The tag character set range is not verified during tag deletion. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.
+
+
URI
POST /v2/{project_id}/stream/{stream_id}/tags/action
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_id
+
+
Yes
+
+
String
+
+
Stream ID.
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
action
+
+
Yes
+
+
String
+
+
Operation to be performed. The value can be delete only.
diff --git a/docs/dis/api-ref/CLASS.TXT.json b/docs/dis/api-ref/CLASS.TXT.json
new file mode 100644
index 000000000..d1339c71a
--- /dev/null
+++ b/docs/dis/api-ref/CLASS.TXT.json
@@ -0,0 +1,578 @@
+[
+ {
+ "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"
+ }
+]
\ No newline at end of file
diff --git a/docs/dis/api-ref/CreateApp.html b/docs/dis/api-ref/CreateApp.html
new file mode 100644
index 000000000..d9080a05c
--- /dev/null
+++ b/docs/dis/api-ref/CreateApp.html
@@ -0,0 +1,116 @@
+
+
+
Creating Consumption Apps
+
Function
This API is used to create consumption apps.
+
+
URI
POST /v2/{project_id}/apps
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
app_name
+
+
Yes
+
+
String
+
+
Unique identifier of the consumer application to be created.
+
The application name contains 1 to 200 characters, including letters, digits, underscores (_), and hyphens (-).
+
Minimum: 1
+
Maximum: 200
+
+
+
+
+
+
+
Response Parameters
None
+
+
Example Requests
Creating Consumption Apps
+
POST https://{Endpoint}/v2/{project_id}/apps
+
+{
+ "app_name" : "newapp"
+}
Parameter list of the CloudTable to which data in the DIS stream will be dumped.
+
+
+
+
+
+
+
Table 4 CloudtableDestinationDescriptorRequest
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
Yes
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
Yes
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Yes
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
No
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
cloudtable_cluster_name
+
+
Yes
+
+
String
+
+
Name of the CloudTable cluster to which data will be dumped.
+
If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.
+
+
+
cloudtable_cluster_id
+
+
Yes
+
+
String
+
+
ID of the CloudTable cluster to which data will be dumped.
+
If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.
+
+
+
cloudtable_table_name
+
+
No
+
+
String
+
+
HBase table name of the CloudTable cluster to which data will be dumped. The parameter is mandatory when data is dumped to the CloudTable HBase.
Schema configuration of the CloudTable HBase data. You can set either this parameter or opentsdb_schema, but this parameter is mandatory when data will be dumped to HBase. After this parameter is set, the JSON data in the stream can be converted to another format and then be imported to the CloudTable HBase.
Schema configuration of the CloudTable OpenTSDB data. You can set either this parameter or opentsdb_schema, but this parameter is mandatory when data will be dumped to OpenTSDB. After this parameter is set, the JSON data in the stream can be converted to another format and then be imported to the CloudTable OpenTSDB.
+
+
+
cloudtable_row_key_delimiter
+
+
No
+
+
String
+
+
Delimiter used to separate the user data that generates HBase row keys. Value range: , . | ; \ - _ and ~
+
Default value: .
+
+
+
obs_backup_bucket_path
+
+
No
+
+
String
+
+
Name of the OBS bucket used to back up data that failed to be dumped to CloudTable.
+
+
+
backup_file_prefix
+
+
No
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to back up data that failed to be dumped to CloudTable. Directory levels are separated by slashes (/) and cannot start with slashes.
+
Value range: a string of letters, digits, and underscores (_)
+
The maximum length is 50 characters.
+
This parameter is left empty by default.
+
+
+
retry_duration
+
+
No
+
+
String
+
+
Time duration for DIS to retry if data fails to be dumped to CloudTable. If this threshold is exceeded, the data that fails to be dumped will be backed up to the OBS bucket/backup_file_prefix /cloudtable_error or OBS bucket/backup_file_prefix/opentsdb_error directory.
Schema configuration of the OpenTSDB data metric in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the metric of the OpenTSDB data.
Schema configuration of the OpenTSDB data timestamp in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the timestamp of the OpenTSDB data.
Schema configuration of the OpenTSDB data value in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the value of the OpenTSDB data.
Schema configuration of the OpenTSDB data tags in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the tags of the OpenTSDB data.
+
+
+
+
+
+
+
Table 9 OpenTSDBMetric
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
type
+
+
Yes
+
+
String
+
+
When type is set to Constant, the value of metric is the value of Value.
When value is set to String, the value of metric is the value of the JSON attribute of the user data in the stream.
+
Enumeration values:
+
Constant
String
+
+
+
value
+
+
Yes
+
+
String
+
+
Constant value or JSON attribute name of the user data in the stream. This value is 1 to 32 characters long. Only letters, digits, and periods (.) are allowed.
+
+
+
+
+
+
+
Table 10 OpenTSDBTimestamp
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
type
+
+
Yes
+
+
String
+
+
When type is set to Timestamp, the value type of the JSON attribute of the user data in the stream is Timestamp, and the timestamp of OpenTSDB can be generated without converting the data format.
When type is set to String, the value type of the JSON attribute of the user data in the stream is Date, and the timestamp of OpenTSDB can be generated only after the data format is converted.
+
+
+
value
+
+
Yes
+
+
String
+
+
JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
format
+
+
Yes
+
+
String
+
+
This parameter is mandatory when type is set to String. When the value type of the JSON attribute of the user data in the stream is Date, format is required to convert the data format to generate the timestamp of OpenTSDB.
+
Value range:
+
yyyy/MM/dd HH:mm:ss
MM/dd/yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
yyyy-MM-dd HH:mm:ss
MM-dd-yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
+
Enumeration values:
+
yyyy/MM/dd HH:mm:ss
MM/dd/yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
yyyy-MM-dd HH:mm:ss
MM-dd-yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
+
+
+
+
+
+
+
Table 11 OpenTSDBValue
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
type
+
+
Yes
+
+
String
+
+
Dump destination. Possible values: Value range:
+
Bigint
Double
Boolean
Timestamp
String
Decimal
+
+
+
value
+
+
Yes
+
+
String
+
+
Constant value or JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
+
+
+
+
Table 12 OpenTSDBTags
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
name
+
+
Yes
+
+
String
+
+
Tag name of the OpenTSDB data that stores the data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
type
+
+
Yes
+
+
String
+
+
Type name of the JSON attribute of the user data in the stream.
+
Value range:
+
Bigint
Double
Boolean
Timestamp
String
Decimal
+
+
+
value
+
+
Yes
+
+
String
+
+
Constant value or JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
Parameter list of the DLI to which data in the DIS stream will be dumped.
+
+
+
+
+
+
+
Table 4 DliDestinationDescriptorRequest
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
Yes
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
Yes
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Yes
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
No
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
dli_database_name
+
+
Yes
+
+
String
+
+
Name of the DLI database to which data in the DIS stream will be dumped.
+
+
+
dli_table_name
+
+
Yes
+
+
String
+
+
Name of the DLI table to which data in the DIS stream will be dumped.
+
Note:
+
Only tables whose data location is DLI are supported, and you must have the permission to insert data into the tables.
+
+
+
obs_bucket_path
+
+
Yes
+
+
String
+
+
Name of the OBS bucket used to temporarily store data in the DIS stream.
+
+
+
file_prefix
+
+
No
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
+
+
retry_duration
+
+
No
+
+
String
+
+
Time duration for DIS to retry if data fails to be dumped to DLI. If the retry time exceeds the value of this parameter, the data that fails to be dumped is backed up to the OBS bucket/file_prefix/dli_error directory. Value range: 0-7,200 Unit: second Default value: 1,800 If this parameter is set to 0, DIS does not retry when the dump fails.
Parameter list of the DWS to which data in the DIS stream will be dumped.
+
+
+
+
+
+
+
Table 4 DWSDestinationDescriptorRequest
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
Yes
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
Yes
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Yes
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
No
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
dws_cluster_name
+
+
Yes
+
+
String
+
+
Name of the DWS cluster that stores the data in the stream.
+
+
+
dws_cluster_id
+
+
Yes
+
+
String
+
+
ID of the DWS cluster to which will be dumped.
+
+
+
dws_database_name
+
+
Yes
+
+
String
+
+
Name of the DWS database that stores the data in the stream.
+
+
+
dws_schema
+
+
Yes
+
+
String
+
+
Schema of the DWS database to which data will be dumped.
+
+
+
dws_table_name
+
+
Yes
+
+
String
+
+
Name of the DWS table that stores the data in the stream.
+
+
+
dws_delimiter
+
+
Yes
+
+
String
+
+
Delimiter used to separate the columns in the DWS tables.
+
The value can be a comma (,), semicolon (;), or vertical bar (|).
+
+
+
user_name
+
+
Yes
+
+
String
+
+
Username of the DWS database to which data will be dumped.
+
+
+
user_password
+
+
Yes
+
+
String
+
+
Password of the DWS database to which data will be dumped.
+
+
+
kms_user_key_name
+
+
Yes
+
+
String
+
+
Key created in Key Management Service (KMS) and used to encrypt the password of the DWS database.
+
+
+
kms_user_key_id
+
+
Yes
+
+
String
+
+
ID of the key created in KMS and used to encrypt the password of the DWS database.
+
+
+
obs_bucket_path
+
+
Yes
+
+
String
+
+
Name of the OBS bucket used to temporarily store data in the DIS stream.
+
+
+
file_prefix
+
+
No
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
+
+
retry_duration
+
+
No
+
+
String
+
+
Duration when you can constantly retry dumping data to DWS after the dump fails. If the dump time exceeds the value of this parameter, the data that fails to be dumped to DWS will be backed up to the OBS bucket/file_prefix/dws_error directory.
+
Value range: 0-7,200
+
Unit: second
+
Default value: 1,800
+
+
+
dws_table_columns
+
+
No
+
+
String
+
+
Column to be dumped to the DWS table. If the value is null or empty, all columns are dumped by default. For example, c1,c2 indicates that columns c1 and c2 in the schema are dumped to DWS.
DWS fault tolerance option (used to specify various parameters of foreign table data).
+
+
+
+
+
+
+
Table 5 Options
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
fill_missing_fields
+
+
No
+
+
String
+
+
Specifies whether to set the field to Null or enable an error message to be displayed in the error table when the last field in a row of the data source file is missing during database import.
+
Value range:
+
true/on
false/off
+
Default value: false/off
+
Enumeration values:
+
true/on
false/off
+
+
+
ignore_extra_data
+
+
No
+
+
String
+
+
Specifies whether to ignore excessive columns when the number of columns in a source data file exceeds that defined in the foreign table. This parameter is used only during data import.
+
Value range:
+
true/on
false/off
+
Default value: false/off
+
Enumeration values:
+
true/on
false/off
+
+
+
compatible_illegal_chars
+
+
No
+
+
String
+
+
Specifies whether to tolerate invalid characters during data import. Specifies whether to convert invalid characters based on the conversion rule and import them to the database, or to report an error and stop the import.
+
Value range:
+
true/on
false/off
+
Default value: false/off
+
Enumeration values:
+
true/on
false/off
+
+
+
reject_limit
+
+
No
+
+
String
+
+
Maximum number of data format errors allowed during the data import. If the number of data format errors does not reach the maximum, the data import is successful.
+
Value range:
+
integer
unlimited
+
Default value: 0, indicating that error information is returned immediately
+
+
+
error_table_name
+
+
No
+
+
String
+
+
Name of the error table that records data format errors. After the parallel import is complete, you can query the error information table to obtain the detailed error information.
Parameter list of the MRS to which data in the DIS stream will be dumped.
+
+
+
+
+
+
+
Table 4 MRSDestinationDescriptorRequest
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
Yes
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
Yes
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Yes
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
No
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
mrs_cluster_name
+
+
Yes
+
+
String
+
+
Name of the MRS cluster to which data in the DIS stream will be dumped.
+
Note:
+
Only MRS clusters with non-Kerberos authentication are supported.
+
+
+
mrs_cluster_id
+
+
Yes
+
+
String
+
+
ID of the MRS cluster to which data in the DIS stream will be dumped.
+
+
+
mrs_hdfs_path
+
+
Yes
+
+
String
+
+
Hadoop Distributed File System (HDFS) path of the MRS cluster to which data in the DIS stream will be dumped.
+
+
+
file_prefix
+
+
No
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
+
+
hdfs_prefix_folder
+
+
No
+
+
String
+
+
Directory to store files that will be dumped to the chosen MRS cluster. Different directory levels are separated by slash (/). Value range: a string of 0 to 50 characters This parameter is left empty by default.
+
+
+
obs_bucket_path
+
+
Yes
+
+
String
+
+
Name of the OBS bucket used to temporarily store data in the DIS stream.
+
+
+
retry_duration
+
+
No
+
+
String
+
+
Time duration for DIS to retry if data fails to be dumped. If the retry time exceeds the value of this parameter, the data that fails to be dumped is backed up to the OBS bucket/file_prefix/mrs_error directory.
+
Value range: 0-7,200
+
Unit: second
+
Default value: 1,800
+
If this parameter is set to 0, DIS does not retry when the dump fails.
This API is used to add permission policies to specified streams.
+
+
URI
POST /v2/{project_id}/streams/{stream_name}/policies
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream for which you want to add an authorization policy.
+
Maximum: 64
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
stream_id
+
+
Yes
+
+
String
+
+
Unique ID of the stream.
+
+
+
principal_name
+
+
Yes
+
+
String
+
+
Authorized user.
+
If the permission is granted to a specified tenant, the format is domainName.*. If the permission is granted to a specified sub-user of a tenant, the format is domainName.userName.
+
Multiple accounts can be added and separated by commas (,), for example, domainName1.userName1,domainName2.userName2.
Name of the stream to which the checkpoint belongs.
+
+
+
app_name
+
+
Yes
+
+
String
+
+
Name of the application associated with the checkpoint.
+
Minimum: 1
+
Maximum: 50
+
+
+
checkpoint_type
+
+
Yes
+
+
String
+
+
Type of the checkpoint. LAST_READ: Only sequence numbers are recorded in databases.
+
Enumeration values:
+
LAST_READ
+
+
+
+
partition_id
+
+
No
+
+
String
+
+
Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:
+
shardId-0000000000
+
0
+
+
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, and shardId-0000000000, shardId-0000000001, shardId-0000000002, respectively.
+
+
+
+
+
+
+
Request Parameters
+
Table 3 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
If the permission is granted to all sub-users of a tenant, the format is domainName.*. If the permission is granted to a specified sub-user of a tenant, the format is domainName.userName.
+
+
+
action_type
+
+
String
+
+
Authorization operation type.
+
putRecords: Upload data.
+
getRecords: Download data.
+
+
Enumeration values:
+
putRecords
+
getRecords
+
+
+
+
effect
+
+
String
+
+
Authorization impact type.
+
accept: The authorization operation is allowed.
+
+
Enumeration values:
+
accept
+
+
+
+
+
+
+
+
Example Requests
Querying Permission Policies
+
GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/policies
This API is used to filter resources (streams) by tag.
+
+
URI
POST /v2/{project_id}/stream/resource_instances/action
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
action
+
+
Yes
+
+
String
+
+
Operation to be performed. The value can be only filter or count.
+
filter: queries data on multiple pages.
+
count: queries the total number of data records. The total number of data records is returned based on the search criteria.
+
+
Enumeration values:
+
filter
+
count
+
+
+
+
limit
+
+
No
+
+
String
+
+
Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1 to 1000.
+
Default: 1000
+
+
+
offset
+
+
No
+
+
String
+
+
Index position. The query starts from the next data record indexed by this parameter. When querying data on the first page, you do not need to pass this parameter. When querying data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. This parameter is not displayed when action is set to count. If action is set to filter, the value defaults to 0. The value must be a positive integer.
The return result contains resources corresponding to all tags in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string.
The return result contains resources corresponding to any tag in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys and the values of a key must be unique.
The return result does not contain resources corresponding to all tags in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys and the values of a key must be unique.
The return result does not contain resources corresponding to any tag in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique.
+
+
+
matches
+
+
No
+
+
String
+
+
Search criteria. The tag key is the field to match. Currently, only resource_name is supported. value indicates the matched value. This field is a fixed dictionary value.
+
+
+
+
+
+
+
Table 4 Tags
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key
+
+
No
+
+
String
+
+
Key.
+
This field cannot be left blank.
+
The key value of a resource must be unique.
+
Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).
+
+
Maximum: 36
+
+
+
values
+
+
No
+
+
Array of strings
+
+
Tag value list.
+
If values are null, it indicates any_value. The relationship between values is OR.
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 5 Response body parameters
Parameter
+
+
Type
+
+
Description
+
+
+
+
action
+
+
String
+
+
Operation to be performed. The value can be only filter or count.
+
filter: queries data on multiple pages.
+
count: queries the total number of data records. The total number of data records is returned based on the search criteria.
+
+
Enumeration values:
+
filter
+
count
+
+
+
+
limit
+
+
String
+
+
Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1 to 1000.
+
Default: 1000
+
+
+
offset
+
+
String
+
+
Index position. The query starts from the next data record indexed by this parameter. When querying data on the first page, you do not need to pass this parameter. When querying data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. This parameter is not displayed when action is set to count. If action is set to filter, the value defaults to 0. The value must be a positive integer.
The return result contains resources corresponding to all tags in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string.
The return result contains resources corresponding to any tag in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys and the values of a key must be unique.
The return result does not contain resources corresponding to all tags in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys and the values of a key must be unique.
The return result does not contain resources corresponding to any tag in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique.
+
+
+
matches
+
+
String
+
+
Search criteria. The tag key is the field to match. Currently, only resource_name is supported. value indicates the matched value. This field is a fixed dictionary value.
+
+
+
+
+
+
+
Table 6 Tags
Parameter
+
+
Type
+
+
Description
+
+
+
+
key
+
+
String
+
+
Key.
+
This field cannot be left blank.
+
The key value of a resource must be unique.
+
Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).
+
+
Maximum: 36
+
+
+
values
+
+
Array of strings
+
+
Tag value list.
+
If values are null, it indicates any_value. The relationship between values is OR.
+
+
+
+
+
+
+
Example Requests
Resource (stream) filtering by tag and record querying
Name of the stream to which the checkpoint belongs.
+
+
+
partition_id
+
+
Yes
+
+
String
+
+
Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:
+
shardId-0000000000
+
0
+
+
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
+
+
+
app_name
+
+
Yes
+
+
String
+
+
Name of the app associated with the checkpoint.
+
+
+
checkpoint_type
+
+
Yes
+
+
String
+
+
Type of the checkpoint.
+
LAST_READ: Only sequence numbers are recorded in databases.
+
+
Enumeration values:
+
LAST_READ
+
+
+
+
+
+
+
+
Request Parameters
+
Table 3 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Response Parameters
Status code: 204
+
+
Table 4 Response body parameters
Parameter
+
+
Type
+
+
Description
+
+
+
+
sequence_number
+
+
String
+
+
Sequence number used to record the consumption checkpoint of the stream.
+
+
+
metadata
+
+
String
+
+
Metadata information of the consumer application.
+
+
+
+
+
+
+
Example Requests
Querying Checkpoint Details
+
GET https://{Endpoint}/v2/{project_id}/checkpoints
This API is used to query the monitoring data of a specified partition of a stream.
+
+
URI
GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream.
+
Maximum: 60
+
+
+
partition_id
+
+
Yes
+
+
String
+
+
Partition No. The value can be in either of the following formats:
+
shardId-0000000000
+
0
+
+
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
+
+
+
+
+
+
+
Table 2 Query parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
label
+
+
No
+
+
String
+
+
Partition monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.)
+
total_put_bytes_per_partition: total input traffic of the partition (byte)
+
total_get_bytes_per_partition: total output traffic of the partition (byte)
+
total_put_records_per_partition: total number of input records of the partition
+
total_get_records_per_partition: total number of output records of the partition
+
+
Enumeration values:
+
total_put_bytes_per_partition
+
total_get_bytes_per_partition
+
total_put_records_per_partition
+
total_get_records_per_partition
+
+
+
+
label_list
+
+
No
+
+
String
+
+
List of labels separated by commas (,) to query multiple labels in batches. (Either label or label_list must be specified. If both label_list and label exist, label_list prevails.)
+
+
+
start_time
+
+
Yes
+
+
Long
+
+
Monitoring start time, which is a 10-digit timestamp.
+
+
+
end_time
+
+
Yes
+
+
String
+
+
Monitoring end time, which is a 10-digit timestamp.
+
+
+
+
+
+
+
Request Parameters
+
Table 3 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
This API is used to query the monitoring data of specified streams.
+
+
URI
GET /v2/{project_id}/streams/{stream_name}/metrics
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream.
+
Maximum: 60
+
+
+
+
+
+
+
Table 2 Query parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
label
+
+
No
+
+
String
+
+
Stream monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.)
+
total_put_bytes_per_stream: total input traffic (byte)
+
total_get_bytes_per_stream: total output traffic (byte)
+
total_put_records_per_stream: total number of input records
+
total_get_records_per_stream: total number of output records
+
total_put_req_latency: average processing time of upload requests (millisecond)
+
total_get_req_latency: average processing time of download requests (millisecond)
+
total_put_req_suc_per_stream: number of successful upload requests
+
total_get_req_suc_per_stream: number of successful download requests
+
traffic_control_put: number of rejected upload requests due to flow control
+
traffic_control_get: number of rejected download requests due to flow control
+
+
Enumeration values:
+
total_put_bytes_per_stream
+
total_get_bytes_per_stream
+
total_put_records_per_stream
+
total_get_records_per_stream
+
total_put_req_latency
+
total_get_req_latency
+
total_put_req_suc_per_stream
+
total_get_req_suc_per_stream
+
traffic_control_put
+
traffic_control_get
+
+
+
+
label_list
+
+
No
+
+
String
+
+
List of labels separated by commas (,) to query multiple labels in batches. (Either label or label_list must be set. If both label_list and label exist, label_list prevails.)
+
+
+
start_time
+
+
Yes
+
+
Long
+
+
Monitoring start time, which is a 10-digit timestamp.
+
+
+
end_time
+
+
Yes
+
+
Long
+
+
Monitoring end time, which is a 10-digit timestamp.
+
+
+
+
+
+
+
Request Parameters
+
Table 3 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Parameter list of the CloudTable to which data in the DIS stream will be dumped.
+
+
+
+
+
+
+
Table 4 PartitionResult
Parameter
+
+
Type
+
+
Description
+
+
+
+
status
+
+
String
+
+
Current status of the partition. Possible values:
+
CREATING: The stream is being created.
ACTIVE: The stream is available.
DELETED: The stream is being deleted.
EXPIRED: The stream has expired.
+
Enumeration values:
+
CREATING
ACTIVE
DELETED
EXPIRED
+
+
+
partition_id
+
+
String
+
+
Unique identifier of the partition.
+
+
+
hash_range
+
+
String
+
+
Possible value range of the hash key used by the partition.
+
+
+
sequence_number_range
+
+
String
+
+
Sequence number range of the partition.
+
+
+
parent_partitions
+
+
String
+
+
Parent partition.
+
+
+
+
+
+
+
Table 5 OBSDestinationDescriptorRequest
Parameter
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
file_prefix
+
+
String
+
+
Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
Maximum: 50
+
+
+
partition_format
+
+
String
+
+
Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created).
+
N/A: Leave this parameter empty, indicating that the date and time directory is not used.
yyyy: year
yyyy/MM: year/month
yyyy/MM/dd: year/month/day
yyyy/MM/dd/HH: year/month/day/hour
yyyy/MM/dd/HH/mm: year/month/day/hour/minute
+
Example: in 2017/11/10/14/49, the directory structure is 2017 > 11 > 10 > 14 > 49. 2017 indicates the outermost folder.
+
Default value: empty.
+
Note:
+
After data is successfully dumped, the directory structure is obs_bucket_path/file_prefix/partition_format.
+
Enumeration values:
+
yyyy
yyyy/MM
yyyy/MM/dd
yyyy/MM/dd/HH
yyyy/MM/dd/HH/mm
+
+
+
obs_bucket_path
+
+
String
+
+
Name of the OBS bucket used to store data from the DIS stream.
+
+
+
destination_file_type
+
+
String
+
+
Dump file format. Possible values:
+
Text (default)
Parquet
CarbonData
+
Note:
+
You can select Parquet or CarbonData only when Source Data Type is set to JSON and Dump Destination is set to OBS.
Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
+
+
+
record_delimiter
+
+
String
+
+
Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
+
Value range:
+
Comma (,), which is the default value
Semicolon (;)
Vertical bar (|)
Newline character (\n)
+
Default: \n
+
+
+
+
+
+
+
Table 6 ProcessingSchema
Parameter
+
+
Type
+
+
Description
+
+
+
+
timestamp_name
+
+
String
+
+
Attribute name of the source data timestamp.
+
+
+
timestamp_type
+
+
String
+
+
Type of the source data timestamp.
+
String
Timestamp: 13-bit timestamp of the long type
+
+
+
timestamp_format
+
+
String
+
+
OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.
+
Value range:
+
yyyy/MM/dd HH:mm:ss
MM/dd/yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
yyyy-MM-dd HH:mm:ss
MM-dd-yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
+
Enumeration values:
+
yyyy/MM/dd HH:mm:ss
MM/dd/yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
yyyy-MM-dd HH:mm:ss
MM-dd-yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
+
+
+
+
+
+
+
Table 7 DWSDestinationDescriptorRequest
Parameter
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
dws_cluster_name
+
+
String
+
+
Name of the DWS cluster that stores the data in the stream.
+
+
+
dws_cluster_id
+
+
String
+
+
ID of the DWS cluster to which will be dumped.
+
+
+
dws_database_name
+
+
String
+
+
Name of the DWS database that stores the data in the stream.
+
+
+
dws_schema
+
+
String
+
+
Schema of the DWS database to which data will be dumped.
+
+
+
dws_table_name
+
+
String
+
+
Name of the DWS table that stores the data in the stream.
+
+
+
dws_delimiter
+
+
String
+
+
Delimiter used to separate the columns in the DWS tables.
+
The value can be a comma (,), semicolon (;), or vertical bar (|).
+
+
+
user_name
+
+
String
+
+
Username of the DWS database to which data will be dumped.
+
+
+
user_password
+
+
String
+
+
Password of the DWS database to which data will be dumped.
+
+
+
kms_user_key_name
+
+
String
+
+
Key created in Key Management Service (KMS) and used to encrypt the password of the DWS database.
+
+
+
kms_user_key_id
+
+
String
+
+
ID of the key created in KMS and used to encrypt the password of the DWS database.
+
+
+
obs_bucket_path
+
+
String
+
+
Name of the OBS bucket used to temporarily store data in the DIS stream.
+
+
+
file_prefix
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
+
+
retry_duration
+
+
String
+
+
Duration when you can constantly retry dumping data to DWS after the dump fails. If the dump time exceeds the value of this parameter, the data that fails to be dumped to DWS will be backed up to the OBS bucket/file_prefix/dws_error directory.
+
Value range: 0-7,200
+
Unit: second
+
Default value: 1,800
+
+
+
dws_table_columns
+
+
String
+
+
Column to be dumped to the DWS table. If the value is null or empty, all columns are dumped by default. For example, c1,c2 indicates that columns c1 and c2 in the schema are dumped to DWS.
DWS fault tolerance option (used to specify various parameters of foreign table data).
+
+
+
+
+
+
+
Table 8 Options
Parameter
+
+
Type
+
+
Description
+
+
+
+
fill_missing_fields
+
+
String
+
+
Specifies whether to set the field to Null or enable an error message to be displayed in the error table when the last field in a row of the data source file is missing during database import.
+
Value range:
+
true/on
false/off
+
Default value: false/off
+
Enumeration values:
+
true/on
false/off
+
+
+
ignore_extra_data
+
+
String
+
+
Specifies whether to ignore excessive columns when the number of columns in a source data file exceeds that defined in the foreign table. This parameter is used only during data import.
+
Value range:
+
true/on
false/off
+
Default value: false/off
+
Enumeration values:
+
true/on
false/off
+
+
+
compatible_illegal_chars
+
+
String
+
+
Specifies whether to tolerate invalid characters during data import. Specifies whether to convert invalid characters based on the conversion rule and import them to the database, or to report an error and stop the import.
+
Value range:
+
true/on
false/off
+
Default value: false/off
+
Enumeration values:
+
true/on
false/off
+
+
+
reject_limit
+
+
String
+
+
Maximum number of data format errors allowed during the data import. If the number of data format errors does not reach the maximum, the data import is successful.
+
Value range:
+
integer
unlimited
+
Default value: 0, indicating that error information is returned immediately
+
+
+
error_table_name
+
+
String
+
+
Name of the error table that records data format errors. After the parallel import is complete, you can query the error information table to obtain the detailed error information.
+
+
+
+
+
+
+
Table 9 MRSDestinationDescriptorRequest
Parameter
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
mrs_cluster_name
+
+
String
+
+
Name of the MRS cluster to which data in the DIS stream will be dumped.
+
Note:
+
Only MRS clusters with non-Kerberos authentication are supported.
+
+
+
mrs_cluster_id
+
+
String
+
+
ID of the MRS cluster to which data in the DIS stream will be dumped.
+
+
+
mrs_hdfs_path
+
+
String
+
+
Hadoop Distributed File System (HDFS) path of the MRS cluster to which data in the DIS stream will be dumped.
+
+
+
file_prefix
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
+
+
hdfs_prefix_folder
+
+
String
+
+
Directory to store files that will be dumped to the chosen MRS cluster. Different directory levels are separated by slash (/). Value range: a string of 0 to 50 characters This parameter is left empty by default.
+
+
+
obs_bucket_path
+
+
String
+
+
Name of the OBS bucket used to temporarily store data in the DIS stream.
+
+
+
retry_duration
+
+
String
+
+
Time duration for DIS to retry if data fails to be dumped. If the retry time exceeds the value of this parameter, the data that fails to be dumped is backed up to the OBS bucket/file_prefix/mrs_error directory.
+
Value range: 0-7,200
+
Unit: second
+
Default value: 1,800
+
If this parameter is set to 0, DIS does not retry when the dump fails.
+
+
+
+
+
+
+
Table 10 DliDestinationDescriptorRequest
Parameter
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
dli_database_name
+
+
String
+
+
Name of the DLI database to which data in the DIS stream will be dumped.
+
+
+
dli_table_name
+
+
String
+
+
Name of the DLI table to which data in the DIS stream will be dumped.
+
Note:
+
Only tables whose data location is DLI are supported, and you must have the permission to insert data into the tables.
+
+
+
obs_bucket_path
+
+
String
+
+
Name of the OBS bucket used to temporarily store data in the DIS stream.
+
+
+
file_prefix
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
+
+
retry_duration
+
+
String
+
+
Time duration for DIS to retry if data fails to be dumped to DLI. If the retry time exceeds the value of this parameter, the data that fails to be dumped is backed up to the OBS bucket/file_prefix/dli_error directory. Value range: 0-7,200 Unit: second Default value: 1,800 If this parameter is set to 0, DIS does not retry when the dump fails.
+
+
+
+
+
+
+
Table 11 CloudtableDestinationDescriptorRequest
Parameter
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
cloudtable_cluster_name
+
+
String
+
+
Name of the CloudTable cluster to which data will be dumped.
+
If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.
+
+
+
cloudtable_cluster_id
+
+
String
+
+
ID of the CloudTable cluster to which data will be dumped.
+
If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.
+
+
+
cloudtable_table_name
+
+
String
+
+
HBase table name of the CloudTable cluster to which data will be dumped. The parameter is mandatory when data is dumped to the CloudTable HBase.
Schema configuration of the CloudTable HBase data. You can set either this parameter or opentsdb_schema, but this parameter is mandatory when data will be dumped to HBase. After this parameter is set, the JSON data in the stream can be converted to another format and then be imported to the CloudTable HBase.
Schema configuration of the CloudTable OpenTSDB data. You can set either this parameter or opentsdb_schema, but this parameter is mandatory when data will be dumped to OpenTSDB. After this parameter is set, the JSON data in the stream can be converted to another format and then be imported to the CloudTable OpenTSDB.
+
+
+
cloudtable_row_key_delimiter
+
+
String
+
+
Delimiter used to separate the user data that generates HBase row keys. Value range: , . | ; \ - _ and ~
+
Default value: .
+
+
+
obs_backup_bucket_path
+
+
String
+
+
Name of the OBS bucket used to back up data that failed to be dumped to CloudTable.
+
+
+
backup_file_prefix
+
+
String
+
+
Self-defined directory created in the OBS bucket and used to back up data that failed to be dumped to CloudTable. Directory levels are separated by slashes (/) and cannot start with slashes.
+
Value range: a string of letters, digits, and underscores (_)
+
The maximum length is 50 characters.
+
This parameter is left empty by default.
+
+
+
retry_duration
+
+
String
+
+
Time duration for DIS to retry if data fails to be dumped to CloudTable. If this threshold is exceeded, the data that fails to be dumped will be backed up to the OBS bucket/backup_file_prefix /cloudtable_error or OBS bucket/backup_file_prefix/opentsdb_error directory.
Schema configuration of the OpenTSDB data metric in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the metric of the OpenTSDB data.
Schema configuration of the OpenTSDB data timestamp in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the timestamp of the OpenTSDB data.
Schema configuration of the OpenTSDB data value in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the value of the OpenTSDB data.
Schema configuration of the OpenTSDB data tags in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the tags of the OpenTSDB data.
+
+
+
+
+
+
+
Table 16 OpenTSDBMetric
Parameter
+
+
Type
+
+
Description
+
+
+
+
type
+
+
String
+
+
When type is set to Constant, the value of metric is the value of Value.
When value is set to String, the value of metric is the value of the JSON attribute of the user data in the stream.
+
Enumeration values:
+
Constant
String
+
+
+
value
+
+
String
+
+
Constant value or JSON attribute name of the user data in the stream. This value is 1 to 32 characters long. Only letters, digits, and periods (.) are allowed.
+
+
+
+
+
+
+
Table 17 OpenTSDBTimestamp
Parameter
+
+
Type
+
+
Description
+
+
+
+
type
+
+
String
+
+
When type is set to Timestamp, the value type of the JSON attribute of the user data in the stream is Timestamp, and the timestamp of OpenTSDB can be generated without converting the data format.
When type is set to String, the value type of the JSON attribute of the user data in the stream is Date, and the timestamp of OpenTSDB can be generated only after the data format is converted.
+
+
+
value
+
+
String
+
+
JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
format
+
+
String
+
+
This parameter is mandatory when type is set to String. When the value type of the JSON attribute of the user data in the stream is Date, format is required to convert the data format to generate the timestamp of OpenTSDB.
+
Value range:
+
yyyy/MM/dd HH:mm:ss
MM/dd/yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
yyyy-MM-dd HH:mm:ss
MM-dd-yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
+
Enumeration values:
+
yyyy/MM/dd HH:mm:ss
MM/dd/yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
yyyy-MM-dd HH:mm:ss
MM-dd-yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
+
+
+
+
+
+
+
Table 18 OpenTSDBValue
Parameter
+
+
Type
+
+
Description
+
+
+
+
type
+
+
String
+
+
Dump destination. Possible values: Value range:
+
Bigint
Double
Boolean
Timestamp
String
Decimal
+
+
+
value
+
+
String
+
+
Constant value or JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
+
+
+
+
Table 19 OpenTSDBTags
Parameter
+
+
Type
+
+
Description
+
+
+
+
name
+
+
String
+
+
Tag name of the OpenTSDB data that stores the data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
type
+
+
String
+
+
Type name of the JSON attribute of the user data in the stream.
+
Value range:
+
Bigint
Double
Boolean
Timestamp
String
Decimal
+
+
+
value
+
+
String
+
+
Constant value or JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)
+
+
+
+
+
+
+
Example Requests
Querying Dump Task Details
+
GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}
This API is used to change the number of partitions in a specific stream.
+
+
URI
PUT /v2/{project_id}/streams/{stream_name}
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream whose partition quantity needs to be changed.
+
Maximum: 64
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream whose partition quantity needs to be changed.
+
Maximum: 64
+
+
+
target_partition_count
+
+
Yes
+
+
Integer
+
+
Number of the target partitions.
+
The value is an integer greater than 0.
+
If the value is greater than the number of current partitions, scaling-up is required. If the value is less than the number of current partitions, scale-down is required.
+
Note: A maximum of five scale-up/down operations can be performed for each stream within one hour. If a scale-up/down operation is successfully performed, you cannot perform one more scale-up/down operation within the next one hour.
This API is used to update the information about specified streams.
+
+
URI
PUT /v3/{project_id}/streams/{stream_name}
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream whose partition quantity needs to be changed.
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream to be updated.
+
Maximum: 64
+
+
+
data_duration
+
+
No
+
+
Integer
+
+
Period of time for which data is retained in the stream. Value range: 24-72 Unit: hour Default value: 24 If this parameter is left blank, the default value is used.
+
Maximum: 168
+
Default: 24
+
+
+
data_type
+
+
No
+
+
String
+
+
Source data type.
+
BLOB: a collection of binary data stored as a single entity in a database management system.
+
JSON: an open-standard file format that uses human-readable text to transmit data objects consisting of attribute–value pairs and array data types.
+
CSV: a simple text format for storing tabular data in a plain text file. Commas are used as delimiters.
+
+
Default value: BLOB
+
Enumeration values:
+
BLOB
+
JSON
+
CSV
+
+
+
+
data_schema
+
+
No
+
+
String
+
+
Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema.
+
+
+
auto_scale_enabled
+
+
No
+
+
Boolean
+
+
Specifies whether to enable auto scaling.
+
true: auto scaling is enabled.
+
false: auto scaling is disabled. This function is disabled by default.
+
+
Default: false
+
Enumeration values:
+
true
+
false
+
+
+
+
auto_scale_min_partition_count
+
+
No
+
+
Long
+
+
Minimum number of partitions for automatic scale-down when auto scaling is enabled.
+
Minimum: 1
+
+
+
auto_scale_max_partition_count
+
+
No
+
+
Long
+
+
Maximum number of partitions for automatic scale-up when auto scaling is enabled.
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 applications.
+
The following describes how to create a DIS stream by calling the Before You Start API. For details, see Calling APIs.
The token obtained on IAM is valid for only 24 hours. If you want to use one token for authentication, you can cache it to avoid frequent calling.
+
+
+
+
Involved APIs
If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header of the API request.
+
API for obtaining a token from IAM
API for creating a DIS stream
+
+
Prerequisites
You have planned the region where DIS is located and determined the endpoint for calling an API based on the region.
+
An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. You can obtain endpoints from Regions and Endpoints.
+
+
Creating a Stream
The following is an example of creating a stream with the simplest configuration.
stream_name indicates the stream name, which can be customized, for example, newstream.
partition_count indicates the number of partitions. A partition is the base throughput unit of a DIS stream. You can specify the number of partitions based on your service throughput requirements.
stream_type indicates the stream type. COMMON indicates a common partition. A single partition supports a maximum of 1 MB/s for data writing and a maximum of 2 MB/s for data reading.
data_duration indicates the lifecycle of a stream, that is, the duration for storing data in the stream partition.
+
If the request is successful, 201 Created is returned.
+
If the request fails, an error code and error information are returned. For details, see Error Codes.
+
+
+
Creating a Stream That Supports Auto Scaling
You can also create a stream that supports auto scaling. The number of partitions can be automatically increased or decreased based on the stream traffic. The following is an example configuration:
In this example, a stream that supports auto scaling is created. The number of partitions to scale ranges from 2 to 10. If the stream has 10 partitions, auto scaling-out will not be triggered.
+
auto_scale_enabled specifies whether to enable auto scaling. The value true indicates that auto scaling is enabled.
auto_scale_min_partition_count indicates the minimum number of partitions allowed when auto scale-in is enabled. In this example, as there are two partitions, automatic scale-in will not be triggered.
auto_scale_max_partition_count indicates the maximum number of partitions allowed when auto scale-out is enabled. In this example, as there are 10 partitions, automatic scale-out will not be triggered.
+
If the request is successful, 201 Created is returned.
+
If the request fails, an error code and error information are returned. For details, see Error Codes.
+
+
+
Creating a Stream with Data Schemas
You can also configure a schema for the stream. When using DIS to dump data to other services, you can map data based on the schema configured for the stream. The following is an example configuration:
When creating a stream, specify a stream type (common or advanced) and the number of partitions.
+
By default, an account can create a maximum of 10 advanced stream partitions and 50 common stream partitions. You can submit a service ticket to increase the quota.
+
+
+
URI
POST /v2/{project_id}/streams
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
+
+
+
+
Request Parameters
+
Table 2 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream.
+
The stream name can contain 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-).
+
Maximum: 64
+
+
+
partition_count
+
+
Yes
+
+
Integer
+
+
Number of partitions. Partitions are the base throughput unit of a DIS stream.
+
+
+
stream_type
+
+
No
+
+
String
+
+
Stream type.
+
COMMON: a common stream. The bandwidth is 1 MB/s.
+
ADVANCED: an advanced stream. The bandwidth is 5 MB/s.
+
+
Enumeration values:
+
COMMON
+
ADVANCED
+
+
+
+
data_type
+
+
No
+
+
String
+
+
Source data type.
+
BLOB: a set of binary data stored in a database management system.
+
JSON: an open-source file format that uses readable text to transmit data objects consisting of attribute values or serialized values.
+
CSV: a simple text format for storing tabular data in a plain text file. Commas (,) are used as separators by default.
+
+
Default value: BLOB
+
Enumeration values:
+
BLOB
+
JSON
+
CSV
+
+
+
+
data_duration
+
+
No
+
+
Integer
+
+
Period of time for which data is retained in the stream. Value range: 24-72 Unit: hour Default value: 24 If this parameter is left blank, the default value is used.
+
Maximum: 168
+
Default: 24
+
+
+
auto_scale_enabled
+
+
No
+
+
Boolean
+
+
Specifies whether to enable auto scaling.
+
true: Auto scaling is enabled.
+
false: Auto scaling is disabled.
+
+
This function is disabled by default.
+
Default: false
+
+
+
auto_scale_min_partition_count
+
+
No
+
+
Long
+
+
Minimum number of partitions for automatic scale-down when auto scaling is enabled.
+
Minimum: 1
+
+
+
auto_scale_max_partition_count
+
+
No
+
+
Integer
+
+
Maximum number of partitions for automatic scale-up when auto scaling is enabled.
+
+
+
data_schema
+
+
No
+
+
String
+
+
Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema.
Data to be uploaded. The uploaded data is the serialized binary data (character string encoded using Base64). For example, if the character string data needs to be uploaded, the character string after Base64 encoding is ZGF0YQ==.
+
+
+
explicit_hash_key
+
+
No
+
+
String
+
+
Hash value of the data to be written to the partition. The hash value overwrites the hash value of partition_key. Value range: 0–long.max
+
+
+
partition_id
+
+
No
+
+
String
+
+
Partition ID of the stream. The value can be in either of the following formats:
+
shardId-0000000000
+
0
+
+
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
+
+
+
partition_key
+
+
No
+
+
String
+
+
Partition to which data is written to. Note:
+
If the partition_id parameter is transferred, the partition_id parameter is used preferentially. If partition_id is not transferred, partition_key is used.
Sequence number of the data to be uploaded. A sequence number is a unique identifier for each record. DIS automatically allocates a sequence number the data producer calls the PutRecords operation to add data to the DIS stream. Sequence number of the same partition key usually changes with time. A longer interval between PutRecords requests results in a larger sequence number.
The validity period of a data cursor is 5 minutes.
+
+
+
+
+
+
+
Table 5 Record
Parameter
+
+
Type
+
+
Description
+
+
+
+
partition_key
+
+
String
+
+
Partition key set when data is being uploaded.
+
Note:
+
If the partition_key parameter is passed when data is uploaded, this parameter will be returned when data is downloaded. If partition_id instead of partition_key is passed when data is uploaded, no partition_key is returned.
+
+
+
sequence_number
+
+
String
+
+
Sequence number of the data record.
+
+
+
data
+
+
String
+
+
Downloaded data.
+
The downloaded data is the serialized binary data (Base64-encoded character string).
+
For example, the data returned by the data download API is "ZGF0YQ==", which is "data" after Base64 decoding.
Partition ID of the stream. The value can be in either of the following formats:
+
shardId-0000000000
+
0
+
+
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
+
+
+
cursor-type
+
+
No
+
+
String
+
+
Cursor type.
+
AT_SEQUENCE_NUMBER: Data is read from the position denoted by a specific sequence number (that is defined by starting-sequence-number). This is the default cursor type.
+
AFTER_SEQUENCE_NUMBER: Data is read right after the position denoted by a specific sequence number (that is defined by starting-sequence-number).
+
TRIM_HORIZON: Data is read from the earliest data record in the partition. For example, a tenant uses a DIS stream to upload three pieces of data A1, A2, and A3. N days later, A1 has expired and A2 and A3 are still in the validity period. In this case, if the tenant uses TRIM_HORIZON to download the data, the system downloads data from A2.
+
LATEST: Data is read from the latest record in the partition. This setting ensures that you always read the latest record in the partition.
+
AT_TIMESTAMP: Data is read from the position denoted by a specific timestamp.
+
+
Enumeration values:
+
AT_SEQUENCE_NUMBER
+
AFTER_SEQUENCE_NUMBER
+
TRIM_HORIZON
+
LATEST
+
AT_TIMESTAMP
+
+
+
+
starting-sequence-number
+
+
No
+
+
String
+
+
Serial number. A sequence number is a unique identifier for each record. DIS automatically allocates a sequence number when the data producer calls the PutRecords operation to add data to the DIS stream. SN of the same partition key usually changes with time. A longer interval between PutRecords requests results in a larger sequence number.
+
The sequence number is closely related to cursor types AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. The two parameters determine the position of the data to be read.
+
Value range: 0 to 9,223,372,036,854,775,807
+
+
+
timestamp
+
+
No
+
+
Long
+
+
Timestamp when the data record starts to be read, which is closely related to cursor type AT_TIMESTAMP. The two parameters determine the position of the data to be read.
+
Note:
+
The timestamp is accurate to milliseconds.
+
+
+
+
+
+
+
Request Parameters
+
Table 3 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 4 Response body parameters
Parameter
+
+
Type
+
+
Description
+
+
+
+
partition_cursor
+
+
String
+
+
Data cursor. Value range: a string of 1 to 512 characters
+
Note:
+
The validity period of a data cursor is 5 minutes.
A status code is an HTTPS response issued by DIS to indicate whether an API request has been successfully completed.
+
+
Status Code
+
+
Status
+
+
Description
+
+
+
+
100
+
+
Continue
+
+
The server has received the initial part of the request and the client should continue to send the remaining part.
+
It is issued on a provisional basis while request processing continues. It alerts the client to wait for a final response.
+
+
+
101
+
+
Switching Protocols
+
+
The requester has asked the server to switch protocols and the server has agreed to do so. The target protocol must be more advanced than the source protocol.
+
For example, the current HTTP protocol is switched to a later version of HTTP.
+
+
+
200
+
+
OK
+
+
The server has successfully processed the request.
+
+
+
201
+
+
Created
+
+
The request has been fulfilled, resulting in the creation of a new resource.
+
+
+
202
+
+
Accepted
+
+
The request has been accepted for processing, but the processing has not been completed.
+
+
+
203
+
+
Non-Authoritative Information
+
+
The server successfully processed the request, but is returning information that may be from another source.
+
+
+
204
+
+
NoContent
+
+
The server has successfully processed the request, but does not return any content.
+
The status code is returned in response to an HTTPS OPTIONS request.
+
+
+
205
+
+
Reset Content
+
+
The server has successfully processed the request, but does not return any content. Unlike a 204 response, this response requires that the requester reset the content.
+
+
+
206
+
+
Partial Content
+
+
The server has successfully processed a part of the GET request.
+
+
+
300
+
+
Multiple Choices
+
+
There are multiple options for the requested resource. For example, this code could be used to present a list of resource characteristics and addresses from which the client such as a browser may choose.
+
+
+
301
+
+
Moved Permanently
+
+
This and all future requests should be permanently directed to the given URI indicated in this response.
+
+
+
302
+
+
Found
+
+
The requested resource was temporarily moved.
+
+
+
303
+
+
See Other
+
+
The response to the request can be found under another URI using a GET or POST method.
+
+
+
304
+
+
Not Modified
+
+
The requested resource has not been modified. In such a case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.
+
+
+
305
+
+
Use Proxy
+
+
The requested resource is available only through a proxy.
+
+
+
306
+
+
Unused
+
+
This HTTP status code is no longer used.
+
+
+
400
+
+
BadRequest
+
+
The request is invalid.
+
The client should modify the request instead of re-initiating it.
+
+
+
401
+
+
Unauthorized
+
+
The authentication information provided by the client is incorrect or invalid.
+
+
+
402
+
+
Payment Required
+
+
Reserved for future use.
+
+
+
403
+
+
Forbidden
+
+
The server has received the request and understood it, but the server is refusing to respond to it.
+
The client should modify the request instead of re-initiating it.
+
+
+
404
+
+
NotFound
+
+
The requested resource could not be found.
+
The client should modify the request instead of re-initiating it.
+
+
+
405
+
+
MethodNotAllowed
+
+
A request method is not supported for the requested resource.
+
The client should modify the request instead of re-initiating it.
+
+
+
406
+
+
Not Acceptable
+
+
The server could not fulfill the request according to the content characteristics of the request.
+
+
+
407
+
+
Proxy Authentication Required
+
+
This code is similar to 401, but indicates that the client must first authenticate itself with the proxy.
+
+
+
408
+
+
Request Time-out
+
+
The server timed out waiting for the request.
+
The client may re-initiate the request without modifications at any later time.
+
+
+
409
+
+
Conflict
+
+
The request could not be processed due to a conflict in the request.
+
For example, an edit conflict between multiple simultaneous updates or the resource that the client attempts to create already exists.
+
+
+
410
+
+
Gone
+
+
The requested resource has been deleted permanently and will not be available again.
+
The status code indicates that the requested resource has been deleted permanently.
+
+
+
411
+
+
Length Required
+
+
The server refused to process the request because the request does not specify the length of its content.
+
+
+
412
+
+
Precondition Failed
+
+
The server does not meet one of the preconditions that the requester puts on the request.
+
+
+
413
+
+
Request Entity Too Large
+
+
The request is larger than the server is willing or able to process. The server may close the connection to prevent the client from continuing the request. If the server temporarily cannot process the request, the response will contain a Retry-After header field.
+
+
+
414
+
+
Request-URI Too Large
+
+
The URI provided was too long for the server to process.
+
+
+
415
+
+
Unsupported Media Type
+
+
The server does not support the media type in the request.
+
+
+
416
+
+
Requested range not satisfiable
+
+
The requested range is invalid.
+
+
+
417
+
+
Expectation Failed
+
+
The server fails to meet the requirements of the Expect request-header field.
+
+
+
422
+
+
UnprocessableEntity
+
+
The request was well-formed but was unable to be followed due to semantic errors.
+
+
+
429
+
+
TooManyRequests
+
+
The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.
+
+
+
441
+
+
Authentication Error
+
+
Authentication fails.
+
+
+
500
+
+
InternalServerError
+
+
The server is able to receive the request but it could not understand the request.
+
+
+
501
+
+
Not Implemented
+
+
The server does not support the requested function.
+
+
+
502
+
+
Bad Gateway
+
+
The server was acting as a gateway or proxy and received an invalid request from a remote server.
+
+
+
503
+
+
ServiceUnavailable
+
+
The requested service is invalid.
+
The client should modify the request instead of re-initiating it.
+
+
+
504
+
+
ServerTimeout
+
+
The server could not return a timely response. The response will reach the client only if the request carries a timeout parameter.
+
+
+
505
+
+
HTTP Version not supported
+
+
The server does not support the HTTP protocol version used in the request.
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 streams to be returned for a single request.
+
+
URI
GET /v2/{project_id}/streams
+
+
Table 1 Path parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
+
+
+
+
Table 2 Query parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
limit
+
+
No
+
+
Integer
+
+
The maximum number of DIS streams to list in a single API call.
+
Value range: 1-100 Default value: 10
+
Minimum: 1
+
Maximum: 100
+
Default: 10
+
+
+
start_stream_name
+
+
No
+
+
String
+
+
Name of the DIS stream to start the stream list with. The returned stream list does not contain this DIS stream name.
+
If pagination query is required, this parameter is not transferred for query on the first page. If the value of has_more_streams is true, the query is performed on the next page. The value of start_stream_name is the name of the last stream in the query result of the first page.
+
+
+
+
+
+
+
Request Parameters
+
Table 3 Request header parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
X-Auth-Token
+
+
Yes
+
+
String
+
+
User token.
+
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Response Parameters
Status code: 200
+
+
Table 4 Response body parameters
Parameter
+
+
Type
+
+
Description
+
+
+
+
total_number
+
+
Long
+
+
Total number of all the DIS streams created by the current tenant.
+
+
+
stream_names
+
+
Array of strings
+
+
List of the streams meeting the current requests.
+
+
+
has_more_streams
+
+
Boolean
+
+
Specify whether there are more matching DIS streams to list. Possible values:
A list of partitions that comprise the DIS stream.
+
+
+
has_more_partitions
+
+
Boolean
+
+
Specifies whether there are more matching partitions of the DIS stream to list.
+
true: yes
+
false: no
+
+
+
+
retention_period
+
+
Integer
+
+
Period for storing data in units of hours.
+
+
+
stream_id
+
+
String
+
+
Unique identifier of the stream.
+
+
+
data_type
+
+
String
+
+
Source data type.
+
BLOB: a set of binary data stored in a database management system.
+
JSON: an open-source file format that uses readable text to transmit data objects consisting of attribute values or serialized values.
+
CSV: a simple text format for storing tabular data in a plain text file. Commas (,) are used as separators by default.
+
+
Default value: BLOB
+
Enumeration values:
+
BLOB
+
JSON
+
CSV
+
+
+
+
data_schema
+
+
String
+
+
Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema. For details about Avro, go to http://avro.apache.org/docs/current/
+
+
+
compression_format
+
+
String
+
+
Compression type of data. Currently, the value can be:
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.
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 token can then be used to authenticate the calling of other APIs.
Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
+
+
Table 1 URI parameter description
Parameter
+
+
Description
+
+
+
+
URI-scheme
+
+
Protocol used to transmit requests. All APIs use HTTPS.
+
+
+
Endpoint
+
+
Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
+
+
+
resource-path
+
+
Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
+
+
+
query-string
+
+
Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.
+
+
+
+
+
+
To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
+
+
+
Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server:
+
Table 2 HTTP methods
Method
+
+
Description
+
+
+
+
GET
+
+
Requests the server to return specified resources.
+
+
+
PUT
+
+
Requests the server to update specified resources.
+
+
+
POST
+
+
Requests the server to add resources or perform special operations.
+
+
+
DELETE
+
+
Requests the server to delete specified resources, for example, an object.
+
+
+
HEAD
+
+
Same as GET except that the server must return only the response header.
+
+
+
PATCH
+
+
Requests the server to update partial content of a specified resource.
+
If the resource does not exist, a new resource will be created.
+
+
+
+
+
+
+
For example, in the case of the API used to obtain a user token, the request method is POST, and the request is as follows:
+
+
Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for HTTPS is 443.
+
+
No
+
This field is mandatory for AK/SK authentication.
+
+
code.test.com
+
or
+
code.test.com:443
+
+
+
Content-Type
+
+
Specifies the request body MIME type. Its default value is application/json. Other values of this field will be provided for specific APIs if any.
+
+
Yes
+
+
application/json
+
+
+
Content-Length
+
+
Specifies the length of the request body. The unit is byte.
+
+
No
+
+
3495
+
+
+
X-Project-Id
+
+
Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.
+
+
No
+
+
e9993fc787d94b6c886cbaa340f9c0f4
+
+
+
X-Auth-Token
+
+
Specifies the user token.
+
It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.
+
After the request is processed, the value of X-Subject-Token in the header is the token value.
+
+
No
+
This field is mandatory for token authentication.
+
+
The following is part of an example token:
+
MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
+
+
+
+
+
+
+
In addition to supporting token-based authentication, APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign the request, and the Authorization (signature authentication) and X-Sdk-Date (time when the request is sent) header fields are automatically added to the request.
+
For more information, see "AK/SK-based Authentication" in Authentication.
+
+
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
+
+
(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format as specified in the Content-Type header field, such as JSON or XML. The request body transfers content except the request header.
+
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
+
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with the actual values. To learn how to obtain a project ID, see Obtaining a Project ID.
+
The scope parameter specifies where a token takes effect. In the following example, the token takes effect only for the resources in a specified project. You can set scope to a domain or a project under a domain. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see obtaining a user token.
If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
app_name
+
+
Yes
+
+
String
+
+
Name of the app, which is the unique identifier of a user data consumption program.
+
+
+
checkpoint_type
+
+
Yes
+
+
String
+
+
Type of the checkpoint.
+
LAST_READ: Only sequence numbers are recorded in databases.
+
+
Enumeration values:
+
LAST_READ
+
+
+
+
stream_name
+
+
Yes
+
+
String
+
+
Name of the stream.
+
+
+
partition_id
+
+
Yes
+
+
String
+
+
Partition identifier of the stream. The value can be in either of the following formats:
+
shardId-0000000000
+
0
+
+
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
+
+
+
sequence_number
+
+
Yes
+
+
String
+
+
Sequence number to be submitted, which is used to record the consumption checkpoint of the stream. Ensure that the sequence number is within the valid range.
+
+
+
metadata
+
+
No
+
+
String
+
+
Metadata information of the consumer application.
+
The metadata information can contain a maximum of 1,000 characters.
Parameter list of OBS to which data in the DIS stream will be dumped.
+
+
+
+
+
+
+
Table 4 OBSDestinationDescriptorRequest
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
task_name
+
+
Yes
+
+
String
+
+
Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
+
+
+
agency_name
+
+
Yes
+
+
String
+
+
Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:
+
Agency Type: Cloud service
Cloud Service: DIS
Validity Period: unlimited
Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.
+
If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.
+
This parameter cannot be left blank and the parameter value cannot exceed 64 characters.
+
If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.
+
Maximum: 64
+
+
+
deliver_time_interval
+
+
Yes
+
+
Integer
+
+
User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.
+
Value range: 30-900
+
Default value: 300
+
Unit: second
+
Minimum: 30
+
Maximum: 900
+
Default: 300
+
+
+
consumer_strategy
+
+
No
+
+
String
+
+
Offset.
+
LATEST: Maximum offset, indicating that the latest data will be extracted.
TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
+
Default value: LATEST
+
Default: LATEST
+
Enumeration values:
+
LATEST
TRIM_HORIZON
+
+
+
file_prefix
+
+
No
+
+
String
+
+
Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
+
The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).
+
This parameter is left empty by default.
+
Maximum: 50
+
+
+
partition_format
+
+
No
+
+
String
+
+
Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created).
+
N/A: Leave this parameter empty, indicating that the date and time directory is not used.
yyyy: year
yyyy/MM: year/month
yyyy/MM/dd: year/month/day
yyyy/MM/dd/HH: year/month/day/hour
yyyy/MM/dd/HH/mm: year/month/day/hour/minute
+
Example: in 2017/11/10/14/49, the directory structure is 2017 > 11 > 10 > 14 > 49. 2017 indicates the outermost folder.
+
Default value: empty.
+
Note:
+
After data is successfully dumped, the directory structure is obs_bucket_path/file_prefix/partition_format.
+
Enumeration values:
+
yyyy
yyyy/MM
yyyy/MM/dd
yyyy/MM/dd/HH
yyyy/MM/dd/HH/mm
+
+
+
obs_bucket_path
+
+
Yes
+
+
String
+
+
Name of the OBS bucket used to store data from the DIS stream.
+
+
+
destination_file_type
+
+
No
+
+
String
+
+
Dump file format. Possible values:
+
Text (default)
Parquet
CarbonData
+
Note:
+
You can select Parquet or CarbonData only when Source Data Type is set to JSON and Dump Destination is set to OBS.
Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
+
+
+
record_delimiter
+
+
No
+
+
String
+
+
Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
+
Value range:
+
Comma (,), which is the default value
Semicolon (;)
Vertical bar (|)
Newline character (\n)
+
Default: \n
+
+
+
+
+
+
+
Table 5 ProcessingSchema
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
timestamp_name
+
+
Yes
+
+
String
+
+
Attribute name of the source data timestamp.
+
+
+
timestamp_type
+
+
Yes
+
+
String
+
+
Type of the source data timestamp.
+
String
Timestamp: 13-bit timestamp of the long type
+
+
+
timestamp_format
+
+
No
+
+
String
+
+
OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.
The API for obtaining the project ID is GET https://{Endpoint}/v3/projects/, where Endpoint indicates the endpoint of IAM. You can obtain the endpoint from Regions and Endpoints. For details about API authentication, see Authentication.
+
The following is an example response. The value of id is the project ID. If multiple IDs are returned, obtain the desired project ID based on the actual region (name).
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.
A 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 passwords and grant user permissions. The domain is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.
+
User
A user is created using an accounta domain to use cloud services. Each user has its own identity credentials (password and access keys).
+
The account, username, and password will be required for API authentication.
+
Project
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and create resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
+
Figure 1 Project isolating model
+
Checkpoint
When an application consumes data, the latest SN of the consumed data is recorded as a checkpoint. When the data is reconsumed, the consumption can be continued based on this checkpoint.
+
Application
Multiple applications can consume data in the same stream. The consumed data in the stream by each application is recorded by checkpoints generated for each application.
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 authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it is more secure than token-based authentication.
+
+
Token-based Authentication
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
+
+
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to a request to get permissions for calling the API.
+
When calling the API to obtain a user token, you must set auth.scope in the request body to project.
After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs, for example, the API used to query a connection list. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token-based authentication is recommended.
+
+
In AK/SK-based authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
+
AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
+
To obtain an access key, perform the following steps:
Log in to the management console, move the cursor to the username in the upper right corner, and select My Credentials from the drop-down list.
On the My Credentials page, choose Access Keys, and click Create Access Key. See Figure 1.
Figure 1 Clicking Create Access Key
+
Click OK and save the access key file as prompted. The access key file will be saved to your browser's configured download location. Open the credentials.csv file to view Access Key Id and Secret Access Key.
+
+
In AK/SK-based authentication, you can use an AK/SK to sign requests based on the signature algorithm or use the signing SDK to sign requests.
The signing SDKs are only used for signing requests and different from the SDKs provided by services.
+
+
+
\ No newline at end of file
diff --git a/docs/dis/api-ref/dis_02_0518.html b/docs/dis/api-ref/dis_02_0518.html
new file mode 100644
index 000000000..be94a243a
--- /dev/null
+++ b/docs/dis/api-ref/dis_02_0518.html
@@ -0,0 +1,46 @@
+
+
+
Response
+
Status Code
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 5xx. It indicates the status of a request. For more information, see Status Codes.
+
For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
+
+
Response Header
Similar to a request, a response also has a header, for example, Content-Type.
+
Figure 1 shows the response header fields for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
+
Figure 1 Header fields of the response to the request for obtaining a user token
+
+
(Optional) Response Body
The body of a response is often returned in structured format as specified in the Content-Type header field, such as JSON or XML. The response body transfers content except the response header.
+
+
The following is part of the response body for the API used to obtain a user token.
+
+
+
\ No newline at end of file
diff --git a/docs/dis/api-ref/dis_02_0600.html b/docs/dis/api-ref/dis_02_0600.html
new file mode 100644
index 000000000..8c5c43714
--- /dev/null
+++ b/docs/dis/api-ref/dis_02_0600.html
@@ -0,0 +1,12 @@
+
+
+
Overview
+
Welcome to Data Ingestion Service API Reference. Data Ingestion Service (DIS) provides efficient collection, transmission, and distribution capabilities for real-time IoT and Internet data, supports multiple IoT protocols, and provides various APIs to help you quickly build real-time data applications.
+
This document describes how to use application programming interfaces (APIs) to perform operations on DIS, such as uploading or downloading data. For details about all supported operations, see API Overview.
+
If you plan to access DIS through an API, ensure that you are familiar with DIS concepts. For details, see "Service Overview" in the DIS User Guide.
diff --git a/docs/dis/api-ref/en-us_image_0000001135802808.png b/docs/dis/api-ref/en-us_image_0000001135802808.png
new file mode 100644
index 000000000..323d460df
Binary files /dev/null and b/docs/dis/api-ref/en-us_image_0000001135802808.png differ
diff --git a/docs/dis/api-ref/en-us_image_0000001238312593.jpg b/docs/dis/api-ref/en-us_image_0000001238312593.jpg
new file mode 100644
index 000000000..b0e263d9b
Binary files /dev/null and b/docs/dis/api-ref/en-us_image_0000001238312593.jpg differ
diff --git a/docs/dis/api-ref/en-us_image_0170647338.png b/docs/dis/api-ref/en-us_image_0170647338.png
new file mode 100644
index 000000000..c0f166719
Binary files /dev/null and b/docs/dis/api-ref/en-us_image_0170647338.png differ
diff --git a/docs/dis/api-ref/en-us_image_0170787737.gif b/docs/dis/api-ref/en-us_image_0170787737.gif
new file mode 100644
index 000000000..cfbc91a43
Binary files /dev/null and b/docs/dis/api-ref/en-us_image_0170787737.gif differ
diff --git a/docs/dis/api-ref/en-us_topic_0000001079240698.html b/docs/dis/api-ref/en-us_topic_0000001079240698.html
new file mode 100644
index 000000000..81112ac72
--- /dev/null
+++ b/docs/dis/api-ref/en-us_topic_0000001079240698.html
@@ -0,0 +1,442 @@
+
+
+
Permissions Policies and Supported Actions
+
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 default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on DIS based on the permissions.
+
You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism provided by IAM that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
+
Note:
+
Policy-based authorization is useful if you want to allow or deny the access to an API.
+
An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries MRS clusters using an API, the user must have been granted permissions that allow the dis:streams:list action.
+
Supported Actions
+
DIS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+
· Permission: A statement in a policy that allows or denies certain operations.
+
· APIs: REST APIs that can be called in a custom policy.
+
· Action: Specific operations that are allowed or denied.
+
· IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM.
+
Note:
+
The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.
+
Table 1 lists the actions that can be defined in custom policies of DIS. All actions listed in the following table support both Project and Enterprise Project.
+
+
Table 1 Permissions policies and supported actions
Note: For the actions not listed Table 1, for example, viewing app quota (/{projectId}/quotas) and viewing DIS resource statistics on the homepage (/v1/{projectId}/statistics), configure system-defined policy DIS User, DIS ReadOnlyAccess, DIS CommonOperations, or DIS FullAccess for users.
+
diff --git a/docs/dis/api-ref/public_sys-resources/ExpandCollapse.js b/docs/dis/api-ref/public_sys-resources/ExpandCollapse.js
new file mode 100644
index 000000000..3f1b7db00
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/ExpandCollapse.js
@@ -0,0 +1 @@
+var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}};
\ No newline at end of file
diff --git a/docs/dis/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/dis/api-ref/public_sys-resources/caution_3.0-en-us.png
new file mode 100644
index 000000000..60f607621
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/caution_3.0-en-us.png differ
diff --git a/docs/dis/api-ref/public_sys-resources/commonltr.css b/docs/dis/api-ref/public_sys-resources/commonltr.css
new file mode 100644
index 000000000..c5480b0ab
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/commonltr.css
@@ -0,0 +1 @@
+body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}
\ No newline at end of file
diff --git a/docs/dis/api-ref/public_sys-resources/commonltr_print.css b/docs/dis/api-ref/public_sys-resources/commonltr_print.css
new file mode 100644
index 000000000..a59823141
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/commonltr_print.css
@@ -0,0 +1 @@
+body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm}
\ No newline at end of file
diff --git a/docs/dis/api-ref/public_sys-resources/commonrtl.css b/docs/dis/api-ref/public_sys-resources/commonrtl.css
new file mode 100644
index 000000000..947a9a033
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/commonrtl.css
@@ -0,0 +1,2 @@
+.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
+*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
\ No newline at end of file
diff --git a/docs/dis/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/dis/api-ref/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 000000000..47a9c7235
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/dis/api-ref/public_sys-resources/delta.gif b/docs/dis/api-ref/public_sys-resources/delta.gif
new file mode 100644
index 000000000..0d1b1f674
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/delta.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/deltaend.gif b/docs/dis/api-ref/public_sys-resources/deltaend.gif
new file mode 100644
index 000000000..cc7da0fc8
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/deltaend.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/dis/api-ref/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 000000000..84eec9be2
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dis/api-ref/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 000000000..39583d168
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-caution.gif b/docs/dis/api-ref/public_sys-resources/icon-caution.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-caution.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-danger.gif b/docs/dis/api-ref/public_sys-resources/icon-danger.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-danger.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-huawei.gif b/docs/dis/api-ref/public_sys-resources/icon-huawei.gif
new file mode 100644
index 000000000..a31d60f89
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-note.gif b/docs/dis/api-ref/public_sys-resources/icon-note.gif
new file mode 100644
index 000000000..31be2b039
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-note.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-notice.gif b/docs/dis/api-ref/public_sys-resources/icon-notice.gif
new file mode 100644
index 000000000..409070650
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-notice.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-tip.gif b/docs/dis/api-ref/public_sys-resources/icon-tip.gif
new file mode 100644
index 000000000..c47bae05c
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-tip.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/icon-warning.gif b/docs/dis/api-ref/public_sys-resources/icon-warning.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/icon-warning.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/imageResize.js b/docs/dis/api-ref/public_sys-resources/imageResize.js
new file mode 100644
index 000000000..e4c520739
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/imageResize.js
@@ -0,0 +1,4 @@
+/** IDP renames $ to $$$,jQueryHW2 */
+var $$$,jQueryHW2;
+jQueryHW2 = $$$ = $;
+function image_size(a){$$$(window).on('load',function(){$$$(a).each(function(){var e=$$$(this);var f=e.width();var d=e.height();var b=f;var c=d;e.click(function(){tb_show("",this.src,false)})})})};
\ No newline at end of file
diff --git a/docs/dis/api-ref/public_sys-resources/imageclose.gif b/docs/dis/api-ref/public_sys-resources/imageclose.gif
new file mode 100644
index 000000000..56818c26b
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/imageclose.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/imageclosehover.gif b/docs/dis/api-ref/public_sys-resources/imageclosehover.gif
new file mode 100644
index 000000000..3bcf231f1
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/imageclosehover.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/imagemax.gif b/docs/dis/api-ref/public_sys-resources/imagemax.gif
new file mode 100644
index 000000000..49fe390b1
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/imagemax.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/imagemaxhover.gif b/docs/dis/api-ref/public_sys-resources/imagemaxhover.gif
new file mode 100644
index 000000000..387b0a981
Binary files /dev/null and b/docs/dis/api-ref/public_sys-resources/imagemaxhover.gif differ
diff --git a/docs/dis/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/dis/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
new file mode 100644
index 000000000..fc18734e9
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
@@ -0,0 +1,2 @@
+/*! jQuery Migrate v1.2.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */
+jQueryHW2.migrateMute===void 0&&(jQueryHW2.migrateMute=!0),function(e,t,n){function r(n){var r=t.console;i[n]||(i[n]=!0,e.migrateWarnings.push(n),r&&r.warn&&!e.migrateMute&&(r.warn("JQMIGRATE: "+n),e.migrateTrace&&r.trace&&r.trace()))}function a(t,a,i,o){if(Object.defineProperty)try{return Object.defineProperty(t,a,{configurable:!0,enumerable:!0,get:function(){return r(o),i},set:function(e){r(o),i=e}}),n}catch(s){}e._definePropertyBroken=!0,t[a]=i}var i={};e.migrateWarnings=[],!e.migrateMute&&t.console&&t.console.log&&t.console.log("JQMIGRATE: Logging is active"),e.migrateTrace===n&&(e.migrateTrace=!0),e.migrateReset=function(){i={},e.migrateWarnings.length=0},"BackCompat"===document.compatMode&&r("jQueryHW2 is not compatible with Quirks Mode");var o=e("",{size:1}).attr("size")&&e.attrFn,s=e.attr,u=e.attrHooks.value&&e.attrHooks.value.get||function(){return null},c=e.attrHooks.value&&e.attrHooks.value.set||function(){return n},l=/^(?:input|button)$/i,d=/^[238]$/,p=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,f=/^(?:checked|selected)$/i;a(e,"attrFn",o||{},"jQueryHW2.attrFn is deprecated"),e.attr=function(t,a,i,u){var c=a.toLowerCase(),g=t&&t.nodeType;return u&&(4>s.length&&r("jQueryHW2.fn.attr( props, pass ) is deprecated"),t&&!d.test(g)&&(o?a in o:e.isFunction(e.fn[a])))?e(t)[a](i):("type"===a&&i!==n&&l.test(t.nodeName)&&t.parentNode&&r("Can't change the 'type' of an input or button in IE 6/7/8"),!e.attrHooks[c]&&p.test(c)&&(e.attrHooks[c]={get:function(t,r){var a,i=e.prop(t,r);return i===!0||"boolean"!=typeof i&&(a=t.getAttributeNode(r))&&a.nodeValue!==!1?r.toLowerCase():n},set:function(t,n,r){var a;return n===!1?e.removeAttr(t,r):(a=e.propFix[r]||r,a in t&&(t[a]=!0),t.setAttribute(r,r.toLowerCase())),r}},f.test(c)&&r("jQueryHW2.fn.attr('"+c+"') may use property instead of attribute")),s.call(e,t,a,i))},e.attrHooks.value={get:function(e,t){var n=(e.nodeName||"").toLowerCase();return"button"===n?u.apply(this,arguments):("input"!==n&&"option"!==n&&r("jQueryHW2.fn.attr('value') no longer gets properties"),t in e?e.value:null)},set:function(e,t){var a=(e.nodeName||"").toLowerCase();return"button"===a?c.apply(this,arguments):("input"!==a&&"option"!==a&&r("jQueryHW2.fn.attr('value', val) no longer sets properties"),e.value=t,n)}};var g,h,v=e.fn.init,m=e.parseJSON,y=/^([^<]*)(<[\w\W]+>)([^>]*)$/;e.fn.init=function(t,n,a){var i;return t&&"string"==typeof t&&!e.isPlainObject(n)&&(i=y.exec(e.trim(t)))&&i[0]&&("<"!==t.charAt(0)&&r("$(html) HTML strings must start with '<' character"),i[3]&&r("$(html) HTML text after last tag is ignored"),"#"===i[0].charAt(0)&&(r("HTML string cannot start with a '#' character"),e.error("JQMIGRATE: Invalid selector string (XSS)")),n&&n.context&&(n=n.context),e.parseHTML)?v.call(this,e.parseHTML(i[2],n,!0),n,a):v.apply(this,arguments)},e.fn.init.prototype=e.fn,e.parseJSON=function(e){return e||null===e?m.apply(this,arguments):(r("jQueryHW2.parseJSON requires a valid JSON string"),null)},e.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||0>e.indexOf("compatible")&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e.browser||(g=e.uaMatch(navigator.userAgent),h={},g.browser&&(h[g.browser]=!0,h.version=g.version),h.chrome?h.webkit=!0:h.webkit&&(h.safari=!0),e.browser=h),a(e,"browser",e.browser,"jQueryHW2.browser is deprecated"),e.sub=function(){function t(e,n){return new t.fn.init(e,n)}e.extend(!0,t,this),t.superclass=this,t.fn=t.prototype=this(),t.fn.constructor=t,t.sub=this.sub,t.fn.init=function(r,a){return a&&a instanceof e&&!(a instanceof t)&&(a=t(a)),e.fn.init.call(this,r,a,n)},t.fn.init.prototype=t.fn;var n=t(document);return r("jQueryHW2.sub() is deprecated"),t},e.ajaxSetup({converters:{"text json":e.parseJSON}});var b=e.fn.data;e.fn.data=function(t){var a,i,o=this[0];return!o||"events"!==t||1!==arguments.length||(a=e.data(o,t),i=e._data(o,t),a!==n&&a!==i||i===n)?b.apply(this,arguments):(r("Use of jQueryHW2.fn.data('events') is deprecated"),i)};var j=/\/(java|ecma)script/i,w=e.fn.andSelf||e.fn.addBack;e.fn.andSelf=function(){return r("jQueryHW2.fn.andSelf() replaced by jQueryHW2.fn.addBack()"),w.apply(this,arguments)},e.clean||(e.clean=function(t,a,i,o){a=a||document,a=!a.nodeType&&a[0]||a,a=a.ownerDocument||a,r("jQueryHW2.clean() is deprecated");var s,u,c,l,d=[];if(e.merge(d,e.buildFragment(t,a).childNodes),i)for(c=function(e){return!e.type||j.test(e.type)?o?o.push(e.parentNode?e.parentNode.removeChild(e):e):i.appendChild(e):n},s=0;null!=(u=d[s]);s++)e.nodeName(u,"script")&&c(u)||(i.appendChild(u),u.getElementsByTagName!==n&&(l=e.grep(e.merge([],u.getElementsByTagName("script")),c),d.splice.apply(d,[s+1,0].concat(l)),s+=l.length));return d});var Q=e.event.add,x=e.event.remove,k=e.event.trigger,N=e.fn.toggle,T=e.fn.live,M=e.fn.die,S="ajaxStart|ajaxStop|ajaxSend|ajaxComplete|ajaxError|ajaxSuccess",C=RegExp("\\b(?:"+S+")\\b"),H=/(?:^|\s)hover(\.\S+|)\b/,A=function(t){return"string"!=typeof t||e.event.special.hover?t:(H.test(t)&&r("'hover' pseudo-event is deprecated, use 'mouseenter mouseleave'"),t&&t.replace(H,"mouseenter$1 mouseleave$1"))};e.event.props&&"attrChange"!==e.event.props[0]&&e.event.props.unshift("attrChange","attrName","relatedNode","srcElement"),e.event.dispatch&&a(e.event,"handle",e.event.dispatch,"jQueryHW2.event.handle is undocumented and deprecated"),e.event.add=function(e,t,n,a,i){e!==document&&C.test(t)&&r("AJAX events should be attached to document: "+t),Q.call(this,e,A(t||""),n,a,i)},e.event.remove=function(e,t,n,r,a){x.call(this,e,A(t)||"",n,r,a)},e.fn.error=function(){var e=Array.prototype.slice.call(arguments,0);return r("jQueryHW2.fn.error() is deprecated"),e.splice(0,0,"error"),arguments.length?this.bind.apply(this,e):(this.triggerHandler.apply(this,e),this)},e.fn.toggle=function(t,n){if(!e.isFunction(t)||!e.isFunction(n))return N.apply(this,arguments);r("jQueryHW2.fn.toggle(handler, handler...) is deprecated");var a=arguments,i=t.guid||e.guid++,o=0,s=function(n){var r=(e._data(this,"lastToggle"+t.guid)||0)%o;return e._data(this,"lastToggle"+t.guid,r+1),n.preventDefault(),a[r].apply(this,arguments)||!1};for(s.guid=i;a.length>o;)a[o++].guid=i;return this.click(s)},e.fn.live=function(t,n,a){return r("jQueryHW2.fn.live() is deprecated"),T?T.apply(this,arguments):(e(this.context).on(t,this.selector,n,a),this)},e.fn.die=function(t,n){return r("jQueryHW2.fn.die() is deprecated"),M?M.apply(this,arguments):(e(this.context).off(t,this.selector||"**",n),this)},e.event.trigger=function(e,t,n,a){return n||C.test(e)||r("Global events are undocumented and deprecated"),k.call(this,e,t,n||document,a)},e.each(S.split("|"),function(t,n){e.event.special[n]={setup:function(){var t=this;return t!==document&&(e.event.add(document,n+"."+e.guid,function(){e.event.trigger(n,null,t,!0)}),e._data(this,n,e.guid++)),!1},teardown:function(){return this!==document&&e.event.remove(document,n+"."+e._data(this,n)),!1}}})}(jQueryHW2,window);
\ No newline at end of file
diff --git a/docs/dis/api-ref/public_sys-resources/jquery-ui.min.js b/docs/dis/api-ref/public_sys-resources/jquery-ui.min.js
new file mode 100644
index 000000000..ba0b043dc
--- /dev/null
+++ b/docs/dis/api-ref/public_sys-resources/jquery-ui.min.js
@@ -0,0 +1,12 @@
+/*! jQuery UI - v1.12.1 - 2016-10-02
+* Includes: widget.js, position.js, data.js, disable-selection.js, focusable.js, form-reset-mixin.js, jquery-1-7.js, keycode.js, labels.js, scroll-parent.js, tabbable.js, unique-id.js, widgets/draggable.js, widgets/droppable.js, widgets/resizable.js, widgets/selectable.js, widgets/sortable.js, widgets/accordion.js, widgets/autocomplete.js, widgets/button.js, widgets/checkboxradio.js, widgets/controlgroup.js, widgets/datepicker.js, widgets/dialog.js, widgets/menu.js, widgets/mouse.js, widgets/progressbar.js, widgets/selectmenu.js, widgets/slider.js, widgets/spinner.js, widgets/tabs.js, widgets/tooltip.js, effect.js, effects/effect-blind.js, effects/effect-bounce.js, effects/effect-clip.js, effects/effect-drop.js, effects/effect-explode.js, effects/effect-fade.js, effects/effect-fold.js, effects/effect-highlight.js, effects/effect-puff.js, effects/effect-pulsate.js, effects/effect-scale.js, effects/effect-shake.js, effects/effect-size.js, effects/effect-slide.js, effects/effect-transfer.js
+* Copyright jQueryHW2 Foundation and other contributors; Licensed MIT */
+
+(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):t(jQueryHW2)})(function(t){function e(t){for(var e=t.css("visibility");"inherit"===e;)t=t.parent(),e=t.css("visibility");return"hidden"!==e}function i(t){for(var e,i;t.length&&t[0]!==document;){if(e=t.css("position"),("absolute"===e||"relative"===e||"fixed"===e)&&(i=parseInt(t.css("zIndex"),10),!isNaN(i)&&0!==i))return i;t=t.parent()}return 0}function s(){this._curInst=null,this._keyEvent=!1,this._disabledInputs=[],this._datepickerShowing=!1,this._inDialog=!1,this._mainDivId="ui-datepicker-div",this._inlineClass="ui-datepicker-inline",this._appendClass="ui-datepicker-append",this._triggerClass="ui-datepicker-trigger",this._dialogClass="ui-datepicker-dialog",this._disableClass="ui-datepicker-disabled",this._unselectableClass="ui-datepicker-unselectable",this._currentClass="ui-datepicker-current-day",this._dayOverClass="ui-datepicker-days-cell-over",this.regional=[],this.regional[""]={closeText:"Done",prevText:"Prev",nextText:"Next",currentText:"Today",monthNames:["January","February","March","April","May","June","July","August","September","October","November","December"],monthNamesShort:["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],dayNames:["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],dayNamesShort:["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],dayNamesMin:["Su","Mo","Tu","We","Th","Fr","Sa"],weekHeader:"Wk",dateFormat:"mm/dd/yy",firstDay:0,isRTL:!1,showMonthAfterYear:!1,yearSuffix:""},this._defaults={showOn:"focus",showAnim:"fadeIn",showOptions:{},defaultDate:null,appendText:"",buttonText:"...",buttonImage:"",buttonImageOnly:!1,hideIfNoPrevNext:!1,navigationAsDateFormat:!1,gotoCurrent:!1,changeMonth:!1,changeYear:!1,yearRange:"c-10:c+10",showOtherMonths:!1,selectOtherMonths:!1,showWeek:!1,calculateWeek:this.iso8601Week,shortYearCutoff:"+10",minDate:null,maxDate:null,duration:"fast",beforeShowDay:null,beforeShow:null,onSelect:null,onChangeMonthYear:null,onClose:null,numberOfMonths:1,showCurrentAtPos:0,stepMonths:1,stepBigMonths:12,altField:"",altFormat:"",constrainInput:!0,showButtonPanel:!1,autoSize:!1,disabled:!1},t.extend(this._defaults,this.regional[""]),this.regional.en=t.extend(!0,{},this.regional[""]),this.regional["en-US"]=t.extend(!0,{},this.regional.en),this.dpDiv=n(t(""))}function n(e){var i="button, .ui-datepicker-prev, .ui-datepicker-next, .ui-datepicker-calendar td a";return e.on("mouseout",i,function(){t(this).removeClass("ui-state-hover"),-1!==this.className.indexOf("ui-datepicker-prev")&&t(this).removeClass("ui-datepicker-prev-hover"),-1!==this.className.indexOf("ui-datepicker-next")&&t(this).removeClass("ui-datepicker-next-hover")}).on("mouseover",i,o)}function o(){t.datepicker._isDisabledDatepicker(p.inline?p.dpDiv.parent()[0]:p.input[0])||(t(this).parents(".ui-datepicker-calendar").find("a").removeClass("ui-state-hover"),t(this).addClass("ui-state-hover"),-1!==this.className.indexOf("ui-datepicker-prev")&&t(this).addClass("ui-datepicker-prev-hover"),-1!==this.className.indexOf("ui-datepicker-next")&&t(this).addClass("ui-datepicker-next-hover"))}function a(e,i){t.extend(e,i);for(var s in i)null==i[s]&&(e[s]=i[s]);return e}function r(t){return function(){var e=this.element.val();t.apply(this,arguments),this._refresh(),e!==this.element.val()&&this._trigger("change")}}t.ui=t.ui||{},t.ui.version="1.12.1";var h=0,l=Array.prototype.slice;t.cleanData=function(e){return function(i){var s,n,o;for(o=0;null!=(n=i[o]);o++)try{s=t._data(n,"events"),s&&s.remove&&t(n).triggerHandler("remove")}catch(a){}e(i)}}(t.cleanData),t.widget=function(e,i,s){var n,o,a,r={},h=e.split(".")[0];e=e.split(".")[1];var l=h+"-"+e;return s||(s=i,i=t.Widget),t.isArray(s)&&(s=t.extend.apply(null,[{}].concat(s))),t.expr[":"][l.toLowerCase()]=function(e){return!!t.data(e,l)},t[h]=t[h]||{},n=t[h][e],o=t[h][e]=function(t,e){return this._createWidget?(arguments.length&&this._createWidget(t,e),void 0):new o(t,e)},t.extend(o,n,{version:s.version,_proto:t.extend({},s),_childConstructors:[]}),a=new i,a.options=t.widget.extend({},a.options),t.each(s,function(e,s){return t.isFunction(s)?(r[e]=function(){function t(){return i.prototype[e].apply(this,arguments)}function n(t){return i.prototype[e].apply(this,t)}return function(){var e,i=this._super,o=this._superApply;return this._super=t,this._superApply=n,e=s.apply(this,arguments),this._super=i,this._superApply=o,e}}(),void 0):(r[e]=s,void 0)}),o.prototype=t.widget.extend(a,{widgetEventPrefix:n?a.widgetEventPrefix||e:e},r,{constructor:o,namespace:h,widgetName:e,widgetFullName:l}),n?(t.each(n._childConstructors,function(e,i){var s=i.prototype;t.widget(s.namespace+"."+s.widgetName,o,i._proto)}),delete n._childConstructors):i._childConstructors.push(o),t.widget.bridge(e,o),o},t.widget.extend=function(e){for(var i,s,n=l.call(arguments,1),o=0,a=n.length;a>o;o++)for(i in n[o])s=n[o][i],n[o].hasOwnProperty(i)&&void 0!==s&&(e[i]=t.isPlainObject(s)?t.isPlainObject(e[i])?t.widget.extend({},e[i],s):t.widget.extend({},s):s);return e},t.widget.bridge=function(e,i){var s=i.prototype.widgetFullName||e;t.fn[e]=function(n){var o="string"==typeof n,a=l.call(arguments,1),r=this;return o?this.length||"instance"!==n?this.each(function(){var i,o=t.data(this,s);return"instance"===n?(r=o,!1):o?t.isFunction(o[n])&&"_"!==n.charAt(0)?(i=o[n].apply(o,a),i!==o&&void 0!==i?(r=i&&i.jquery?r.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+n+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+n+"'")}):r=void 0:(a.length&&(n=t.widget.extend.apply(null,[n].concat(a))),this.each(function(){var e=t.data(this,s);e?(e.option(n||{}),e._init&&e._init()):t.data(this,s,new i(n,this))})),r}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
