From 83fa2f6615435b7752557849469137bf03ba6ca2 Mon Sep 17 00:00:00 2001 From: "Xiong, Chen Xiao" Date: Tue, 27 Jun 2023 15:26:05 +0000 Subject: [PATCH] DIS API 20230116 version Reviewed-by: Kacur, Michal Co-authored-by: Xiong, Chen Xiao Co-committed-by: Xiong, Chen Xiao --- docs/dis/api-ref/.placeholder | 0 docs/dis/api-ref/ALL_META.TXT.json | 154 +-- docs/dis/api-ref/BatchCreateTags.html | 27 +- docs/dis/api-ref/BatchDeleteTags.html | 26 +- docs/dis/api-ref/BatchStartTransferTask.html | 7 +- docs/dis/api-ref/BatchStopTransferTask.html | 7 +- docs/dis/api-ref/CLASS.TXT.json | 203 ++-- docs/dis/api-ref/CreateApp.html | 83 +- .../api-ref/CreateCloudTableTransferTask.html | 685 -------------- docs/dis/api-ref/CreateDliTransferTask.html | 246 ----- docs/dis/api-ref/CreateDwsTransferTask.html | 445 --------- docs/dis/api-ref/CreateMrsTransferTask.html | 287 ------ docs/dis/api-ref/CreatePolicies.html | 177 ---- docs/dis/api-ref/CreateTag.html | 23 +- docs/dis/api-ref/DeleteApp.html | 7 +- docs/dis/api-ref/DeleteCheckpoint.html | 116 ++- docs/dis/api-ref/DeleteStream.html | 7 +- docs/dis/api-ref/DeleteTag.html | 7 +- docs/dis/api-ref/DeleteTransferTask.html | 7 +- docs/dis/api-ref/ErrorCode.html | 560 +++++------ docs/dis/api-ref/ListApp.html | 176 ++-- docs/dis/api-ref/ListPolicies.html | 185 ---- docs/dis/api-ref/ListResourcesByTags.html | 279 +++--- docs/dis/api-ref/ListTags.html | 19 +- docs/dis/api-ref/ListTransferTasks.html | 171 ++-- docs/dis/api-ref/ShowApp.html | 7 +- docs/dis/api-ref/ShowCheckpoint.html | 136 ++- docs/dis/api-ref/ShowConsumerState.html | 229 +++-- docs/dis/api-ref/ShowPartitionMetrics.html | 24 +- docs/dis/api-ref/ShowStreamMetrics.html | 31 +- docs/dis/api-ref/ShowStreamTags.html | 23 +- docs/dis/api-ref/ShowTransferTask.html | 877 +----------------- docs/dis/api-ref/UpdatePartitionCount.html | 12 +- docs/dis/api-ref/UpdateStream.html | 183 ---- docs/dis/api-ref/dis_02_0003.html | 11 +- docs/dis/api-ref/dis_02_0015.html | 1 + docs/dis/api-ref/dis_02_0016_01.html | 351 +++---- docs/dis/api-ref/dis_02_0018.html | 197 ++-- docs/dis/api-ref/dis_02_0019.html | 25 +- docs/dis/api-ref/dis_02_0020.html | 41 +- docs/dis/api-ref/dis_02_0022.html | 1 + docs/dis/api-ref/dis_02_0023.html | 17 +- docs/dis/api-ref/dis_02_0024.html | 330 +++---- docs/dis/api-ref/dis_02_0025.html | 533 +++++------ docs/dis/api-ref/dis_02_0200.html | 1 + docs/dis/api-ref/dis_02_0400.html | 4 +- docs/dis/api-ref/dis_02_0403.html | 134 ++- docs/dis/api-ref/dis_02_0410.html | 13 +- docs/dis/api-ref/dis_02_0500.html | 1 + docs/dis/api-ref/dis_02_0501.html | 13 +- docs/dis/api-ref/dis_02_0511.html | 1 + docs/dis/api-ref/dis_02_0512.html | 1 + docs/dis/api-ref/dis_02_0513.html | 1 + docs/dis/api-ref/dis_02_0514.html | 1 + docs/dis/api-ref/dis_02_0515.html | 9 +- docs/dis/api-ref/dis_02_0516.html | 1 + docs/dis/api-ref/dis_02_0517.html | 61 +- docs/dis/api-ref/dis_02_0518.html | 9 +- docs/dis/api-ref/dis_02_0600.html | 1 + ...8312593.jpg => en-us_image_0191919629.jpg} | Bin .../api-ref/en-us_topic_0000001079240698.html | 399 ++------ .../public_sys-resources/icon-arrowdn.gif | Bin 68 -> 1887 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 70 -> 1890 bytes .../public_sys-resources/imageclose.gif | Bin 155 -> 0 bytes .../public_sys-resources/imageclosehover.gif | Bin 179 -> 0 bytes .../api-ref/public_sys-resources/imagemax.gif | Bin 181 -> 0 bytes .../public_sys-resources/imagemaxhover.gif | Bin 185 -> 0 bytes .../public_sys-resources/macFFBgHack.png | Bin 207 -> 0 bytes docs/dis/api-ref/topic_300000000.html | 7 +- docs/dis/api-ref/topic_300000001.html | 1 + docs/dis/api-ref/topic_300000002.html | 1 + docs/dis/api-ref/topic_300000003.html | 1 + docs/dis/api-ref/topic_300000004.html | 11 +- docs/dis/api-ref/topic_300000005.html | 1 + docs/dis/api-ref/topic_300000006.html | 1 + 75 files changed, 1942 insertions(+), 5664 deletions(-) delete mode 100644 docs/dis/api-ref/.placeholder delete mode 100644 docs/dis/api-ref/CreateCloudTableTransferTask.html delete mode 100644 docs/dis/api-ref/CreateDliTransferTask.html delete mode 100644 docs/dis/api-ref/CreateDwsTransferTask.html delete mode 100644 docs/dis/api-ref/CreateMrsTransferTask.html delete mode 100644 docs/dis/api-ref/CreatePolicies.html delete mode 100644 docs/dis/api-ref/ListPolicies.html delete mode 100644 docs/dis/api-ref/UpdateStream.html rename docs/dis/api-ref/{en-us_image_0000001238312593.jpg => en-us_image_0191919629.jpg} (100%) delete mode 100644 docs/dis/api-ref/public_sys-resources/imageclose.gif delete mode 100644 docs/dis/api-ref/public_sys-resources/imageclosehover.gif delete mode 100644 docs/dis/api-ref/public_sys-resources/imagemax.gif delete mode 100644 docs/dis/api-ref/public_sys-resources/imagemaxhover.gif delete mode 100644 docs/dis/api-ref/public_sys-resources/macFFBgHack.png diff --git a/docs/dis/api-ref/.placeholder b/docs/dis/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/dis/api-ref/ALL_META.TXT.json b/docs/dis/api-ref/ALL_META.TXT.json index 31bde217..670d3f3c 100644 --- a/docs/dis/api-ref/ALL_META.TXT.json +++ b/docs/dis/api-ref/ALL_META.TXT.json @@ -143,7 +143,7 @@ "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", + "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.A maximum of 10 advanced stream partit", "doc_type":"api", "kw":"Creating Streams,Stream Management,API Reference", "title":"Creating Streams", @@ -153,7 +153,7 @@ "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 ", + "des":"This API is used to query all the streams created by the current tenant.During query, you need to specify the stream from which the stream list is returned and the maximu", "doc_type":"api", "kw":"Querying Streams,Stream Management,API Reference", "title":"Querying Streams", @@ -189,40 +189,10 @@ "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", + "code":"20", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"App Management", @@ -232,7 +202,7 @@ { "uri":"CreateApp.html", "product_code":"dis", - "code":"24", + "code":"21", "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", @@ -242,7 +212,7 @@ { "uri":"ListApp.html", "product_code":"dis", - "code":"25", + "code":"22", "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", @@ -252,7 +222,7 @@ { "uri":"DeleteApp.html", "product_code":"dis", - "code":"26", + "code":"23", "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", @@ -262,7 +232,7 @@ { "uri":"ShowApp.html", "product_code":"dis", - "code":"27", + "code":"24", "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", @@ -272,7 +242,7 @@ { "uri":"ShowConsumerState.html", "product_code":"dis", - "code":"28", + "code":"25", "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", @@ -282,7 +252,7 @@ { "uri":"topic_300000002.html", "product_code":"dis", - "code":"29", + "code":"26", "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", @@ -292,7 +262,7 @@ { "uri":"dis_02_0403.html", "product_code":"dis", - "code":"30", + "code":"27", "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", @@ -302,7 +272,7 @@ { "uri":"ShowCheckpoint.html", "product_code":"dis", - "code":"31", + "code":"28", "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", @@ -312,7 +282,7 @@ { "uri":"DeleteCheckpoint.html", "product_code":"dis", - "code":"32", + "code":"29", "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", @@ -322,7 +292,7 @@ { "uri":"topic_300000003.html", "product_code":"dis", - "code":"33", + "code":"30", "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", @@ -332,7 +302,7 @@ { "uri":"dis_02_0018.html", "product_code":"dis", - "code":"34", + "code":"31", "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", @@ -342,7 +312,7 @@ { "uri":"dis_02_0019.html", "product_code":"dis", - "code":"35", + "code":"32", "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", @@ -352,7 +322,7 @@ { "uri":"dis_02_0020.html", "product_code":"dis", - "code":"36", + "code":"33", "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", @@ -362,7 +332,7 @@ { "uri":"topic_300000004.html", "product_code":"dis", - "code":"37", + "code":"34", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Dump Task Management", @@ -372,7 +342,7 @@ { "uri":"dis_02_0410.html", "product_code":"dis", - "code":"38", + "code":"35", "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", @@ -382,17 +352,17 @@ { "uri":"ListTransferTasks.html", "product_code":"dis", - "code":"39", + "code":"36", "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", + "kw":"Querying Dump Task,Dump Task Management,API Reference", + "title":"Querying Dump Task", "githuburl":"" }, { "uri":"DeleteTransferTask.html", "product_code":"dis", - "code":"40", + "code":"37", "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", @@ -402,7 +372,7 @@ { "uri":"ShowTransferTask.html", "product_code":"dis", - "code":"41", + "code":"38", "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", @@ -412,7 +382,7 @@ { "uri":"BatchStartTransferTask.html", "product_code":"dis", - "code":"42", + "code":"39", "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", @@ -422,57 +392,17 @@ { "uri":"BatchStopTransferTask.html", "product_code":"dis", - "code":"43", + "code":"40", "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", + "code":"41", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Monitoring Management", @@ -482,7 +412,7 @@ { "uri":"ShowStreamMetrics.html", "product_code":"dis", - "code":"49", + "code":"42", "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", @@ -492,7 +422,7 @@ { "uri":"ShowPartitionMetrics.html", "product_code":"dis", - "code":"50", + "code":"43", "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", @@ -502,7 +432,7 @@ { "uri":"topic_300000006.html", "product_code":"dis", - "code":"51", + "code":"44", "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", @@ -512,7 +442,7 @@ { "uri":"CreateTag.html", "product_code":"dis", - "code":"52", + "code":"45", "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", @@ -522,7 +452,7 @@ { "uri":"ShowStreamTags.html", "product_code":"dis", - "code":"53", + "code":"46", "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", @@ -532,7 +462,7 @@ { "uri":"DeleteTag.html", "product_code":"dis", - "code":"54", + "code":"47", "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", @@ -542,7 +472,7 @@ { "uri":"BatchCreateTags.html", "product_code":"dis", - "code":"55", + "code":"48", "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", @@ -552,7 +482,7 @@ { "uri":"ListTags.html", "product_code":"dis", - "code":"56", + "code":"49", "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", @@ -562,7 +492,7 @@ { "uri":"ListResourcesByTags.html", "product_code":"dis", - "code":"57", + "code":"50", "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", @@ -572,7 +502,7 @@ { "uri":"BatchDeleteTags.html", "product_code":"dis", - "code":"58", + "code":"51", "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", @@ -582,7 +512,7 @@ { "uri":"en-us_topic_0000001079240698.html", "product_code":"dis", - "code":"59", + "code":"52", "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", @@ -592,7 +522,7 @@ { "uri":"dis_02_0500.html", "product_code":"dis", - "code":"60", + "code":"53", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -602,7 +532,7 @@ { "uri":"ErrorCode.html", "product_code":"dis", - "code":"61", + "code":"54", "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", @@ -612,7 +542,7 @@ { "uri":"dis_02_0022.html", "product_code":"dis", - "code":"62", + "code":"55", "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", @@ -622,7 +552,7 @@ { "uri":"dis_02_0501.html", "product_code":"dis", - "code":"63", + "code":"56", "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", @@ -632,7 +562,7 @@ { "uri":"dis_02_0023.html", "product_code":"dis", - "code":"64", + "code":"57", "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", diff --git a/docs/dis/api-ref/BatchCreateTags.html b/docs/dis/api-ref/BatchCreateTags.html index 4f7f4784..58351092 100644 --- a/docs/dis/api-ref/BatchCreateTags.html +++ b/docs/dis/api-ref/BatchCreateTags.html @@ -5,7 +5,7 @@

URI

POST /v2/{project_id}/stream/{stream_id}/tags/action

-
Table 1 Path parameters

Parameter

+
@@ -54,8 +54,8 @@ - @@ -78,9 +78,7 @@ - - -
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

String

Operation to be performed. The value can be create only.

-
  • create: batch creation

    -
+

Operation to be performed. The value can only be create, which indicates batch creation.

Enumeration values:

  • create

@@ -115,10 +113,10 @@

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

    +

Key

+
  • It cannot be left blank.

    +
  • It must be unique for each resource.

    +
  • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

Minimum: 1

Maximum: 36

@@ -130,10 +128,10 @@

String

Value.

-
  • The value contains a maximum of 43 characters.

    -
  • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

    -
  • The value can contain only digits, letters, hyphens (-), and underscores (_).

    +

Value

+
  • It can contain a maximum of 43 characters.

    +
  • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

    +
  • It can only contain digits, letters, hyphens (-), and underscores (_).

Minimum: 0

Maximum: 43

@@ -185,3 +183,4 @@ + diff --git a/docs/dis/api-ref/BatchDeleteTags.html b/docs/dis/api-ref/BatchDeleteTags.html index 28e2ebde..4667814f 100644 --- a/docs/dis/api-ref/BatchDeleteTags.html +++ b/docs/dis/api-ref/BatchDeleteTags.html @@ -5,7 +5,7 @@

URI

POST /v2/{project_id}/stream/{stream_id}/tags/action

-
Table 1 Path parameters

Parameter

+
@@ -54,8 +54,7 @@ - @@ -78,9 +77,7 @@ - - -
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

String

Operation to be performed. The value can be delete only.

-
  • delete: batch deletion

    -
+

Operation to be performed. The value can only be delete, which indicates batch deletion.

Enumeration values:

  • delete

@@ -115,10 +112,10 @@

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

    +

Key

+
  • It cannot be left blank.

    +
  • It must be unique for each resource.

    +
  • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

Minimum: 1

Maximum: 36

@@ -130,10 +127,10 @@

String

Value.

-
  • The value contains a maximum of 43 characters.

    -
  • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

    -
  • The value can contain only digits, letters, hyphens (-), and underscores (_).

    +

Value

+
  • It can contain a maximum of 43 characters.

    +
  • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

    +
  • It can only contain digits, letters, hyphens (-), and underscores (_).

Minimum: 0

Maximum: 43

@@ -185,3 +182,4 @@ + diff --git a/docs/dis/api-ref/BatchStartTransferTask.html b/docs/dis/api-ref/BatchStartTransferTask.html index f19315e5..2261d95b 100644 --- a/docs/dis/api-ref/BatchStartTransferTask.html +++ b/docs/dis/api-ref/BatchStartTransferTask.html @@ -5,7 +5,7 @@

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action

-
Table 1 Path parameters

Parameter

+
@@ -55,9 +55,7 @@ -
Table 1 Path Parameters

Parameter

Mandatory

String

Dump task operation. Currently, only the following operation is supported:

-
  • start: The dump task is started.

    -
+

Dump task operation. The value can only be start, which indicates starting a dump task.

Enumeration values:

  • start

@@ -137,3 +135,4 @@ + diff --git a/docs/dis/api-ref/BatchStopTransferTask.html b/docs/dis/api-ref/BatchStopTransferTask.html index ba1e9fce..9f097a73 100644 --- a/docs/dis/api-ref/BatchStopTransferTask.html +++ b/docs/dis/api-ref/BatchStopTransferTask.html @@ -5,7 +5,7 @@

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action

-
Table 1 Path parameters

Parameter

+
@@ -55,9 +55,7 @@ -
Table 1 Path Parameters

Parameter

Mandatory

String

Dump task operation. Currently, only the following operation is supported:

-
  • stop: The dump task is stopped.

    -
+

Dump task operation. The value can only be stop, which indicates stopping a dump task.

Enumeration values:

  • stop

@@ -137,3 +135,4 @@ + diff --git a/docs/dis/api-ref/CLASS.TXT.json b/docs/dis/api-ref/CLASS.TXT.json index d1339c71..fd0d4f77 100644 --- a/docs/dis/api-ref/CLASS.TXT.json +++ b/docs/dis/api-ref/CLASS.TXT.json @@ -126,7 +126,7 @@ "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", + "desc":"This API is used to create a stream.When creating a stream, specify a stream type (common or advanced) and the number of partitions.A maximum of 10 advanced stream partit", "product_code":"dis", "title":"Creating Streams", "uri":"dis_02_0016_01.html", @@ -135,7 +135,7 @@ "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 ", + "desc":"This API is used to query all the streams created by the current tenant.During query, you need to specify the stream from which the stream list is returned and the maximu", "product_code":"dis", "title":"Querying Streams", "uri":"dis_02_0024.html", @@ -170,33 +170,6 @@ "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", @@ -204,7 +177,7 @@ "uri":"topic_300000001.html", "doc_type":"api", "p_code":"13", - "code":"23" + "code":"20" }, { "desc":"This API is used to create consumption apps.POST /v2/{project_id}/appsNoneCreating Consumption AppsNoneSee Error Codes.", @@ -212,8 +185,8 @@ "title":"Creating Consumption Apps", "uri":"CreateApp.html", "doc_type":"api", - "p_code":"23", - "code":"24" + "p_code":"20", + "code":"21" }, { "desc":"This API is used to query apps.GET /v2/{project_id}/appsStatus code: 200Querying AppsStatus code: 200Normal response.See Error Codes.", @@ -221,8 +194,8 @@ "title":"Querying Apps", "uri":"ListApp.html", "doc_type":"api", - "p_code":"23", - "code":"25" + "p_code":"20", + "code":"22" }, { "desc":"This API is used to delete apps.DELETE /v2/{project_id}/apps/{app_name}NoneDeleting AppsNoneSee Error Codes.", @@ -230,8 +203,8 @@ "title":"Deleting Apps", "uri":"DeleteApp.html", "doc_type":"api", - "p_code":"23", - "code":"26" + "p_code":"20", + "code":"23" }, { "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.", @@ -239,8 +212,8 @@ "title":"Querying App Details", "uri":"ShowApp.html", "doc_type":"api", - "p_code":"23", - "code":"27" + "p_code":"20", + "code":"24" }, { "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", @@ -248,8 +221,8 @@ "title":"Querying App Consumption Status", "uri":"ShowConsumerState.html", "doc_type":"api", - "p_code":"23", - "code":"28" + "p_code":"20", + "code":"25" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -258,7 +231,7 @@ "uri":"topic_300000002.html", "doc_type":"api", "p_code":"13", - "code":"29" + "code":"26" }, { "desc":"This API is used to submit checkpoints.POST /v2/{project_id}/checkpointsNoneSubmitting CheckpointsNoneSee Error Codes.", @@ -266,8 +239,8 @@ "title":"Submitting Checkpoints", "uri":"dis_02_0403.html", "doc_type":"api", - "p_code":"29", - "code":"30" + "p_code":"26", + "code":"27" }, { "desc":"This API is used to query checkpoint details.GET /v2/{project_id}/checkpointsStatus code: 204Querying Checkpoint DetailsStatus code: 204Normal response.See Error Codes.", @@ -275,8 +248,8 @@ "title":"Querying Checkpoint Details", "uri":"ShowCheckpoint.html", "doc_type":"api", - "p_code":"29", - "code":"31" + "p_code":"26", + "code":"28" }, { "desc":"This API is used to delete checkpoints.DELETE /v2/{project_id}/checkpointsNoneDeleting CheckpointsNoneSee Error Codes.", @@ -284,8 +257,8 @@ "title":"Deleting Checkpoints", "uri":"DeleteCheckpoint.html", "doc_type":"api", - "p_code":"29", - "code":"32" + "p_code":"26", + "code":"29" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -294,7 +267,7 @@ "uri":"topic_300000003.html", "doc_type":"api", "p_code":"13", - "code":"33" + "code":"30" }, { "desc":"This API is used to upload data to DIS streams.POST /v2/{project_id}/recordsStatus code: 200Uploading DataNoneSee Error Codes.", @@ -302,8 +275,8 @@ "title":"Uploading Data", "uri":"dis_02_0018.html", "doc_type":"api", - "p_code":"33", - "code":"34" + "p_code":"30", + "code":"31" }, { "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.", @@ -311,8 +284,8 @@ "title":"Downloading Data", "uri":"dis_02_0019.html", "doc_type":"api", - "p_code":"33", - "code":"35" + "p_code":"30", + "code":"32" }, { "desc":"This API is used to obtain data cursors.GET /v2/{project_id}/cursorsStatus code: 200Obtaining Data CursorsStatus code: 200Normal response.See Error Codes.", @@ -320,8 +293,8 @@ "title":"Obtaining Data Cursors", "uri":"dis_02_0020.html", "doc_type":"api", - "p_code":"33", - "code":"36" + "p_code":"30", + "code":"33" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -330,7 +303,7 @@ "uri":"topic_300000004.html", "doc_type":"api", "p_code":"13", - "code":"37" + "code":"34" }, { "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/", @@ -338,17 +311,17 @@ "title":"Adding OBS Dump Tasks", "uri":"dis_02_0410.html", "doc_type":"api", - "p_code":"37", - "code":"38" + "p_code":"34", + "code":"35" }, { "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", + "title":"Querying Dump Task", "uri":"ListTransferTasks.html", "doc_type":"api", - "p_code":"37", - "code":"39" + "p_code":"34", + "code":"36" }, { "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.", @@ -356,8 +329,8 @@ "title":"Deleting Dump Tasks", "uri":"DeleteTransferTask.html", "doc_type":"api", - "p_code":"37", - "code":"40" + "p_code":"34", + "code":"37" }, { "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", @@ -365,8 +338,8 @@ "title":"Querying Dump Task Details", "uri":"ShowTransferTask.html", "doc_type":"api", - "p_code":"37", - "code":"41" + "p_code":"34", + "code":"38" }, { "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.", @@ -374,8 +347,8 @@ "title":"Starting Dump Tasks in Batches", "uri":"BatchStartTransferTask.html", "doc_type":"api", - "p_code":"37", - "code":"42" + "p_code":"34", + "code":"39" }, { "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.", @@ -383,44 +356,8 @@ "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" + "p_code":"34", + "code":"40" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -429,7 +366,7 @@ "uri":"topic_300000005.html", "doc_type":"api", "p_code":"13", - "code":"48" + "code":"41" }, { "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", @@ -437,8 +374,8 @@ "title":"Querying Stream Monitoring Data", "uri":"ShowStreamMetrics.html", "doc_type":"api", - "p_code":"48", - "code":"49" + "p_code":"41", + "code":"42" }, { "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", @@ -446,8 +383,8 @@ "title":"Querying Partition Monitoring Data", "uri":"ShowPartitionMetrics.html", "doc_type":"api", - "p_code":"48", - "code":"50" + "p_code":"41", + "code":"43" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -456,7 +393,7 @@ "uri":"topic_300000006.html", "doc_type":"api", "p_code":"13", - "code":"51" + "code":"44" }, { "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.", @@ -464,8 +401,8 @@ "title":"Adding Tags for Specified Streams", "uri":"CreateTag.html", "doc_type":"api", - "p_code":"51", - "code":"52" + "p_code":"44", + "code":"45" }, { "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", @@ -473,8 +410,8 @@ "title":"Querying Tags of Specified Streams", "uri":"ShowStreamTags.html", "doc_type":"api", - "p_code":"51", - "code":"53" + "p_code":"44", + "code":"46" }, { "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.", @@ -482,8 +419,8 @@ "title":"Deleting Tags of Specified Streams", "uri":"DeleteTag.html", "doc_type":"api", - "p_code":"51", - "code":"54" + "p_code":"44", + "code":"47" }, { "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", @@ -491,8 +428,8 @@ "title":"Adding Resource Tags in Batches", "uri":"BatchCreateTags.html", "doc_type":"api", - "p_code":"51", - "code":"55" + "p_code":"44", + "code":"48" }, { "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", @@ -500,8 +437,8 @@ "title":"Querying Tags of Specified Regions", "uri":"ListTags.html", "doc_type":"api", - "p_code":"51", - "code":"56" + "p_code":"44", + "code":"49" }, { "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 ", @@ -509,8 +446,8 @@ "title":"Using Tags to Filter Resources (Streams)", "uri":"ListResourcesByTags.html", "doc_type":"api", - "p_code":"51", - "code":"57" + "p_code":"44", + "code":"50" }, { "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", @@ -518,8 +455,8 @@ "title":"Deleting Resource Tags in Batches", "uri":"BatchDeleteTags.html", "doc_type":"api", - "p_code":"51", - "code":"58" + "p_code":"44", + "code":"51" }, { "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 ", @@ -528,7 +465,7 @@ "uri":"en-us_topic_0000001079240698.html", "doc_type":"api", "p_code":"", - "code":"59" + "code":"52" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -537,7 +474,7 @@ "uri":"dis_02_0500.html", "doc_type":"api", "p_code":"", - "code":"60" + "code":"53" }, { "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.", @@ -545,8 +482,8 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"60", - "code":"61" + "p_code":"53", + "code":"54" }, { "desc":"A status code is an HTTPS response issued by DIS to indicate whether an API request has been successfully completed.", @@ -554,8 +491,8 @@ "title":"Status Codes", "uri":"dis_02_0022.html", "doc_type":"api", - "p_code":"60", - "code":"62" + "p_code":"53", + "code":"55" }, { "desc":"This section describes how to obtain a project ID on the console or by calling an API.", @@ -563,8 +500,8 @@ "title":"Obtaining a Project ID", "uri":"dis_02_0501.html", "doc_type":"api", - "p_code":"60", - "code":"63" + "p_code":"53", + "code":"56" }, { "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.", @@ -573,6 +510,6 @@ "uri":"dis_02_0023.html", "doc_type":"api", "p_code":"", - "code":"64" + "code":"57" } ] \ No newline at end of file diff --git a/docs/dis/api-ref/CreateApp.html b/docs/dis/api-ref/CreateApp.html index d9080a05..0115aeb3 100644 --- a/docs/dis/api-ref/CreateApp.html +++ b/docs/dis/api-ref/CreateApp.html @@ -1,112 +1,112 @@

Creating Consumption Apps

-

Function

This API is used to create consumption apps.

+

Function

This API is used to create consumption apps.

-

URI

POST /v2/{project_id}/apps

+

URI

POST /v2/{project_id}/apps

-
Table 1 Path parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID.

+

Project ID.

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

app_name

+

app_name

Yes

+

Yes

String

+

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

+

Name of the consumer application to be created

+

The application name contains 1 to 200 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

+

Minimum: 1

+

Maximum: 200

-

Response Parameters

None

+

Response Parameters

None

-

Example Requests

Creating Consumption Apps

-
POST https://{Endpoint}/v2/{project_id}/apps
+

Example Requests

Creating Consumption Apps

+
POST https://{Endpoint}/v2/{project_id}/apps
 
 {
   "app_name" : "newapp"
 }
-

Example Responses

None

+

Example Responses

None

-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

201

+

201

Normal response.

+

Normal response.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

@@ -114,3 +114,4 @@
+ diff --git a/docs/dis/api-ref/CreateCloudTableTransferTask.html b/docs/dis/api-ref/CreateCloudTableTransferTask.html deleted file mode 100644 index 6257feff..00000000 --- a/docs/dis/api-ref/CreateCloudTableTransferTask.html +++ /dev/null @@ -1,685 +0,0 @@ - - -

Adding CloudTable Dump Tasks

-

Function

This API is used to add CloudTable dump tasks.

-
-

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks

- -
- - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID.

-

stream_name

-

Yes

-

String

-

Name of the stream.

-

Maximum: 60

-
-
-
-

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

-

destination_type

-

Yes

-

String

-

Dump destination. Possible values:

-
  • OBS: Data is dumped to OBS.
  • MRS: Data is dumped to MRS.
  • DLI: Data is dumped to DLI.
  • CLOUDTABLE: Data is dumped to CloudTable.
  • DWS: Data is dumped to DWS.
-

Default: NOWHERE

-

Enumeration values:

-
  • CLOUDTABLE
-

cloudtable_destination_descriptor

-

No

-

CloudtableDestinationDescriptorRequest object

-

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.

-

cloudtable_schema

-

No

-

CloudtableSchema object

-

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.

-

opentsdb_schema

-

No

-

Array of OpenTSDBSchema objects

-

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.

-

Value range: 0-7,200

-

Unit: second

-

Default value: 1,800

-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 CloudtableSchema

Parameter

-

Mandatory

-

Type

-

Description

-

row_key

-

Yes

-

Array of RowKey objects

-

HBase rowkey schema used by the CloudTable cluster to convert JSON data into HBase rowkeys.

-

Value range: 1-64

-

columns

-

Yes

-

Array of Column objects

-

HBase column schema used by the CloudTable cluster to convert JSON data into HBase columns.

-

Value range: 1 to 4,096

-
-
- -
- - - - - - - - - - - - - - - - -
Table 6 RowKey

Parameter

-

Mandatory

-

Type

-

Description

-

value

-

Yes

-

String

-

JSON attribute name, which is used to generate HBase rowkeys for JSON data in the DIS stream.

-

type

-

Yes

-

String

-

JSON attribute type of JSON data in the DIS stream. Value range:

-
  • Bigint
  • Double
  • Boolean
  • Timestamp
  • String
  • Decimal
-

Enumeration values:

-
  • Bigint
  • Double
  • Boolean
  • Timestamp
  • String
  • Decimal
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 Column

Parameter

-

Mandatory

-

Type

-

Description

-

column_family_name

-

Yes

-

String

-

Name of the HBase column family to which data will be dumped.

-

column_name

-

Yes

-

String

-

Name of the HBase column to which data will be dumped.

-

Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)

-

value

-

Yes

-

String

-

JSON attribute name, which is used to generate HBase column values for JSON data in the DIS stream.

-

type

-

Yes

-

String

-

JSON attribute type of JSON data in the DIS stream.

-

Value range:

-
  • Bigint
  • Double
  • Boolean
  • Timestamp
  • String
  • Decimal
-

Enumeration values:

-
  • Bigint
  • Double
  • Boolean
  • Timestamp
  • String
  • Decimal
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 OpenTSDBSchema

Parameter

-

Mandatory

-

Type

-

Description

-

metric

-

Yes

-

Array of OpenTSDBMetric objects

-

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.

-

timestamp

-

Yes

-

OpenTSDBTimestamp object

-

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.

-

value

-

Yes

-

OpenTSDBValue object

-

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.

-

tags

-

Yes

-

Array of OpenTSDBTags objects

-

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 (_)

-
-
-
-

Response Parameters

None

-
-

Example Requests

  • Adding CloudTable HBase Dump Tasks
    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    -
    -{
    -  "destination_type" : "CLOUDTABLE",
    -  "cloudtable_destination_descriptor" : {
    -    "task_name" : "hbasetask",
    -    "consumer_strategy" : "TRIM_HORIZON",
    -    "agency_name" : "dis_admin_agency",
    -    "cloudtable_cluster_name" : "cloudtablecluster",
    -    "cloudtable_cluster_id" : "b8c095e2-db5f-4732-8a1d-eacd662e35dc",
    -    "cloudtable_table_name" : "cloudtabletable",
    -    "cloudtable_row_key_delimiter" : "|",
    -    "retry_duration" : 1800,
    -    "obs_backup_bucket_path" : "obsbackupbucket",
    -    "backup_file_prefix" : "",
    -    "cloudtable_schema" : {
    -      "row_key" : [ {
    -        "value" : "datavalue",
    -        "type" : "String"
    -      } ],
    -      "columns" : [ {
    -        "column_family_name" : "cfname1",
    -        "column_name" : "ID",
    -        "value" : "datavalue1",
    -        "type" : "String"
    -      }, {
    -        "column_family_name" : "cfname2",
    -        "column_name" : "VALUE",
    -        "value" : "datavalue2",
    -        "type" : "String"
    -      } ]
    -    }
    -  }
    -}
    -
  • Adding CloudTable OpenTSDB Dump Tasks
    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    -
    -{
    -  "destination_type" : "CLOUDTABLE",
    -  "cloudtable_destination_descriptor" : {
    -    "task_name" : "opentsdbtask",
    -    "consumer_strategy" : "LATEST",
    -    "agency_name" : "dis_admin_agency",
    -    "cloudtable_cluster_name" : "cloudtablecluster",
    -    "cloudtable_cluster_id" : "b8c095e2-db5f-4732-8a1d-eacd662e35dc",
    -    "retry_duration" : 1800,
    -    "obs_backup_bucket_path" : "obsbackupbucket",
    -    "backup_file_prefix" : "",
    -    "opentsdb_schema" : [ {
    -      "metric" : [ {
    -        "type" : "Constant",
    -        "value" : "age"
    -      } ],
    -      "timestamp" : {
    -        "value" : "date",
    -        "type" : "String",
    -        "format" : "yyyy/MM/dd HH:mm:ss"
    -      },
    -      "value" : {
    -        "value" : "value",
    -        "type" : "Bigint"
    -      },
    -      "tags" : [ {
    -        "name" : "name",
    -        "value" : "name",
    -        "type" : "Bigint"
    -      } ]
    -    } ]
    -  }
    -}
    -
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

Normal response.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
diff --git a/docs/dis/api-ref/CreateDliTransferTask.html b/docs/dis/api-ref/CreateDliTransferTask.html deleted file mode 100644 index 952e4e8d..00000000 --- a/docs/dis/api-ref/CreateDliTransferTask.html +++ /dev/null @@ -1,246 +0,0 @@ - - -

Adding DLI Dump Tasks

-

Function

This API is used to add DLI dump tasks.

-
-

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks

- -
- - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID.

-

stream_name

-

Yes

-

String

-

Name of the stream.

-

Maximum: 60

-
-
-
-

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

-

destination_type

-

Yes

-

String

-

Dump destination. Possible values:

-
  • OBS: Data is dumped to OBS.
  • MRS: Data is dumped to MRS.
  • DLI: Data is dumped to DLI.
  • CLOUDTABLE: Data is dumped to CloudTable.
  • DWS: Data is dumped to DWS.
-

Default: NOWHERE

-

Enumeration values:

-
  • DLI
-

dli_destination_descriptor

-

No

-

DliDestinationDescriptorRequest object

-

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.

-
-
-
-

Response Parameters

None

-
-

Example Requests

None

-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

Normal response.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
diff --git a/docs/dis/api-ref/CreateDwsTransferTask.html b/docs/dis/api-ref/CreateDwsTransferTask.html deleted file mode 100644 index 1789366f..00000000 --- a/docs/dis/api-ref/CreateDwsTransferTask.html +++ /dev/null @@ -1,445 +0,0 @@ - - -

Adding DWS Dump Tasks

-

Function

This API is used to add DWS dump tasks.

-
-

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks

- -
- - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID.

-

stream_name

-

Yes

-

String

-

Name of the stream.

-

Maximum: 60

-
-
-
-

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

-

destination_type

-

Yes

-

String

-

Dump destination. Possible values:

-
  • OBS: Data is dumped to OBS.
  • MRS: Data is dumped to MRS.
  • DLI: Data is dumped to DLI.
  • CLOUDTABLE: Data is dumped to CloudTable.
  • DWS: Data is dumped to DWS.
-

Default: NOWHERE

-

Enumeration values:

-
  • DWS
-

dws_destination_descriptor

-

No

-

DWSDestinationDescriptorRequest object

-

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.

-

This parameter is left blank by default.

-

options

-

No

-

Options object

-

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.

-
-
-
-

Response Parameters

None

-
-

Example Requests

Adding DWS Dump Tasks

-
POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
-
-{
-  "destination_type" : "DWS",
-  "dws_destination_descriptor" : {
-    "task_name" : "dwstask",
-    "consumer_strategy" : "LATEST",
-    "agency_name" : "dis_admin_agency",
-    "dws_cluster_name" : "dwscluster",
-    "dws_cluster_id" : "f82dc227-3691-47eb-bca7-e7851f509b2a",
-    "dws_database_name" : "postgres",
-    "dws_schema" : "dbadmin",
-    "dws_table_name" : "dwstablename",
-    "dws_delimiter" : "",
-    "user_name" : "dbadmin",
-    "user_password" : "userpassword",
-    "kms_user_key_name" : "kmskey",
-    "kms_user_key_id" : "1e759f06-9188-4d21-afab-a75e57c04d2b",
-    "obs_bucket_path" : "obsbucket",
-    "file_prefix" : "",
-    "deliver_time_interval" : 60,
-    "retry_duration" : 1800,
-    "options" : {
-      "fill_missing_fields" : "false",
-      "ignore_extra_data" : "false",
-      "compatible_illegal_chars" : "false"
-    }
-  }
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

Normal response.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
diff --git a/docs/dis/api-ref/CreateMrsTransferTask.html b/docs/dis/api-ref/CreateMrsTransferTask.html deleted file mode 100644 index 5a541199..00000000 --- a/docs/dis/api-ref/CreateMrsTransferTask.html +++ /dev/null @@ -1,287 +0,0 @@ - - -

Adding MRS Dump Tasks

-

Function

This API is used to add MRS dump tasks.

-
-

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks

- -
- - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID.

-

stream_name

-

Yes

-

String

-

Name of the stream.

-

Maximum: 60

-
-
-
-

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

-

destination_type

-

Yes

-

String

-

Dump destination. Possible values:

-
  • OBS: Data is dumped to OBS.
  • MRS: Data is dumped to MRS.
  • DLI: Data is dumped to DLI.
  • CLOUDTABLE: Data is dumped to CloudTable.
  • DWS: Data is dumped to DWS.
-

Default: NOWHERE

-

Enumeration values:

-
  • MRS
-

mrs_destination_descriptor

-

No

-

MRSDestinationDescriptorRequest object

-

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.

-
-
-
-

Response Parameters

None

-
-

Example Requests

Adding MRS Dump Tasks

-
POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
-
-{
-  "destination_type" : "MRS",
-  "mrs_destination_descriptor" : {
-    "task_name" : "mrstask",
-    "consumer_strategy" : "LATEST",
-    "agency_name" : "dis_admin_agency",
-    "destination_file_type" : "text",
-    "mrs_cluster_id" : "f8123fa6-99f1-4ed9-83f4-c827c7277d41",
-    "mrs_cluster_name" : "mrscluster",
-    "mrs_hdfs_path" : "/user",
-    "obs_bucket_path" : "obsbucket",
-    "file_prefix" : "",
-    "hdfs_prefix_folder" : "",
-    "deliver_time_interval" : 30,
-    "retry_duration" : 1800
-  }
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

Normal response.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
diff --git a/docs/dis/api-ref/CreatePolicies.html b/docs/dis/api-ref/CreatePolicies.html deleted file mode 100644 index 51e211db..00000000 --- a/docs/dis/api-ref/CreatePolicies.html +++ /dev/null @@ -1,177 +0,0 @@ - - -

Adding Permission Policies

-

Function

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.

-

action_type

-

Yes

-

String

-

Authorization operation type.

-
  • putRecords: Upload data.

    -
  • getRecords: Download data.

    -
-

Enumeration values:

-
  • putRecords

    -
  • getRecords

    -
-

effect

-

Yes

-

String

-

Authorization impact type.

-
  • accept: The authorization operation is allowed.

    -
-

Enumeration values:

-
  • accept

    -
-
-
-
-

Response Parameters

None

-
-

Example Requests

  • Adding Permission Policies for Tenants

    -
    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/policies
    -
    -{
    -  "stream_id" : "CiFdELMr0401K9GGZlp",
    -  "principal_name" : "domainname1",
    -  "action_type" : "putRecords",
    -  "effect" : "accept"
    -}
    -
  • Adding Permission Policies for Sub-users

    -
    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/policies
    -
    -{
    -  "stream_id" : "CiFdELMr0401K9GGZlp",
    -  "principal_name" : "domainname1.username1",
    -  "action_type" : "putRecords",
    -  "effect" : "accept"
    -}
    -
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

Normal response.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
diff --git a/docs/dis/api-ref/CreateTag.html b/docs/dis/api-ref/CreateTag.html index b1532c3f..6b421ce2 100644 --- a/docs/dis/api-ref/CreateTag.html +++ b/docs/dis/api-ref/CreateTag.html @@ -5,7 +5,7 @@

URI

POST /v2/{project_id}/stream/{stream_id}/tags

-
Table 1 Path parameters

Parameter

+
@@ -55,8 +55,8 @@ - @@ -102,10 +102,10 @@ - -
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

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

    +

Key

+
  • It cannot be left blank.

    +
  • It must be unique for each resource.

    +
  • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

Minimum: 1

Maximum: 36

@@ -117,10 +117,10 @@

String

Value.

-
  • The value contains a maximum of 43 characters.

    -
  • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

    -
  • The value can contain only digits, letters, hyphens (-), and underscores (_).

    +

Value

+
  • It can contain a maximum of 43 characters.

    +
  • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

    +
  • It can only contain digits, letters, hyphens (-), and underscores (_).

Minimum: 0

Maximum: 43

@@ -168,3 +168,4 @@ + diff --git a/docs/dis/api-ref/DeleteApp.html b/docs/dis/api-ref/DeleteApp.html index 17499131..c8aa7a68 100644 --- a/docs/dis/api-ref/DeleteApp.html +++ b/docs/dis/api-ref/DeleteApp.html @@ -5,7 +5,7 @@

URI

DELETE /v2/{project_id}/apps/{app_name}

-
Table 1 Path parameters

Parameter

+
@@ -54,8 +54,8 @@ - @@ -93,3 +93,4 @@ + diff --git a/docs/dis/api-ref/DeleteCheckpoint.html b/docs/dis/api-ref/DeleteCheckpoint.html index faf636dc..95c5e6d6 100644 --- a/docs/dis/api-ref/DeleteCheckpoint.html +++ b/docs/dis/api-ref/DeleteCheckpoint.html @@ -1,141 +1,138 @@

Deleting Checkpoints

-

Function

This API is used to delete checkpoints.

+

Function

This API is used to delete checkpoints.

-

URI

DELETE /v2/{project_id}/checkpoints

+

URI

DELETE /v2/{project_id}/checkpoints

-
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 1 Path parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID.

+

Project ID.

-
Table 2 Query parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

stream_name

+

stream_name

Yes

+

Yes

String

+

String

Name of the stream to which the checkpoint belongs.

+

Name of the stream to which the checkpoint belongs.

app_name

+

app_name

Yes

+

Yes

String

+

String

Name of the application associated with the checkpoint.

-

Minimum: 1

-

Maximum: 50

+

Name of the application associated with the checkpoint.

+

Minimum: 1

+

Maximum: 50

checkpoint_type

+

checkpoint_type

Yes

+

Yes

String

+

String

Type of the checkpoint. LAST_READ: Only sequence numbers are recorded in databases.

-

Enumeration values:

-
  • LAST_READ

    -
+

Type of the checkpoint

+
  • LAST_READ: Only sequence numbers are recorded in databases.
+

Enumeration values:

+
  • LAST_READ

partition_id

+

partition_id

No

+

No

String

+

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.

+

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.

-

Request Parameters

-
Table 3 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 3 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

-

Response Parameters

None

+

Response Parameters

None

-

Example Requests

Deleting Checkpoints

-
DELETE https://{Endpoint}/v2/{project_id}/checkpoints
+

Example Requests

Deleting Checkpoints

+
DELETE https://{Endpoint}/v2/{project_id}/checkpoints
-

Example Responses

None

+

Example Responses

None

-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

204

+

204

Normal response.

+

Normal response.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

@@ -143,3 +140,4 @@
+ diff --git a/docs/dis/api-ref/DeleteStream.html b/docs/dis/api-ref/DeleteStream.html index e9847842..fc68aa0d 100644 --- a/docs/dis/api-ref/DeleteStream.html +++ b/docs/dis/api-ref/DeleteStream.html @@ -5,7 +5,7 @@

URI

DELETE /v2/{project_id}/streams/{stream_name}

-
Table 1 Path parameters

Parameter

+
@@ -55,8 +55,8 @@ - @@ -94,3 +94,4 @@ + diff --git a/docs/dis/api-ref/DeleteTag.html b/docs/dis/api-ref/DeleteTag.html index 5e47dc3b..c73ad7a7 100644 --- a/docs/dis/api-ref/DeleteTag.html +++ b/docs/dis/api-ref/DeleteTag.html @@ -5,7 +5,7 @@

URI

DELETE /v2/{project_id}/stream/{stream_id}/tags/{key}

-
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 1 Path parameters

Parameter

+
@@ -63,8 +63,8 @@ - @@ -102,3 +102,4 @@ + diff --git a/docs/dis/api-ref/DeleteTransferTask.html b/docs/dis/api-ref/DeleteTransferTask.html index 553c2db6..c105170a 100644 --- a/docs/dis/api-ref/DeleteTransferTask.html +++ b/docs/dis/api-ref/DeleteTransferTask.html @@ -5,7 +5,7 @@

URI

DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}

-
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 1 Path parameters

Parameter

+
@@ -63,8 +63,8 @@ - @@ -102,3 +102,4 @@ + diff --git a/docs/dis/api-ref/ErrorCode.html b/docs/dis/api-ref/ErrorCode.html index 0ae44d23..d189a1cd 100644 --- a/docs/dis/api-ref/ErrorCode.html +++ b/docs/dis/api-ref/ErrorCode.html @@ -2,610 +2,511 @@

Error Codes

-
Table 1 Path Parameters

Parameter

Mandatory

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Status Code

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -617,3 +518,4 @@ + diff --git a/docs/dis/api-ref/ListApp.html b/docs/dis/api-ref/ListApp.html index a1120c14..47c6267a 100644 --- a/docs/dis/api-ref/ListApp.html +++ b/docs/dis/api-ref/ListApp.html @@ -1,186 +1,179 @@

Querying Apps

-

Function

This API is used to query apps.

+

Function

This API is used to query apps.

-

URI

GET /v2/{project_id}/apps

+

URI

GET /v2/{project_id}/apps

-

Status Code

Error Codes

+

Error Codes

Error Message

+

Error Message

Description

+

Description

Solution

+

Solution

400

+

400

DIS.4117

+

DIS.4117

Invalid Project Id. %s

+

Invalid Project Id. %s

Invalid project ID.

+

Invalid project ID.

Ensure that the project ID is valid.

+

Ensure that the project ID is valid.

400

+

400

DIS.4200

+

DIS.4200

Invalid request. %s

+

Invalid request. %s

Invalid request.

+

Invalid request.

Ensure that the request is invalid by referring to API Reference

+

Ensure that the request is invalid by referring to API Reference

400

+

400

DIS.4201

+

DIS.4201

Invalid partition_id. %s

+

Invalid partition_id. %s

Invalid partition ID.

+

Invalid partition ID.

Ensure that the partition ID is valid.

+

Ensure that the partition ID is valid.

400

+

400

DIS.4202

+

DIS.4202

Empty request.

+

Empty request.

The request is empty.

+

The request is empty.

Enter a valid request.

+

Enter a valid request.

400

+

400

DIS.4203

+

DIS.4203

Invalid monitoring period. %s

+

Invalid monitoring period. %s

The start time for querying the monitoring information is invalid.

+

The start time for querying the monitoring information is invalid.

Enter a valid timestamp.

+

Enter a valid timestamp.

400

+

400

DIS.4204

+

DIS.4204

The monitoring period cannot be longer than 7 days.

+

The monitoring period cannot be longer than 7 days.

Only the monitoring information generated in the recent seven days can be queried.

+

Only the monitoring information generated in the recent seven days can be queried.

Query the monitoring information generated in the recent seven days.

+

Query the monitoring information generated in the recent seven days.

400

+

400

DIS.4205

+

DIS.4205

Stream is not running.

+

Stream is not running.

The stream is not in the running state.

+

The stream is not in the running state.

Check the stream status.

+

Check the stream status.

400

+

400

DIS.4208

+

DIS.4208

Mrs cluster is invalid. %s

+

Mrs cluster is invalid. %s

The MRS cluster entered during MRS dump task creation is invalid.

+

The MRS cluster entered during MRS dump task creation is invalid.

Ensure that the MRS cluster name and ID are correct and the cluster is running in security mode.

+

Ensure that the MRS cluster name and ID are correct and the cluster is running in security mode.

400

+

400

DIS.4209

+

DIS.4209

Invalid metrics label. %s

+

Invalid metrics label. %s

The monitoring metric entered during monitoring information query is invalid.

+

The monitoring metric entered during monitoring information query is invalid.

Check and modify the monitoring metric by referring to API Reference.

+

Check and modify the monitoring metric by referring to API Reference.

400

+

400

DIS.4215

+

DIS.4215

Invalid cursor type. %s

+

Invalid cursor type. %s

The cursor type entered during data cursor acquisition is invalid.

+

The cursor type entered during data cursor acquisition is invalid.

Check and modify the cursor type by referring to API Reference.

+

Check and modify the cursor type by referring to API Reference.

400

+

400

DIS.4216

+

DIS.4216

Invalid sequence_number. %s

+

Invalid sequence_number. %s

The starting sequence number entered during data cursor acquisition is invalid.

+

The starting sequence number entered during data cursor acquisition is invalid.

Enter a valid starting sequence number.

+

Enter a valid starting sequence number.

400

+

400

DIS.4217

+

DIS.4217

Invalid partition cursor. %s

+

Invalid partition cursor. %s

The partition cursor entered during data download from DIS is invalid.

+

The partition cursor entered during data download from DIS is invalid.

Obtain the partition cursor again and download the data.

+

Obtain the partition cursor again and download the data.

400

+

400

DIS.4224

+

DIS.4224

Sequence_number out of range. %s

+

Sequence_number out of range. %s

The starting sequence number entered during data cursor acquisition is not in a valid range.

+

The starting sequence number entered during data cursor acquisition is not in a valid range.

Enter a valid starting sequence number.

+

Enter a valid starting sequence number.

400

+

400

DIS.4225

+

DIS.4225

Expired partition cursor. %s

+

Expired partition cursor. %s

The partition cursor entered during data download from DIS has expired.

+

The partition cursor entered during data download from DIS has expired.

Obtain the partition cursor again and download the data.

+

Obtain the partition cursor again and download the data.

400

+

400

DIS.4226

+

DIS.4226

A partition iterator error occurred or a record to which the SN corresponds has expired. Try to obtain the partition iterator again.

+

A partition iterator error occurred or a record to which the SN corresponds has expired. Try to obtain the partition iterator again.

The starting sequence number of the partition cursor entered during data acquisition has expired.

+

The starting sequence number of the partition cursor entered during data acquisition has expired.

Obtain the data cursor again and use the new cursor to obtain data.

+

Obtain the data cursor again and use the new cursor to obtain data.

400

+

400

DIS.4300

+

DIS.4300

Request error.

+

Request error.

Incorrect request body.

+

Incorrect request body.

Modify the request body by referring to API Reference.

+

Modify the request body by referring to API Reference.

400

+

400

DIS.4301

+

DIS.4301

The stream does not exist. %s

+

The stream does not exist. %s

The stream does not exist.

+

The stream does not exist.

Ensure that the stream exists.

+

Ensure that the stream exists.

400

+

400

DIS.4302

+

DIS.4302

Partition does not exist. %s

+

Partition does not exist. %s

The partition does not exist.

+

The partition does not exist.

Ensure that the partition ID exists.

+

Ensure that the partition ID exists.

400

+

400

DIS.4303

+

DIS.4303

Exceeded traffic control limit.

+

Exceeded traffic control limit.

The flow control limit is exceeded.

+

The flow control limit is exceeded.

Add the stream or reduce the upload rate.

+

Add the stream or reduce the upload rate.

400

+

400

DIS.4305

+

DIS.4305

Too many stream requests.

+

Too many stream requests.

An excessive number of user requests are generated at the same time.

+

An excessive number of user requests are generated at the same time.

Reduce the requesting frequency and try again.

+

Reduce the requesting frequency and try again.

400

+

400

DIS.4306

+

DIS.4306

Bucket does not exist. %s

+

Bucket does not exist. %s

The OBS bucket does not exist.

+

The OBS bucket does not exist.

Ensure that the OBS bucket exists.

+

Ensure that the OBS bucket exists.

400

+

400

DIS.4307

+

DIS.4307

The stream already exists.

+

The stream already exists.

The stream already exists.

+

The stream already exists.

Enter a new stream name.

+

Enter a new stream name.

400

+

400

DIS.4308

+

DIS.4308

Insufficient quota.

+

Insufficient quota.

Insufficient stream or partition quotas.

+

Insufficient stream or partition quotas.

Release the resources that will not be used to ensure that the quota limit is not exceeded or submit a service ticket to increase the quota limit.

+

Release the resources that will not be used to ensure that the quota limit is not exceeded or submit a service ticket to increase the quota limit.

400

+

400

DIS.4309

+

DIS.4309

Too many request failures. Please try again later.

+

Too many request failures. Please try again later.

The IP address is added to the blacklist.

+

The IP address is added to the blacklist.

Ensure that the authentication information and request are valid and try again later.

+

Ensure that the authentication information and request are valid and try again later.

400

+

400

DIS.4310

+

DIS.4310

OBS access error.

+

OBS access error.

OBS fails to be accessed.

+

OBS fails to be accessed.

Ensure that the user has permissions to access OBS.

+

Ensure that the user has permissions to access OBS.

400

+

400

DIS.4319

+

DIS.4319

Partition is expired. %s

+

Partition is expired. %s

The partition has expired.

+

The partition has expired.

Use a correct and valid partition.

+

Use a correct and valid partition.

400

+

400

DIS.4329

+

DIS.4329

app quota exceeded.

+

app quota exceeded.

The application quota exceeds the limit.

+

The application quota exceeds the limit.

Release the applications that are not used.

+

Release the applications that are not used.

400

+

400

DIS.4330

+

DIS.4330

app already exist.

+

app already exist.

An application with the same name already exists.

+

An application with the same name already exists.

Enter a new application name.

+

Enter a new application name.

400

+

400

DIS.4331

+

DIS.4331

app is using.

+

app is using.

The application fails to be deleted.

+

The application fails to be deleted.

Ensure that the application that you want to delete is not being used.

+

Ensure that the application that you want to delete is not being used.

400

+

400

DIS.4332

+

DIS.4332

app not found.

+

app not found.

The application does not exist.

+

The application does not exist.

Ensure that the application name is correct.

+

Ensure that the application name is correct.

400

+

400

DIS.4335

+

DIS.4335

Invalid IAM agency.

+

Invalid IAM agency.

The IAM agency used during dump task creation is invalid.

+

The IAM agency used during dump task creation is invalid.

Ensure that dis_admin_agency created by DIS or the user-defined IAM agency exists and permission is complete.

+

Ensure that dis_admin_agency created by DIS or the user-defined IAM agency exists and permission is complete.

400

+

400

DIS.4336

+

DIS.4336

Invalid HDFS path.

+

Invalid HDFS path.

The MRS HDFS path entered during MRS dump task creation is invalid.

+

The MRS HDFS path entered during MRS dump task creation is invalid.

Ensure that the MRS HDFS path exists.

+

Ensure that the MRS HDFS path exists.

400

+

400

DIS.4337

+

DIS.4339

The DLI database does not exist.

+

Consumer quota exceeded.

The DLI database entered during DLI dump task creation does not exist.

+

The consumer quota of the consumer group is insufficient.

Ensure that the DLI database exists.

+

Allocate consumers properly or create a consumer group to meet the requirement.

400

+

400

DIS.4338

+

DIS.4354

The DLI table does not exist.

+

The transfer task does not exist.

The DLI table entered during DLI dump task creation does not exist.

+

The dump task to be deleted or updated does not exist.

Ensure that the DLI table exists and is an internal table.

+

Ensure that the dump task exists.

400

+

400

DIS.4339

+

DIS.4355

Consumer quota exceeded.

+

The transfer task already exists.

The consumer quota of the consumer group is insufficient.

+

A dump task with the same name already exists.

Allocate consumers properly or create a consumer group to meet the requirement.

+

Enter a new dump task name.

400

+

400

DIS.4341

+

DIS.4357

The CloudTable cluster does not exist.

+

Exceeded transfer task quota.

The CloudTable cluster entered during CloudTable dump task creation does not exist.

+

A maximum of five dump tasks can be created for one stream at the same time.

Ensure that the CloudTable cluster exists and is running properly.

+

Delete the discarded dump tasks and then add dump tasks again.

400

+

400

DIS.4342

+

DIS.4360

The CloudTable table does not exist

+

Invalid data schema.

The CloudTable table entered during CloudTable dump task creation does not exist.

+

The data schema entered during stream creation or update is invalid.

Ensure that the CloudTable table exists.

+

Ensure that the data schema format is correct and try again.

400

+

400

DIS.4343

+

DIS.4375

The CloudTable table family does not exist.

+

The app does not commit checkpoint

The CloudTable column family entered during CloudTable dump task creation does not exist.

+

The application does not submit the checkpoint operation in the stream.

Ensure that the CloudTable column family exists.

+

Check whether the application has submitted the checkpoint operation in the consumption stream.

400

+

400

DIS.4345

+

DIS.4601

Invalid CloudTable schema.

+

The number of resource tags has reached the maximum.

The schema entered during CloudTable dump task creation is invalid.

+

A maximum of 10 tags can be added to a resource.

Check the schema based on the returned details to ensure that the configured JSON attribute name exists and the parameters are valid.

+

Delete the discarded tags and then add tags again.

400

+

400

DIS.4348

+

DIS.4602

Invalid CloudTable openTSDB schema.

+

Invalid resource type.

The schema entered during CloudTable OpenTSDB dump task creation is invalid.

+

Invalid resource type.

Check the schema based on the returned details to ensure that the configured JSON attribute name exists and the parameters are valid.

+

Ensure that the resource type is valid.

400

+

400

DIS.4350

+

DIS.4603

Invalid DWS cluster.

+

The resource does not exist.

The DWS cluster entered during DWS dump task creation does not exist.

+

The resource does not exist.

Ensure that the DWS cluster exists and is running properly.

+

Ensure that the resource exists.

400

+

400

DIS.4351

+

DIS.4604

Invalid KMS userKey.

+

The key does not exist.

The KMS key entered during DWS dump task creation is invalid.

+

The tag key does not exist.

Ensure that the KMS key exists.

+

Ensure that the tag key exists.

400

+

400

DIS.4354

+

DIS.4605

The transfer task does not exist.

+

The action is not supported.

The dump task to be deleted or updated does not exist.

+

The current tag operation is not supported.

Ensure that the dump task exists.

+

Ensure that the current tag operation is valid. Currently, only the create and delete operations are supported.

400

+

403

DIS.4355

+

DIS.4116

The transfer task already exists.

+

Invalid RBAC. %s

A dump task with the same name already exists.

+

User operations are restricted.

Enter a new dump task name.

+

Ensure that the account is not in arrears, or has permissions to operate DIS.

400

+

500

DIS.4357

+

DIS.5000

Exceeded transfer task quota.

+

System error.

A maximum of five dump tasks can be created for one stream at the same time.

+

System error.

Delete the discarded dump tasks and then add dump tasks again.

-

400

-

DIS.4360

-

Invalid data schema.

-

The data schema entered during stream creation or update is invalid.

-

Ensure that the data schema format is correct and try again.

-

400

-

DIS.4375

-

The app does not commit checkpoint

-

The application does not submit the checkpoint operation in the stream.

-

Check whether the application has submitted the checkpoint operation in the consumption stream.

-

400

-

DIS.4601

-

The number of resource tags has reached the maximum.

-

A maximum of 10 tags can be added to a resource.

-

Delete the discarded tags and then add tags again.

-

400

-

DIS.4602

-

Invalid resource type.

-

Invalid resource type.

-

Ensure that the resource type is valid.

-

400

-

DIS.4603

-

The resource does not exist.

-

The resource does not exist.

-

Ensure that the resource exists.

-

400

-

DIS.4604

-

The key does not exist.

-

The tag key does not exist.

-

Ensure that the tag key exists.

-

400

-

DIS.4605

-

The action is not supported.

-

The current tag operation is not supported.

-

Ensure that the current tag operation is valid. Currently, only the create and delete operations are supported.

-

403

-

DIS.4116

-

Invalid RBAC. %s

-

User operations are restricted.

-

Ensure that the account has passed real-name authentication, is not in arrears, or has permissions to operate DIS.

-

500

-

DIS.5000

-

System error.

-

System error.

-

Contact customer service or technical support to handle system errors.

+

Contact customer service or technical support to handle system errors.

Table 1 Path parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID.

+

Project ID.

-
Table 2 Query parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

limit

+

limit

No

+

No

Integer

+

Integer

Maximum number of apps to list in a single API call. Value range: 1-100 Default value: 10

-

Minimum: 1

-

Maximum: 100

-

Default: 10

+

Maximum number of apps to list in a single API call

+

Range: 1 to 100

+

Default value: 10

+

Minimum: 1

+

Maximum: 100

+

Default: 10

start_app_name

+

start_app_name

No

+

No

String

+

String

Name of the app to start the list with. The returned app list does not contain this app name.

+

Name of the app to start the list with. The returned app list does not contain this app name.

stream_name

+

stream_name

No

+

No

String

+

String

Name of the stream whose apps will be returned.

+

Name of the stream whose apps will be returned.

-

Request Parameters

-
Table 3 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 3 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

has_more_app

+

has_more_app

Boolean

+

Boolean

Specifies whether there are more matching consumer applications to list.

-
  • true: yes

    -
  • false: no

    -
+

Whether there are more matching consumer applications

+
  • true: yes
  • false: no

apps

+

apps

Array of DescribeAppResult objects

+

Array of DescribeAppResult objects

AppEntry list that meets the current request.

+

AppEntry list that meets the current request.

total_number

+

total_number

Integer

+

Integer

Total number of apps that meet criteria.

+

Total number of apps that meet criteria.

-
Table 5 DescribeAppResult

Parameter

+
- - - - - - - - - - - - - - -
Table 5 DescribeAppResult

Parameter

Type

+

Type

Description

+

Description

app_name

+

app_name

String

+

String

Name of the app.

+

Name of the app.

app_id

+

app_id

String

+

String

Unique identifier of the app.

+

Unique identifier of the app.

create_time

+

create_time

Long

+

Long

Time when the app is created, in milliseconds.

-

commit_checkpoint_stream_names

-

Array of strings

-

List of associated streams.

+

Time when the app is created, in milliseconds.

-

Example Requests

Querying Apps

-
GET https://{Endpoint}/v2/{project_id}/apps
+

Example Requests

Querying Apps

+
GET https://{Endpoint}/v2/{project_id}/apps
-

Example Responses

Status code: 200

-

Normal response.

-
{
+

Example Responses

Status code: 200

+

Normal response.

+
{
   "total_number" : 1,
   "apps" : [ {
     "app_id" : "bd6IPpvgiIflQPMpi9M",
@@ -190,38 +183,38 @@
   "has_more_app" : true
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - -

Status Code

Description

+

Description

200

+

200

Normal response.

+

Normal response.

400

+

400

Invalid Parameters

+

Invalid Parameters

404

+

404

Application not found

+

Application not found

500

+

500

Internal Server Error

+

Internal Server Error

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

@@ -229,3 +222,4 @@
+ diff --git a/docs/dis/api-ref/ListPolicies.html b/docs/dis/api-ref/ListPolicies.html deleted file mode 100644 index 06147eaa..00000000 --- a/docs/dis/api-ref/ListPolicies.html +++ /dev/null @@ -1,185 +0,0 @@ - - -

Querying Permission Policies

-

Function

This API is used to query permission policies of specified streams.

-
-

URI

GET /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 DIS stream to be created.

-

Maximum: 60

-
-
-
-

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

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

stream_id

-

String

-

Unique ID of the stream.

-

rules

-

Array of PrincipalRule objects

-

List of authorization information records.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 4 PrincipalRule

Parameter

-

Type

-

Description

-

principal

-

String

-

ID of the authorized user.

-

principal_name

-

String

-

Name of the authorized user.

-

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

Example Responses

Status code: 200

-

Normal response.

-
{
-  "streamId" : "CiFdELMr0401K9GGZlp",
-  "rules" : [ {
-    "action_type" : "putRecords",
-    "principal" : "3b3f237122574xxxxb74482ae11005ba.*",
-    "principal_name" : "anotherusername",
-    "effect" : "accept"
-  } ]
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

200

-

Normal response.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
diff --git a/docs/dis/api-ref/ListResourcesByTags.html b/docs/dis/api-ref/ListResourcesByTags.html index af6b1ae4..71f7d101 100644 --- a/docs/dis/api-ref/ListResourcesByTags.html +++ b/docs/dis/api-ref/ListResourcesByTags.html @@ -1,302 +1,241 @@

Using Tags to Filter Resources (Streams)

-

Function

This API is used to filter resources (streams) by tag.

+

Function

This API is used to filter resources (streams) by tag.

-

URI

POST /v2/{project_id}/stream/resource_instances/action

+

URI

POST /v2/{project_id}/stream/resource_instances/action

-
Table 1 Path parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID.

+

Project ID.

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

-

The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

User token

+

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

action

+

action

Yes

+

Yes

String

+

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

    -
+

Operation to be performed.

+
  • 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

+

limit

No

+

No

String

+

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

+

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

+

offset

No

+

No

String

+

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.

+

Index position. The query starts from the next data record indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number.

tags

+

tags

No

+

No

Array of Tags objects

+

Array of Tags objects

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

tags_any

+

tags_any

No

+

No

Array of Tags objects

+

Array of Tags objects

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

not_tags

+

not_tags

No

+

No

Array of Tags objects

+

Array of Tags objects

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 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. Each tag key must be unique, and the tag values of one key must also be unique.

not_tags_any

+

not_tags_any

No

+

No

Array of Tags objects

+

Array of Tags objects

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.

+

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

+

matches

No

+

No

String

+

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.

+

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

+
- - - - - - - - - - -
Table 4 Tags

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

No

+

No

String

+

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

+

Key

+
  • It cannot be left blank.
  • It must be unique for each resource.
  • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
+

Maximum: 36

values

+

values

No

+

No

Array of strings

+

Array of strings

Tag value list.

-

If values are null, it indicates any_value. The relationship between values is OR.

+

List of tag values

+

If values is an empty list, it indicates any_value. The values are in the OR relationship.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

action

+

resources

String

+

Array of Tags objects

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

    -
+

Resource List.

limit

+

total_count

String

+

Integer

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.

-

tags

-

Array of Tags objects

-

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.

-

tags_any

-

Array of Tags objects

-

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.

-

not_tags

-

Array of Tags objects

-

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.

-

not_tags_any

-

Array of Tags objects

-

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.

+

Array of Tags objects.

-
Table 6 Tags

Parameter

+
- - - - - - - -
Table 6 Tags

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

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

+

Key

+
  • It cannot be left blank.
  • It must be unique for each resource.
  • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
+

Maximum: 36

values

+

values

Array of strings

+

Array of strings

Tag value list.

-

If values are null, it indicates any_value. The relationship between values is OR.

+

List of tag values

+

If values is an empty list, it indicates any_value. The values are in the OR relationship.

-

Example Requests

  • Resource (stream) filtering by tag and record querying

    -
    POST https://{Endpoint}/v2/{project_id}/stream/resource_instances/action
    +

    Example Requests

    • Resource (stream) filtering by tag and record querying
      POST https://{Endpoint}/v2/{project_id}/stream/resource_instances/action
       
       {
         "action" : "count",
      @@ -312,8 +251,7 @@
           "value" : "resource1"
         } ]
       }
      -
    • Resource (stream) filtering by tag and querying by page.

      -
      POST https://{Endpoint}/v2/{project_id}/stream/resource_instances/action
      +
    • Resource (stream) filtering by tag and querying by page.
      POST https://{Endpoint}/v2/{project_id}/stream/resource_instances/action
       
       {
         "offset" : "0",
      @@ -330,9 +268,9 @@
       }
    -

    Example Responses

    Status code: 200

    -

    Request body for filtering resources (streams) by tag.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Request body for filtering resources (streams) by tag.

    +
    {
       "resources" : [ {
         "resource_detail" : null,
         "resource_id" : "cdfs_cefs_wesas_12_dsad",
    @@ -348,23 +286,23 @@
       "total_count" : 1000
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request body for filtering resources (streams) by tag.

    +

    Request body for filtering resources (streams) by tag.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -372,3 +310,4 @@
    + diff --git a/docs/dis/api-ref/ListTags.html b/docs/dis/api-ref/ListTags.html index 65956514..94f5b361 100644 --- a/docs/dis/api-ref/ListTags.html +++ b/docs/dis/api-ref/ListTags.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/stream/tags

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -45,8 +45,8 @@ - @@ -86,10 +86,10 @@ - @@ -98,8 +98,8 @@ - @@ -145,3 +145,4 @@ + diff --git a/docs/dis/api-ref/ListTransferTasks.html b/docs/dis/api-ref/ListTransferTasks.html index b8093d88..4d6de7c9 100644 --- a/docs/dis/api-ref/ListTransferTasks.html +++ b/docs/dis/api-ref/ListTransferTasks.html @@ -1,184 +1,162 @@ -

    Querying Dump Tasks

    -

    Function

    This API is used to query dump tasks.

    +

    Querying Dump Task

    +

    Function

    This API is used to query dump tasks.

    -

    URI

    GET /v2/{project_id}/streams/{stream_name}/transfer-tasks

    +

    URI

    GET /v2/{project_id}/streams/{stream_name}/transfer-tasks

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

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

      +

    Key

    +
    • It cannot be left blank.

      +
    • It must be unique for each resource.

      +
    • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

    Maximum: 36

    Array of strings

    Tag value list.

    -

    If values are null, it indicates any_value. The relationship between values is OR.

    +

    List of tag values

    +

    If values is an empty list, it indicates any_value. The values are in the OR relationship.

    Table 1 Path parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 Path parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the stream to be queried.

    -

    Maximum: 60

    +

    Name of the stream to be queried.

    +

    Maximum: 60

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    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

    +

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total_number

    +

    total_number

    Integer

    +

    Integer

    Total number of dump tasks.

    +

    Total number of dump tasks.

    quota

    +

    quota

    Integer

    +

    Integer

    Maximum number of dump tasks that can be created.

    +

    Maximum number of dump tasks that can be created.

    tasks

    +

    tasks

    Array of TransferTask objects

    +

    Array of TransferTask objects

    List of dump tasks.

    +

    List of dump tasks.

    -
    Table 4 TransferTask

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 4 TransferTask

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    task_name

    +

    task_name

    String

    +

    String

    Name of the dump task.

    +

    Name of the dump task.

    state

    +

    state

    String

    +

    String

    Dump task status. Possible values:

    -
    • ERROR: An error occurs.

      -
    • STARTING: The dump task is being started.

      -
    • PAUSED: The dump task has been stopped.

      -
    • RUNNING: The dump task is running.

      -
    • DELETE: The dump task has been deleted.

      -
    • ABNORMAL: The dump task is abnormal.

      -
    -

    Enumeration values:

    -
    • ERROR

      -
    • STARTING

      -
    • PAUSED

      -
    • RUNNING

      -
    • DELETE

      -
    • ABNORMAL

      -
    +

    Dump task status. Possible values:

    +
    • ERROR: An error occurs.
    • STARTING: The dump task is being started.
    • PAUSED: The dump task has been stopped.
    • RUNNING: The dump task is running.
    • DELETE: The dump task has been deleted.
    • ABNORMAL: The dump task is abnormal.
    +

    Enumeration values:

    +
    • ERROR
    • STARTING
    • PAUSED
    • RUNNING
    • DELETE
    • ABNORMAL

    destination_type

    +

    destination_type

    String

    +

    String

    Dump destination. Possible values:

    -
    • OBS: Data is dumped to OBS.

      -
    • MRS: Data is dumped to MRS.

      -
    • DLI: Data is dumped to DLI.

      -
    • CLOUDTABLE: Data is dumped to CloudTable.

      -
    • DWS: Data is dumped to DWS.

      -
    -

    Enumeration values:

    -
    • OBS

      -
    • MRS

      -
    • DLI

      -
    • CLOUDTABLE

      -
    • DWS

      -
    +

    Dump destination. Possible values:

    +
    • OBS: Data is dumped to OBS.
    +

    Enumeration values:

    +
    • OBS

    create_time

    +

    create_time

    Long

    +

    Long

    Time when the dump task is created.

    +

    Time when the dump task is created.

    last_transfer_timestamp

    +

    last_transfer_timestamp

    Long

    +

    Long

    Latest dump time of the dump task.

    +

    Latest dump time of the dump task.

    -

    Example Requests

    Querying Dump Tasks

    -
    GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    +

    Example Requests

    Querying Dump Tasks

    +
    GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    -

    Example Responses

    Status code: 200

    -

    Normal response.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Normal response.

    +
    {
       "tasks" : [ {
         "task_id" : "As805BudhcH1lDs6gbn",
         "destination_type" : "OBS",
    @@ -190,23 +168,23 @@
       "total_number" : 1
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -214,3 +192,4 @@
    + diff --git a/docs/dis/api-ref/ShowApp.html b/docs/dis/api-ref/ShowApp.html index 541a907a..6629b7db 100644 --- a/docs/dis/api-ref/ShowApp.html +++ b/docs/dis/api-ref/ShowApp.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/apps/{app_name}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -54,8 +54,8 @@ - @@ -140,3 +140,4 @@ + diff --git a/docs/dis/api-ref/ShowCheckpoint.html b/docs/dis/api-ref/ShowCheckpoint.html index 34173426..66f3c36e 100644 --- a/docs/dis/api-ref/ShowCheckpoint.html +++ b/docs/dis/api-ref/ShowCheckpoint.html @@ -1,172 +1,167 @@

    Querying Checkpoint Details

    -

    Function

    This API is used to query checkpoint details.

    +

    Function

    This API is used to query checkpoint details.

    -

    URI

    GET /v2/{project_id}/checkpoints

    +

    URI

    GET /v2/{project_id}/checkpoints

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    -
    Table 2 Query parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the stream to which the checkpoint belongs.

    +

    Name of the stream to which the checkpoint belongs.

    partition_id

    +

    partition_id

    Yes

    +

    Yes

    String

    +

    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.

    +

    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

    +

    app_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the app associated with the checkpoint.

    +

    Name of the app associated with the checkpoint.

    checkpoint_type

    +

    checkpoint_type

    Yes

    +

    Yes

    String

    +

    String

    Type of the checkpoint.

    -
    • LAST_READ: Only sequence numbers are recorded in databases.

      -
    -

    Enumeration values:

    -
    • LAST_READ

      -
    +

    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

    +

    Request Parameters

    +
    - - - - - - -
    Table 3 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -

    Response Parameters

    Status code: 204

    +

    Response Parameters

    Status code: 204

    -
    Table 4 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    sequence_number

    +

    sequence_number

    String

    +

    String

    Sequence number used to record the consumption checkpoint of the stream.

    +

    Sequence number used to record the consumption checkpoint of the stream.

    metadata

    +

    metadata

    String

    +

    String

    Metadata information of the consumer application.

    +

    Metadata information of the consumer application.

    -

    Example Requests

    Querying Checkpoint Details

    -
    GET https://{Endpoint}/v2/{project_id}/checkpoints
    +

    Example Requests

    Querying Checkpoint Details

    +
    GET https://{Endpoint}/v2/{project_id}/checkpoints
    -

    Example Responses

    Status code: 204

    -

    Normal response.

    -
    {
    +

    Example Responses

    Status code: 204

    +

    Normal response.

    +
    {
       "sequence_number" : "newstram",
       "metadata" : ""
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    204

    +

    204

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -174,3 +169,4 @@
    + diff --git a/docs/dis/api-ref/ShowConsumerState.html b/docs/dis/api-ref/ShowConsumerState.html index 02af4c12..1766a8d4 100644 --- a/docs/dis/api-ref/ShowConsumerState.html +++ b/docs/dis/api-ref/ShowConsumerState.html @@ -1,174 +1,242 @@

    Querying App Consumption Status

    -

    Function

    This API is used to query the consumption status of apps.

    +

    Function

    This API is used to query the consumption status of apps.

    -

    URI

    GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}

    +

    URI

    GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}

    -
    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    app_name

    +

    app_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the app to be queried.

    +

    Name of the app to be queried.

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the stream to be queried.

    -

    Maximum: 60

    +

    Name of the stream to be queried.

    +

    Maximum: 60

    -
    Table 2 Query parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

    Max. number of partitions to list in a single API call. The minimum value is 1 and the maximum value is 1,000. The default value is 100.

    -

    Minimum: 1

    -

    Maximum: 1000

    -

    Default: 100

    +

    Max. number of partitions to list in a single API call. The minimum value is 1 and the maximum value is 1,000. The default value is 100.

    +

    Minimum: 1

    +

    Maximum: 1000

    +

    Default: 100

    start_partition_id

    +

    start_partition_id

    No

    +

    No

    String

    +

    String

    Name of the partition to start the partition list with. The returned partition list does not contain this partition.

    +

    Name of the partition to start the partition list with. The returned partition list does not contain this partition.

    checkpoint_type

    +

    checkpoint_type

    Yes

    +

    Yes

    String

    +

    String

    Type of the checkpoint.

    -
    • LAST_READ: Only sequence numbers are recorded in databases.

      -
    -

    Enumeration values:

    -
    • LAST_READ

      -
    +

    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

    +

    Request Parameters

    +
    - - - - - - -
    Table 3 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 4 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    app_name

    +

    has_more

    String

    +

    String

    Name of the app.

    +

    Specify whether there are more matching DIS streams to list. Possible values:

    +
    • true: yes
    • false: no
    +

    Default: false.

    app_id

    +

    stream_name

    String

    +

    String

    Unique identifier of the app.

    +

    Stream Name

    create_time

    +

    app_name

    Long

    +

    String

    Time when the app is created, in milliseconds.

    +

    App Name

    commit_checkpoint_stream_names

    +

    partition_consuming_states

    Array of strings

    +

    Array of strings

    List of associated streams.

    +

    partition consuming state list

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Partition_consuming_states

    Parameter

    +

    Type

    +

    Description

    +

    partition_id

    +

    String

    +

    Partition Id

    +

    sequence_number

    +

    String

    +

    Partition Sequence Number

    +

    latest_offset

    +

    Long

    +

    partition data latest offset

    +

    earliest_offset

    +

    Long

    +

    partition data earliest offset

    +

    metadata

    +

    String

    +

    user-defined metadata information

    +

    checkpoint_type

    +

    String

    +

    Type of the checkpoint.

    +

    LAST_READ: Only sequence numbers are recorded in databases.

    +

    Enumeration values:

    +

    LAST_READ

    +

    status

    +

    String

    +

    Partition Status:

    +

    CREATING

    +

    ACTIVE

    +

    DELETED

    +

    EXPIRED

    -

    Example Requests

    Querying App Consumption Status

    -
    GET https://{Endpoint}/v2/{project_id}/apps/{app_name}/streams/{stream_name}
    +

    Example Requests

    Querying App Consumption Status

    +
    GET https://{Endpoint}/v2/{project_id}/apps/{app_name}/streams/{stream_name}
    -

    Example Responses

    Status code: 200

    -

    Normal response.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Normal response.

    +
    {
       "stream_name" : "newstream",
       "app_name" : "newapp",
       "partition_consuming_states" : [ {
    @@ -180,23 +248,23 @@
       } ]
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -204,3 +272,4 @@
    + diff --git a/docs/dis/api-ref/ShowPartitionMetrics.html b/docs/dis/api-ref/ShowPartitionMetrics.html index 7edb0900..166c2b07 100644 --- a/docs/dis/api-ref/ShowPartitionMetrics.html +++ b/docs/dis/api-ref/ShowPartitionMetrics.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -40,18 +40,14 @@ -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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.

    +

    Partition ID 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

    +
    @@ -67,11 +63,11 @@ - - @@ -239,3 +234,4 @@ + diff --git a/docs/dis/api-ref/ShowStreamMetrics.html b/docs/dis/api-ref/ShowStreamMetrics.html index 320110e3..2367e738 100644 --- a/docs/dis/api-ref/ShowStreamMetrics.html +++ b/docs/dis/api-ref/ShowStreamMetrics.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/streams/{stream_name}/metrics

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    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

      +

    Partition monitoring metric. (Either label or label_list must be specified. If they are both specified, label_list prevails.)

    +
    • total_put_bytes_per_partition: total input traffic in a partition (byte)

      +
    • total_get_bytes_per_partition: total output traffic in a partition (byte)

      +
    • total_put_records_per_partition: total number of input records in a partition

      +
    • total_get_records_per_partition: total number of output records in a partition

    Enumeration values:

    • total_put_bytes_per_partition

      @@ -129,8 +125,7 @@

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    Table 1 Path parameters

    Parameter

    +
    @@ -38,7 +38,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -54,17 +54,17 @@ - - @@ -245,3 +245,4 @@ + diff --git a/docs/dis/api-ref/ShowStreamTags.html b/docs/dis/api-ref/ShowStreamTags.html index aaeadd1b..69da6cac 100644 --- a/docs/dis/api-ref/ShowStreamTags.html +++ b/docs/dis/api-ref/ShowStreamTags.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/stream/{stream_id}/tags

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    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

      +

    Stream monitoring metric (Either label or label_list must be specified. If they are both 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

      @@ -128,8 +128,8 @@

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    Table 1 Path parameters

    Parameter

    +
    @@ -54,8 +54,8 @@ - @@ -95,10 +95,10 @@ - - - - - - - - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

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

      +

    Key

    +
    • It cannot be left blank.

      +
    • It must be unique for each resource.

      +
    • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

    Minimum: 1

    Maximum: 36

    @@ -108,10 +108,10 @@

    String

    Value.

    -
    • The value contains a maximum of 43 characters.

      -
    • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

      -
    • The value can contain only digits, letters, hyphens (-), and underscores (_).

      +

    Value

    +
    • It can contain a maximum of 43 characters.

      +
    • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

      +
    • It can only contain digits, letters, hyphens (-), and underscores (_).

    Minimum: 0

    Maximum: 43

    @@ -160,3 +160,4 @@ + diff --git a/docs/dis/api-ref/ShowTransferTask.html b/docs/dis/api-ref/ShowTransferTask.html index 22dfadb5..46651bcc 100644 --- a/docs/dis/api-ref/ShowTransferTask.html +++ b/docs/dis/api-ref/ShowTransferTask.html @@ -110,9 +110,9 @@

    String

    Dump destination. Possible values:

    -
    • OBS: Data is dumped to OBS.
    • MRS: Data is dumped to MRS.
    • DLI: Data is dumped to DLI.
    • CLOUDTABLE: Data is dumped to CloudTable.
    • DWS: Data is dumped to DWS.
    +
    • OBS: Data is dumped to OBS.

    Enumeration values:

    -
    • OBS
    • MRS
    • DLI
    • CLOUDTABLE
    • DWS
    +
    • OBS

    create_time

    @@ -143,34 +143,6 @@

    Parameter list of OBS to which data in the DIS stream will be dumped.

    dws_destination_descripton

    -

    DWSDestinationDescriptorRequest object

    -

    Parameter list of the DWS to which data in the DIS stream will be dumped.

    -

    mrs_destination_description

    -

    MRSDestinationDescriptorRequest object

    -

    Parameter list of the MRS to which data in the DIS stream will be dumped.

    -

    dli_destination_description

    -

    DliDestinationDescriptorRequest object

    -

    Parameter list of the DLI to which data in the DIS stream will be dumped.

    -

    cloudtable_destination_descripton

    -

    CloudtableDestinationDescriptorRequest object

    -

    Parameter list of the CloudTable to which data in the DIS stream will be dumped.

    -
    @@ -313,12 +285,10 @@

    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.

    +
    • Text (default)

    Default: text

    Enumeration values:

    -
    • text
    • parquet
    • carbon
    +
    • text

    processing_schema

    @@ -379,844 +349,6 @@
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    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.

    -

    This parameter is left blank by default.

    -

    options

    -

    Options object

    -

    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.

    -

    cloudtable_schema

    -

    CloudtableSchema object

    -

    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.

    -

    opentsdb_schema

    -

    Array of OpenTSDBSchema objects

    -

    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.

    -

    Value range: 0-7,200

    -

    Unit: second

    -

    Default value: 1,800

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 12 CloudtableSchema

    Parameter

    -

    Type

    -

    Description

    -

    row_key

    -

    Array of RowKey objects

    -

    HBase rowkey schema used by the CloudTable cluster to convert JSON data into HBase rowkeys.

    -

    Value range: 1-64

    -

    columns

    -

    Array of Column objects

    -

    HBase column schema used by the CloudTable cluster to convert JSON data into HBase columns.

    -

    Value range: 1 to 4,096

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 13 RowKey

    Parameter

    -

    Type

    -

    Description

    -

    value

    -

    String

    -

    JSON attribute name, which is used to generate HBase rowkeys for JSON data in the DIS stream.

    -

    type

    -

    String

    -

    JSON attribute type of JSON data in the DIS stream. Value range:

    -
    • Bigint
    • Double
    • Boolean
    • Timestamp
    • String
    • Decimal
    -

    Enumeration values:

    -
    • Bigint
    • Double
    • Boolean
    • Timestamp
    • String
    • Decimal
    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 14 Column

    Parameter

    -

    Type

    -

    Description

    -

    column_family_name

    -

    String

    -

    Name of the HBase column family to which data will be dumped.

    -

    column_name

    -

    String

    -

    Name of the HBase column to which data will be dumped.

    -

    Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)

    -

    value

    -

    String

    -

    JSON attribute name, which is used to generate HBase column values for JSON data in the DIS stream.

    -

    type

    -

    String

    -

    JSON attribute type of JSON data in the DIS stream.

    -

    Value range:

    -
    • Bigint
    • Double
    • Boolean
    • Timestamp
    • String
    • Decimal
    -

    Enumeration values:

    -
    • Bigint
    • Double
    • Boolean
    • Timestamp
    • String
    • Decimal
    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 15 OpenTSDBSchema

    Parameter

    -

    Type

    -

    Description

    -

    metric

    -

    Array of OpenTSDBMetric objects

    -

    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.

    -

    timestamp

    -

    OpenTSDBTimestamp object

    -

    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.

    -

    value

    -

    OpenTSDBValue object

    -

    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.

    -

    tags

    -

    Array of OpenTSDBTags objects

    -

    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}
    @@ -1276,3 +408,4 @@
    + diff --git a/docs/dis/api-ref/UpdatePartitionCount.html b/docs/dis/api-ref/UpdatePartitionCount.html index 5d27cd06..28afc4c7 100644 --- a/docs/dis/api-ref/UpdatePartitionCount.html +++ b/docs/dis/api-ref/UpdatePartitionCount.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/streams/{stream_name}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -55,8 +55,8 @@ - @@ -89,10 +89,11 @@ - @@ -136,3 +137,4 @@ + diff --git a/docs/dis/api-ref/UpdateStream.html b/docs/dis/api-ref/UpdateStream.html deleted file mode 100644 index fc44d833..00000000 --- a/docs/dis/api-ref/UpdateStream.html +++ /dev/null @@ -1,183 +0,0 @@ - - -

    Updating Stream Information

    -

    Function

    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

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    Integer

    Number of the target partitions.

    +

    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.

    +

    Note:

    +

    Each stream can be scaled up and down for five times within one hour. After a stream is scaled up or down, it cannot be scaled up or down again in the next one hour.

    Minimum: 0

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

    -
    -
    -
    -

    Response Parameters

    None

    -
    -

    Example Requests

    • Updating Lifecycles of Streams

      -
      PUT https://{Endpoint}/v3/{project_id}/streams/{stream_name}
      -
      -{
      -  "stream_name" : "stz_test",
      -  "data_duration" : 48
      -}
      -
    • Updating Stream Types

      -
      PUT https://{Endpoint}/v3/{project_id}/streams/{stream_name}
      -
      -{
      -  "stream_name" : "stz_test",
      -  "data_type" : "JSON"
      -}
      -
    -
    -

    Example Responses

    None

    -
    -

    Status Codes

    -
    - - - - - - - -

    Status Code

    -

    Description

    -

    204

    -

    Normal response.

    -
    -
    -
    -

    Error Codes

    See Error Codes.

    -
    - -
    - -
    diff --git a/docs/dis/api-ref/dis_02_0003.html b/docs/dis/api-ref/dis_02_0003.html index be3d2d73..387a15e9 100644 --- a/docs/dis/api-ref/dis_02_0003.html +++ b/docs/dis/api-ref/dis_02_0003.html @@ -2,7 +2,7 @@

    Application Example

    Scenarios

    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.

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

    @@ -10,7 +10,7 @@
    • 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.

    +

    An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. You can obtain endpoints of the service from Regions and Endpoints.

    Creating a Stream

    The following is an example of creating a stream with the simplest configuration.

    1. Obtain the token by following the instructions in Token-based Authentication.
    2. Send POST https://Endpoint of DIS/v2/{project_id}/streams.
    3. Add X-Auth-Token to the request header.
    4. Specify the following parameters in the request body:
      {
      @@ -49,14 +49,11 @@
       "auto_scale_enabled": true,
       "auto_scale_min_partition_count": 1,
       "auto_scale_max_partition_count": 10
      -"data_type": "JSON",
      -"data_schema": 
      -"{\"type\":\"record\",\"name\":\"RecordName\",\"fields\":[{\"name\":\"key1\",\"type\":\"string\"},{\"name\":\"key2\",\"type\":\"string\"}]}"
      +"data_type": "BLOG",
       }
      -

      In this example, a stream whose source data type is JSON and that contains the key1 and key2 attributes is created.

      -
      • data_type indicates the type of source data. The value JSON indicates that the data format in the partition is JSON.
      • data_schema indicates the source data schema, which describes the source data structures in JSON and CSV formats using the Avro Schema syntax.

      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.

    + diff --git a/docs/dis/api-ref/dis_02_0015.html b/docs/dis/api-ref/dis_02_0015.html index 26037e8d..42fafe22 100644 --- a/docs/dis/api-ref/dis_02_0015.html +++ b/docs/dis/api-ref/dis_02_0015.html @@ -20,3 +20,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0016_01.html b/docs/dis/api-ref/dis_02_0016_01.html index 3dc89891..362b6548 100644 --- a/docs/dis/api-ref/dis_02_0016_01.html +++ b/docs/dis/api-ref/dis_02_0016_01.html @@ -1,340 +1,274 @@

    Creating Streams

    -

    Function

    This API is used to create a stream.

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

      -
    +

    Function

    This API is used to create a stream.

    +
    • When creating a stream, specify a stream type (common or advanced) and the number of partitions.
    • A maximum of 10 advanced stream partitions and 50 common stream partitions can be created for an account by default. You can submit a work order to increase the quota.
    -

    URI

    POST /v2/{project_id}/streams

    +

    URI

    POST /v2/{project_id}/streams

    -
    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -
    Table 3 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the stream.

    -

    The stream name can contain 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-).

    -

    Maximum: 64

    +

    Stream name

    +

    The stream name can contain 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-).

    +

    Maximum: 64

    partition_count

    +

    partition_count

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of partitions. Partitions are the base throughput unit of a DIS stream.

    +

    Number of partitions

    +

    Partitions are the base throughput unit of the DIS stream.

    stream_type

    +

    stream_type

    No

    +

    No

    String

    +

    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

      -
    +

    Stream type

    +
    • COMMON: a common stream with a bandwidth of 1 MB/s
    • ADVANCED: an advanced stream with a bandwidth of 5 MB/s
    +

    Enumeration values:

    +
    • COMMON
    • ADVANCED

    data_type

    +

    data_type

    No

    +

    No

    String

    +

    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

      -
    +

    Source data type

    +
    • BLOB: a collection of binary data stored as a single entity in a database management system
    +

    Default value: BLOB

    +

    Enumeration values:

    +
    • BLOB

    data_duration

    +

    data_duration

    No

    +

    No

    Integer

    +

    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 retention period

    +

    Value range: 24–72

    +

    Unit: hour

    +

    Default value: 24

    +

    If this parameter is left unspecified, the default value will be used.

    +

    Maximum: 72

    +

    Default: 24

    auto_scale_enabled

    +

    auto_scale_enabled

    No

    +

    No

    Boolean

    +

    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

    +

    Whether to enable auto scaling

    +
    • true: Auto scaling is enabled.
    • false: Auto scaling is disabled.
    +

    By default, this function is disabled.

    +

    Default: false

    auto_scale_min_partition_count

    +

    auto_scale_min_partition_count

    No

    +

    No

    Long

    +

    Long

    Minimum number of partitions for automatic scale-down when auto scaling is enabled.

    -

    Minimum: 1

    +

    Minimum number of partitions for automatic scale-down when auto scaling is enabled.

    +

    Minimum: 1

    auto_scale_max_partition_count

    +

    auto_scale_max_partition_count

    No

    +

    No

    Integer

    +

    Integer

    Maximum number of partitions for automatic scale-up when auto scaling is enabled.

    +

    Maximum number of partitions for automatic scale-up when auto scaling is enabled.

    data_schema

    +

    compression_format

    No

    +

    No

    String

    +

    String

    Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema.

    +

    Data compression type. The following types are available:

    +
    • snappy
    • gzip
    • zip
    +

    Data is not compressed by default.

    +

    Enumeration values:

    +
    • snappy
    • gzip
    • zip

    csv_properties

    +

    tags

    No

    +

    No

    CSVProperties object

    +

    Array of Tag objects

    Attributes of data in CSV format, such as delimiter.

    +

    List of stream tags.

    compression_format

    +

    sys_tags

    No

    +

    No

    String

    +

    Array of SysTag objects

    Compression type of data. Currently, the value can be:

    -
    • snappy

      -
    • gzip

      -
    • zip

      -
    -

    Data is not compressed by default.

    -

    Enumeration values:

    -
    • snappy

      -
    • gzip

      -
    • zip

      -
    -

    tags

    -

    No

    -

    Array of Tag objects

    -

    List of stream tags.

    -

    sys_tags

    -

    No

    -

    Array of SysTag objects

    -

    Stream enterprise projects.

    +

    Stream enterprise projects.

    -
    Table 4 CSVProperties

    Parameter

    +
    - - - - - - - + + + + +
    Table 4 Tag

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    delimiter

    +

    key

    No

    +

    No

    String

    +

    String

    Data separator.

    +

    Key

    +
    • It cannot be left blank.
    • It must be unique for each resource.
    • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
    +

    Minimum: 1

    +

    Maximum: 36

    +

    value

    +

    No

    +

    String

    +

    Value

    +
    • It can contain a maximum of 43 characters.
    • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
    • It can only contain digits, letters, hyphens (-), and underscores (_).
    +

    Minimum: 0

    +

    Maximum: 43

    -
    Table 5 Tag

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 5 SysTag

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    No

    +

    No

    String

    +

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

      -
    -

    Minimum: 1

    -

    Maximum: 36

    +

    Key

    +
    • It cannot be left blank.
    • Its value must be _sys_enterprise_project_id.
    +

    Enumeration values:

    +
    • _sys_enterprise_project_id

    value

    +

    value

    No

    +

    No

    String

    +

    String

    Value.

    -
    • The value contains a maximum of 43 characters.

      -
    • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

      -
    • The value can contain only digits, letters, hyphens (-), and underscores (_).

      -
    -

    Minimum: 0

    -

    Maximum: 43

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 6 SysTag

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    key

    -

    No

    -

    String

    -

    Key.

    -
    • This field cannot be left blank.

      -
    • The value must be _sys_enterprise_project_id.

      -
    -

    Enumeration values:

    -
    • _sys_enterprise_project_id

      -
    -

    value

    -

    No

    -

    String

    -

    Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.

    -
    • 36-digit UUID

      -
    +

    Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.

    +
    • It is a 36-digit UUID.
    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    Creating Streams

    -
    POST https://{Endpoint}/v2/{project_id}/streams
    +

    Example Requests

    Creating Streams

    +
    POST https://{Endpoint}/v2/{project_id}/streams
     
     {
       "stream_name" : "newstream",
    @@ -342,25 +276,25 @@
       "data_duration" : 24
     }
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    201

    +

    201

    Created

    +

    Created

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -368,3 +302,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0018.html b/docs/dis/api-ref/dis_02_0018.html index b2adb269..f6929f1a 100644 --- a/docs/dis/api-ref/dis_02_0018.html +++ b/docs/dis/api-ref/dis_02_0018.html @@ -1,228 +1,226 @@

    Uploading Data

    -

    Function

    This API is used to upload data to DIS streams.

    +

    Function

    This API is used to upload data to DIS streams.

    -

    URI

    POST /v2/{project_id}/records

    +

    URI

    POST /v2/{project_id}/records

    -
    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -
    Table 3 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the stream.

    -

    Maximum: 60

    +

    Name of the stream.

    +

    Maximum: 64

    stream_id

    +

    stream_id

    No

    +

    No

    String

    +

    String

    Unique ID of the stream.

    -

    If no stream is found by stream_name and stream_id is not empty, stream_id is used to search for the stream.

    -

    Note:

    -

    This parameter is mandatory when data is uploaded to the authorized stream.

    +

    Unique ID of the stream

    +

    If no stream is found based on stream_name and stream_id is not empty, stream_id is used to search for the stream.

    +

    Note:

    +

    This parameter is mandatory when data is uploaded to the authorized stream.

    records

    +

    records

    Yes

    +

    Yes

    Array of PutRecordsRequestEntry objects

    +

    Array of PutRecordsRequestEntry objects

    List of records to be uploaded.

    +

    List of records to be uploaded.

    -
    Table 4 PutRecordsRequestEntry

    Parameter

    +
    - - - - - - - - - - - - - - - - - - -
    Table 4 PutRecordsRequestEntry

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    Yes

    +

    Yes

    String

    +

    String

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

    +

    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

    +

    explicit_hash_key

    No

    +

    No

    String

    +

    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

    +

    Hash value of the data to be written to the partition. The hash value overwrites the hash value of partition_key.

    +

    Value range: 0 to long.max

    partition_id

    +

    partition_id

    No

    +

    No

    String

    +

    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 ID of the stream The value can be in either of the following formats: - shardId-0000000000- 0For 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

    +

    partition_key

    No

    +

    No

    String

    +

    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.

    +

    Partition to which data is written to Note:If the partition_id parameter is transferred, it will be preferentially used. If partition_id is not passed, partition_key will be used.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    failed_record_count

    +

    failed_record_count

    Integer

    +

    Integer

    Number of data records that fail to be uploaded.

    +

    Number of data records that fail to be uploaded.

    records

    +

    records

    Array of PutRecordsResultEntry objects

    +

    Array of PutRecordsResultEntry objects

    List of upload results.

    +

    List of upload results.

    -
    Table 6 PutRecordsResultEntry

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 6 PutRecordsResultEntry

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    partition_id

    +

    partition_id

    String

    +

    String

    ID of the partition to which data is uploaded.

    +

    ID of the partition to which data is uploaded.

    sequence_number

    +

    sequence_number

    String

    +

    String

    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.

    +

    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.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    +

    Error code.

    error_message

    +

    error_message

    String

    +

    String

    Error message.

    +

    Error message.

    -

    Example Requests

    Uploading Data

    -
    POST https://{Endpoint}/v2/{project_id}/records
    +

    Example Requests

    Uploading Data

    +
    POST https://{Endpoint}/v2/{project_id}/records
     
     {
       "stream_name" : "newstream",
    @@ -231,25 +229,25 @@
       } ]
     }
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -257,3 +255,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0019.html b/docs/dis/api-ref/dis_02_0019.html index ed512cd3..a5f4e121 100644 --- a/docs/dis/api-ref/dis_02_0019.html +++ b/docs/dis/api-ref/dis_02_0019.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/records

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -45,7 +45,7 @@ @@ -56,7 +56,7 @@ - @@ -82,8 +82,8 @@ - @@ -111,7 +111,7 @@ - @@ -132,9 +132,7 @@ - - @@ -164,8 +162,8 @@ - @@ -214,3 +212,4 @@ + diff --git a/docs/dis/api-ref/dis_02_0020.html b/docs/dis/api-ref/dis_02_0020.html index 0e803edf..368ecc8e 100644 --- a/docs/dis/api-ref/dis_02_0020.html +++ b/docs/dis/api-ref/dis_02_0020.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/cursors

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Data cursor, which needs to be obtained through the API for obtaining data cursors.

    -

    Value range: a string of 1 to 512 characters

    +

    Value: 1 to 512 characters

    Note:

    The validity period of a data cursor is 5 minutes.

    Integer

    Maximum number of bytes that can be obtained for each request.

    +

    Maximum number of bytes that can be obtained for each request

    Note:

    If the value is less than the size of a single record in the partition, the record cannot be obtained.

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    String

    Next iterator.

    +

    Next iterator

    Note:

    The validity period of a data cursor is 5 minutes.

    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.

    +

    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

    @@ -148,7 +146,7 @@

    String

    Downloaded data.

    +

    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.

    String

    Timestamp data type.

    -
    • CreateTime: creation time.

      +

    Timestamp type

    +
    • CreateTime: creation time

    Default: CreateTime

    Table 1 Path parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    - @@ -147,7 +144,8 @@ - - + + + + + + @@ -34,3 +48,4 @@
    Table 2 Query parameters

    Parameter

    +
    @@ -53,11 +53,7 @@ - - - - + + + + +
    Table 2 Query Parameters

    Parameter

    Mandatory

    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 ID of the stream The value can be in either of the following formats:- shardId-0000000000- 0For 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

    @@ -66,13 +62,7 @@

    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.

      -
    +

    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 valid record stored in the partition. For example, a tenant used 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. If the tenant specifies TRIM_HORIZON for downloading data, the system downloads data from A2. - LATEST: Data is read just after the most recent record in the partition. This setting ensures that you always read the most recent data in the partition. - AT_TIMESTAMP: Data is read from the position denoted by a specific timestamp.

    Enumeration values:

    • AT_SEQUENCE_NUMBER

    • AFTER_SEQUENCE_NUMBER

      @@ -88,9 +78,7 @@

    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

    +

    Sequence number. A sequence number is the unique identifier of each record. DIS automatically allocates a sequence number when the data producer calls the PutRecords operation to add data to the DIS stream. The sequence number 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 location of the data to be accessed. Value range: 0 to 9223372036854775807

    timestamp

    @@ -99,11 +87,20 @@

    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.

    +

    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.

    stream-id

    +

    No

    +

    String

    +

    Unique ID of the stream. This parameter is mandatory for obtaining the iterator of an authorized stream.

    +
    @@ -125,8 +122,8 @@

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    String

    Data cursor. Value range: a string of 1 to 512 characters

    +

    Data cursor

    +

    Value: 1 to 512 characters

    Note:

    The validity period of a data cursor is 5 minutes.

    Minimum: 1

    @@ -191,3 +189,4 @@ + diff --git a/docs/dis/api-ref/dis_02_0022.html b/docs/dis/api-ref/dis_02_0022.html index 4c638feb..c78f52f3 100644 --- a/docs/dis/api-ref/dis_02_0022.html +++ b/docs/dis/api-ref/dis_02_0022.html @@ -332,3 +332,4 @@ + diff --git a/docs/dis/api-ref/dis_02_0023.html b/docs/dis/api-ref/dis_02_0023.html index 1686070a..a0fad546 100644 --- a/docs/dis/api-ref/dis_02_0023.html +++ b/docs/dis/api-ref/dis_02_0023.html @@ -8,7 +8,21 @@

    2018-10-25

    +

    2023-04-03

    +

    Modified the following sections:

    +

    Creating Streams

    +

    2022-09-30

    +

    Modified the following sections:

    + +

    Offline the following sections:

    +
    • Updating Stream Information
    • Adding Permission Policies
    • Querying Permission Policies
    +

    2018-10-25

    Accepted in OTC 3.2.

    + diff --git a/docs/dis/api-ref/dis_02_0024.html b/docs/dis/api-ref/dis_02_0024.html index 9263cf8c..9b7c36e2 100644 --- a/docs/dis/api-ref/dis_02_0024.html +++ b/docs/dis/api-ref/dis_02_0024.html @@ -1,350 +1,319 @@

    Querying Streams

    -

    Function

    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.

    +

    Function

    This API is used to query all the streams created by the current tenant.

    +

    During query, you need to specify the stream from which the stream list is returned and the maximum number of streams returned in a single request.

    -

    URI

    GET /v2/{project_id}/streams

    +

    URI

    GET /v2/{project_id}/streams

    -
    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    -
    Table 2 Query parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    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

    +

    The maximum number of DIS streams to list in a single API call

    +

    Value range: 1 to 100

    +

    Default value: 10

    +

    Minimum: 1

    +

    Maximum: 100

    +

    Default: 10

    start_stream_name

    +

    start_stream_name

    No

    +

    No

    String

    +

    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.

    +

    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 when you query data 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

    +

    Request Parameters

    +
    - - - - - - -
    Table 3 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 4 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total_number

    +

    total_number

    Long

    +

    Long

    Total number of all the DIS streams created by the current tenant.

    +

    Total number of all the DIS streams created by the current tenant.

    stream_names

    +

    stream_names

    Array of strings

    +

    Array of strings

    List of the streams meeting the current requests.

    +

    List of the streams meeting the current requests.

    has_more_streams

    +

    has_more_streams

    Boolean

    +

    Boolean

    Specify whether there are more matching DIS streams to list. Possible values:

    -
    • true: yes

      -
    • false: no

      -
    -

    Default: false

    +

    Whether there are more matching DIS streams

    +
    • true: yes
    • false: no
    +

    Default: false

    stream_info_list

    +

    stream_info_list

    Array of StreamInfo objects

    +

    Array of StreamInfo objects

    Stream details.

    +

    Stream details.

    -
    Table 5 StreamInfo

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 StreamInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    stream_name

    +

    stream_name

    String

    +

    String

    Name of the stream.

    +

    Name of the stream.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when the stream is created. The value is a 13-bit timestamp.

    +

    Time when the stream is created. The value is a 13-bit timestamp.

    retention_period

    +

    retention_period

    Integer

    +

    Integer

    Period for storing data in units of hours.

    +

    Period for storing data in units of hours.

    status

    +

    status

    String

    +

    String

    Current status of the stream. Possible values:

    -
    • CREATING: The stream is being created.

      -
    • RUNNING: The stream is running.

      -
    • TERMINATING: The stream is being deleted.

      -
    • TERMINATED: The stream has been deleted.

      -
    -

    Enumeration values:

    -
    • CREATING

      -
    • RUNNING

      -
    • TERMINATING

      -
    • FROZEN

      -
    +

    Current status of the stream

    +
    • CREATING: creating
    • RUNNING: running
    • TERMINATING: deleting
    • TERMINATED: deleted
    +

    Enumeration values:

    +
    • CREATING
    • RUNNING
    • TERMINATING
    • FROZEN

    stream_type

    +

    stream_type

    String

    +

    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

      -
    +

    Stream type

    +
    • COMMON: a common stream with a bandwidth of 1 MB/s
    • ADVANCED: an advanced stream with a bandwidth of 5 MB/s
    +

    Enumeration values:

    +
    • COMMON
    • ADVANCED

    data_type

    +

    data_type

    String

    +

    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

      -
    +

    Source data type

    +
    • BLOB: a collection of binary data stored as a single entity in a database management system
    +

    Default value: BLOB

    +

    Enumeration values:

    +
    • BLOB

    partition_count

    +

    partition_count

    Integer

    +

    Integer

    Quantity of partitions. Partitions are the base throughput unit of a DIS stream.

    +

    Number of partitions

    +

    Partitions are the base throughput unit of the DIS stream.

    auto_scale_enabled

    +

    auto_scale_enabled

    Boolean

    +

    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

    +

    Whether to enable auto scaling

    +
    • true: Auto scaling is enabled.
    • false: Auto scaling is disabled.
    +

    By default, this function is disabled.

    +

    Default: false

    auto_scale_min_partition_count

    +

    auto_scale_min_partition_count

    Integer

    +

    Integer

    Minimum number of partitions for automatic scale-down when auto scaling is enabled.

    -

    Minimum: 1

    +

    Minimum number of partitions for automatic scale-down when auto scaling is enabled.

    +

    Minimum: 1

    auto_scale_max_partition_count

    +

    auto_scale_max_partition_count

    Integer

    +

    Integer

    Maximum number of partitions for automatic scale-up when auto scaling is enabled.

    +

    Maximum number of partitions for automatic scale-up when auto scaling is enabled.

    tags

    +

    tags

    Array of Tag objects

    +

    Array of Tag objects

    List of stream tags.

    +

    List of stream tags.

    sys_tags

    +

    sys_tags

    Array of SysTag objects

    +

    Array of SysTag objects

    Stream enterprise projects.

    +

    Stream enterprise projects.

    -
    Table 6 Tag

    Parameter

    +
    - - - - - - - -
    Table 6 Tag

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    String

    +

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

      -
    -

    Minimum: 1

    -

    Maximum: 36

    +

    Key

    +
    • It cannot be left blank.
    • It must be unique for each resource.
    • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
    +

    Minimum: 1

    +

    Maximum: 36

    value

    +

    value

    String

    +

    String

    Value.

    -
    • The value contains a maximum of 43 characters.

      -
    • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

      -
    • The value can contain only digits, letters, hyphens (-), and underscores (_).

      -
    -

    Minimum: 0

    -

    Maximum: 43

    +

    Value

    +
    • It can contain a maximum of 43 characters.
    • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
    • It can only contain digits, letters, hyphens (-), and underscores (_).
    +

    Minimum: 0

    +

    Maximum: 43

    -
    Table 7 SysTag

    Parameter

    +
    - - - - - - - -
    Table 7 SysTag

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    String

    +

    String

    Key.

    -
    • This field cannot be left blank.

      -
    • The value must be _sys_enterprise_project_id.

      -
    -

    Enumeration values:

    -
    • _sys_enterprise_project_id

      -
    +

    Key

    +
    • It cannot be left blank.
    • Its value must be _sys_enterprise_project_id.
    +

    Enumeration values:

    +
    • _sys_enterprise_project_id

    value

    +

    value

    String

    +

    String

    Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.

    -
    • 36-digit UUID

      -
    +

    Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.

    +
    • It is a 36-digit UUID.
    -

    Example Requests

    Querying Streams

    -
    GET https://{Endpoint}/v2/{project_id}/streams
    +

    Example Requests

    Querying Streams

    +
    GET https://{Endpoint}/v2/{project_id}/streams
    -

    Example Responses

    Status code: 200

    -

    Normal response.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Normal response.

    +
    {
       "total_number" : 1,
       "stream_names" : [ "newstream" ],
       "stream_info_list" : [ {
    @@ -364,23 +333,23 @@
       "has_more_streams" : false
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -388,3 +357,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0025.html b/docs/dis/api-ref/dis_02_0025.html index c6fddb8a..8ca4977d 100644 --- a/docs/dis/api-ref/dis_02_0025.html +++ b/docs/dis/api-ref/dis_02_0025.html @@ -1,521 +1,451 @@

    Querying Stream Details

    -

    Function

    This API is used to query details about a specified stream.

    +

    Function

    This API is used to query details about a specified stream.

    -

    URI

    GET /v2/{project_id}/streams/{stream_name}

    +

    URI

    GET /v2/{project_id}/streams/{stream_name}

    -
    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Stream to be queried.

    -

    Maximum: 60

    +

    Stream to be queried.

    +

    Maximum: 60

    -
    Table 2 Query parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    start_partitionId

    +

    start_partitionId

    No

    +

    No

    String

    +

    String

    Name of the partition to start the partition list with. The returned partition list does not contain this partition.

    +

    Name of the partition to start the partition list with. The returned partition list does not contain this partition.

    limit_partitions

    +

    limit_partitions

    No

    +

    No

    Integer

    +

    Integer

    Maximum number of partitions to list in a single API call. Value range: 1-1,000 Default value: 100

    -

    Minimum: 1

    -

    Maximum: 1000

    -

    Default: 100

    +

    Maximum number of partitions to list in a single API call

    +

    Value range: 1 to 1000

    +

    Default value: 100

    +

    Minimum: 1

    +

    Maximum: 1000

    +

    Default: 100

    +

    stream_id

    +

    No

    +

    String

    +

    Stream ID. This parameter is mandatory for querying details of an authorized stream.

    -

    Request Parameters

    -
    Table 3 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 3 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 4 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    stream_name

    +

    stream_name

    String

    +

    String

    Name of the stream.

    +

    Name of the stream.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a stream is created. The value is a 13-bit timestamp.

    +

    Time when a stream is created. The value is a 13-bit timestamp.

    last_modified_time

    +

    last_modified_time

    Long

    +

    Long

    Time when a stream is the most recently modified. The value is a 13-bit timestamp.

    +

    Time when a stream is the most recently modified. The value is a 13-bit timestamp.

    status

    +

    status

    String

    +

    String

    Current status of the stream. Possible values:

    -
    • CREATING: The stream is being created.

      -
    • RUNNING: The stream is running.

      -
    • TERMINATING: The stream is being deleted.

      -
    • TERMINATED: The stream has been deleted.

      -
    -

    Enumeration values:

    -
    • CREATING

      -
    • RUNNING

      -
    • TERMINATING

      -
    • FROZEN

      -
    +

    Current status of the stream

    +
    • CREATING: creating
    • RUNNING: running
    • TERMINATING: deleting
    • TERMINATED: deleted
    +

    Enumeration values:

    +
    • CREATING
    • RUNNING
    • TERMINATING
    • FROZEN

    stream_type

    +

    stream_type

    String

    +

    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

      -
    +

    Stream type

    +
    • COMMON: a common stream with a bandwidth of 1 MB/s
    • ADVANCED: an advanced stream with a bandwidth of 5 MB/s
    +

    Enumeration values:

    +
    • COMMON
    • ADVANCED

    partitions

    +

    partitions

    Array of PartitionResult objects

    +

    Array of PartitionResult objects

    A list of partitions that comprise the DIS stream.

    +

    A list of partitions that comprise the DIS stream.

    has_more_partitions

    +

    has_more_partitions

    Boolean

    +

    Boolean

    Specifies whether there are more matching partitions of the DIS stream to list.

    -
    • true: yes

      -
    • false: no

      -
    +

    Whether there are more matching partitions

    +
    • true: yes
    • false: no

    retention_period

    +

    retention_period

    Integer

    +

    Integer

    Period for storing data in units of hours.

    +

    Period for storing data in units of hours.

    stream_id

    +

    stream_id

    String

    +

    String

    Unique identifier of the stream.

    +

    Unique identifier of the stream.

    data_type

    +

    data_type

    String

    +

    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

      -
    +

    Source data type

    +
    • BLOB: a collection of binary data stored as a single entity in a database management system
    +

    Default value: BLOB

    +

    Enumeration values:

    +
    • BLOB

    data_schema

    +

    compression_format

    String

    +

    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/

    +

    Data compression type. The following types are available:

    +
    • snappy
    • gzip
    • zip
    +

    Data is not compressed by default.

    +

    Enumeration values:

    +
    • snappy
    • gzip
    • zip

    compression_format

    +

    writable_partition_count

    String

    +

    Integer

    Compression type of data. Currently, the value can be:

    -
    • snappy

      -
    • gzip

      -
    • zip

      -
    -

    Data is not compressed by default.

    -

    Enumeration values:

    -
    • snappy

      -
    • gzip

      -
    • zip

      -
    +

    Total number of writable partitions (including partitions in ACTIVE state only).

    csv_properties

    +

    readable_partition_count

    CSVProperties object

    +

    Integer

    Attributes of data in CSV format, such as delimiter.

    +

    Total number of readable partitions (including partitions in ACTIVE and DELETED state).

    writable_partition_count

    +

    update_partition_counts

    Integer

    +

    Array of UpdatePartitionCount objects

    Total number of writable partitions (including partitions in ACTIVE state only).

    +

    List of scaling operation records.

    readable_partition_count

    +

    tags

    Integer

    +

    Array of Tag objects

    Total number of readable partitions (including partitions in ACTIVE and DELETED state).

    +

    List of stream tags.

    update_partition_counts

    +

    sys_tags

    Array of UpdatePartitionCount objects

    +

    Array of SysTag objects

    List of scaling operation records.

    +

    Enterprise project of a stream.

    tags

    +

    auto_scale_enabled

    Array of Tag objects

    +

    Boolean

    List of stream tags.

    +

    Whether to enable auto scaling

    +
    • true: Auto scaling is enabled.
    • false: Auto scaling is disabled.
    +

    By default, this function is disabled.

    sys_tags

    +

    auto_scale_min_partition_count

    Array of SysTag objects

    +

    Integer

    Enterprise project of a stream.

    +

    Minimum number of partitions for automatic scale-down when auto scaling is enabled.

    auto_scale_enabled

    +

    auto_scale_max_partition_count

    Boolean

    +

    Integer

    Specifies whether to enable auto scaling.

    -
    • true: auto scaling is enabled.

      -
    • false: auto scaling is disabled.

      -
    -

    This function is disabled by default.

    -

    auto_scale_min_partition_count

    -

    Integer

    -

    Minimum number of partitions for automatic scale-down when auto scaling is enabled.

    -

    auto_scale_max_partition_count

    -

    Integer

    -

    Maximum number of partitions for automatic scale-up when auto scaling is enabled.

    +

    Maximum number of partitions for automatic scale-up when auto scaling is enabled.

    -
    Table 5 PartitionResult

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 5 PartitionResult

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    status

    +

    status

    String

    +

    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

      -
    +

    Current status of the partition

    +
    • CREATING: creating
    • ACTIVE: available
    • DELETED: deleted
    • EXPIRED: expired
    +

    Enumeration values:

    +
    • CREATING
    • ACTIVE
    • DELETED
    • EXPIRED

    partition_id

    +

    partition_id

    String

    +

    String

    Unique identifier of the partition.

    +

    Unique identifier of the partition.

    hash_range

    +

    hash_range

    String

    +

    String

    Possible value range of the hash key used by the partition.

    +

    Possible value range of the hash key used by the partition.

    sequence_number_range

    +

    sequence_number_range

    String

    +

    String

    Sequence number range of the partition.

    +

    Sequence number range of the partition.

    parent_partitions

    +

    parent_partitions

    String

    +

    String

    Parent partition.

    +

    Parent partition.

    -
    Table 6 CSVProperties

    Parameter

    +
    - - - - - + + + + + + + + + + + + + + + + + + + +
    Table 6 UpdatePartitionCount

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    delimiter

    +

    create_timestamp

    String

    +

    Long

    Data separator.

    +

    Scaling execution timestamp, which is a 13-digit timestamp.

    +

    src_partition_count

    +

    Integer

    +

    Number of partitions before scaling.

    +

    target_partition_count

    +

    Integer

    +

    Number of partitions after scaling.

    +

    result_code

    +

    Integer

    +

    Response code of the scaling operation.

    +

    result_msg

    +

    Integer

    +

    Response to the scaling operation.

    +

    auto_scale

    +

    Boolean

    +

    Whether the scaling operation is automatic

    +
    • true: auto scaling
    • false: manual scaling
    -
    Table 7 UpdatePartitionCount

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - -
    Table 7 Tag

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    create_timestamp

    +

    key

    Long

    +

    String

    Scaling execution timestamp, which is a 13-digit timestamp.

    +

    Key

    +
    • It cannot be left blank.
    • It must be unique for each resource.
    • It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
    +

    Minimum: 1

    +

    Maximum: 36

    src_partition_count

    +

    value

    Integer

    +

    String

    Number of partitions before scaling.

    -

    target_partition_count

    -

    Integer

    -

    Number of partitions after scaling.

    -

    result_code

    -

    Integer

    -

    Response code of the scaling operation.

    -

    result_msg

    -

    Integer

    -

    Response to the scaling operation.

    -

    auto_scale

    -

    Boolean

    -

    Specifies whether the scaling operation is automatic.

    -
    • true: Auto scaling is enabled.

      -
    • false: Manual scaling is enabled.

      -
    +

    Value

    +
    • It can contain a maximum of 43 characters.
    • It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
    • It can only contain digits, letters, hyphens (-), and underscores (_).
    +

    Minimum: 0

    +

    Maximum: 43

    -
    Table 8 Tag

    Parameter

    +
    - - - - - - - - - - -
    Table 8 SysTag

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    String

    +

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

      -
    -

    Minimum: 1

    -

    Maximum: 36

    +

    Key

    +
    • It cannot be left blank.
    • Its value must be _sys_enterprise_project_id.
    +

    Enumeration values:

    +
    • _sys_enterprise_project_id

    value

    +

    value

    String

    +

    String

    Value.

    -
    • The value contains a maximum of 43 characters.

      -
    • Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).

      -
    • The value can contain only digits, letters, hyphens (-), and underscores (_).

      -
    -

    Minimum: 0

    -

    Maximum: 43

    -
    -
    - -
    - - - - - - - - - - -
    Table 9 SysTag

    Parameter

    -

    Type

    -

    Description

    -

    key

    -

    String

    -

    Key.

    -
    • This field cannot be left blank.

      -
    • The value must be _sys_enterprise_project_id.

      -
    -

    Enumeration values:

    -
    • _sys_enterprise_project_id

      -
    -

    value

    -

    String

    -

    Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.

    -
    • 36-digit UUID

      -
    +

    Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.

    +
    • It is a 36-digit UUID.
    -

    Example Requests

    Querying Stream Details

    -
    GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}
    +

    Example Requests

    Querying Stream Details

    +
    GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}
    -

    Example Responses

    Status code: 200

    -

    Normal response.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Normal response.

    +
    {
       "stream_id" : "8QM3Nt9YTLOwtUVYJhO",
       "stream_name" : "newstream",
       "create_time" : 1593569685875,
    @@ -539,23 +469,23 @@
       "has_more_partitions" : false
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -563,3 +493,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0200.html b/docs/dis/api-ref/dis_02_0200.html index 90d2eb18..cad1da9c 100644 --- a/docs/dis/api-ref/dis_02_0200.html +++ b/docs/dis/api-ref/dis_02_0200.html @@ -3,3 +3,4 @@

    API Overview

    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.

    + diff --git a/docs/dis/api-ref/dis_02_0400.html b/docs/dis/api-ref/dis_02_0400.html index e7b8dc47..cfc5218b 100644 --- a/docs/dis/api-ref/dis_02_0400.html +++ b/docs/dis/api-ref/dis_02_0400.html @@ -160,8 +160,7 @@

    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.

    -
    -Content-Type: application/json
    +
    Content-Type: application/json
     {
         "auth": {
             "identity": {
    @@ -193,3 +192,4 @@ Content-Type: application/json
     
     
     
    +
    diff --git a/docs/dis/api-ref/dis_02_0403.html b/docs/dis/api-ref/dis_02_0403.html
    index 54cdf741..6944fa9b 100644
    --- a/docs/dis/api-ref/dis_02_0403.html
    +++ b/docs/dis/api-ref/dis_02_0403.html
    @@ -1,141 +1,136 @@
     
     
     

    Submitting Checkpoints

    -

    Function

    This API is used to submit checkpoints.

    +

    Function

    This API is used to submit checkpoints.

    -

    URI

    POST /v2/{project_id}/checkpoints

    +

    URI

    POST /v2/{project_id}/checkpoints

    -
    Table 1 Path parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID.

    +

    Project ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token.

    -

    The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

    +

    User token

    +

    The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

    -
    Table 3 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    app_name

    +

    app_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the app, which is the unique identifier of a user data consumption program.

    +

    Name of the app, which is the unique identifier of a user data consumption program.

    checkpoint_type

    +

    checkpoint_type

    Yes

    +

    Yes

    String

    +

    String

    Type of the checkpoint.

    -
    • LAST_READ: Only sequence numbers are recorded in databases.

      -
    -

    Enumeration values:

    -
    • LAST_READ

      -
    +

    Type of the checkpoint

    +
    • LAST_READ: Only sequence numbers are recorded in databases.
    +

    Enumeration values:

    +
    • LAST_READ

    stream_name

    +

    stream_name

    Yes

    +

    Yes

    String

    +

    String

    Name of the stream.

    +

    Name of the stream.

    partition_id

    +

    partition_id

    Yes

    +

    Yes

    String

    +

    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.

    +

    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.

    sequence_number

    +

    sequence_number

    Yes

    +

    Yes

    String

    +

    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.

    +

    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

    +

    metadata

    No

    +

    No

    String

    +

    String

    Metadata information of the consumer application.

    -

    The metadata information can contain a maximum of 1,000 characters.

    -

    Maximum: 1000

    +

    Metadata information of the consumer application

    +

    The metadata information can contain a maximum of 1,000 characters.

    +

    Maximum: 1000

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    Submitting Checkpoints

    -
    POST https://{Endpoint}/v2/{project_id}/checkpoints
    +

    Example Requests

    Submitting Checkpoints

    +
    POST https://{Endpoint}/v2/{project_id}/checkpoints
     
     {
       "stream_name" : "newstream",
    @@ -145,25 +140,25 @@
       "checkpoint_type" : "LAST_READ"
     }
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    201

    +

    201

    Normal response.

    +

    Normal response.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    @@ -171,3 +166,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0410.html b/docs/dis/api-ref/dis_02_0410.html index 63676539..4c810abc 100644 --- a/docs/dis/api-ref/dis_02_0410.html +++ b/docs/dis/api-ref/dis_02_0410.html @@ -80,7 +80,7 @@

    String

    Dump destination. Possible values:

    -
    • OBS: Data is dumped to OBS.
    • MRS: Data is dumped to MRS.
    • DLI: Data is dumped to DLI.
    • CLOUDTABLE: Data is dumped to CloudTable.
    • DWS: Data is dumped to DWS.
    +
    • OBS: Data is dumped to OBS.

    Default: NOWHERE

    Enumeration values:

    • OBS
    @@ -205,12 +205,10 @@

    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.

    +
    • Text (default)

    Default: text

    Enumeration values:

    -
    • text
    • parquet
    • carbon
    +
    • text

    processing_schema

    @@ -302,7 +300,7 @@ "deliver_time_interval" : 30 } } -
  • Adding OBS Dump Tasks (The dump file format is Parquet.)
    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    +
  • Adding OBS Dump Tasks (The dump file format is Text.)
    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
     
     {
       "destination_type" : "OBS",
    @@ -310,7 +308,7 @@
         "task_name" : "newtask",
         "consumer_strategy" : "LATEST",
         "agency_name" : "dis_admin_agency",
    -    "destination_file_type" : "parquet",
    +    "destination_file_type" : "text",
         "obs_bucket_path" : "obsbucket",
         "file_prefix" : "",
         "partition_format" : "yyyy/MM/dd/HH/mm",
    @@ -346,3 +344,4 @@
     
     
     
    +
    diff --git a/docs/dis/api-ref/dis_02_0500.html b/docs/dis/api-ref/dis_02_0500.html
    index 8ae0f288..1104e449 100644
    --- a/docs/dis/api-ref/dis_02_0500.html
    +++ b/docs/dis/api-ref/dis_02_0500.html
    @@ -12,3 +12,4 @@
     
  • + diff --git a/docs/dis/api-ref/dis_02_0501.html b/docs/dis/api-ref/dis_02_0501.html index d06e34aa..8c78c7cc 100644 --- a/docs/dis/api-ref/dis_02_0501.html +++ b/docs/dis/api-ref/dis_02_0501.html @@ -1,8 +1,8 @@

    Obtaining a Project ID

    -

    Obtaining a Project ID by Calling an API

    You can obtain a project ID by calling the API for Querying Project Information Based on the Specified Criteria.

    -

    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.

    +

    Obtaining a Project ID by Calling an API

    You can obtain the project ID by calling the API used to query project information.

    +

    The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained 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).

    {
         "projects": [
    @@ -31,7 +31,7 @@
     

    Obtaining a Project ID from the Console

    A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:

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

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

    -
    Figure 1 Viewing project IDs
    +
    Figure 1 Viewing project IDs
    @@ -40,10 +40,3 @@
    - - \ No newline at end of file diff --git a/docs/dis/api-ref/dis_02_0511.html b/docs/dis/api-ref/dis_02_0511.html index 17558dc4..7decab16 100644 --- a/docs/dis/api-ref/dis_02_0511.html +++ b/docs/dis/api-ref/dis_02_0511.html @@ -16,3 +16,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0512.html b/docs/dis/api-ref/dis_02_0512.html index 4f85c986..8106907f 100644 --- a/docs/dis/api-ref/dis_02_0512.html +++ b/docs/dis/api-ref/dis_02_0512.html @@ -8,3 +8,4 @@
    + diff --git a/docs/dis/api-ref/dis_02_0513.html b/docs/dis/api-ref/dis_02_0513.html index a173042d..554d228f 100644 --- a/docs/dis/api-ref/dis_02_0513.html +++ b/docs/dis/api-ref/dis_02_0513.html @@ -8,3 +8,4 @@ + diff --git a/docs/dis/api-ref/dis_02_0514.html b/docs/dis/api-ref/dis_02_0514.html index 51930b51..9beb69d4 100644 --- a/docs/dis/api-ref/dis_02_0514.html +++ b/docs/dis/api-ref/dis_02_0514.html @@ -8,3 +8,4 @@ + diff --git a/docs/dis/api-ref/dis_02_0515.html b/docs/dis/api-ref/dis_02_0515.html index 9bef405f..b61c5701 100644 --- a/docs/dis/api-ref/dis_02_0515.html +++ b/docs/dis/api-ref/dis_02_0515.html @@ -5,7 +5,7 @@
  • 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
    +
    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.

  • @@ -16,10 +16,3 @@ - - \ No newline at end of file diff --git a/docs/dis/api-ref/dis_02_0516.html b/docs/dis/api-ref/dis_02_0516.html index 5e3b6e46..9f28d77f 100644 --- a/docs/dis/api-ref/dis_02_0516.html +++ b/docs/dis/api-ref/dis_02_0516.html @@ -12,3 +12,4 @@ + diff --git a/docs/dis/api-ref/dis_02_0517.html b/docs/dis/api-ref/dis_02_0517.html index b9e373ac..c19a2bc1 100644 --- a/docs/dis/api-ref/dis_02_0517.html +++ b/docs/dis/api-ref/dis_02_0517.html @@ -6,29 +6,29 @@

    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.

    -
    {
    -    "auth": {
    -        "identity": {
    -            "methods": [
    -                "password"
    -            ],
    -            "password": {
    -                "user": {
    -                    "name": "username",
    -                    "password": "********",
    -                    "domain": {
    -                        "name": "domainname"
    -                    }
    -                }
    -            }
    -        },
    -        "scope": {
    -            "project": {
    -                "id": "xxxxxxxxxxxxxxxxxx"
    -            }
    -        }
    -    }
    +

    When calling the API to obtain a user token, you must set auth.scope in the request body to project.

    +
    { 
    +    "auth": { 
    +        "identity": { 
    +            "methods": [ 
    +                "password" 
    +            ], 
    +            "password": { 
    +                "user": { 
    +                    "name": "username", 
    +                    "password": "********", 
    +                    "domain": { 
    +                        "name": "domainname" 
    +                    } 
    +                } 
    +            } 
    +        }, 
    +        "scope": { 
    +            "project": { 
    +                "id": "xxxxxxxxxxxxxxxxxx" 
    +            } 
    +        } 
    +    } 
     }

    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:

    @@ -40,10 +40,12 @@ Content-Type: application/json
     

    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:
    1. 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.
    2. On the My Credentials page, choose Access Keys, and click Create Access Key. See Figure 1.
      Figure 1 Clicking Create Access Key
      -
    3. 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.
    +
    To obtain an access key, perform the following steps:
    1. 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.
    2. On the My Credentials page, choose Access Keys, and click Create Access Key. See Figure 1.
      Figure 1 Clicking Create Access Key
      +
    3. 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.
      • Only two access keys can be added for each user.
      • To ensure access key security, the access key is automatically downloaded only when it is generated for the first time and cannot be obtained from the management console later. Keep them properly.
      +
      +
    -
    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.

    +
    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. For details about how to sign requests and use the signature SDK, see API Request Signing Guide.

    The signing SDKs are only used for signing requests and different from the SDKs provided by services.

    @@ -54,10 +56,3 @@ Content-Type: application/json
    - - \ 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 index be94a243..40057cae 100644 --- a/docs/dis/api-ref/dis_02_0518.html +++ b/docs/dis/api-ref/dis_02_0518.html @@ -7,7 +7,7 @@

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

    @@ -37,10 +37,3 @@ - - \ 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 index 8c5c4371..0cecefe7 100644 --- a/docs/dis/api-ref/dis_02_0600.html +++ b/docs/dis/api-ref/dis_02_0600.html @@ -10,3 +10,4 @@ + diff --git a/docs/dis/api-ref/en-us_image_0000001238312593.jpg b/docs/dis/api-ref/en-us_image_0191919629.jpg similarity index 100% rename from docs/dis/api-ref/en-us_image_0000001238312593.jpg rename to docs/dis/api-ref/en-us_image_0191919629.jpg diff --git a/docs/dis/api-ref/en-us_topic_0000001079240698.html b/docs/dis/api-ref/en-us_topic_0000001079240698.html index 81112ac7..7d5cc0f5 100644 --- a/docs/dis/api-ref/en-us_topic_0000001079240698.html +++ b/docs/dis/api-ref/en-us_topic_0000001079240698.html @@ -15,428 +15,217 @@

    · 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 1lists 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

    Permissions

    -

    APIs

    -

    Actions

    -

    Project

    -

    Enterprise Project

    -

    Creating a consumer app

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Permissions policies and supported actions

    Operation

    POST /v2/{project_id}/apps

    +

    DIS Administrator

    dis:apps:create

    +

    DIS Operator

    -

    ×

    +

    DIS User

    Deleting an app

    +

    Creating streams

    DELETE /v2/{project_id}/apps/{app_name}

    +

    dis:apps:delete

    +

    -

    ×

    +

    x

    Querying apps

    +

    Deleting streams

    GET

    -

    /v2/{project_id}/apps

    +

    dis:apps:list

    +

    -

    ×

    +

    x

    Querying app details

    +

    Querying the stream list

    GET

    -

    /v2/{project_id}/apps/{app_name}

    +

    dis:apps:get

    +

    -

    ×

    +

    Querying the app consumption status

    +

    Querying stream details

    GET

    -

    /v2/{project_id}/apps/{app}/streams/{stream_name}

    +

    dis:appState:get

    +

    -

    +

    Querying all events of a user in pagination mode

    +

    Viewing stream monitoring information

    GET

    -

    /v1/{project_id}/events

    +

    dis:events:list

    +

    -

    ×

    +

    Creating a subscription

    +

    Querying partition monitoring information

    POST

    -

    /v1/{project_id}/event-subs

    +

    dis:eventEnumSubs:create

    +

    -

    ×

    +

    Deleting a subscription

    +

    Obtaining stream consumption information

    DELETE

    -

    /v1/{project_id}/event-subs/{sub_id}

    +

    dis:eventEnumSubs:delete

    +

    -

    ×

    +

    Modifying a subscription

    +

    Changing partition quantity

    PUT

    -

    /v1/{project_id}/event-subs/{sub_id}

    +

    dis:eventEnumSubs:update

    +

    -

    ×

    +

    x

    Querying all subscriptions of a user

    +

    Uploading data

    GET

    -

    /v1/{project_id}/event-subs

    +

    dis:eventEnumSubs:list

    +

    x

    -

    ×

    +

    Adding a permission policy

    +

    Obtaining data cursors

    POST

    -

    /v2/{project_id}/streams/{streamName}/policies

    +

    dis:streamPolicies:create

    +

    x

    -

    +

    Querying permission policies

    +

    Downloading data

    GET

    -

    /v2/{project_id}/streams/{streamName}/policies

    +

    dis:streamPolicies:list

    +

    x

    -

    +

    Deleting a permission policy of a stream

    +

    Creating applications

    DELETE

    -

    /v2/{project_id}/streams/{streamName}/policies

    +

    dis:streamPolicies:delete

    +

    -

    +

    Querying details of a stream

    +

    Querying application details

    GET

    -

    /v2/{project_id}/streams/{streamName}

    +

    dis:streams:get

    +

    -

    +

    Creating a stream

    +

    Querying the application list

    POST

    -

    /v2/{project_id}/streams

    +

    dis:streams:create

    +

    -

    +

    Deleting a Stream

    +

    Deleting applications

    DELETE

    -

    /v2/{project_id}/streams/{stream_name}

    +

    dis:streams:delete

    +

    -

    +

    Querying streams

    +

    Adding checkpoints

    GET

    -

    /v2/{project_id}/streams

    +

    dis:streams:list

    +

    x

    -

    ×

    +

    Updating stream information

    +

    Querying checkpoints

    PUT

    -

    /v2/{project_id}/streams/{stream_name}/update

    +

    dis:streams:update

    +

    -

    +

    Creating a dump task

    +

    Deleting checkpoints

    POST

    -

    /v2/{project_id}/streams/{stream_name}/transfer-tasks

    +

    dis:transferTasks:create

    +

    x

    -

    +

    Updating a dump task

    +

    Creating dump tasks

    PUT

    -

    /v2/{project_id}/streams/{stream_name}/transfer-tasks

    +

    dis:transferTasks:update

    +

    -

    +

    Querying dump tasks

    +

    Querying dump task details

    GET

    -

    /v2/{project_id}/streams/{stream_name}/transfer-tasks

    +

    dis:transferTasks:list

    +

    -

    +

    Querying details of a dump task

    +

    Querying the dump task list

    GET

    -

    /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}

    +

    dis:transferTasks:get

    +

    -

    +

    Deleting a dump task

    +

    Deleting dump tasks

    DELETE

    -

    /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}

    +

    dis:transferTasks:delete

    +

    -

    -

    Uploading Data to a DIS Stream

    -

    POST

    -

    /v2/{project_id}/records

    -

    dis:records:write

    -

    -

    -

    Obtaining a data cursor

    -

    GET

    -

    /v2/{project_id}/cursors

    -

    dis:records:readCursor

    -

    -

    -

    Downloading data from a DIS stream

    -

    GET

    -

    /v2/{project_id}/records

    -

    dis:records:read

    -

    -

    -

    Adding a checkpoint

    -

    POST

    -

    /v2/{project_id}/checkpoints

    -

    dis:checkpoints:commit

    -

    -

    -

    Querying checkpoint details

    -

    GET

    -

    /v2/{project_id}/checkpoints

    -

    dis:checkpoints:get

    -

    -

    -

    Deleting a checkpoint

    -

    DELETE

    -

    /v2/{project_id}/checkpoints

    -

    dis:checkpoints:delete

    -

    -

    -

    Filtering streams by tag

    -

    POST

    -

    /{project_id}/{resource_type}/resource_instances/action

    -

    dis:tagResources:list

    -

    -

    ×

    -

    Adding or deleting resource tags in batches

    -

    POST

    -

    /{project_id}/{resource_type}/{resource_id}/tags/action

    -

    dis:tagResources:update

    -

    -

    ×

    -

    Adding a Tag to a Specified Stream

    -

    POST

    -

    /{project_id}/{resource_type}/{resource_id}/tags

    -

    dis:tagResources:create

    -

    -

    ×

    -

    Deleting a tag of a specified stream

    -

    DELETE

    -

    /{project_id}/{resource_type}/{resource_id}/tags/{key}

    -

    dis:tagResources:delete

    -

    -

    ×

    -

    Querying all tags of a specified region

    -

    GET

    -

    /{project_id}/{resource_type}/tags

    -

    dis:tags:list

    -

    -

    ×

    +

    -

    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/icon-arrowdn.gif b/docs/dis/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be2f2ce458e888f8a9b803f9387247726a..379428032932289326e52c2772bd90ba3d88b906 100644 GIT binary patch literal 1887 zcmZ?wbhEHbCgqow z*eU^C3h_d20o>TUVm+{T^pf*)^(zt!^bPe4Kwg3=^!3HBG&dKny0|1L72#g21{a4^ z7NqJ2r55Lx7A2Jm>Ih`8X1|p zSh~8p7&*iAy5uL9=BDPA!1Sgd^t#~G3rY&P1wfl!Qj0RnQd8WD@^clyUbf1_?G{Iz z=0WwQ;C71>PQCg-$LND17Ac}(Lcr7mV#1RxkONQnsd>QEUIa|mjQ{`r{qy_R&mZ5v zef{$J)5j0*-@SeF`qj%9&!0Vg^7zri2lwyYy>t84%^TORUA=Po(!~qs&z(JU`qar2 z$B!L7a`@1}1N-;w-Lrew&K=vgZQZhY)5ZeMTG_VdAT{+S(zE> zX{jm6Nr?&Zaj`McQIQehVWA3>*p!%p5Wn0u7E$th{n6D>ft^YU5&dnB%c=(a~-RV>2EO25SIA CZ-yWM literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q diff --git a/docs/dis/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dis/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d168d6db303b366b5b8c1780698a6bb6017..6aaaa11c23e919c4798d7dcd2b1ae98dd35dd316 100644 GIT binary patch literal 1890 zcmZ?wbhEHb7yetOgf{ zR2HP_2c;J0mlh?b0+lO+tSYc_E=o--$uA1Y&(DE{Vn9ZINq%ugeu08>u$h8JcxGNo zetEGbSiP^Wm1kaYNn&1ds;7&s63_&_%*+%k11Cod14Ab>6ALqQLqk^=3j-5FHzP|& zBUd9gQwvj9m|mCsATTyHM;rzL?XHK6w zdE)r7qel)OI(T6JzP)>P@7lRz`?jrHHgDRvVg0(bYgVsXxnlXUrArnsTDV~Tyt#8` z&zd=7`n0K2CQq6;p}()Ur@O1OqrI)QrMaoGp}wxRrn;)KqP(oMq`0WCAU`iRCp#-M zBRwrOB{?ZEAwDiPCORrIB0MZKBseHAz~9f;$J@)(!`;o*#o5Wx!QRf+#@fo#!raW% z#MsEtKwnQ+M_Wr%LtRZ(MOjHvL0(Q)Mp{ZzLR?H#L|8~rfS-?-hntI&gPo0)g_((w zfkE*n3y@@B&;b#k`jUY|nSq%>!ec`MLnAA%oR7zc2TpB#@>)|YCO&lN;uMU!b7Eqm H1A{dHTIz>f literal 70 zcmZ?wbhEHbt!vk=Wq<+2pDdgV46F<~AOVnC295*< zZWf7v1q%)~GqG@}I5a$PY-W<+k~py8;bA60Nuebx1QU-kGH?}b>G+uJ(X7m#l2h^N zfyZQV*Q^xD%@4dL8RnPm*-_+hs@>N4-xki`wBrl-gVR_fCoewKsjI(AM?iqV8URhk BH5vc_ diff --git a/docs/dis/api-ref/public_sys-resources/imageclosehover.gif b/docs/dis/api-ref/public_sys-resources/imageclosehover.gif deleted file mode 100644 index 3bcf231f1d23f6e6e8a3cbb2d501770ff40e495a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 179 zcmZ?wbhEHb6krfw*v!E2|Ns9f_r6cL_PyuY_m*qltIvHeKKEU6?Ry3sK=CIFCj$cq zgAPa@WCjCA0)rrjM#F*y2b)=0IBW_U9ym6$O7NxJ_@LO-!NVJ~=m_h}-YkIww~n098Sz4fXkH$Ol3p2EY;V-Pv{Ap;9@ L-=-QV0S0RTMs_~T diff --git a/docs/dis/api-ref/public_sys-resources/imagemax.gif b/docs/dis/api-ref/public_sys-resources/imagemax.gif deleted file mode 100644 index 49fe390b113c71fa56110f3dc36d9a6a50f5b6e6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 181 zcmZ?wbhEHb6krfw*v!E2|NsB*-@m_q|NhytXZP;iJ9_l!-o1ObZr!?e?OFzGK=CIF zCj$c~gAPa%WCjCA5`!>@jK&3qre+R70hI^^MW<#yb{-yviwm6@MFeF$b_66GV`j9_ z`y-*yc%qZdk;`CZprRuayMvm=gar=H)AhY)O*yei`Cv0s<1e09K`#Opy45NjUAbk& Q(dDf3^IRev5*!$;0Rb{R%K!iX diff --git a/docs/dis/api-ref/public_sys-resources/imagemaxhover.gif b/docs/dis/api-ref/public_sys-resources/imagemaxhover.gif deleted file mode 100644 index 387b0a981ad70a1123a8d97d76f96c014c7f8619..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 185 zcmZ?wbhEHb6krfw*v!E2|NsB@K=l3pz3>08z5l=W{r{!+zDFGeqW4~V-#hJnZ@Bfn z=GOO;Yu__~f#OdVP6h@(1|1L&WCjCA8iOo{jD~S$J)w3@U??y!%=BxkR{1 fG<+7hb}F&15=pzXSZpzujlfq`Cl)4VCI)K&ahXC) diff --git a/docs/dis/api-ref/public_sys-resources/macFFBgHack.png b/docs/dis/api-ref/public_sys-resources/macFFBgHack.png deleted file mode 100644 index c6473b324ee1dae1faaacc0826639833f551116c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 207 zcmeAS@N?(olHy`uVBq!ia0vp^k|4~%1|*NXY)uAIEX7WqAsj$Z!;#Vf4nJ za0`Jjl>Qs8<JF;+Fd5q0wCR k?u=~bH}2*0f`J3~k>FVdQ&MBb@0BAfpf&c&j diff --git a/docs/dis/api-ref/topic_300000000.html b/docs/dis/api-ref/topic_300000000.html index 28c03560..c75fa6e2 100644 --- a/docs/dis/api-ref/topic_300000000.html +++ b/docs/dis/api-ref/topic_300000000.html @@ -15,15 +15,10 @@ - - - + diff --git a/docs/dis/api-ref/topic_300000001.html b/docs/dis/api-ref/topic_300000001.html index 41016afe..cf4e7a7f 100644 --- a/docs/dis/api-ref/topic_300000001.html +++ b/docs/dis/api-ref/topic_300000001.html @@ -21,3 +21,4 @@ + diff --git a/docs/dis/api-ref/topic_300000002.html b/docs/dis/api-ref/topic_300000002.html index 0dd300b5..ce40788b 100644 --- a/docs/dis/api-ref/topic_300000002.html +++ b/docs/dis/api-ref/topic_300000002.html @@ -17,3 +17,4 @@ + diff --git a/docs/dis/api-ref/topic_300000003.html b/docs/dis/api-ref/topic_300000003.html index 6edf5f91..d022747d 100644 --- a/docs/dis/api-ref/topic_300000003.html +++ b/docs/dis/api-ref/topic_300000003.html @@ -17,3 +17,4 @@ + diff --git a/docs/dis/api-ref/topic_300000004.html b/docs/dis/api-ref/topic_300000004.html index a636d108..fe72538c 100644 --- a/docs/dis/api-ref/topic_300000004.html +++ b/docs/dis/api-ref/topic_300000004.html @@ -7,7 +7,7 @@ + diff --git a/docs/dis/api-ref/topic_300000005.html b/docs/dis/api-ref/topic_300000005.html index 26942b2e..1b01cb33 100644 --- a/docs/dis/api-ref/topic_300000005.html +++ b/docs/dis/api-ref/topic_300000005.html @@ -15,3 +15,4 @@ + diff --git a/docs/dis/api-ref/topic_300000006.html b/docs/dis/api-ref/topic_300000006.html index 48c61f17..e23a6eda 100644 --- a/docs/dis/api-ref/topic_300000006.html +++ b/docs/dis/api-ref/topic_300000006.html @@ -25,3 +25,4 @@ +