mikacur/data-ingestion-service_aligns_with_the_OTC_platform_07_23
1
0
Fork 0
forked from docs/data-ingestion-service
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2022-11-03 14:56:51 +00:00
parent 1666eaa227
commit 096dd667bf
20 changed files with 275 additions and 272 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/api_description/data_management/uploading_data.rst
View File

@ -65,7 +65,7 @@ Request Parameters
+===================+=================+=================+=======================================================================================================================================================================================================================================+
| 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 |
| 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: |
| | | | |

4
api-ref/source/api_description/dump_task_management/adding_obs_dump_tasks.rst
View File

@ -176,9 +176,9 @@ Request Parameters
| | | | - Comma (,), which is the default value |
| | | | - Semicolon (;) |
| | | | - Vertical bar (|) |
| | | | - Newline character (\n) |
| | | | - Newline character (\\n) |
| | | | |
| | | | Default: **``\n``** |
| | | | Default: **\\n** |
+-----------------------+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _dis_02_0410__request_processingschema:

4
api-ref/source/api_description/dump_task_management/querying_dump_task_details.rst
View File

@ -247,9 +247,9 @@ Response Parameters
| | | - Comma (,), which is the default value |
| | | - Semicolon (;) |
| | | - Vertical bar (|) |
| | | - Newline character (\n) |
| | | - Newline character (\\n) |
| | | |
| | | Default: **``\n``** |
| | | Default: **\\n** |
+-----------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _showtransfertask__response_processingschema:

54
api-ref/source/api_description/stream_management/creating_streams.rst
View File

@ -146,33 +146,33 @@ Request Parameters
.. table:: **Table 5** 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. |
| | | | |
| | | | - 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** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
.. _dis_02_0016_01__request_systag:

54
api-ref/source/api_description/stream_management/querying_stream_details.rst
View File

@ -253,33 +253,33 @@ Response Parameters
.. table:: **Table 8** 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. |
| | | |
| | | - 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** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------+
.. _dis_02_0025__response_systag:

56
api-ref/source/api_description/stream_management/querying_streams.rst
View File

@ -132,7 +132,7 @@ Response Parameters
| | | |
| | | - 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. |
| | | - 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. |
| | | |
@ -173,33 +173,33 @@ Response Parameters
.. 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. |
| | | |
| | | - 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** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------+
.. _dis_02_0024__response_systag:

2
api-ref/source/api_description/stream_management/updating_stream_information.rst
View File

@ -47,7 +47,7 @@ Request Parameters
| | | | |
| | | | - 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. |
| | | | - 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. |
| | | | |

54
api-ref/source/api_description/tag_management/adding_resource_tags_in_batches.rst
View File

@ -57,33 +57,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. |
| | | | |
| | | | - 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** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
Response Parameters
-------------------

54
api-ref/source/api_description/tag_management/adding_tags_for_specified_streams.rst
View File

@ -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. |
| | | | |
| | | | - 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** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
Response Parameters
-------------------

54
api-ref/source/api_description/tag_management/deleting_resource_tags_in_batches.rst
View File

@ -57,33 +57,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. |
| | | | |
| | | | - 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** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
Response Parameters
-------------------

34
api-ref/source/api_description/tag_management/querying_tags_of_specified_regions.rst
View File

@ -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. |
| | | |
| | | - This field cannot be left blank. |
| | | |
| | | - The key value of a resource must be unique. |
| | | |
| | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------+
| values | Array of strings | Tag value list. |
| | | |
| | | If values are null, it indicates any_value. The relationship between values is OR. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------+
Example Requests
----------------

54
api-ref/source/api_description/tag_management/querying_tags_of_specified_streams.rst
View File

@ -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. |
| | | |
| | | - 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** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------+
Example Requests
----------------

68
api-ref/source/api_description/tag_management/using_tags_to_filter_resources_streams.rst
View File

@ -74,23 +74,23 @@ Request Parameters
.. 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. |
| | | | |
| | | | - This field cannot be left blank. |
| | | | |
| | | | - The key value of a resource must be unique. |
| | | | |
| | | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). |
| | | | |
| | | | Maximum: **36** |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------+
| values | No | Array of strings | Tag value list. |
| | | | |
| | | | If values are null, it indicates any_value. The relationship between values is OR. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -135,23 +135,23 @@ Response Parameters
.. 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. |
| | | |
| | | - This field cannot be left blank. |
| | | |
| | | - The key value of a resource must be unique. |
| | | |
| | | - Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\\u4E00-\\u9FFF). |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------+
| values | Array of strings | Tag value list. |
| | | |
| | | If values are null, it indicates any_value. The relationship between values is OR. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------+
Example Requests
----------------

1
api-ref/source/appendix/obtaining_a_project_id.rst
View File

@ -55,5 +55,4 @@ A project ID is required for some URLs when an API is called. To obtain a projec
.. figure:: /_static/images/en-us_image_0000001238312593.jpg
:alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs

1
api-ref/source/before_you_start/concepts.rst
View File

@ -23,7 +23,6 @@ Concepts
.. figure:: /_static/images/en-us_image_0170787737.gif
:alt: **Figure 1** Project isolating model
**Figure 1** Project isolating model
- Checkpoint

1
api-ref/source/calling_apis/authentication.rst
View File

