forked from docs/data-ingestion-service
Changes to dis_api-ref from docs/doc-exports#263 (DIS API test1 version
Upload Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
parent
920fef4410
commit
ba52716044
BIN
api-ref/source/_static/images/en-us_image_0000001135802808.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001135802808.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001238312593.jpg
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001238312593.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
BIN
api-ref/source/_static/images/en-us_image_0170647338.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0170647338.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
api-ref/source/_static/images/en-us_image_0170787737.gif
Normal file
BIN
api-ref/source/_static/images/en-us_image_0170787737.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
@ -0,0 +1,88 @@
|
||||
:original_name: CreateApp.html
|
||||
|
||||
.. _CreateApp:
|
||||
|
||||
Creating Consumption Apps
|
||||
=========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to create consumption apps.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
POST /v2/{project_id}/apps
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID.
|
||||
========== ========= ====== ===========
|
||||
|
||||
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 |
|
||||
+=================+=================+=================+=================================================================================================================+
|
||||
| app_name | Yes | String | Unique identifier of the consumer application to be created. |
|
||||
| | | | |
|
||||
| | | | The application name contains 1 to 200 characters, including letters, digits, underscores (_), and hyphens (-). |
|
||||
| | | | |
|
||||
| | | | Minimum: **1** |
|
||||
| | | | |
|
||||
| | | | Maximum: **200** |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Creating Consumption Apps
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{Endpoint}/v2/{project_id}/apps
|
||||
|
||||
{
|
||||
"app_name" : "newapp"
|
||||
}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
201 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
@ -0,0 +1,71 @@
|
||||
:original_name: DeleteApp.html
|
||||
|
||||
.. _DeleteApp:
|
||||
|
||||
Deleting Apps
|
||||
=============
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete apps.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v2/{project_id}/apps/{app_name}
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
========== ========= ====== ==============================
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ==============================
|
||||
project_id Yes String Project ID.
|
||||
app_name Yes String Name of the app to be deleted.
|
||||
========== ========= ====== ==============================
|
||||
|
||||
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
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting Apps
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v2/{project_id}/apps/{app_name}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
204 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
22
api-ref/source/api_description/app_management/index.rst
Normal file
22
api-ref/source/api_description/app_management/index.rst
Normal file
@ -0,0 +1,22 @@
|
||||
:original_name: topic_300000001.html
|
||||
|
||||
.. _topic_300000001:
|
||||
|
||||
App Management
|
||||
==============
|
||||
|
||||
- :ref:`Creating Consumption Apps <createapp>`
|
||||
- :ref:`Querying Apps <listapp>`
|
||||
- :ref:`Deleting Apps <deleteapp>`
|
||||
- :ref:`Querying App Details <showapp>`
|
||||
- :ref:`Querying App Consumption Status <showconsumerstate>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_consumption_apps
|
||||
querying_apps
|
||||
deleting_apps
|
||||
querying_app_details
|
||||
querying_app_consumption_status
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,96 @@
|
||||
:original_name: ShowApp.html
|
||||
|
||||
.. _ShowApp:
|
||||
|
||||
Querying App Details
|
||||
====================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to query app details.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
GET /v2/{project_id}/apps/{app_name}
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
========== ========= ====== ==============================
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ==============================
|
||||
project_id Yes String Project ID.
|
||||
app_name Yes String Name of the app to be queried.
|
||||
========== ========= ====== ==============================
|
||||
|
||||
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 |
|
||||
+================================+==================+================================================+
|
||||
| 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. |
|
||||
+--------------------------------+------------------+------------------------------------------------+
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Querying App Details
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{Endpoint}/v2/{project_id}/apps/{app_name}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
**Status code: 200**
|
||||
|
||||
Normal response.
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"app_id" : "bd6IPpvgiIflQPMpi9M",
|
||||
"app_name" : "newstream",
|
||||
"create_time" : 1593569685875,
|
||||
"commit_checkpoint_stream_names" : [ "newstream" ]
|
||||
}
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
200 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
137
api-ref/source/api_description/app_management/querying_apps.rst
Normal file
137
api-ref/source/api_description/app_management/querying_apps.rst
Normal file
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,98 @@
|
||||
:original_name: DeleteCheckpoint.html
|
||||
|
||||
.. _DeleteCheckpoint:
|
||||
|
||||
Deleting Checkpoints
|
||||
====================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete checkpoints.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v2/{project_id}/checkpoints
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID.
|
||||
========== ========= ====== ===========
|
||||
|
||||
.. 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. |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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). |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting Checkpoints
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v2/{project_id}/checkpoints
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
204 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
@ -0,0 +1,18 @@
|
||||
:original_name: topic_300000002.html
|
||||
|
||||
.. _topic_300000002:
|
||||
|
||||
Checkpoint Management
|
||||
=====================
|
||||
|
||||
- :ref:`Submitting Checkpoints <dis_02_0403>`
|
||||
- :ref:`Querying Checkpoint Details <showcheckpoint>`
|
||||
- :ref:`Deleting Checkpoints <deletecheckpoint>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
submitting_checkpoints
|
||||
querying_checkpoint_details
|
||||
deleting_checkpoints
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
18
api-ref/source/api_description/data_management/index.rst
Normal file
18
api-ref/source/api_description/data_management/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
:original_name: topic_300000003.html
|
||||
|
||||
.. _topic_300000003:
|
||||
|
||||
Data Management
|
||||
===============
|
||||
|
||||
- :ref:`Uploading Data <dis_02_0018>`
|
||||
- :ref:`Downloading Data <dis_02_0019>`
|
||||
- :ref:`Obtaining Data Cursors <dis_02_0020>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
uploading_data
|
||||
downloading_data
|
||||
obtaining_data_cursors
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,72 @@
|
||||
:original_name: DeleteTransferTask.html
|
||||
|
||||
.. _DeleteTransferTask:
|
||||
|
||||
Deleting Dump Tasks
|
||||
===================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete dump tasks.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
=========== ========= ====== ====================================
|
||||
Parameter Mandatory Type Description
|
||||
=========== ========= ====== ====================================
|
||||
project_id Yes String Project ID.
|
||||
stream_name Yes String Name of the stream.
|
||||
task_name Yes String Name of the dump task to be deleted.
|
||||
=========== ========= ====== ====================================
|
||||
|
||||
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
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting Dump Tasks
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
204 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
@ -0,0 +1,32 @@
|
||||
:original_name: topic_300000004.html
|
||||
|
||||
.. _topic_300000004:
|
||||
|
||||
Dump Task Management
|
||||
====================
|
||||
|
||||
- :ref:`Adding OBS Dump Tasks <dis_02_0410>`
|
||||
- :ref:`Querying Dump Tasks <listtransfertasks>`
|
||||
- :ref:`Deleting Dump Tasks <deletetransfertask>`
|
||||
- :ref:`Querying Dump Task Details <showtransfertask>`
|
||||
- :ref:`Starting Dump Tasks in Batches <batchstarttransfertask>`
|
||||
- :ref:`Pausing Dump Tasks in Batches <batchstoptransfertask>`
|
||||
- :ref:`Adding DWS Dump Tasks <createdwstransfertask>`
|
||||
- :ref:`Adding MRS Dump Tasks <createmrstransfertask>`
|
||||
- :ref:`Adding DLI Dump Tasks <createdlitransfertask>`
|
||||
- :ref:`Adding CloudTable Dump Tasks <createcloudtabletransfertask>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
adding_obs_dump_tasks
|
||||
querying_dump_tasks
|
||||
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
|
||||
@ -0,0 +1,97 @@
|
||||
:original_name: BatchStopTransferTask.html
|
||||
|
||||
.. _BatchStopTransferTask:
|
||||
|
||||
Pausing Dump Tasks in Batches
|
||||
=============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to pause dump tasks in batches.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
+-----------------+-----------------+-----------------+-----------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=================+===================================+
|
||||
| project_id | Yes | String | Project ID. |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------+
|
||||
| stream_name | Yes | String | Name of the stream to be queried. |
|
||||
| | | | |
|
||||
| | | | Maximum: **60** |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------+
|
||||
|
||||
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 <batchstoptransfertask__request_batchtransfertask>` objects | List of dump tasks to be paused. |
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
|
||||
.. _batchstoptransfertask__request_batchtransfertask:
|
||||
|
||||
.. table:: **Table 3** BatchTransferTask
|
||||
|
||||
========= ========= ====== =============
|
||||
Parameter Mandatory Type Description
|
||||
========= ========= ====== =============
|
||||
id Yes String Dump task ID.
|
||||
========= ========= ====== =============
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Pausing Dump Tasks in Batches
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/action
|
||||
|
||||
{
|
||||
"action" : "stop",
|
||||
"tasks" : [ {
|
||||
"id" : "9dSu1wfCytSk1aOLxvF"
|
||||
} ]
|
||||
}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
200 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,97 @@
|
||||
:original_name: BatchStartTransferTask.html
|
||||
|
||||
.. _BatchStartTransferTask:
|
||||
|
||||
Starting Dump Tasks in Batches
|
||||
==============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to start dump tasks in batches.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
+-----------------+-----------------+-----------------+-----------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=================+===================================+
|
||||
| project_id | Yes | String | Project ID. |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------+
|
||||
| stream_name | Yes | String | Name of the stream to be queried. |
|
||||
| | | | |
|
||||
| | | | Maximum: **60** |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------+
|
||||
|
||||
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 <batchstarttransfertask__request_batchtransfertask>` objects | List of dump tasks to be operated. |
|
||||
+-----------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
||||
|
||||
.. _batchstarttransfertask__request_batchtransfertask:
|
||||
|
||||
.. table:: **Table 3** BatchTransferTask
|
||||
|
||||
========= ========= ====== =============
|
||||
Parameter Mandatory Type Description
|
||||
========= ========= ====== =============
|
||||
id Yes String Dump task ID.
|
||||
========= ========= ====== =============
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Starting Dump Tasks in Batches
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/action
|
||||
|
||||
{
|
||||
"action" : "start",
|
||||
"tasks" : [ {
|
||||
"id" : "9dSu1wfCytSk1aOLxvF"
|
||||
} ]
|
||||
}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
200 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
26
api-ref/source/api_description/index.rst
Normal file
26
api-ref/source/api_description/index.rst
Normal file
@ -0,0 +1,26 @@
|
||||
:original_name: dis_02_0015.html
|
||||
|
||||
.. _dis_02_0015:
|
||||
|
||||
API Description
|
||||
===============
|
||||
|
||||
- :ref:`Stream Management <topic_300000000>`
|
||||
- :ref:`App Management <topic_300000001>`
|
||||
- :ref:`Checkpoint Management <topic_300000002>`
|
||||
- :ref:`Data Management <topic_300000003>`
|
||||
- :ref:`Dump Task Management <topic_300000004>`
|
||||
- :ref:`Monitoring Management <topic_300000005>`
|
||||
- :ref:`Tag Management <topic_300000006>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
stream_management/index
|
||||
app_management/index
|
||||
checkpoint_management/index
|
||||
data_management/index
|
||||
dump_task_management/index
|
||||
monitoring_management/index
|
||||
tag_management/index
|
||||
@ -0,0 +1,16 @@
|
||||
:original_name: topic_300000005.html
|
||||
|
||||
.. _topic_300000005:
|
||||
|
||||
Monitoring Management
|
||||
=====================
|
||||
|
||||
- :ref:`Querying Stream Monitoring Data <showstreammetrics>`
|
||||
- :ref:`Querying Partition Monitoring Data <showpartitionmetrics>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_stream_monitoring_data
|
||||
querying_partition_monitoring_data
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,99 @@
|
||||
:original_name: UpdatePartitionCount.html
|
||||
|
||||
.. _UpdatePartitionCount:
|
||||
|
||||
Changing Partition Quantity
|
||||
===========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to change the number of partitions in a specific stream.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
PUT /v2/{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. |
|
||||
| | | | |
|
||||
| | | | 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_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** |
|
||||
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Changing Partition Quantity
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
PUT https://{Endpoint}/v2/{project_id}/streams/{stream_name}
|
||||
|
||||
{
|
||||
"stream_name" : "newstream",
|
||||
"target_partition_count" : 5
|
||||
}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
200 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,74 @@
|
||||
:original_name: DeleteStream.html
|
||||
|
||||
.. _DeleteStream:
|
||||
|
||||
Deleting Specified Streams
|
||||
==========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete specified streams.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v2/{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 to be deleted. |
|
||||
| | | | |
|
||||
| | | | 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
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting Specified Streams
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v2/{project_id}/streams/{stream_name}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
204 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
28
api-ref/source/api_description/stream_management/index.rst
Normal file
28
api-ref/source/api_description/stream_management/index.rst
Normal file
@ -0,0 +1,28 @@
|
||||
:original_name: topic_300000000.html
|
||||
|
||||
.. _topic_300000000:
|
||||
|
||||
Stream Management
|
||||
=================
|
||||
|
||||
- :ref:`Creating Streams <dis_02_0016_01>`
|
||||
- :ref:`Querying Streams <dis_02_0024>`
|
||||
- :ref:`Deleting Specified Streams <deletestream>`
|
||||
- :ref:`Querying Stream Details <dis_02_0025>`
|
||||
- :ref:`Changing Partition Quantity <updatepartitioncount>`
|
||||
- :ref:`Updating Stream Information <updatestream>`
|
||||
- :ref:`Adding Permission Policies <createpolicies>`
|
||||
- :ref:`Querying Permission Policies <listpolicies>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_streams
|
||||
querying_streams
|
||||
deleting_specified_streams
|
||||
querying_stream_details
|
||||
changing_partition_quantity
|
||||
updating_stream_information
|
||||
adding_permission_policies
|
||||
querying_permission_policies
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,72 @@
|
||||
:original_name: DeleteTag.html
|
||||
|
||||
.. _DeleteTag:
|
||||
|
||||
Deleting Tags of Specified Streams
|
||||
==================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete tags of specified streams.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v2/{project_id}/stream/{stream_id}/tags/{key}
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID.
|
||||
stream_id Yes String Stream ID.
|
||||
key Yes String Tag key.
|
||||
========== ========= ====== ===========
|
||||
|
||||
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
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting Tags of Specified Streams
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v2/{project_id}/stream/{stream_id}/tags/{key}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ================
|
||||
Status Code Description
|
||||
=========== ================
|
||||
204 Normal response.
|
||||
=========== ================
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
||||
26
api-ref/source/api_description/tag_management/index.rst
Normal file
26
api-ref/source/api_description/tag_management/index.rst
Normal file
@ -0,0 +1,26 @@
|
||||
:original_name: topic_300000006.html
|
||||
|
||||
.. _topic_300000006:
|
||||
|
||||
Tag Management
|
||||
==============
|
||||
|
||||
- :ref:`Adding Tags for Specified Streams <createtag>`
|
||||
- :ref:`Querying Tags of Specified Streams <showstreamtags>`
|
||||
- :ref:`Deleting Tags of Specified Streams <deletetag>`
|
||||
- :ref:`Adding Resource Tags in Batches <batchcreatetags>`
|
||||
- :ref:`Querying Tags of Specified Regions <listtags>`
|
||||
- :ref:`Using Tags to Filter Resources (Streams) <listresourcesbytags>`
|
||||
- :ref:`Deleting Resource Tags in Batches <batchdeletetags>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
adding_tags_for_specified_streams
|
||||
querying_tags_of_specified_streams
|
||||
deleting_tags_of_specified_streams
|
||||
adding_resource_tags_in_batches
|
||||
querying_tags_of_specified_regions
|
||||
using_tags_to_filter_resources_streams
|
||||
deleting_resource_tags_in_batches
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user