forked from docs/data-ingestion-service
Compare commits
4 Commits
main
...
propose-di
| Author | SHA1 | Date | |
|---|---|---|---|
| 7514c10107 | |||
| a4d6cc9f6b | |||
| dfaf57a24a | |||
| cc3e3e2aa1 |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 41 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 110 KiB |
@ -1,88 +0,0 @@
|
||||
: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 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 | Name of the consumer application to be created |
|
||||
| | | | |
|
||||
| | | | The application name contains 1 to 200 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
|
||||
| | | | |
|
||||
| | | | Minimum: **1** |
|
||||
| | | | |
|
||||
| | | | Maximum: **200** |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
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>`.
|
||||
@ -1,71 +0,0 @@
|
||||
: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 used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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>`.
|
||||
@ -1,22 +0,0 @@
|
||||
: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
@ -1,96 +0,0 @@
|
||||
: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 used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
**Status code: 200**
|
||||
|
||||
.. 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>`.
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,96 +0,0 @@
|
||||
: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, 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 used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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>`.
|
||||
@ -1,18 +0,0 @@
|
||||
: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
@ -1,18 +0,0 @@
|
||||
: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
@ -1,72 +0,0 @@
|
||||
: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 used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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>`.
|
||||
@ -1,24 +0,0 @@
|
||||
:original_name: topic_300000004.html
|
||||
|
||||
.. _topic_300000004:
|
||||
|
||||
Dump Task Management
|
||||
====================
|
||||
|
||||
- :ref:`Adding OBS Dump Tasks <dis_02_0410>`
|
||||
- :ref:`Querying Dump Task <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>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
adding_obs_dump_tasks
|
||||
querying_dump_task
|
||||
deleting_dump_tasks
|
||||
querying_dump_task_details
|
||||
starting_dump_tasks_in_batches
|
||||
pausing_dump_tasks_in_batches
|
||||
@ -1,95 +0,0 @@
|
||||
: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. The value can only be **stop**, which indicates stopping a dump task. |
|
||||
| | | | |
|
||||
| | | | 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
@ -1,95 +0,0 @@
|
||||
: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. The value can only be **start**, which indicates starting a dump task. |
|
||||
| | | | |
|
||||
| | | | 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>`.
|
||||
@ -1,26 +0,0 @@
|
||||
: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
|
||||
@ -1,16 +0,0 @@
|
||||
: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
File diff suppressed because it is too large
Load Diff
@ -1,74 +0,0 @@
|
||||
: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 used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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>`.
|
||||
@ -1,22 +0,0 @@
|
||||
: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>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_streams
|
||||
querying_streams
|
||||
deleting_specified_streams
|
||||
querying_stream_details
|
||||
changing_partition_quantity
|
||||
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
@ -1,72 +0,0 @@
|
||||
: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 used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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>`.
|
||||
@ -1,26 +0,0 @@
|
||||
: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
@ -1,8 +0,0 @@
|
||||
:original_name: dis_02_0200.html
|
||||
|
||||
.. _dis_02_0200:
|
||||
|
||||
API Overview
|
||||
============
|
||||
|
||||
DIS provides self-developed APIs that comply with RESTful API design specifications. You can use DIS functions listed in :ref:`API Description <dis_02_0015>` by calling these APIs.
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,18 +0,0 @@
|
||||
:original_name: dis_02_0500.html
|
||||
|
||||
.. _dis_02_0500:
|
||||
|
||||
Appendix
|
||||
========
|
||||
|
||||
- :ref:`Error Codes <errorcode>`
|
||||
- :ref:`Status Codes <dis_02_0022>`
|
||||
- :ref:`Obtaining a Project ID <dis_02_0501>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
error_codes
|
||||
status_codes
|
||||
obtaining_a_project_id
|
||||
@ -1,58 +0,0 @@
|
||||
:original_name: dis_02_0501.html
|
||||
|
||||
.. _dis_02_0501:
|
||||
|
||||
Obtaining a Project ID
|
||||
======================
|
||||
|
||||
Obtaining a Project ID by Calling an API
|
||||
----------------------------------------
|
||||
|
||||
You can obtain the project ID by calling the API `used to query project information <https://docs.otc.t-systems.com/api/iam/en-us_topic_0057845625.html>`__.
|
||||
|
||||
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 <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. For details about API authentication, see :ref:`Authentication <dis_02_0517>`.
|
||||
|
||||
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).
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"projects": [
|
||||
{
|
||||
"domain_id": "65382450e8f64ac0870cd180d14e684b",
|
||||
"is_domain": false,
|
||||
"parent_id": "65382450e8f64ac0870cd180d14e684b",
|
||||
"name": "region_name",
|
||||
"description": "",
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
|
||||
},
|
||||
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects"
|
||||
}
|
||||
}
|
||||
|
||||
Obtaining a Project ID from the Console
|
||||
---------------------------------------
|
||||
|
||||
A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:
|
||||
|
||||
#. Log in to the management console.
|
||||
|
||||
#. Click the username and select **My Credentials** from the drop-down list.
|
||||
|
||||
On the **My Credentials** page, view project IDs in the project list.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0191919629.jpg
|
||||
:alt: **Figure 1** Viewing project IDs
|
||||
|
||||
**Figure 1** Viewing project IDs
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,8 +0,0 @@
|
||||
:original_name: dis_02_0512.html
|
||||
|
||||
.. _dis_02_0512:
|
||||
|
||||
API Calling
|
||||
===========
|
||||
|
||||
DIS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs <dis_02_0516>`.
|
||||
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