@ -80,7 +80,6 @@ To obtain an access key, perform the following steps:
.. figure:: /_static/images/en-us_image_0000001135802808.png
:alt: **Figure 1** Clicking Create Access Key
**Figure 1** Clicking Create Access Key
#. Click **OK** and save the access key file as prompted. The access key file will be saved to your browser's configured download location. Open the **credentials.csv** file to view **Access Key Id** and **Secret Access Key**.

2
api-ref/source/calling_apis/making_an_api_request.rst
View File

@ -109,7 +109,7 @@ This part is optional. The body of a request is often sent in a structured forma
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
In the case of the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *username*, *domainname*, *\*******\** (login password), and *xxxxxxxxxxxxxxxxxx* (project ID) with the actual values. To learn how to obtain a project ID, see :ref:`Obtaining a Project ID <dis_02_0501>`.
In the case of the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *username*, *domainname*, ``********`` (login password), and *xxxxxxxxxxxxxxxxxx* (project ID) with the actual values. To learn how to obtain a project ID, see :ref:`Obtaining a Project ID <dis_02_0501>`.
.. note::

1
api-ref/source/calling_apis/response.rst
View File

@ -26,7 +26,6 @@ Similar to a request, a response also has a header, for example, **Content-Type*
.. figure:: /_static/images/en-us_image_0170647338.png
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token
**Figure 1** Header fields of the response to the request for obtaining a user token
(Optional) Response Body

17
api-ref/source/conf.py
View File

@ -26,6 +26,9 @@ otcdocs_auto_version = False
project = 'Data Ingestion Service'
otcdocs_repo_name = 'docs/data-ingestion-service'
# Those variables are required for edit/bug links
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@ -35,6 +38,9 @@ sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ----------------------------------------------------
# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not
# what it is expected
smartquotes = False
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@ -69,11 +75,12 @@ show_authors = False
html_theme = 'otcdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'disable_search': True,
'site_name': 'Internal Documentation Portal'
"disable_search": "True",
"site_name": "Internal Documentation Portal",
"logo_url": "https://docs-int.otc-service.com",
}
# The name for this set of Sphinx documents. If None, it defaults to
@ -89,8 +96,8 @@ html_static_path = ['_static']
# -- Options for PDF output --------------------------------------------------
latex_documents = [
('index',
('index',
'dis-api-ref.tex',
u'Data Ingestion Service - API Reference',
u'OpenTelekomCloud', 'manual'),
]
]

30
api-ref/source/permissions_policies_and_supported_actions.rst
View File

@ -42,15 +42,15 @@ The check mark (Y) indicates that an action takes effect. The cross mark (x) ind
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Permissions | APIs | Actions | Project | Enterprise Project |
+==================================================+===================================================================+===========================+=============+====================+
| Creating a consumer app | POST /v2/{project_id}/apps | dis:apps:create | Y | × |
| 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 | × |
| Deleting an app | DELETE /v2/{project_id}/apps/{app_name} | dis:apps:delete | Y | x |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Querying apps | GET | dis:apps:list | Y | × |
| Querying apps | GET | dis:apps:list | Y | x |
| | | | | |
| | /v2/{project_id}/apps | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Querying app details | GET | dis:apps:get | Y | × |
| Querying app details | GET | dis:apps:get | Y | x |
| | | | | |
| | /v2/{project_id}/apps/{app_name} | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
@ -58,23 +58,23 @@ The check mark (Y) indicates that an action takes effect. The cross mark (x) ind
| | | | | |
| | /v2/{project_id}/apps/{app}/streams/{stream_name} | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Querying all events of a user in pagination mode | GET | dis:events:list | Y | × |
| 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 | × |
| Creating a subscription | POST | dis:eventEnumSubs:create | Y | x |
| | | | | |
| | /v1/{project_id}/event-subs | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Deleting a subscription | DELETE | dis:eventEnumSubs:delete | Y | × |
| Deleting a subscription | DELETE | dis:eventEnumSubs:delete | Y | x |
| | | | | |
| | /v1/{project_id}/event-subs/{sub_id} | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Modifying a subscription | PUT | dis:eventEnumSubs:update | Y | × |
| 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 | × |
| Querying all subscriptions of a user | GET | dis:eventEnumSubs:list | Y | x |
| | | | | |
| | /v1/{project_id}/event-subs | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
@ -102,7 +102,7 @@ The check mark (Y) indicates that an action takes effect. The cross mark (x) ind
| | | | | |
| | /v2/{project_id}/streams/{stream_name} | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Querying streams | GET | dis:streams:list | Y | × |
| Querying streams | GET | dis:streams:list | Y | x |
| | | | | |
| | /v2/{project_id}/streams | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
@ -154,23 +154,23 @@ The check mark (Y) indicates that an action takes effect. The cross mark (x) ind
| | | | | |
| | /v2/{project_id}/checkpoints | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+
| Filtering streams by tag | POST | dis:tagResources:list | Y | × |
| 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 | × |
| 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 | × |
| 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 | × |
| 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 | × |
| Querying all tags of a specified region | GET | dis:tags:list | Y | x |
| | | | | |
| | /{project_id}/{resource_type}/tags | | | |
+--------------------------------------------------+-------------------------------------------------------------------+---------------------------+-------------+--------------------+