From f8c0bfcf4cc014fcfb5221a159721d1524550046 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Tue, 27 Jun 2023 15:25:12 +0000 Subject: [PATCH] Changes to dis_api-ref from docs/doc-exports#574 (DIS API 20230116 version Alig Reviewed-by: Kacur, Michal Co-authored-by: proposalbot Co-committed-by: proposalbot --- ...8312593.jpg => en-us_image_0191919629.jpg} | Bin .../creating_consumption_apps.rst | 38 +- .../app_management/deleting_apps.rst | 16 +- .../querying_app_consumption_status.rst | 83 ++- .../app_management/querying_app_details.rst | 16 +- .../app_management/querying_apps.rst | 67 +- .../deleting_checkpoints.rst | 66 +- .../querying_checkpoint_details.rst | 28 +- .../submitting_checkpoints.rst | 28 +- .../data_management/downloading_data.rst | 70 +- .../obtaining_data_cursors.rst | 126 ++-- .../data_management/uploading_data.rst | 86 ++- .../adding_cloudtable_dump_tasks.rst | 447 ----------- .../adding_dli_dump_tasks.rst | 163 ---- .../adding_dws_dump_tasks.rst | 282 ------- .../adding_mrs_dump_tasks.rst | 197 ----- .../adding_obs_dump_tasks.rst | 16 +- .../deleting_dump_tasks.rst | 16 +- .../dump_task_management/index.rst | 12 +- .../pausing_dump_tasks_in_batches.rst | 26 +- ..._dump_tasks.rst => querying_dump_task.rst} | 30 +- .../querying_dump_task_details.rst | 696 ++---------------- .../starting_dump_tasks_in_batches.rst | 26 +- .../querying_partition_monitoring_data.rst | 54 +- .../querying_stream_monitoring_data.rst | 40 +- .../adding_permission_policies.rst | 128 ---- .../changing_partition_quantity.rst | 52 +- .../stream_management/creating_streams.rst | 261 +++---- .../deleting_specified_streams.rst | 16 +- .../stream_management/index.rst | 6 - .../querying_permission_policies.rst | 132 ---- .../querying_stream_details.rst | 328 ++++----- .../stream_management/querying_streams.rst | 295 ++++---- .../updating_stream_information.rst | 134 ---- .../adding_resource_tags_in_batches.rst | 94 ++- .../adding_tags_for_specified_streams.rst | 70 +- .../deleting_resource_tags_in_batches.rst | 92 ++- .../deleting_tags_of_specified_streams.rst | 16 +- .../querying_tags_of_specified_regions.rst | 50 +- .../querying_tags_of_specified_streams.rst | 70 +- ...using_tags_to_filter_resources_streams.rst | 178 ++--- api-ref/source/appendix/error_codes.rst | 20 +- .../appendix/obtaining_a_project_id.rst | 6 +- api-ref/source/application_example.rst | 13 +- .../source/calling_apis/authentication.rst | 7 +- api-ref/source/change_history.rst | 48 +- ...issions_policies_and_supported_actions.rst | 188 ++--- 47 files changed, 1232 insertions(+), 3601 deletions(-) rename api-ref/source/_static/images/{en-us_image_0000001238312593.jpg => en-us_image_0191919629.jpg} (100%) delete mode 100644 api-ref/source/api_description/dump_task_management/adding_cloudtable_dump_tasks.rst delete mode 100644 api-ref/source/api_description/dump_task_management/adding_dli_dump_tasks.rst delete mode 100644 api-ref/source/api_description/dump_task_management/adding_dws_dump_tasks.rst delete mode 100644 api-ref/source/api_description/dump_task_management/adding_mrs_dump_tasks.rst rename api-ref/source/api_description/dump_task_management/{querying_dump_tasks.rst => querying_dump_task.rst} (75%) delete mode 100644 api-ref/source/api_description/stream_management/adding_permission_policies.rst delete mode 100644 api-ref/source/api_description/stream_management/querying_permission_policies.rst delete mode 100644 api-ref/source/api_description/stream_management/updating_stream_information.rst diff --git a/api-ref/source/_static/images/en-us_image_0000001238312593.jpg b/api-ref/source/_static/images/en-us_image_0191919629.jpg similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001238312593.jpg rename to api-ref/source/_static/images/en-us_image_0191919629.jpg diff --git a/api-ref/source/api_description/app_management/creating_consumption_apps.rst b/api-ref/source/api_description/app_management/creating_consumption_apps.rst index 253c9ef..634dacc 100644 --- a/api-ref/source/api_description/app_management/creating_consumption_apps.rst +++ b/api-ref/source/api_description/app_management/creating_consumption_apps.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/apps -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -28,27 +28,27 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=================================================================================================================+ - | app_name | Yes | String | Unique identifier of the consumer application to be created. | - | | | | | - | | | | The application name contains 1 to 200 characters, including letters, digits, underscores (_), and hyphens (-). | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **200** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================================+ + | app_name | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/app_management/deleting_apps.rst b/api-ref/source/api_description/app_management/deleting_apps.rst index e06a8f3..a771d02 100644 --- a/api-ref/source/api_description/app_management/deleting_apps.rst +++ b/api-ref/source/api_description/app_management/deleting_apps.rst @@ -15,7 +15,7 @@ URI DELETE /v2/{project_id}/apps/{app_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== ============================== Parameter Mandatory Type Description @@ -29,13 +29,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/app_management/querying_app_consumption_status.rst b/api-ref/source/api_description/app_management/querying_app_consumption_status.rst index 0f6820e..623eb20 100644 --- a/api-ref/source/api_description/app_management/querying_app_consumption_status.rst +++ b/api-ref/source/api_description/app_management/querying_app_consumption_status.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/apps/{app_name}/streams/{stream_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+-----------------------------------+ | Parameter | Mandatory | Type | Description | @@ -29,7 +29,7 @@ GET /v2/{project_id}/apps/{app_name}/streams/{stream_name} | | | | Maximum: **60** | +-----------------+-----------------+-----------------+-----------------------------------+ -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -44,9 +44,9 @@ GET /v2/{project_id}/apps/{app_name}/streams/{stream_name} +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ | start_partition_id | No | String | Name of the partition to start the partition list with. The returned partition list does not contain this partition. | +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | checkpoint_type | Yes | String | Type of the checkpoint. | + | checkpoint_type | Yes | String | Type of the checkpoint | | | | | | - | | | | - LAST_READ: Only sequence numbers are recorded in databases. | + | | | | - **LAST_READ**: Only sequence numbers are recorded in databases. | | | | | | | | | | Enumeration values: | | | | | | @@ -58,13 +58,13 @@ Request Parameters .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -73,17 +73,56 @@ Response Parameters .. table:: **Table 4** Response body parameters - +--------------------------------+------------------+------------------------------------------------+ - | Parameter | Type | Description | - +================================+==================+================================================+ - | app_name | String | Name of the app. | - +--------------------------------+------------------+------------------------------------------------+ - | app_id | String | Unique identifier of the app. | - +--------------------------------+------------------+------------------------------------------------+ - | create_time | Long | Time when the app is created, in milliseconds. | - +--------------------------------+------------------+------------------------------------------------+ - | commit_checkpoint_stream_names | Array of strings | List of associated streams. | - +--------------------------------+------------------+------------------------------------------------+ + +----------------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============================+=======================+===============================================================================+ + | has_more | String | Specify whether there are more matching DIS streams to list. Possible values: | + | | | | + | | | - true: yes | + | | | - false: no | + | | | | + | | | Default: **false**. | + +----------------------------+-----------------------+-------------------------------------------------------------------------------+ + | stream_name | String | Stream Name | + +----------------------------+-----------------------+-------------------------------------------------------------------------------+ + | app_name | String | App Name | + +----------------------------+-----------------------+-------------------------------------------------------------------------------+ + | partition_consuming_states | Array of strings | partition consuming state list | + +----------------------------+-----------------------+-------------------------------------------------------------------------------+ + +.. table:: **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 ---------------- diff --git a/api-ref/source/api_description/app_management/querying_app_details.rst b/api-ref/source/api_description/app_management/querying_app_details.rst index 55ca0ab..bfad95d 100644 --- a/api-ref/source/api_description/app_management/querying_app_details.rst +++ b/api-ref/source/api_description/app_management/querying_app_details.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/apps/{app_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== ============================== Parameter Mandatory Type Description @@ -29,13 +29,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/app_management/querying_apps.rst b/api-ref/source/api_description/app_management/querying_apps.rst index 72e3d7f..91f4885 100644 --- a/api-ref/source/api_description/app_management/querying_apps.rst +++ b/api-ref/source/api_description/app_management/querying_apps.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/apps -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -23,12 +23,16 @@ GET /v2/{project_id}/apps project_id Yes String Project ID. ========== ========= ====== =========== -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+===============================================================================================+ - | limit | No | Integer | Maximum number of apps to list in a single API call. Value range: 1-100 Default value: 10 | + | limit | No | Integer | Maximum number of apps to list in a single API call | + | | | | | + | | | | Range: 1 to 100 | + | | | | | + | | | | Default value: **10** | | | | | | | | | | Minimum: **1** | | | | | | @@ -46,13 +50,13 @@ Request Parameters .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -61,35 +65,30 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------------------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=================================================================================+==========================================================================+ - | has_more_app | Boolean | Specifies whether there are more matching consumer applications to list. | - | | | | - | | | - true: yes | - | | | | - | | | - false: no | - +-----------------------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------+ - | apps | Array of :ref:`DescribeAppResult ` objects | AppEntry list that meets the current request. | - +-----------------------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------+ - | total_number | Integer | Total number of apps that meet criteria. | - +-----------------------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=================================================================================+=======================================================+ + | has_more_app | Boolean | Whether there are more matching consumer applications | + | | | | + | | | - **true**: yes | + | | | - **false**: no | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------+ + | apps | Array of :ref:`DescribeAppResult ` objects | AppEntry list that meets the current request. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------+ + | total_number | Integer | Total number of apps that meet criteria. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------+ .. _listapp__response_describeappresult: .. table:: **Table 5** DescribeAppResult - +--------------------------------+------------------+------------------------------------------------+ - | Parameter | Type | Description | - +================================+==================+================================================+ - | app_name | String | Name of the app. | - +--------------------------------+------------------+------------------------------------------------+ - | app_id | String | Unique identifier of the app. | - +--------------------------------+------------------+------------------------------------------------+ - | create_time | Long | Time when the app is created, in milliseconds. | - +--------------------------------+------------------+------------------------------------------------+ - | commit_checkpoint_stream_names | Array of strings | List of associated streams. | - +--------------------------------+------------------+------------------------------------------------+ + =========== ====== ============================================== + Parameter Type Description + =========== ====== ============================================== + app_name String Name of the app. + app_id String Unique identifier of the app. + create_time Long Time when the app is created, in milliseconds. + =========== ====== ============================================== Example Requests ---------------- diff --git a/api-ref/source/api_description/checkpoint_management/deleting_checkpoints.rst b/api-ref/source/api_description/checkpoint_management/deleting_checkpoints.rst index 9f9ae5e..2742a3f 100644 --- a/api-ref/source/api_description/checkpoint_management/deleting_checkpoints.rst +++ b/api-ref/source/api_description/checkpoint_management/deleting_checkpoints.rst @@ -15,7 +15,7 @@ URI DELETE /v2/{project_id}/checkpoints -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -23,46 +23,44 @@ DELETE /v2/{project_id}/checkpoints project_id Yes String Project ID. ========== ========= ====== =========== -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=========================================================================================================================================================================+ - | stream_name | Yes | String | Name of the stream to which the checkpoint belongs. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_name | Yes | String | Name of the application associated with the checkpoint. | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **50** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | checkpoint_type | Yes | String | Type of the checkpoint. LAST_READ: Only sequence numbers are recorded in databases. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **LAST_READ** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_id | No | String | Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats: | - | | | | | - | | | | - shardId-0000000000 | - | | | | | - | | | | - 0 | - | | | | | - | | | | For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, and shardId-0000000000, shardId-0000000001, shardId-0000000002, respectively. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================================================================================================================+ + | stream_name | Yes | String | Name of the stream to which the checkpoint belongs. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app_name | Yes | String | Name of the application associated with the checkpoint. | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **50** | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | checkpoint_type | Yes | String | Type of the checkpoint | + | | | | | + | | | | - **LAST_READ**: Only sequence numbers are recorded in databases. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **LAST_READ** | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | partition_id | No | String | Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:- shardId-0000000000- 0 | + | | | | | + | | | | For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/checkpoint_management/querying_checkpoint_details.rst b/api-ref/source/api_description/checkpoint_management/querying_checkpoint_details.rst index 40623db..1455209 100644 --- a/api-ref/source/api_description/checkpoint_management/querying_checkpoint_details.rst +++ b/api-ref/source/api_description/checkpoint_management/querying_checkpoint_details.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/checkpoints -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -23,26 +23,22 @@ GET /v2/{project_id}/checkpoints project_id Yes String Project ID. ========== ========= ====== =========== -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+============================================================================================================================================================================+ | stream_name | Yes | String | Name of the stream to which the checkpoint belongs. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_id | Yes | String | Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats: | - | | | | | - | | | | - shardId-0000000000 | - | | | | | - | | | | - 0 | + | partition_id | Yes | String | Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:- shardId-0000000000- 0 | | | | | | | | | | For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | app_name | Yes | String | Name of the app associated with the checkpoint. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | checkpoint_type | Yes | String | Type of the checkpoint. | + | checkpoint_type | Yes | String | Type of the checkpoint | | | | | | - | | | | - LAST_READ: Only sequence numbers are recorded in databases. | + | | | | - **LAST_READ**: Only sequence numbers are recorded in databases. | | | | | | | | | | Enumeration values: | | | | | | @@ -54,13 +50,13 @@ Request Parameters .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/checkpoint_management/submitting_checkpoints.rst b/api-ref/source/api_description/checkpoint_management/submitting_checkpoints.rst index 9a574e6..9dc837c 100644 --- a/api-ref/source/api_description/checkpoint_management/submitting_checkpoints.rst +++ b/api-ref/source/api_description/checkpoint_management/submitting_checkpoints.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/checkpoints -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -28,13 +28,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters @@ -43,9 +43,9 @@ Request Parameters +=================+=================+=================+============================================================================================================================================================================+ | app_name | Yes | String | Name of the app, which is the unique identifier of a user data consumption program. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | checkpoint_type | Yes | String | Type of the checkpoint. | + | checkpoint_type | Yes | String | Type of the checkpoint | | | | | | - | | | | - LAST_READ: Only sequence numbers are recorded in databases. | + | | | | - **LAST_READ**: Only sequence numbers are recorded in databases. | | | | | | | | | | Enumeration values: | | | | | | @@ -53,17 +53,13 @@ Request Parameters +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | stream_name | Yes | String | Name of the stream. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_id | Yes | String | Partition identifier of the stream. The value can be in either of the following formats: | - | | | | | - | | | | - shardId-0000000000 | - | | | | | - | | | | - 0 | + | partition_id | Yes | 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. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | sequence_number | Yes | String | Sequence number to be submitted, which is used to record the consumption checkpoint of the stream. Ensure that the sequence number is within the valid range. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | String | Metadata information of the consumer application. | + | metadata | No | String | Metadata information of the consumer application | | | | | | | | | | The metadata information can contain a maximum of 1,000 characters. | | | | | | diff --git a/api-ref/source/api_description/data_management/downloading_data.rst b/api-ref/source/api_description/data_management/downloading_data.rst index 5e24a03..ec8a0bb 100644 --- a/api-ref/source/api_description/data_management/downloading_data.rst +++ b/api-ref/source/api_description/data_management/downloading_data.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/records -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -23,20 +23,20 @@ GET /v2/{project_id}/records project_id Yes String Project ID. ========== ========= ====== =========== -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==================+=================+=================+========================================================================================================+ | partition-cursor | Yes | 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. | +------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ - | max_fetch_bytes | No | Integer | Maximum number of bytes that can be obtained for each request. | + | max_fetch_bytes | No | Integer | Maximum number of bytes that can be obtained for each request | | | | | | | | | | Note: | | | | | | @@ -48,13 +48,13 @@ Request Parameters .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -68,7 +68,7 @@ Response Parameters +=======================+===============================================================+====================================================+ | records | Array of :ref:`Record ` objects | List of downloaded records. | +-----------------------+---------------------------------------------------------------+----------------------------------------------------+ - | next_partition_cursor | String | Next iterator. | + | next_partition_cursor | String | Next iterator | | | | | | | | Note: | | | | | @@ -79,31 +79,27 @@ Response Parameters .. table:: **Table 5** Record - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================================================================================================================================================================================+ - | partition_key | String | Partition key set when data is being uploaded. | - | | | | - | | | Note: | - | | | | - | | | If the partition_key parameter is passed when data is uploaded, this parameter will be returned when data is downloaded. If partition_id instead of partition_key is passed when data is uploaded, no partition_key is returned. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sequence_number | String | Sequence number of the data record. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data | String | Downloaded data. | - | | | | - | | | The downloaded data is the serialized binary data (Base64-encoded character string). | - | | | | - | | | For example, the data returned by the data download API is "ZGF0YQ==", which is "data" after Base64 decoding. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | timestamp | Long | Timestamp when the record is written to DIS. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | timestamp_type | String | Timestamp data type. | - | | | | - | | | - CreateTime: creation time. | - | | | | - | | | Default: **CreateTime** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================================================================================================================================================================================================================================================================+ + | partition_key | String | Partition key set when data is being uploaded Note:If the **partition_key** parameter is passed when data is uploaded, this parameter will be returned when data is downloaded. If **partition_id** instead of **partition_key** is passed when data is uploaded, no **partition_key** is returned. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sequence_number | String | Sequence number of the data record. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | data | String | Downloaded data | + | | | | + | | | The downloaded data is the serialized binary data (Base64-encoded character string). | + | | | | + | | | For example, the data returned by the data download API is "ZGF0YQ==", which is "data" after Base64 decoding. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | timestamp | Long | Timestamp when the record is written to DIS. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | timestamp_type | String | Timestamp type | + | | | | + | | | - **CreateTime**: creation time | + | | | | + | | | Default: **CreateTime** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/api_description/data_management/obtaining_data_cursors.rst b/api-ref/source/api_description/data_management/obtaining_data_cursors.rst index 118124d..9e0a37c 100644 --- a/api-ref/source/api_description/data_management/obtaining_data_cursors.rst +++ b/api-ref/source/api_description/data_management/obtaining_data_cursors.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/cursors -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -23,70 +23,52 @@ GET /v2/{project_id}/cursors project_id Yes String Project ID. ========== ========= ====== =========== -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+==========================================================================================================================================================================================================================================================================================================================================================+ - | stream-name | Yes | String | Name of the stream. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition-id | Yes | 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. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cursor-type | No | String | Cursor type. | - | | | | | - | | | | - AT_SEQUENCE_NUMBER: Data is read from the position denoted by a specific sequence number (that is defined by starting-sequence-number). This is the default cursor type. | - | | | | | - | | | | - AFTER_SEQUENCE_NUMBER: Data is read right after the position denoted by a specific sequence number (that is defined by starting-sequence-number). | - | | | | | - | | | | - TRIM_HORIZON: Data is read from the earliest data record in the partition. For example, a tenant uses a DIS stream to upload three pieces of data A1, A2, and A3. N days later, A1 has expired and A2 and A3 are still in the validity period. In this case, if the tenant uses TRIM_HORIZON to download the data, the system downloads data from A2. | - | | | | | - | | | | - LATEST: Data is read from the latest record in the partition. This setting ensures that you always read the latest record in the partition. | - | | | | | - | | | | - AT_TIMESTAMP: Data is read from the position denoted by a specific timestamp. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **AT_SEQUENCE_NUMBER** | - | | | | | - | | | | - **AFTER_SEQUENCE_NUMBER** | - | | | | | - | | | | - **TRIM_HORIZON** | - | | | | | - | | | | - **LATEST** | - | | | | | - | | | | - **AT_TIMESTAMP** | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | starting-sequence-number | No | String | Serial number. A sequence number is a unique identifier for each record. DIS automatically allocates a sequence number when the data producer calls the PutRecords operation to add data to the DIS stream. SN of the same partition key usually changes with time. A longer interval between PutRecords requests results in a larger sequence number. | - | | | | | - | | | | The sequence number is closely related to cursor types AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. The two parameters determine the position of the data to be read. | - | | | | | - | | | | Value range: 0 to 9,223,372,036,854,775,807 | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | timestamp | No | Long | Timestamp when the data record starts to be read, which is closely related to cursor type AT_TIMESTAMP. The two parameters determine the position of the data to be read. | - | | | | | - | | | | Note: | - | | | | | - | | | | The timestamp is accurate to milliseconds. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+=================+=================+===========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | stream-name | Yes | String | Name of the stream. | + +--------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | partition-id | Yes | String | 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 | No | String | Cursor type - **AT_SEQUENCE_NUMBER**: Data is read from the position denoted by a specific sequence number (that is defined by **starting-sequence-number**). This is the default cursor type. - **AFTER_SEQUENCE_NUMBER**: Data is read right after the position denoted by a specific sequence number (that is defined by **starting-sequence-number**). - **TRIM_HORIZON**: Data is read from the earliest 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** | + | | | | | + | | | | - **TRIM_HORIZON** | + | | | | | + | | | | - **LATEST** | + | | | | | + | | | | - **AT_TIMESTAMP** | + +--------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | starting-sequence-number | No | String | 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 | No | Long | Timestamp when the data record starts to be read, which is closely related to cursor type **AT_TIMESTAMP**. The two parameters determine the position of the data to be read. | + | | | | | + | | | | Note: | + | | | | | + | | | | The timestamp is accurate to milliseconds. | + +--------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | stream-id | No | String | Unique ID of the stream. This parameter is mandatory for obtaining the iterator of an authorized stream. | + +--------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -95,19 +77,21 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------------------+-----------------------+-----------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================+ - | partition_cursor | String | Data cursor. Value range: a string of 1 to 512 characters | - | | | | - | | | Note: | - | | | | - | | | The validity period of a data cursor is 5 minutes. | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================+ + | partition_cursor | String | Data cursor | + | | | | + | | | Value: 1 to 512 characters | + | | | | + | | | Note: | + | | | | + | | | The validity period of a data cursor is 5 minutes. | + | | | | + | | | Minimum: **1** | + | | | | + | | | Maximum: **512** | + +-----------------------+-----------------------+----------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/api_description/data_management/uploading_data.rst b/api-ref/source/api_description/data_management/uploading_data.rst index fce1bac..33c39f1 100644 --- a/api-ref/source/api_description/data_management/uploading_data.rst +++ b/api-ref/source/api_description/data_management/uploading_data.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/records -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -28,57 +28,55 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==============================================================================================+==============================================================================================================+ - | stream_name | Yes | String | Name of the stream. | - | | | | | - | | | | Maximum: **60** | - +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | stream_id | No | 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. | - +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | records | Yes | Array of :ref:`PutRecordsRequestEntry ` objects | List of records to be uploaded. | - +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==============================================================================================+====================================================================================================================+ + | stream_name | Yes | String | Name of the stream. | + | | | | | + | | | | Maximum: **64** | + +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | stream_id | No | String | 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 | Yes | Array of :ref:`PutRecordsRequestEntry ` objects | List of records to be uploaded. | + +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ .. _dis_02_0018__request_putrecordsrequestentry: .. table:: **Table 4** PutRecordsRequestEntry - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+=======================================================================================================================================================================================================================================+ - | data | Yes | 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==. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | explicit_hash_key | No | String | Hash value of the data to be written to the partition. The hash value overwrites the hash value of partition_key. Value range: 0-long.max | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_id | No | String | Partition ID of the stream. The value can be in either of the following formats: | - | | | | | - | | | | - shardId-0000000000 | - | | | | | - | | | | - 0 | - | | | | | - | | | | For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_key | No | String | Partition to which data is written to. Note: | - | | | | | - | | | | If the partition_id parameter is transferred, the partition_id parameter is used preferentially. If partition_id is not transferred, partition_key is used. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===================+=================+=================+===================================================================================================================================================================================================================================================================================+ + | data | Yes | 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==**. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | explicit_hash_key | No | String | Hash value of the data to be written to the partition. The hash value overwrites the hash value of **partition_key**. | + | | | | | + | | | | Value range: 0 to long.max | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | partition_id | No | String | 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 | No | String | 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 ------------------- diff --git a/api-ref/source/api_description/dump_task_management/adding_cloudtable_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/adding_cloudtable_dump_tasks.rst deleted file mode 100644 index 4cf3c9e..0000000 --- a/api-ref/source/api_description/dump_task_management/adding_cloudtable_dump_tasks.rst +++ /dev/null @@ -1,447 +0,0 @@ -:original_name: CreateCloudTableTransferTask.html - -.. _CreateCloudTableTransferTask: - -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:: **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:: **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:: **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 | :ref:`CloudtableDestinationDescriptorRequest ` object | Parameter list of the CloudTable to which data in the DIS stream will be dumped. | - +-----------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_cloudtabledestinationdescriptorrequest: - -.. table:: **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 | :ref:`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 :ref:`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 | - +------------------------------+-----------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_cloudtableschema: - -.. table:: **Table 5** CloudtableSchema - - +-----------------+-----------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===============================================================================+=============================================================================================+ - | row_key | Yes | Array of :ref:`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 :ref:`Column ` objects | HBase column schema used by the CloudTable cluster to convert JSON data into HBase columns. | - | | | | | - | | | | Value range: 1 to 4,096 | - +-----------------+-----------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_rowkey: - -.. table:: **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** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_column: - -.. table:: **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** | - +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_opentsdbschema: - -.. table:: **Table 8** OpenTSDBSchema - - +-----------+-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+===============================================================================================+=================================================================================================================================================================================================+ - | metric | Yes | Array of :ref:`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 | :ref:`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 | :ref:`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 :ref:`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. | - +-----------+-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_opentsdbmetric: - -.. table:: **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. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_opentsdbtimestamp: - -.. table:: **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** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_opentsdbvalue: - -.. table:: **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 (_) | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createcloudtabletransfertask__request_opentsdbtags: - -.. table:: **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 - - .. code-block:: text - - 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 - - .. code-block:: text - - 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 :ref:`Error Codes `. diff --git a/api-ref/source/api_description/dump_task_management/adding_dli_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/adding_dli_dump_tasks.rst deleted file mode 100644 index 49ab8ee..0000000 --- a/api-ref/source/api_description/dump_task_management/adding_dli_dump_tasks.rst +++ /dev/null @@ -1,163 +0,0 @@ -:original_name: CreateDliTransferTask.html - -.. _CreateDliTransferTask: - -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:: **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:: **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:: **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 | :ref:`DliDestinationDescriptorRequest ` object | Parameter list of the DLI to which data in the DIS stream will be dumped. | - +----------------------------+-----------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - -.. _createdlitransfertask__request_dlidestinationdescriptorrequest: - -.. table:: **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 :ref:`Error Codes `. diff --git a/api-ref/source/api_description/dump_task_management/adding_dws_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/adding_dws_dump_tasks.rst deleted file mode 100644 index 36d0d40..0000000 --- a/api-ref/source/api_description/dump_task_management/adding_dws_dump_tasks.rst +++ /dev/null @@ -1,282 +0,0 @@ -:original_name: CreateDwsTransferTask.html - -.. _CreateDwsTransferTask: - -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:: **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:: **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:: **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 | :ref:`DWSDestinationDescriptorRequest ` object | Parameter list of the DWS to which data in the DIS stream will be dumped. | - +----------------------------+-----------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - -.. _createdwstransfertask__request_dwsdestinationdescriptorrequest: - -.. table:: **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 | :ref:`Options ` object | DWS fault tolerance option (used to specify various parameters of foreign table data). | - +-----------------------+-----------------+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdwstransfertask__request_options: - -.. table:: **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 - -.. code-block:: text - - 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 :ref:`Error Codes `. diff --git a/api-ref/source/api_description/dump_task_management/adding_mrs_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/adding_mrs_dump_tasks.rst deleted file mode 100644 index f54cbb1..0000000 --- a/api-ref/source/api_description/dump_task_management/adding_mrs_dump_tasks.rst +++ /dev/null @@ -1,197 +0,0 @@ -:original_name: CreateMrsTransferTask.html - -.. _CreateMrsTransferTask: - -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:: **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:: **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:: **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 | :ref:`MRSDestinationDescriptorRequest ` object | Parameter list of the MRS to which data in the DIS stream will be dumped. | - +----------------------------+-----------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - -.. _createmrstransfertask__request_mrsdestinationdescriptorrequest: - -.. table:: **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 - -.. code-block:: text - - 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 :ref:`Error Codes `. diff --git a/api-ref/source/api_description/dump_task_management/adding_obs_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/adding_obs_dump_tasks.rst index 4309d06..a6eca97 100644 --- a/api-ref/source/api_description/dump_task_management/adding_obs_dump_tasks.rst +++ b/api-ref/source/api_description/dump_task_management/adding_obs_dump_tasks.rst @@ -48,10 +48,6 @@ Request Parameters | 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** | | | | | | @@ -152,20 +148,12 @@ Request Parameters | destination_file_type | No | String | Dump file format. Possible values: | | | | | | | | | | - Text (default) | - | | | | - Parquet | - | | | | - CarbonData | - | | | | | - | | | | Note: | - | | | | | - | | | | You can select Parquet or CarbonData only when Source Data Type is set to JSON and Dump Destination is set to OBS. | | | | | | | | | | Default: **text** | | | | | | | | | | Enumeration values: | | | | | | | | | | - **text** | - | | | | - **parquet** | - | | | | - **carbon** | +-----------------------+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | processing_schema | No | :ref:`ProcessingSchema ` object | Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm. | +-----------------------+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -245,7 +233,7 @@ Example Requests } } -- Adding OBS Dump Tasks (The dump file format is Parquet.) +- Adding OBS Dump Tasks (The dump file format is Text.) .. code-block:: text @@ -257,7 +245,7 @@ Example Requests "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", diff --git a/api-ref/source/api_description/dump_task_management/deleting_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/deleting_dump_tasks.rst index 7a7c7a9..7352494 100644 --- a/api-ref/source/api_description/dump_task_management/deleting_dump_tasks.rst +++ b/api-ref/source/api_description/dump_task_management/deleting_dump_tasks.rst @@ -15,7 +15,7 @@ URI DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters =========== ========= ====== ==================================== Parameter Mandatory Type Description @@ -30,13 +30,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/dump_task_management/index.rst b/api-ref/source/api_description/dump_task_management/index.rst index 8014bc7..7a74c58 100644 --- a/api-ref/source/api_description/dump_task_management/index.rst +++ b/api-ref/source/api_description/dump_task_management/index.rst @@ -6,27 +6,19 @@ Dump Task Management ==================== - :ref:`Adding OBS Dump Tasks ` -- :ref:`Querying Dump Tasks ` +- :ref:`Querying Dump Task ` - :ref:`Deleting Dump Tasks ` - :ref:`Querying Dump Task Details ` - :ref:`Starting Dump Tasks in Batches ` - :ref:`Pausing Dump Tasks in Batches ` -- :ref:`Adding DWS Dump Tasks ` -- :ref:`Adding MRS Dump Tasks ` -- :ref:`Adding DLI Dump Tasks ` -- :ref:`Adding CloudTable Dump Tasks ` .. toctree:: :maxdepth: 1 :hidden: adding_obs_dump_tasks - querying_dump_tasks + querying_dump_task deleting_dump_tasks querying_dump_task_details starting_dump_tasks_in_batches pausing_dump_tasks_in_batches - adding_dws_dump_tasks - adding_mrs_dump_tasks - adding_dli_dump_tasks - adding_cloudtable_dump_tasks diff --git a/api-ref/source/api_description/dump_task_management/pausing_dump_tasks_in_batches.rst b/api-ref/source/api_description/dump_task_management/pausing_dump_tasks_in_batches.rst index 65eabfd..907d18d 100644 --- a/api-ref/source/api_description/dump_task_management/pausing_dump_tasks_in_batches.rst +++ b/api-ref/source/api_description/dump_task_management/pausing_dump_tasks_in_batches.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+-----------------------------------+ | Parameter | Mandatory | Type | Description | @@ -32,19 +32,17 @@ Request Parameters .. table:: **Table 2** Request body parameters - +-----------------+-----------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==============================================================================================+============================================================================+ - | action | Yes | String | Dump task operation. Currently, only the following operation is supported: | - | | | | | - | | | | - stop: The dump task is stopped. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **stop** | - +-----------------+-----------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | tasks | Yes | Array of :ref:`BatchTransferTask ` objects | List of dump tasks to be paused. | - +-----------------+-----------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ + +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==============================================================================================+============================================================================================+ + | action | Yes | String | Dump task operation. The value can only be **stop**, which indicates stopping a dump task. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **stop** | + +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | tasks | Yes | Array of :ref:`BatchTransferTask ` objects | List of dump tasks to be paused. | + +-----------------+-----------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. _batchstoptransfertask__request_batchtransfertask: diff --git a/api-ref/source/api_description/dump_task_management/querying_dump_tasks.rst b/api-ref/source/api_description/dump_task_management/querying_dump_task.rst similarity index 75% rename from api-ref/source/api_description/dump_task_management/querying_dump_tasks.rst rename to api-ref/source/api_description/dump_task_management/querying_dump_task.rst index 6545fbb..f859452 100644 --- a/api-ref/source/api_description/dump_task_management/querying_dump_tasks.rst +++ b/api-ref/source/api_description/dump_task_management/querying_dump_task.rst @@ -2,8 +2,8 @@ .. _ListTransferTasks: -Querying Dump Tasks -=================== +Querying Dump Task +================== Function -------- @@ -69,54 +69,28 @@ Response Parameters | state | 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** | +-------------------------+-----------------------+----------------------------------------------+ | destination_type | 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** | +-------------------------+-----------------------+----------------------------------------------+ | create_time | Long | Time when the dump task is created. | +-------------------------+-----------------------+----------------------------------------------+ diff --git a/api-ref/source/api_description/dump_task_management/querying_dump_task_details.rst b/api-ref/source/api_description/dump_task_management/querying_dump_task_details.rst index 8098878..e4c7767 100644 --- a/api-ref/source/api_description/dump_task_management/querying_dump_task_details.rst +++ b/api-ref/source/api_description/dump_task_management/querying_dump_task_details.rst @@ -45,63 +45,47 @@ Response Parameters .. table:: **Table 3** Response body parameters - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================================+==========================================================================================================================+==================================================================================+ - | stream_name | String | Name of the stream to which the dump task belongs. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | task_name | String | Name of the dump task. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | state | 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** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | destination_type | 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** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | create_time | Long | Time when the dump task is created. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | last_transfer_timestamp | Long | Latest dump time of the dump task. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | partitions | Array of :ref:`PartitionResult ` objects | List of partition dump details. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | obs_destination_description | :ref:`OBSDestinationDescriptorRequest ` object | Parameter list of OBS to which data in the DIS stream will be dumped. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | dws_destination_descripton | :ref:`DWSDestinationDescriptorRequest ` object | Parameter list of the DWS to which data in the DIS stream will be dumped. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | mrs_destination_description | :ref:`MRSDestinationDescriptorRequest ` object | Parameter list of the MRS to which data in the DIS stream will be dumped. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | dli_destination_description | :ref:`DliDestinationDescriptorRequest ` object | Parameter list of the DLI to which data in the DIS stream will be dumped. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ - | cloudtable_destination_descripton | :ref:`CloudtableDestinationDescriptorRequest ` object | Parameter list of the CloudTable to which data in the DIS stream will be dumped. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+============================================================================================================+=======================================================================+ + | stream_name | String | Name of the stream to which the dump task belongs. | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | task_name | String | Name of the dump task. | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | state | 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** | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | destination_type | String | Dump destination. Possible values: | + | | | | + | | | - OBS: Data is dumped to OBS. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **OBS** | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | create_time | Long | Time when the dump task is created. | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | last_transfer_timestamp | Long | Latest dump time of the dump task. | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | partitions | Array of :ref:`PartitionResult ` objects | List of partition dump details. | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | obs_destination_description | :ref:`OBSDestinationDescriptorRequest ` object | Parameter list of OBS to which data in the DIS stream will be dumped. | + +-----------------------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. _showtransfertask__response_partitionresult: @@ -223,20 +207,12 @@ Response Parameters | destination_file_type | String | Dump file format. Possible values: | | | | | | | | - Text (default) | - | | | - Parquet | - | | | - CarbonData | - | | | | - | | | Note: | - | | | | - | | | You can select Parquet or CarbonData only when Source Data Type is set to JSON and Dump Destination is set to OBS. | | | | | | | | Default: **text** | | | | | | | | Enumeration values: | | | | | | | | - **text** | - | | | - **parquet** | - | | | - **carbon** | +-----------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | processing_schema | :ref:`ProcessingSchema ` object | Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm. | +-----------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -287,596 +263,6 @@ Response Parameters | | | - **dd-MM-yyyy HH:mm:ss** | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -.. _showtransfertask__response_dwsdestinationdescriptorrequest: - -.. table:: **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 | :ref:`Options ` object | DWS fault tolerance option (used to specify various parameters of foreign table data). | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_options: - -.. table:: **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. | - +--------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_mrsdestinationdescriptorrequest: - -.. table:: **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. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_dlidestinationdescriptorrequest: - -.. table:: **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. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_cloudtabledestinationdescriptorrequest: - -.. table:: **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 | :ref:`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 :ref:`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 | - +------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_cloudtableschema: - -.. table:: **Table 12** CloudtableSchema - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================+=============================================================================================+ - | row_key | Array of :ref:`RowKey ` objects | HBase rowkey schema used by the CloudTable cluster to convert JSON data into HBase rowkeys. | - | | | | - | | | Value range: 1-64 | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - | columns | Array of :ref:`Column ` objects | HBase column schema used by the CloudTable cluster to convert JSON data into HBase columns. | - | | | | - | | | Value range: 1 to 4,096 | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_rowkey: - -.. table:: **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** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_column: - -.. table:: **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** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_opentsdbschema: - -.. table:: **Table 15** OpenTSDBSchema - - +-----------+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+====================================================================================+=================================================================================================================================================================================================+ - | metric | Array of :ref:`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 | :ref:`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 | :ref:`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 :ref:`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. | - +-----------+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_opentsdbmetric: - -.. table:: **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. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_opentsdbtimestamp: - -.. table:: **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** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_opentsdbvalue: - -.. table:: **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 (_) | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showtransfertask__response_opentsdbtags: - -.. table:: **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 ---------------- diff --git a/api-ref/source/api_description/dump_task_management/starting_dump_tasks_in_batches.rst b/api-ref/source/api_description/dump_task_management/starting_dump_tasks_in_batches.rst index c0710a8..153a2f4 100644 --- a/api-ref/source/api_description/dump_task_management/starting_dump_tasks_in_batches.rst +++ b/api-ref/source/api_description/dump_task_management/starting_dump_tasks_in_batches.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+-----------------------------------+ | Parameter | Mandatory | Type | Description | @@ -32,19 +32,17 @@ Request Parameters .. table:: **Table 2** Request body parameters - +-----------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===============================================================================================+============================================================================+ - | action | Yes | String | Dump task operation. Currently, only the following operation is supported: | - | | | | | - | | | | - start: The dump task is started. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **start** | - +-----------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | tasks | Yes | Array of :ref:`BatchTransferTask ` objects | List of dump tasks to be operated. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+===============================================================================================+=============================================================================================+ + | action | Yes | String | Dump task operation. The value can only be **start**, which indicates starting a dump task. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **start** | + +-----------------+-----------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | tasks | Yes | Array of :ref:`BatchTransferTask ` objects | List of dump tasks to be operated. | + +-----------------+-----------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. _batchstarttransfertask__request_batchtransfertask: diff --git a/api-ref/source/api_description/monitoring_management/querying_partition_monitoring_data.rst b/api-ref/source/api_description/monitoring_management/querying_partition_monitoring_data.rst index f6f3764..f467b47 100644 --- a/api-ref/source/api_description/monitoring_management/querying_partition_monitoring_data.rst +++ b/api-ref/source/api_description/monitoring_management/querying_partition_monitoring_data.rst @@ -15,40 +15,34 @@ URI GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================================================================================================================+ - | project_id | Yes | String | Project ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stream_name | Yes | String | Name of the stream. | - | | | | | - | | | | Maximum: **60** | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_id | Yes | String | Partition No. The value can be in either of the following formats: | - | | | | | - | | | | - shardId-0000000000 | - | | | | | - | | | | - 0 | - | | | | | - | | | | For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | stream_name | Yes | String | Name of the stream. | + | | | | | + | | | | Maximum: **60** | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | partition_id | Yes | String | Partition 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:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+======================================================================================================================================================================================+ - | label | No | String | Partition monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.) | + | label | No | String | 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 of the partition (byte) | + | | | | - **total_put_bytes_per_partition**: total input traffic in a partition (byte) | | | | | | - | | | | - total_get_bytes_per_partition: total output traffic of the partition (byte) | + | | | | - **total_get_bytes_per_partition**: total output traffic in a partition (byte) | | | | | | - | | | | - total_put_records_per_partition: total number of input records of the partition | + | | | | - **total_put_records_per_partition**: total number of input records in a partition | | | | | | - | | | | - total_get_records_per_partition: total number of output records of the partition | + | | | | - **total_get_records_per_partition**: total number of output records in a partition | | | | | | | | | | Enumeration values: | | | | | | @@ -72,13 +66,11 @@ Request Parameters .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=====================================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/monitoring_management/querying_stream_monitoring_data.rst b/api-ref/source/api_description/monitoring_management/querying_stream_monitoring_data.rst index bf0d67a..8663a23 100644 --- a/api-ref/source/api_description/monitoring_management/querying_stream_monitoring_data.rst +++ b/api-ref/source/api_description/monitoring_management/querying_stream_monitoring_data.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/streams/{stream_name}/metrics -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+---------------------+ | Parameter | Mandatory | Type | Description | @@ -27,32 +27,32 @@ GET /v2/{project_id}/streams/{stream_name}/metrics | | | | Maximum: **60** | +-----------------+-----------------+-----------------+---------------------+ -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+================================================================================================================================================================================+ - | label | No | String | Stream monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.) | + | label | No | String | 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_put_bytes_per_stream**: total input traffic (byte) | | | | | | - | | | | - total_get_bytes_per_stream: total output traffic (byte) | + | | | | - **total_get_bytes_per_stream**: total output traffic (byte) | | | | | | - | | | | - total_put_records_per_stream: total number of input records | + | | | | - **total_put_records_per_stream**: total number of input records | | | | | | - | | | | - total_get_records_per_stream: total number of output records | + | | | | - **total_get_records_per_stream**: total number of output records | | | | | | - | | | | - total_put_req_latency: average processing time of upload requests (millisecond) | + | | | | - **total_put_req_latency**: average processing time of upload requests (millisecond) | | | | | | - | | | | - total_get_req_latency: average processing time of download 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_put_req_suc_per_stream**: number of successful upload requests | | | | | | - | | | | - total_get_req_suc_per_stream: number of successful download 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_put**: number of rejected upload requests due to flow control | | | | | | - | | | | - traffic_control_get: number of rejected download requests due to flow control | + | | | | - **traffic_control_get**: number of rejected download requests due to flow control | | | | | | | | | | Enumeration values: | | | | | | @@ -88,13 +88,13 @@ Request Parameters .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/stream_management/adding_permission_policies.rst b/api-ref/source/api_description/stream_management/adding_permission_policies.rst deleted file mode 100644 index 6828f65..0000000 --- a/api-ref/source/api_description/stream_management/adding_permission_policies.rst +++ /dev/null @@ -1,128 +0,0 @@ -:original_name: CreatePolicies.html - -.. _CreatePolicies: - -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:: **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:: **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:: **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 - - .. code-block:: text - - 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 - - .. code-block:: text - - 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 :ref:`Error Codes `. diff --git a/api-ref/source/api_description/stream_management/changing_partition_quantity.rst b/api-ref/source/api_description/stream_management/changing_partition_quantity.rst index bbf212f..ca9b69f 100644 --- a/api-ref/source/api_description/stream_management/changing_partition_quantity.rst +++ b/api-ref/source/api_description/stream_management/changing_partition_quantity.rst @@ -15,7 +15,7 @@ URI PUT /v2/{project_id}/streams/{stream_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -32,33 +32,35 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+=================+=================+==========================================================================================================================================================================================================================================+ - | stream_name | Yes | String | Name of the stream whose partition quantity needs to be changed. | - | | | | | - | | | | Maximum: **64** | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | target_partition_count | Yes | Integer | Number of the target partitions. | - | | | | | - | | | | The value is an integer greater than 0. | - | | | | | - | | | | If the value is greater than the number of current partitions, scaling-up is required. If the value is less than the number of current partitions, scale-down is required. | - | | | | | - | | | | Note: A maximum of five scale-up/down operations can be performed for each stream within one hour. If a scale-up/down operation is successfully performed, you cannot perform one more scale-up/down operation within the next one hour. | - | | | | | - | | | | Minimum: **0** | - +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+=================+=================+============================================================================================================================================================================+ + | stream_name | Yes | String | Name of the stream whose partition quantity needs to be changed. | + | | | | | + | | | | Maximum: **64** | + +------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_partition_count | Yes | Integer | Number of the target partitions | + | | | | | + | | | | The value is an integer greater than 0. | + | | | | | + | | | | If the value is greater than the number of current partitions, scaling-up is required. If the value is less than the number of current partitions, scale-down is required. | + | | | | | + | | | | Note: | + | | | | | + | | | | 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** | + +------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api_description/stream_management/creating_streams.rst b/api-ref/source/api_description/stream_management/creating_streams.rst index 135e8a9..291b808 100644 --- a/api-ref/source/api_description/stream_management/creating_streams.rst +++ b/api-ref/source/api_description/stream_management/creating_streams.rst @@ -11,15 +11,14 @@ 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. +- 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 -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -32,160 +31,136 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================================+=================+=====================================================================+======================================================================================================================================================================+ - | stream_name | Yes | String | Name of the stream. | - | | | | | - | | | | The stream name can contain 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-). | - | | | | | - | | | | Maximum: **64** | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_count | Yes | Integer | Number of partitions. Partitions are the base throughput unit of a DIS stream. | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stream_type | No | String | Stream type. | - | | | | | - | | | | - COMMON: a common stream. The bandwidth is 1 MB/s. | - | | | | | - | | | | - ADVANCED: an advanced stream. The bandwidth is 5 MB/s. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **COMMON** | - | | | | | - | | | | - **ADVANCED** | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_type | No | String | Source data type. | - | | | | | - | | | | - BLOB: a set of binary data stored in a database management system. | - | | | | | - | | | | - JSON: an open-source file format that uses readable text to transmit data objects consisting of attribute values or serialized values. | - | | | | | - | | | | - CSV: a simple text format for storing tabular data in a plain text file. Commas (,) are used as separators by default. | - | | | | | - | | | | Default value: BLOB | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **BLOB** | - | | | | | - | | | | - **JSON** | - | | | | | - | | | | - **CSV** | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_duration | No | Integer | Period of time for which data is retained in the stream. Value range: 24-72 Unit: hour Default value: 24 If this parameter is left blank, the default value is used. | - | | | | | - | | | | Maximum: **168** | - | | | | | - | | | | Default: **24** | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_enabled | No | Boolean | Specifies whether to enable auto scaling. | - | | | | | - | | | | - true: Auto scaling is enabled. | - | | | | | - | | | | - false: Auto scaling is disabled. | - | | | | | - | | | | This function is disabled by default. | - | | | | | - | | | | Default: **false** | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_min_partition_count | No | Long | Minimum number of partitions for automatic scale-down when auto scaling is enabled. | - | | | | | - | | | | Minimum: **1** | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_max_partition_count | No | Integer | Maximum number of partitions for automatic scale-up when auto scaling is enabled. | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_schema | No | String | Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema. | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | csv_properties | No | :ref:`CSVProperties ` object | Attributes of data in CSV format, such as delimiter. | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | compression_format | No | String | 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 :ref:`Tag ` objects | List of stream tags. | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sys_tags | No | Array of :ref:`SysTag ` objects | Stream enterprise projects. | - +--------------------------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _dis_02_0016_01__request_csvproperties: - -.. table:: **Table 4** CSVProperties - - ========= ========= ====== =============== - Parameter Mandatory Type Description - ========= ========= ====== =============== - delimiter No String Data separator. - ========= ========= ====== =============== + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================================+=================+=================================================================+==============================================================================================================+ + | stream_name | Yes | String | Stream name | + | | | | | + | | | | The stream name can contain 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-). | + | | | | | + | | | | Maximum: **64** | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | partition_count | Yes | Integer | Number of partitions | + | | | | | + | | | | Partitions are the base throughput unit of the DIS stream. | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | stream_type | No | String | 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 | No | String | 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 | No | Integer | 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 | No | Boolean | 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 | No | Long | Minimum number of partitions for automatic scale-down when auto scaling is enabled. | + | | | | | + | | | | Minimum: **1** | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | auto_scale_max_partition_count | No | Integer | Maximum number of partitions for automatic scale-up when auto scaling is enabled. | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | compression_format | No | String | Data compression type. The following types are available: | + | | | | | + | | | | - snappy | + | | | | - gzip | + | | | | - zip | + | | | | | + | | | | Data is not compressed by default. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **snappy** | + | | | | - **gzip** | + | | | | - **zip** | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`Tag ` objects | List of stream tags. | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | sys_tags | No | Array of :ref:`SysTag ` objects | Stream enterprise projects. | + +--------------------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. _dis_02_0016_01__request_tag: -.. table:: **Table 5** Tag +.. table:: **Table 4** Tag - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================================+ - | key | No | String | Key. | - | | | | | - | | | | - This field cannot be left blank. | - | | | | | - | | | | - The key value of a resource must be unique. | - | | | | | - | | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | value | No | 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** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================================================+ + | key | No | String | 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** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _dis_02_0016_01__request_systag: -.. table:: **Table 6** SysTag +.. table:: **Table 5** SysTag +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+==============================================================================================================+ - | key | No | String | Key. | + | key | No | String | Key | | | | | | - | | | | - This field cannot be left blank. | - | | | | | - | | | | - The value must be \_sys_enterprise_project_id. | + | | | | - It cannot be left blank. | + | | | | - Its value must be **\_sys_enterprise_project_id**. | | | | | | | | | | Enumeration values: | | | | | | @@ -193,7 +168,7 @@ Request Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ | value | No | String | Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page. | | | | | | - | | | | - 36-digit UUID | + | | | | - It is a 36-digit UUID. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ Response Parameters diff --git a/api-ref/source/api_description/stream_management/deleting_specified_streams.rst b/api-ref/source/api_description/stream_management/deleting_specified_streams.rst index 0f96d01..c2a9b19 100644 --- a/api-ref/source/api_description/stream_management/deleting_specified_streams.rst +++ b/api-ref/source/api_description/stream_management/deleting_specified_streams.rst @@ -15,7 +15,7 @@ URI DELETE /v2/{project_id}/streams/{stream_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+-----------------------------------+ | Parameter | Mandatory | Type | Description | @@ -32,13 +32,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/stream_management/index.rst b/api-ref/source/api_description/stream_management/index.rst index c4ed4d9..abd8e18 100644 --- a/api-ref/source/api_description/stream_management/index.rst +++ b/api-ref/source/api_description/stream_management/index.rst @@ -10,9 +10,6 @@ Stream Management - :ref:`Deleting Specified Streams ` - :ref:`Querying Stream Details ` - :ref:`Changing Partition Quantity ` -- :ref:`Updating Stream Information ` -- :ref:`Adding Permission Policies ` -- :ref:`Querying Permission Policies ` .. toctree:: :maxdepth: 1 @@ -23,6 +20,3 @@ Stream Management deleting_specified_streams querying_stream_details changing_partition_quantity - updating_stream_information - adding_permission_policies - querying_permission_policies diff --git a/api-ref/source/api_description/stream_management/querying_permission_policies.rst b/api-ref/source/api_description/stream_management/querying_permission_policies.rst deleted file mode 100644 index 2ef274b..0000000 --- a/api-ref/source/api_description/stream_management/querying_permission_policies.rst +++ /dev/null @@ -1,132 +0,0 @@ -:original_name: ListPolicies.html - -.. _ListPolicies: - -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:: **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:: **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:: **Table 3** Response body parameters - - +-----------+------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================================+============================================+ - | stream_id | String | Unique ID of the stream. | - +-----------+------------------------------------------------------------------------------+--------------------------------------------+ - | rules | Array of :ref:`PrincipalRule ` objects | List of authorization information records. | - +-----------+------------------------------------------------------------------------------+--------------------------------------------+ - -.. _listpolicies__response_principalrule: - -.. table:: **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 - -.. code-block:: text - - GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/policies - -Example Responses ------------------ - -**Status code: 200** - -Normal response. - -.. code-block:: - - { - "streamId" : "CiFdELMr0401K9GGZlp", - "rules" : [ { - "action_type" : "putRecords", - "principal" : "3b3f237122574xxxxb74482ae11005ba.*", - "principal_name" : "anotherusername", - "effect" : "accept" - } ] - } - -Status Codes ------------- - -=========== ================ -Status Code Description -=========== ================ -200 Normal response. -=========== ================ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api_description/stream_management/querying_stream_details.rst b/api-ref/source/api_description/stream_management/querying_stream_details.rst index 3ba34fa..f980183 100644 --- a/api-ref/source/api_description/stream_management/querying_stream_details.rst +++ b/api-ref/source/api_description/stream_management/querying_stream_details.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/streams/{stream_name} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+-----------------------+ | Parameter | Mandatory | Type | Description | @@ -27,14 +27,18 @@ GET /v2/{project_id}/streams/{stream_name} | | | | Maximum: **60** | +-----------------+-----------------+-----------------+-----------------------+ -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters +-------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +===================+=================+=================+======================================================================================================================+ | start_partitionId | No | String | Name of the partition to start the partition list with. The returned partition list does not contain this partition. | +-------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | limit_partitions | No | Integer | Maximum number of partitions to list in a single API call. Value range: 1-1,000 Default value: 100 | + | limit_partitions | No | Integer | Maximum number of partitions to list in a single API call | + | | | | | + | | | | Value range: 1 to 1000 | + | | | | | + | | | | Default value: **100** | | | | | | | | | | Minimum: **1** | | | | | | @@ -42,19 +46,21 @@ GET /v2/{project_id}/streams/{stream_name} | | | | | | | | | Default: **100** | +-------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ + | stream_id | No | String | Stream ID. This parameter is mandatory for querying details of an authorized stream. | + +-------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -63,121 +69,95 @@ Response Parameters .. table:: **Table 4** Response body parameters - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================================+===========================================================================================+===============================================================================================================================================================================+ - | stream_name | String | Name of the stream. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a stream is created. The value is a 13-bit timestamp. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | last_modified_time | Long | Time when a stream is the most recently modified. The value is a 13-bit timestamp. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | 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** | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stream_type | 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** | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partitions | Array of :ref:`PartitionResult ` objects | A list of partitions that comprise the DIS stream. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | has_more_partitions | Boolean | Specifies whether there are more matching partitions of the DIS stream to list. | - | | | | - | | | - true: yes | - | | | | - | | | - false: no | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | retention_period | Integer | Period for storing data in units of hours. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stream_id | String | Unique identifier of the stream. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_type | String | Source data type. | - | | | | - | | | - BLOB: a set of binary data stored in a database management system. | - | | | | - | | | - JSON: an open-source file format that uses readable text to transmit data objects consisting of attribute values or serialized values. | - | | | | - | | | - CSV: a simple text format for storing tabular data in a plain text file. Commas (,) are used as separators by default. | - | | | | - | | | Default value: BLOB | - | | | | - | | | Enumeration values: | - | | | | - | | | - **BLOB** | - | | | | - | | | - **JSON** | - | | | | - | | | - **CSV** | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_schema | String | Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema. For details about Avro, go to http://avro.apache.org/docs/current/ | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | compression_format | String | Compression type of data. Currently, the value can be: | - | | | | - | | | - snappy | - | | | | - | | | - gzip | - | | | | - | | | - zip | - | | | | - | | | Data is not compressed by default. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **snappy** | - | | | | - | | | - **gzip** | - | | | | - | | | - **zip** | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | csv_properties | :ref:`CSVProperties ` object | Attributes of data in CSV format, such as delimiter. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | writable_partition_count | Integer | Total number of writable partitions (including partitions in ACTIVE state only). | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | readable_partition_count | Integer | Total number of readable partitions (including partitions in ACTIVE and DELETED state). | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_partition_counts | Array of :ref:`UpdatePartitionCount ` objects | List of scaling operation records. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | List of stream tags. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sys_tags | Array of :ref:`SysTag ` objects | Enterprise project of a stream. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_enabled | Boolean | 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. | - +--------------------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+===========================================================================================+====================================================================================================+ + | stream_name | String | Name of the stream. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | create_time | Long | Time when a stream is created. The value is a 13-bit timestamp. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | last_modified_time | Long | Time when a stream is the most recently modified. The value is a 13-bit timestamp. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | status | String | Current status of the stream | + | | | | + | | | - **CREATING**: creating | + | | | - **RUNNING**: running | + | | | - **TERMINATING**: deleting | + | | | - **TERMINATED**: deleted | + | | | | + | | | Enumeration values: | + | | | | + | | | - **CREATING** | + | | | - **RUNNING** | + | | | - **TERMINATING** | + | | | - **FROZEN** | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | stream_type | String | 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 | Array of :ref:`PartitionResult ` objects | A list of partitions that comprise the DIS stream. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | has_more_partitions | Boolean | Whether there are more matching partitions | + | | | | + | | | - **true**: yes | + | | | - **false**: no | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | retention_period | Integer | Period for storing data in units of hours. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | stream_id | String | Unique identifier of the stream. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | data_type | String | Source data type | + | | | | + | | | - **BLOB**: a collection of binary data stored as a single entity in a database management system | + | | | | + | | | Default value: **BLOB** | + | | | | + | | | Enumeration values: | + | | | | + | | | - **BLOB** | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | compression_format | String | Data compression type. The following types are available: | + | | | | + | | | - snappy | + | | | - gzip | + | | | - zip | + | | | | + | | | Data is not compressed by default. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **snappy** | + | | | - **gzip** | + | | | - **zip** | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | writable_partition_count | Integer | Total number of writable partitions (including partitions in ACTIVE state only). | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | readable_partition_count | Integer | Total number of readable partitions (including partitions in ACTIVE and DELETED state). | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | update_partition_counts | Array of :ref:`UpdatePartitionCount ` objects | List of scaling operation records. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | List of stream tags. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | sys_tags | Array of :ref:`SysTag ` objects | Enterprise project of a stream. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | auto_scale_enabled | Boolean | Whether to enable auto scaling | + | | | | + | | | - **true**: Auto scaling is enabled. | + | | | - **false**: Auto scaling is disabled. | + | | | | + | | | By default, this function is disabled. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | 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. | + +--------------------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ .. _dis_02_0025__response_partitionresult: @@ -186,24 +166,18 @@ Response Parameters +-----------------------+-----------------------+-------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+=============================================================+ - | status | String | Current status of the partition. Possible values: | + | status | String | Current status of the partition | | | | | - | | | - CREATING: The stream is being created. | - | | | | - | | | - ACTIVE: The stream is available. | - | | | | - | | | - DELETED: The stream is being deleted. | - | | | | - | | | - EXPIRED: The stream has expired. | + | | | - **CREATING**: creating | + | | | - **ACTIVE**: available | + | | | - **DELETED**: deleted | + | | | - **EXPIRED**: expired | | | | | | | | Enumeration values: | | | | | | | | - **CREATING** | - | | | | | | | - **ACTIVE** | - | | | | | | | - **DELETED** | - | | | | | | | - **EXPIRED** | +-----------------------+-----------------------+-------------------------------------------------------------+ | partition_id | String | Unique identifier of the partition. | @@ -215,19 +189,9 @@ Response Parameters | parent_partitions | String | Parent partition. | +-----------------------+-----------------------+-------------------------------------------------------------+ -.. _dis_02_0025__response_csvproperties: - -.. table:: **Table 6** CSVProperties - - ========= ====== =============== - Parameter Type Description - ========= ====== =============== - delimiter String Data separator. - ========= ====== =============== - .. _dis_02_0025__response_updatepartitioncount: -.. table:: **Table 7** UpdatePartitionCount +.. table:: **Table 6** UpdatePartitionCount +------------------------+-----------------------+-------------------------------------------------------------+ | Parameter | Type | Description | @@ -242,57 +206,51 @@ Response Parameters +------------------------+-----------------------+-------------------------------------------------------------+ | result_msg | Integer | Response to the scaling operation. | +------------------------+-----------------------+-------------------------------------------------------------+ - | auto_scale | Boolean | Specifies whether the scaling operation is automatic. | + | auto_scale | Boolean | Whether the scaling operation is automatic | | | | | - | | | - true: Auto scaling is enabled. | - | | | | - | | | - false: Manual scaling is enabled. | + | | | - **true**: auto scaling | + | | | - **false**: manual scaling | +------------------------+-----------------------+-------------------------------------------------------------+ .. _dis_02_0025__response_tag: -.. table:: **Table 8** Tag +.. table:: **Table 7** Tag - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================+ - | key | String | Key. | - | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The key value of a resource must be unique. | - | | | | - | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ - | value | 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** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================================+ + | key | String | 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 | 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** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _dis_02_0025__response_systag: -.. table:: **Table 9** SysTag +.. table:: **Table 8** SysTag +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+==============================================================================================================+ - | key | String | Key. | + | key | String | Key | | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The value must be \_sys_enterprise_project_id. | + | | | - It cannot be left blank. | + | | | - Its value must be **\_sys_enterprise_project_id**. | | | | | | | | Enumeration values: | | | | | @@ -300,7 +258,7 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ | value | String | Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page. | | | | | - | | | - 36-digit UUID | + | | | - It is a 36-digit UUID. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ Example Requests diff --git a/api-ref/source/api_description/stream_management/querying_streams.rst b/api-ref/source/api_description/stream_management/querying_streams.rst index 28fbabe..e6ddde3 100644 --- a/api-ref/source/api_description/stream_management/querying_streams.rst +++ b/api-ref/source/api_description/stream_management/querying_streams.rst @@ -8,16 +8,16 @@ Querying Streams Function -------- -This API is used to query all streams created by the current tenant. +This API is used to query all the 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. +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 -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -25,38 +25,38 @@ GET /v2/{project_id}/streams project_id Yes String Project ID. ========== ========= ====== =========== -.. table:: **Table 2** Query parameters +.. table:: **Table 2** Query Parameters - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+=========================================================================================================================================================================================================================================================================================+ - | limit | No | Integer | The maximum number of DIS streams to list in a single API call. | - | | | | | - | | | | Value range: 1-100 Default value: 10 | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **100** | - | | | | | - | | | | Default: **10** | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_stream_name | No | String | Name of the DIS stream to start the stream list with. The returned stream list does not contain this DIS stream name. | - | | | | | - | | | | If pagination query is required, this parameter is not transferred for query on the first page. If the value of has_more_streams is true, the query is performed on the next page. The value of start_stream_name is the name of the last stream in the query result of the first page. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===================+=================+=================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | 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 | No | String | Name of the DIS stream to start the stream list with. The returned stream list does not contain this DIS stream name. If pagination query is required, this parameter is not transferred 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:: **Table 3** Request header parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================+ - | X-Auth-Token | Yes | String | User token. | - | | | | | - | | | | The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -65,141 +65,121 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================+===============================================================================+ - | total_number | Long | Total number of all the DIS streams created by the current tenant. | - +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | stream_names | Array of strings | List of the streams meeting the current requests. | - +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | has_more_streams | Boolean | Specify whether there are more matching DIS streams to list. Possible values: | - | | | | - | | | - true: yes | - | | | | - | | | - false: no | - | | | | - | | | Default: **false** | - +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | stream_info_list | Array of :ref:`StreamInfo ` objects | Stream details. | - +-----------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ + +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================================================================+====================================================================+ + | total_number | Long | Total number of all the DIS streams created by the current tenant. | + +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------+ + | stream_names | Array of strings | List of the streams meeting the current requests. | + +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------+ + | has_more_streams | Boolean | Whether there are more matching DIS streams | + | | | | + | | | - **true**: yes | + | | | - **false**: no | + | | | | + | | | Default: **false** | + +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------+ + | stream_info_list | Array of :ref:`StreamInfo ` objects | Stream details. | + +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------+ .. _dis_02_0024__response_streaminfo: .. table:: **Table 5** StreamInfo - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================================+===============================================================+========================================================================================================================================================+ - | stream_name | String | Name of the stream. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when the stream is created. The value is a 13-bit timestamp. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | retention_period | Integer | Period for storing data in units of hours. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | 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** | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stream_type | String | Stream type. | - | | | | - | | | - COMMON: a common stream. The bandwidth is 1 MB/s. | - | | | | - | | | - ADVANCED: an advanced stream. The bandwidth is 5 MB/s. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **COMMON** | - | | | | - | | | - **ADVANCED** | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_type | 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** | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | partition_count | Integer | Quantity of partitions. Partitions are the base throughput unit of a DIS stream. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_enabled | Boolean | Specifies whether to enable auto scaling. | - | | | | - | | | - true: auto scaling is enabled. | - | | | | - | | | - false: auto scaling is disabled. | - | | | | - | | | This function is disabled by default. | - | | | | - | | | Default: **false** | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_min_partition_count | Integer | Minimum number of partitions for automatic scale-down when auto scaling is enabled. | - | | | | - | | | Minimum: **1** | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_scale_max_partition_count | Integer | Maximum number of partitions for automatic scale-up when auto scaling is enabled. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | List of stream tags. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sys_tags | Array of :ref:`SysTag ` objects | Stream enterprise projects. | - +--------------------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+===============================================================+====================================================================================================+ + | stream_name | String | Name of the stream. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | create_time | Long | Time when the stream is created. The value is a 13-bit timestamp. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | retention_period | Integer | Period for storing data in units of hours. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | status | String | Current status of the stream | + | | | | + | | | - **CREATING**: creating | + | | | - **RUNNING**: running | + | | | - **TERMINATING**: deleting | + | | | - **TERMINATED**: deleted | + | | | | + | | | Enumeration values: | + | | | | + | | | - **CREATING** | + | | | - **RUNNING** | + | | | - **TERMINATING** | + | | | - **FROZEN** | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | stream_type | String | 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 | String | 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 | Integer | Number of partitions | + | | | | + | | | Partitions are the base throughput unit of the DIS stream. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | auto_scale_enabled | Boolean | 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 | Integer | Minimum number of partitions for automatic scale-down when auto scaling is enabled. | + | | | | + | | | Minimum: **1** | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | auto_scale_max_partition_count | Integer | Maximum number of partitions for automatic scale-up when auto scaling is enabled. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | List of stream tags. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | sys_tags | Array of :ref:`SysTag ` objects | Stream enterprise projects. | + +--------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ .. _dis_02_0024__response_tag: .. table:: **Table 6** Tag - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================+ - | key | String | Key. | - | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The key value of a resource must be unique. | - | | | | - | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ - | value | 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** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================================+ + | key | String | 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 | 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** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _dis_02_0024__response_systag: @@ -208,11 +188,10 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+==============================================================================================================+ - | key | String | Key. | + | key | String | Key | | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The value must be \_sys_enterprise_project_id. | + | | | - It cannot be left blank. | + | | | - Its value must be **\_sys_enterprise_project_id**. | | | | | | | | Enumeration values: | | | | | @@ -220,7 +199,7 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ | value | String | Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page. | | | | | - | | | - 36-digit UUID | + | | | - It is a 36-digit UUID. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ Example Requests diff --git a/api-ref/source/api_description/stream_management/updating_stream_information.rst b/api-ref/source/api_description/stream_management/updating_stream_information.rst deleted file mode 100644 index 81c2356..0000000 --- a/api-ref/source/api_description/stream_management/updating_stream_information.rst +++ /dev/null @@ -1,134 +0,0 @@ -:original_name: UpdateStream.html - -.. _UpdateStream: - -Updating Stream Information -=========================== - -Function --------- - -This API is used to update the information about specified streams. - -URI ---- - -PUT /v3/{project_id}/streams/{stream_name} - -.. table:: **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:: **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 - - .. code-block:: text - - PUT https://{Endpoint}/v3/{project_id}/streams/{stream_name} - - { - "stream_name" : "stz_test", - "data_duration" : 48 - } - -- Updating Stream Types - - .. code-block:: text - - 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 :ref:`Error Codes `. diff --git a/api-ref/source/api_description/tag_management/adding_resource_tags_in_batches.rst b/api-ref/source/api_description/tag_management/adding_resource_tags_in_batches.rst index e520c65..38965fd 100644 --- a/api-ref/source/api_description/tag_management/adding_resource_tags_in_batches.rst +++ b/api-ref/source/api_description/tag_management/adding_resource_tags_in_batches.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/stream/{stream_id}/tags/action -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -29,61 +29,59 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+============================================================+==========================================================+ - | action | Yes | String | Operation to be performed. The value can be create only. | - | | | | | - | | | | - create: batch creation | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **create** | - +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------+ - | tags | Yes | Array of :ref:`Tag ` objects | Tag list. | - +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------+ + +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+============================================================+==============================================================================================+ + | action | Yes | String | Operation to be performed. The value can only be **create**, which indicates batch creation. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **create** | + +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ + | tags | Yes | Array of :ref:`Tag ` objects | Tag list. | + +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ .. _batchcreatetags__request_tag: .. table:: **Table 4** Tag - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================================+ - | key | No | String | Key. | - | | | | | - | | | | - This field cannot be left blank. | - | | | | | - | | | | - The key value of a resource must be unique. | - | | | | | - | | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | value | No | 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** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================================================+ + | key | No | String | 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** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api_description/tag_management/adding_tags_for_specified_streams.rst b/api-ref/source/api_description/tag_management/adding_tags_for_specified_streams.rst index 136bf71..fae8e09 100644 --- a/api-ref/source/api_description/tag_management/adding_tags_for_specified_streams.rst +++ b/api-ref/source/api_description/tag_management/adding_tags_for_specified_streams.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/stream/{stream_id}/tags -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters +-----------------+-----------------+-----------------+-----------------+ | Parameter | Mandatory | Type | Description | @@ -32,13 +32,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters @@ -52,33 +52,33 @@ Request Parameters .. table:: **Table 4** Tag - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================================+ - | key | No | String | Key. | - | | | | | - | | | | - This field cannot be left blank. | - | | | | | - | | | | - The key value of a resource must be unique. | - | | | | | - | | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | value | No | 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** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================================================+ + | key | No | String | 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** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api_description/tag_management/deleting_resource_tags_in_batches.rst b/api-ref/source/api_description/tag_management/deleting_resource_tags_in_batches.rst index af1eb14..71b09f7 100644 --- a/api-ref/source/api_description/tag_management/deleting_resource_tags_in_batches.rst +++ b/api-ref/source/api_description/tag_management/deleting_resource_tags_in_batches.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/stream/{stream_id}/tags/action -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -29,61 +29,57 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+======================================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+============================================================+==========================================================+ - | action | Yes | String | Operation to be performed. The value can be delete only. | - | | | | | - | | | | - delete: batch deletion | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **delete** | - +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------+ - | tags | Yes | Array of :ref:`Tag ` objects | Tag list. | - +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------+ + +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+============================================================+==============================================================================================+ + | action | Yes | String | Operation to be performed. The value can only be **delete**, which indicates batch deletion. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **delete** | + +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ + | tags | Yes | Array of :ref:`Tag ` objects | Tag list. | + +-----------------+-----------------+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ .. _batchdeletetags__request_tag: .. table:: **Table 4** Tag - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================================+ - | key | No | String | Key. | - | | | | | - | | | | - This field cannot be left blank. | - | | | | | - | | | | - The key value of a resource must be unique. | - | | | | | - | | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | value | No | 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** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================================================+ + | key | No | String | 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** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api_description/tag_management/deleting_tags_of_specified_streams.rst b/api-ref/source/api_description/tag_management/deleting_tags_of_specified_streams.rst index 7887ddd..6a27439 100644 --- a/api-ref/source/api_description/tag_management/deleting_tags_of_specified_streams.rst +++ b/api-ref/source/api_description/tag_management/deleting_tags_of_specified_streams.rst @@ -15,7 +15,7 @@ URI DELETE /v2/{project_id}/stream/{stream_id}/tags/{key} -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -30,13 +30,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- diff --git a/api-ref/source/api_description/tag_management/querying_tags_of_specified_regions.rst b/api-ref/source/api_description/tag_management/querying_tags_of_specified_regions.rst index d3b1459..421c899 100644 --- a/api-ref/source/api_description/tag_management/querying_tags_of_specified_regions.rst +++ b/api-ref/source/api_description/tag_management/querying_tags_of_specified_regions.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/stream/tags -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -28,13 +28,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -53,23 +53,23 @@ Response Parameters .. table:: **Table 4** Tags - +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================+ - | key | String | Key. | - | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The key value of a resource must be unique. | - | | | | - | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ - | values | Array of strings | Tag value list. | - | | | | - | | | If values are null, it indicates any_value. The relationship between values is OR. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================================================+ + | key | String | 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 | Array of strings | List of tag values | + | | | | + | | | If **values** is an empty list, it indicates **any_value**. The values are in the OR relationship. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/api_description/tag_management/querying_tags_of_specified_streams.rst b/api-ref/source/api_description/tag_management/querying_tags_of_specified_streams.rst index 44a95d4..4bdbfa2 100644 --- a/api-ref/source/api_description/tag_management/querying_tags_of_specified_streams.rst +++ b/api-ref/source/api_description/tag_management/querying_tags_of_specified_streams.rst @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/stream/{stream_id}/tags -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -29,13 +29,13 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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 ------------------- @@ -54,33 +54,33 @@ Response Parameters .. table:: **Table 4** Tag - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================+ - | key | String | Key. | - | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The key value of a resource must be unique. | - | | | | - | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ - | value | 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** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================================+ + | key | String | 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 | 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** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/api_description/tag_management/using_tags_to_filter_resources_streams.rst b/api-ref/source/api_description/tag_management/using_tags_to_filter_resources_streams.rst index f3c1555..9bd65b5 100644 --- a/api-ref/source/api_description/tag_management/using_tags_to_filter_resources_streams.rst +++ b/api-ref/source/api_description/tag_management/using_tags_to_filter_resources_streams.rst @@ -15,7 +15,7 @@ URI POST /v2/{project_id}/stream/resource_instances/action -.. table:: **Table 1** Path parameters +.. table:: **Table 1** Path Parameters ========== ========= ====== =========== Parameter Mandatory Type Description @@ -28,69 +28,65 @@ Request Parameters .. table:: **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). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================+ + | X-Auth-Token | Yes | String | 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:: **Table 3** Request body parameters - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | action | Yes | String | Operation to be performed. The value can be only filter or count. | - | | | | | - | | | | - filter: queries data on multiple pages. | - | | | | | - | | | | - count: queries the total number of data records. The total number of data records is returned based on the search criteria. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **filter** | - | | | | | - | | | | - **count** | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | String | Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1 to 1000. | - | | | | | - | | | | Default: **1000** | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | String | Index position. The query starts from the next data record indexed by this parameter. When querying data on the first page, you do not need to pass this parameter. When querying data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. This parameter is not displayed when action is set to count. If action is set to filter, the value defaults to 0. The value must be a positive integer. | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`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 | No | Array of :ref:`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 | No | Array of :ref:`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 | No | Array of :ref:`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 | No | String | Search criteria. The tag key is the field to match. Currently, only resource_name is supported. value indicates the matched value. This field is a fixed dictionary value. | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | action | Yes | String | 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 | No | String | Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1 to 1000. | + | | | | | + | | | | Default: **1000** | + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | String | Index position. The query starts from the next data record indexed by this parameter. 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 | No | Array of :ref:`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 | No | Array of :ref:`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 | No | Array of :ref:`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. Each tag key must be unique, and the tag values of one key must also be unique. | + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | not_tags_any | No | Array of :ref:`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 | No | String | Search criteria. The tag key is the field to match. Currently, only resource_name is supported. value indicates the matched value. This field is a fixed dictionary value. | + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listresourcesbytags__request_tags: .. table:: **Table 4** Tags - +-----------------+-----------------+------------------+--------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+======================================================================================+ - | key | No | String | Key. | - | | | | | - | | | | - This field cannot be left blank. | - | | | | | - | | | | - The key value of a resource must be unique. | - | | | | | - | | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+------------------+--------------------------------------------------------------------------------------+ - | values | No | Array of strings | Tag value list. | - | | | | | - | | | | If values are null, it indicates any_value. The relationship between values is OR. | - +-----------------+-----------------+------------------+--------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+====================================================================================================================================+ + | key | No | String | 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 | No | Array of strings | List of tag values | + | | | | | + | | | | If **values** is an empty list, it indicates **any_value**. The values are in the OR relationship. | + +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -99,59 +95,33 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===================================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | action | String | Operation to be performed. The value can be only filter or count. | - | | | | - | | | - filter: queries data on multiple pages. | - | | | | - | | | - count: queries the total number of data records. The total number of data records is returned based on the search criteria. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **filter** | - | | | | - | | | - **count** | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | String | Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1 to 1000. | - | | | | - | | | Default: **1000** | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | String | Index position. The query starts from the next data record indexed by this parameter. When querying data on the first page, you do not need to pass this parameter. When querying data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. This parameter is not displayed when action is set to count. If action is set to filter, the value defaults to 0. The value must be a positive integer. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`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 :ref:`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 :ref:`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 :ref:`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. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-------------------------------------------------------------------+--------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+===================================================================+====================================================================+ + | resources | Array of :ref:`Tags ` objects | Resource List. | + +-------------+-------------------------------------------------------------------+--------------------------------------------------------------------+ + | total_count | Integer | Array of :ref:`Tags ` objects. | + +-------------+-------------------------------------------------------------------+--------------------------------------------------------------------+ .. _listresourcesbytags__response_tags: .. table:: **Table 6** Tags - +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================+ - | key | String | Key. | - | | | | - | | | - This field cannot be left blank. | - | | | | - | | | - The key value of a resource must be unique. | - | | | | - | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ - | values | Array of strings | Tag value list. | - | | | | - | | | If values are null, it indicates any_value. The relationship between values is OR. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================================================+ + | key | String | 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 | Array of strings | List of tag values | + | | | | + | | | If **values** is an empty list, it indicates **any_value**. The values are in the OR relationship. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index 782b5bd..4943675 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -72,26 +72,8 @@ Error Codes +-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | DIS.4336 | Invalid HDFS path. | The MRS HDFS path entered during MRS dump task creation is invalid. | Ensure that the MRS HDFS path exists. | +-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4337 | The DLI database does not exist. | The DLI database entered during DLI dump task creation does not exist. | Ensure that the DLI database exists. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4338 | The DLI table does not exist. | The DLI table entered during DLI dump task creation does not exist. | Ensure that the DLI table exists and is an internal table. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | DIS.4339 | Consumer quota exceeded. | The consumer quota of the consumer group is insufficient. | Allocate consumers properly or create a consumer group to meet the requirement. | +-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4341 | The CloudTable cluster does not exist. | The CloudTable cluster entered during CloudTable dump task creation does not exist. | Ensure that the CloudTable cluster exists and is running properly. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4342 | The CloudTable table does not exist | The CloudTable table entered during CloudTable dump task creation does not exist. | Ensure that the CloudTable table exists. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4343 | The CloudTable table family does not exist. | The CloudTable column family entered during CloudTable dump task creation does not exist. | Ensure that the CloudTable column family exists. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4345 | Invalid CloudTable schema. | The schema entered during CloudTable dump task creation is invalid. | Check the schema based on the returned details to ensure that the configured JSON attribute name exists and the parameters are valid. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4348 | Invalid CloudTable openTSDB schema. | The schema entered during CloudTable OpenTSDB dump task creation is invalid. | Check the schema based on the returned details to ensure that the configured JSON attribute name exists and the parameters are valid. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4350 | Invalid DWS cluster. | The DWS cluster entered during DWS dump task creation does not exist. | Ensure that the DWS cluster exists and is running properly. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DIS.4351 | Invalid KMS userKey. | The KMS key entered during DWS dump task creation is invalid. | Ensure that the KMS key exists. | -+-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | DIS.4354 | The transfer task does not exist. | The dump task to be deleted or updated does not exist. | Ensure that the dump task exists. | +-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | DIS.4355 | The transfer task already exists. | A dump task with the same name already exists. | Enter a new dump task name. | @@ -112,7 +94,7 @@ Error Codes +-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +| 403 | DIS.4116 | Invalid RBAC. %s | User operations are restricted. | Ensure that the account 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. | +-------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst index 61e81ae..abba0df 100644 --- a/api-ref/source/appendix/obtaining_a_project_id.rst +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -8,9 +8,9 @@ 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 `__. +You can obtain the project ID by calling the API `used to query project information `__. -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 :ref:`Authentication `. +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 :ref:`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). @@ -52,7 +52,7 @@ A project ID is required for some URLs when an API is called. To obtain a projec On the **My Credentials** page, view project IDs in the project list. -.. figure:: /_static/images/en-us_image_0000001238312593.jpg +.. figure:: /_static/images/en-us_image_0191919629.jpg :alt: **Figure 1** Viewing project IDs **Figure 1** Viewing project IDs diff --git a/api-ref/source/application_example.rst b/api-ref/source/application_example.rst index 7fbefb9..c8f20c2 100644 --- a/api-ref/source/application_example.rst +++ b/api-ref/source/application_example.rst @@ -10,7 +10,7 @@ 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 :ref:`Before You Start ` API. For details, see :ref:`Calling APIs `. +The following describes how to create a DIS stream by calling the :ref:`Before You Start ` API. For details, see :ref:`Calling APIs `. .. note:: @@ -29,7 +29,7 @@ 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 ----------------- @@ -120,16 +120,9 @@ You can also configure a schema for the stream. When using DIS to dump data to o "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 :ref:`Error Codes `. diff --git a/api-ref/source/calling_apis/authentication.rst b/api-ref/source/calling_apis/authentication.rst index fa3c47d..bf4948b 100644 --- a/api-ref/source/calling_apis/authentication.rst +++ b/api-ref/source/calling_apis/authentication.rst @@ -84,7 +84,12 @@ To obtain an access key, perform the following steps: #. Click **OK** and save the access key file as prompted. The access key file will be saved to your browser's configured download location. Open the **credentials.csv** file to view **Access Key Id** and **Secret Access Key**. -In AK/SK-based authentication, you can use an AK/SK to sign requests based on the signature algorithm or use the signing SDK to sign requests. + .. note:: + + - 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. For details about how to sign requests and use the signature SDK, see API Request Signing Guide. .. important:: diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 181cd6b..98af470 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,18 +5,36 @@ Change History ============== -+-----------------------------------+---------------------------------------------------------------+ -| Released On | Description | -+===================================+===============================================================+ -| 2018-10-25 | Accepted in OTC 3.2. | -+-----------------------------------+---------------------------------------------------------------+ -| 2018-09-29 | Modified the following contents: | -| | | -| | Added tag management APIs | -+-----------------------------------+---------------------------------------------------------------+ -| 2018-09-26 | Modified the following contents: | -| | | -| | A status code was added in :ref:`Status Codes `. | -+-----------------------------------+---------------------------------------------------------------+ -| 2018-03-16 | This issue is the first official release. | -+-----------------------------------+---------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+=====================================================================================+ +| 2023-04-03 | Modified the following sections: | +| | | +| | :ref:`Creating Streams ` | ++-----------------------------------+-------------------------------------------------------------------------------------+ +| 2022-09-30 | Modified the following sections: | +| | | +| | - :ref:`Application Example ` | +| | - :ref:`Stream Management ` | +| | - :ref:`App Management ` | +| | - :ref:`Checkpoint Management ` | +| | - :ref:`Permissions Policies and Supported Actions ` | +| | | +| | Offline the following sections: | +| | | +| | - Updating Stream Information | +| | - Adding Permission Policies | +| | - Querying Permission Policies | ++-----------------------------------+-------------------------------------------------------------------------------------+ +| 2018-10-25 | Accepted in OTC 3.2. | ++-----------------------------------+-------------------------------------------------------------------------------------+ +| 2018-09-29 | Modified the following contents: | +| | | +| | Added tag management APIs | ++-----------------------------------+-------------------------------------------------------------------------------------+ +| 2018-09-26 | Modified the following contents: | +| | | +| | A status code was added in :ref:`Status Codes `. | ++-----------------------------------+-------------------------------------------------------------------------------------+ +| 2018-03-16 | This issue is the first official release. | ++-----------------------------------+-------------------------------------------------------------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions.rst b/api-ref/source/permissions_policies_and_supported_actions.rst index ab398e7..ae54655 100644 --- a/api-ref/source/permissions_policies_and_supported_actions.rst +++ b/api-ref/source/permissions_policies_and_supported_actions.rst @@ -33,146 +33,56 @@ Note: The check mark (Y) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect. -:ref:`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. +:ref:`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. -.. _en-us_topic_0000001079240698__table538416112711: +.. _en-us_topic_0000001079240698__table397013152131: .. table:: **Table 1** Permissions policies and supported actions - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Permissions | APIs | Actions | Project | Enterprise Project | - +==================================================+===================================================================+===========================+=============+====================+ - | Creating a consumer app | POST /v2/{project_id}/apps | dis:apps:create | Y | x | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting an app | DELETE /v2/{project_id}/apps/{app_name} | dis:apps:delete | Y | x | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying apps | GET | dis:apps:list | Y | x | - | | | | | | - | | /v2/{project_id}/apps | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying app details | GET | dis:apps:get | Y | x | - | | | | | | - | | /v2/{project_id}/apps/{app_name} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying the app consumption status | GET | dis:appState:get | Y | Y | - | | | | | | - | | /v2/{project_id}/apps/{app}/streams/{stream_name} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying all events of a user in pagination mode | GET | dis:events:list | Y | x | - | | | | | | - | | /v1/{project_id}/events | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Creating a subscription | POST | dis:eventEnumSubs:create | Y | x | - | | | | | | - | | /v1/{project_id}/event-subs | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting a subscription | DELETE | dis:eventEnumSubs:delete | Y | x | - | | | | | | - | | /v1/{project_id}/event-subs/{sub_id} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Modifying a subscription | PUT | dis:eventEnumSubs:update | Y | x | - | | | | | | - | | /v1/{project_id}/event-subs/{sub_id} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying all subscriptions of a user | GET | dis:eventEnumSubs:list | Y | x | - | | | | | | - | | /v1/{project_id}/event-subs | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Adding a permission policy | POST | dis:streamPolicies:create | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{streamName}/policies | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying permission policies | GET | dis:streamPolicies:list | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{streamName}/policies | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting a permission policy of a stream | DELETE | dis:streamPolicies:delete | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{streamName}/policies | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying details of a stream | GET | dis:streams:get | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{streamName} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Creating a stream | POST | dis:streams:create | Y | Y | - | | | | | | - | | /v2/{project_id}/streams | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting a Stream | DELETE | dis:streams:delete | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying streams | GET | dis:streams:list | Y | x | - | | | | | | - | | /v2/{project_id}/streams | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Updating stream information | PUT | dis:streams:update | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name}/update | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Creating a dump task | POST | dis:transferTasks:create | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name}/transfer-tasks | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Updating a dump task | PUT | dis:transferTasks:update | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name}/transfer-tasks | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying dump tasks | GET | dis:transferTasks:list | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name}/transfer-tasks | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying details of a dump task | GET | dis:transferTasks:get | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting a dump task | DELETE | dis:transferTasks:delete | Y | Y | - | | | | | | - | | /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Uploading Data to a DIS Stream | POST | dis:records:write | Y | Y | - | | | | | | - | | /v2/{project_id}/records | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Obtaining a data cursor | GET | dis:records:readCursor | Y | Y | - | | | | | | - | | /v2/{project_id}/cursors | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Downloading data from a DIS stream | GET | dis:records:read | Y | Y | - | | | | | | - | | /v2/{project_id}/records | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Adding a checkpoint | POST | dis:checkpoints:commit | Y | Y | - | | | | | | - | | /v2/{project_id}/checkpoints | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying checkpoint details | GET | dis:checkpoints:get | Y | Y | - | | | | | | - | | /v2/{project_id}/checkpoints | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting a checkpoint | DELETE | dis:checkpoints:delete | Y | Y | - | | | | | | - | | /v2/{project_id}/checkpoints | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Filtering streams by tag | POST | dis:tagResources:list | Y | x | - | | | | | | - | | /{project_id}/{resource_type}/resource_instances/action | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Adding or deleting resource tags in batches | POST | dis:tagResources:update | Y | x | - | | | | | | - | | /{project_id}/{resource_type}/{resource_id}/tags/action | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Adding a Tag to a Specified Stream | POST | dis:tagResources:create | Y | x | - | | | | | | - | | /{project_id}/{resource_type}/{resource_id}/tags | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Deleting a tag of a specified stream | DELETE | dis:tagResources:delete | Y | x | - | | | | | | - | | /{project_id}/{resource_type}/{resource_id}/tags/{key} | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - | Querying all tags of a specified region | GET | dis:tags:list | Y | x | - | | | | | | - | | /{project_id}/{resource_type}/tags | | | | - +--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+ - -Note: For the actions not listed :ref:`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. + +-------------------------------------------+-----------------------+------------------+--------------+ + | **Operation** | **DIS Administrator** | **DIS Operator** | **DIS User** | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Creating streams | Y | Y | x | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Deleting streams | Y | Y | x | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying the stream list | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying stream details | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Viewing stream monitoring information | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying partition monitoring information | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Obtaining stream consumption information | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Changing partition quantity | Y | Y | x | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Uploading data | Y | x | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Obtaining data cursors | Y | x | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Downloading data | Y | x | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Creating applications | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying application details | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying the application list | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Deleting applications | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Adding checkpoints | Y | x | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying checkpoints | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Deleting checkpoints | Y | x | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Creating dump tasks | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying dump task details | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Querying the dump task list | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+ + | Deleting dump tasks | Y | Y | Y | + +-------------------------------------------+-----------------------+------------------+--------------+