Changes to dds_api-ref from docs/doc-exports#502 (dds api 2.0.38sp24 version
dd Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
parent
0879068072
commit
6e4208654a
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 110 KiB After Width: | Height: | Size: 110 KiB |
@ -22,7 +22,7 @@ If you use a token for authentication, you must obtain the user's token and add
|
||||
Procedure
|
||||
---------
|
||||
|
||||
#. Obtain the token by following instructions in section :ref:`Token Authentication <dds_api_0010>`.
|
||||
#. Obtain the token by following instructions in section :ref:`Authentication <dds_api_0010>`.
|
||||
|
||||
#. Send **POST https://DDS endpoint/v3/{project_id}/instances**.
|
||||
|
||||
@ -42,7 +42,7 @@ Procedure
|
||||
"name": "test-cluster", //DB instance name
|
||||
"datastore": {
|
||||
"type": "DDS-Community", // Database type and version
|
||||
"version": "3.4", //Database version
|
||||
"version": "4.0", //Database version
|
||||
"storage_engine": "wiredTiger" //Storage engine
|
||||
},
|
||||
"region": "aaa", //Region name
|
||||
@ -50,7 +50,7 @@ Procedure
|
||||
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", //VPC ID
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", //Subnet ID
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", //Security group ID
|
||||
"password": "Test@123", //Administrator password
|
||||
"password": "******", //Administrator password
|
||||
"disk_encryption_id": "d4825f1b-5e47-4ff7-8ca9-0960da1770b1", //Key ID for encrypting disks
|
||||
"mode": "Sharding", //Sharded-cluster instance type
|
||||
"flavor": [
|
||||
@ -75,7 +75,7 @@ Procedure
|
||||
}
|
||||
],
|
||||
"backup_strategy": {
|
||||
"start_time": "08:15-09:15", //Backup time window
|
||||
"start_time": "23:00-00:00", //Backup period
|
||||
"keep_days": "8" //Retention days of backup files
|
||||
},
|
||||
"ssl_option":"1"
|
||||
@ -90,7 +90,7 @@ Procedure
|
||||
"name": "test-cluster",
|
||||
"datastore": {
|
||||
"type": "DDS-Community",
|
||||
"version": "3.4",
|
||||
"version": "4.0",
|
||||
"storage_engine": "wiredTiger"
|
||||
},
|
||||
"created": "2019-01-14 08:50:27",
|
||||
@ -122,9 +122,10 @@ Procedure
|
||||
}
|
||||
],
|
||||
"backup_strategy": {
|
||||
"start_time": "08:15-09:15",
|
||||
"start_time": "23:00-00:00",
|
||||
"keep_days": "8"
|
||||
},
|
||||
"enterprise_project_id": "",
|
||||
"ssl_option":"1",
|
||||
"job_id": "c0c606b6-470a-48c7-97a2-6c7f146014d4"
|
||||
}
|
||||
|
||||
@ -87,7 +87,7 @@ You can also add additional fields to the request header, for example, the field
|
||||
|
||||
A request body is generally sent in a structured format (for example, JSON or XML), corresponding to **Content-Type** in the request header, and is used to transfer content other than the request header.
|
||||
|
||||
If the request body contains Chinese characters, convert the Chinese characters into the UTF-8 encoding format.
|
||||
If the request body contains full-width characters, convert the full-width characters into the UTF-8 encoding format.
|
||||
|
||||
Response Headers
|
||||
----------------
|
||||
|
||||
@ -8,7 +8,7 @@ Scenarios
|
||||
DDS open APIs allow users to create, view, or delete DB instances, query API versions, DB engines, DB engine versions, and DB instance class supported by the system. The application scenarios are shown as follows.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0208249507.png
|
||||
.. figure:: /_static/images/en-us_image_0000001336985362.png
|
||||
:alt: **Figure 1** Scenarios
|
||||
|
||||
**Figure 1** Scenarios
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,73 +0,0 @@
|
||||
:original_name: dds_api_0022.html
|
||||
|
||||
.. _dds_api_0022:
|
||||
|
||||
Deleting a DB Instance
|
||||
======================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a DB instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
DELETE /v3/{project_id}/instances/{instance_id}
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ========= =================================================
|
||||
Name Mandatory Description
|
||||
=========== ========= =================================================
|
||||
project_id Yes Specifies the project ID of a tenant in a region.
|
||||
instance_id Yes Specifies the DB instance ID.
|
||||
=========== ========= =================================================
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Request header
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://DDS endpoint/v3/{project_id}/instances/{instance_id}
|
||||
|
||||
- Request body
|
||||
|
||||
N/A
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
====== ====== ==========================
|
||||
Name Type Description
|
||||
====== ====== ==========================
|
||||
job_id String Indicates the workflow ID.
|
||||
====== ====== ==========================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id": "252f11f1-2912-4c06-be55-1999bde659c5"
|
||||
}
|
||||
|
||||
**Status Code**
|
||||
---------------
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
@ -1,18 +0,0 @@
|
||||
:original_name: dds_instance_mgmt.html
|
||||
|
||||
.. _dds_instance_mgmt:
|
||||
|
||||
DB Instance Management
|
||||
======================
|
||||
|
||||
- :ref:`Creating a DB Instance <dds_api_0020>`
|
||||
- :ref:`Deleting a DB Instance <dds_api_0022>`
|
||||
- :ref:`Querying DB Instances <dds_api_0023>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_db_instance
|
||||
deleting_a_db_instance
|
||||
querying_db_instances
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,20 +0,0 @@
|
||||
:original_name: dds_api_description.html
|
||||
|
||||
.. _dds_api_description:
|
||||
|
||||
API Description
|
||||
===============
|
||||
|
||||
- :ref:`Querying the API Version <dds_api_version>`
|
||||
- :ref:`Querying Database Version Information <dds_database_version>`
|
||||
- :ref:`Querying All DB Instance Specifications <dds_instance_specification>`
|
||||
- :ref:`DB Instance Management <dds_instance_mgmt>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_the_api_version/index
|
||||
querying_database_version_information
|
||||
querying_all_db_instance_specifications
|
||||
db_instance_management/index
|
||||
File diff suppressed because it is too large
Load Diff
@ -9,15 +9,27 @@ DDS provides extension APIs, allowing you to perform specific operations using A
|
||||
|
||||
.. table:: **Table 1** API description
|
||||
|
||||
+----------------------------------------+-------------------------------------------------------------------------------+
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Type | Description |
|
||||
+========================================+===============================================================================+
|
||||
| API Version Queries | - Query all API versions. |
|
||||
+=========================================+======================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
|
||||
| Querying the API Version | - Query all API versions. |
|
||||
| | - Query a specified API version. |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------+
|
||||
| Database Version Information Queries | Obtain database version information about a specified instance type. |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------+
|
||||
| All DB Instance Specifications Queries | Query all DB instance specifications in a specified region. |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------+
|
||||
| DB Instance Management | Manage DB instances, including creating, deleting, and querying DB instances. |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------+
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Querying Database Version Information | Obtain database version information about a specified instance type. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Querying All DB Instance Specifications | Query all DB instance specifications in a specified region. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Querying the Database Disk Type | Query the database disk type in the current region. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Managing DB Instances | Create, restart, delete, and query instances, scale up storage, add instance nodes, change instance specifications, switch over primary and standby nodes, enable or disable SSL, change instance names, change database ports, change security groups, and bind or unbind an EIP, change the private network address of an instance, enable the shard/config IP addresses, configure cross-CIDR access, query regions and AZs to which an instance can be migrated. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Managing Connections | Query instance node sessions, terminate instance node sessions, and query the number of instance node connections. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Backing up and Restoring an Instance | Create manual backups, delete manual backups, query backups, query the automated backup policy, set the automated backup policy, restore to a new DB instance, obtain the backup download link, query the restoration time range, obtain the list of databases that can be restored, obtain the list of database collections that can be restored, obtain the current DB instance, and restore a database or table to a specified point in time. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Obtaining Log Information | Query database slow logs, obtain the download link of slow logs, query database error logs, obtain the download link of error logs, set audit log policies, query audit log policies, obtain the audit logs, and obtain the download link of audit logs. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Managing Tags | Manage tags, including querying resources by tag, adding and deleting a tag or tags, and querying resource tags and project tags. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Managing Databases and Accounts | Create a database user, create a database role, query database users and roles, change the database user password, , query the cluster balancing settings, enable or disable cluster balancing, and set the activity time window of cluster balancing, delete database users, delete database roles, and check the database password. |
|
||||
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,69 @@
|
||||
:original_name: dds_api_0028.html
|
||||
|
||||
.. _dds_api_0028:
|
||||
|
||||
Deleting a Manual Backup
|
||||
========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a manual backup for a DB instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
========== ========= =================================================
|
||||
Name Mandatory Description
|
||||
========== ========= =================================================
|
||||
project_id Yes Specifies the project ID of a tenant in a region.
|
||||
backup_id Yes Specifies the backup file ID.
|
||||
========== ========= =================================================
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Example request
|
||||
|
||||
DELETE https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/backups/8d9586c40b33449a815518d4635a2cd9br02
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
====== ====== ======================
|
||||
Name Type Description
|
||||
====== ====== ======================
|
||||
job_id String Indicates the task ID.
|
||||
====== ====== ======================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id": "fcaab90b-960d-4441-b73d-a5b2532c5ec5"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
@ -0,0 +1,36 @@
|
||||
:original_name: dds_backup_restore.html
|
||||
|
||||
.. _dds_backup_restore:
|
||||
|
||||
Backup and Restoration
|
||||
======================
|
||||
|
||||
- :ref:`Creating a Manual Backup <dds_api_0027>`
|
||||
- :ref:`Deleting a Manual Backup <dds_api_0028>`
|
||||
- :ref:`Querying the Backup List <dds_api_0029>`
|
||||
- :ref:`Querying an Automated Backup Policy <dds_api_0030>`
|
||||
- :ref:`Setting an Automated Backup Policy <dds_api_0031>`
|
||||
- :ref:`Restoring Data to a New DB Instance <dds_api_0038>`
|
||||
- :ref:`Obtaining the Link for Downloading a Backup File <dds_api_0059>`
|
||||
- :ref:`Querying the Restoration Time Ranges <dds_api_0080>`
|
||||
- :ref:`Obtaining the List of Databases That Can Be Restored <dds_api_0081>`
|
||||
- :ref:`Obtaining the List of Database Collections That Can Be Restored <dds_api_0082>`
|
||||
- :ref:`Restoring Data to the Original DB Instance <dds_api_0083>`
|
||||
- :ref:`Restoring Databases and Tables to a Point in Time <dds_api_0084>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_manual_backup
|
||||
deleting_a_manual_backup
|
||||
querying_the_backup_list
|
||||
querying_an_automated_backup_policy
|
||||
setting_an_automated_backup_policy
|
||||
restoring_data_to_a_new_db_instance
|
||||
obtaining_the_link_for_downloading_a_backup_file
|
||||
querying_the_restoration_time_ranges
|
||||
obtaining_the_list_of_databases_that_can_be_restored
|
||||
obtaining_the_list_of_database_collections_that_can_be_restored
|
||||
restoring_data_to_the_original_db_instance
|
||||
restoring_databases_and_tables_to_a_point_in_time
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,94 @@
|
||||
:original_name: dds_api_0081.html
|
||||
|
||||
.. _dds_api_0081:
|
||||
|
||||
Obtaining the List of Databases That Can Be Restored
|
||||
====================================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to obtain the list of databases that can be restored.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
This API applies only to replica sets.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-database?restore_time={restore_time}&offset={offset}&limit={limit}
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=======================+=======================+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| restore_time | Yes | Specifies the restoration time point. |
|
||||
| | | |
|
||||
| | | The value is a UNIX timestamp, in milliseconds. The time zone is UTC. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| offset | No | Specifies the index position. |
|
||||
| | | |
|
||||
| | | - The value must be greater than or equal to **0**. |
|
||||
| | | - If this parameter is not transferred, the value is **0** by default. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| limit | No | Specifies the upper limit of the number of queried records. |
|
||||
| | | |
|
||||
| | | - The value ranges from 1 to 100. |
|
||||
| | | - If this parameter is not transferred, the first 100 records are queried by default. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Example request
|
||||
|
||||
GET https://dds.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-database?restore_time=1607689584000&limit=10&offset=1
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+-------------+-----------------+-----------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+=============+=================+=============================================================================+
|
||||
| databases | Array of String | Indicates the database list. Each element in the list indicates a database. |
|
||||
+-------------+-----------------+-----------------------------------------------------------------------------+
|
||||
| total_count | Integer | Indicates the total number of databases. |
|
||||
+-------------+-----------------+-----------------------------------------------------------------------------+
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"databases": [
|
||||
"test_db"
|
||||
],
|
||||
"total_count": 1
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
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,18 @@
|
||||
:original_name: dds_connect_0001.html
|
||||
|
||||
.. _dds_connect_0001:
|
||||
|
||||
Connection Management
|
||||
=====================
|
||||
|
||||
- :ref:`Querying Sessions of an Instance Node <dds_connect_0002>`
|
||||
- :ref:`Killing Sessions of an Instance Node <dds_connect_0003>`
|
||||
- :ref:`Querying the Number of Connections to an Instance Node <dds_connect_0004>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_sessions_of_an_instance_node
|
||||
killing_sessions_of_an_instance_node
|
||||
querying_the_number_of_connections_to_an_instance_node
|
||||
@ -0,0 +1,86 @@
|
||||
:original_name: dds_connect_0003.html
|
||||
|
||||
.. _dds_connect_0003:
|
||||
|
||||
Killing Sessions of an Instance Node
|
||||
====================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to kill sessions of an instance node.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
- Community Edition 3.4 and 4.0 instances are supported.
|
||||
- Inactive sessions cannot be terminated.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Path parameters
|
||||
|
||||
+------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+=====================================================================================================================================================+
|
||||
| project_id | Yes | String | Specifies the project ID of a tenant in a region. |
|
||||
+------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| node_id | Yes | String | Specifies the node ID. The following nodes can be queried: mongos nodes in the cluster, and all nodes in the replica set and single node instances. |
|
||||
+------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Request body parameters
|
||||
|
||||
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+==================+===================================================================================================+
|
||||
| sessions | Yes | Array of strings | Specifies the IDs of sessions to be terminated. |
|
||||
| | | | |
|
||||
| | | | For details, see the session ID returned in :ref:`Table 4 <dds_connect_0002__table599818593239>`. |
|
||||
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Request example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
|
||||
{
|
||||
"sessions" : [ "34631", "34703" ]
|
||||
}
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
|
||||
{
|
||||
"sessions" : [ "34631", "34703" ]
|
||||
}
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
{}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
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,94 @@
|
||||
:original_name: dds_api_0054.html
|
||||
|
||||
.. _dds_api_0054:
|
||||
|
||||
Changing a Database Port
|
||||
========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to change a database port.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
- This operation cannot be performed on frozen or abnormal instances.
|
||||
- The DB instance must be restarted to make port number modifications take effect. Exercise caution when modifying the database port.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-port
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=============+===========+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+------+-----------+---------+------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+======+===========+=========+==========================================================================================+
|
||||
| port | Yes | Integer | Specifies the port number. The port is in range 2100 to 9500, or 27017, 27018, or 27019. |
|
||||
+------+-----------+---------+------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example request
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-port
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"port": 8888
|
||||
}
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 3** Parameter description
|
||||
|
||||
====== ======= ==========================
|
||||
Name Type Description
|
||||
====== ======= ==========================
|
||||
job_id String Indicates the workflow ID.
|
||||
port Integer Indicates the port number.
|
||||
====== ======= ==========================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
||||
"port":"8888"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,94 @@
|
||||
:original_name: dds_api_0055.html
|
||||
|
||||
.. _dds_api_0055:
|
||||
|
||||
Changing a Security Group
|
||||
=========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to change the security group associated with a DB instance.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
- Abnormal instances do not support this operation.
|
||||
- Please confirm the modified security group policy. This policy may affect the current instance connection, causing the connection interruption.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-security-group
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=============+===========+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+-------------------+-----------+--------+---------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+===================+===========+========+=============================================+
|
||||
| security_group_id | Yes | String | Specifies the ID of the new security group. |
|
||||
+-------------------+-----------+--------+---------------------------------------------+
|
||||
|
||||
- Example request
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-security-group
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"security_group_id": "73bed21a-708b-4985-b697-a96d0e0d2b39"
|
||||
}
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 3** Parameter description
|
||||
|
||||
================= ====== ===========================================
|
||||
Name Type Description
|
||||
================= ====== ===========================================
|
||||
job_id String Indicates the workflow ID.
|
||||
security_group_id String Indicates the ID of the new security group.
|
||||
================= ====== ===========================================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
||||
"security_group_id":"73bed21a-708b-4985-b697-a96d0e0d2b39"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,70 @@
|
||||
:original_name: dds_api_0022.html
|
||||
|
||||
.. _dds_api_0022:
|
||||
|
||||
Deleting a DB Instance
|
||||
======================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a DB instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=============+===========+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Example request
|
||||
|
||||
DELETE https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
====== ====== ==========================
|
||||
Name Type Description
|
||||
====== ====== ==========================
|
||||
job_id String Indicates the workflow ID.
|
||||
====== ====== ==========================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id": "252f11f1-2912-4c06-be55-1999bde659c5"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:202.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,44 @@
|
||||
:original_name: dds_instance_mgmt.html
|
||||
|
||||
.. _dds_instance_mgmt:
|
||||
|
||||
DB Instance Management
|
||||
======================
|
||||
|
||||
- :ref:`Creating a DB Instance <dds_api_0020>`
|
||||
- :ref:`Restarting a DB Instance <dds_api_0021>`
|
||||
- :ref:`Deleting a DB Instance <dds_api_0022>`
|
||||
- :ref:`Querying Instances and Details <dds_api_0023>`
|
||||
- :ref:`Scaling Up Storage Space <dds_api_0024>`
|
||||
- :ref:`Adding Nodes for a Cluster Instance <dds_api_0025>`
|
||||
- :ref:`Modifying DB Instance Specifications <dds_api_0026>`
|
||||
- :ref:`Performing a Primary/Secondary Switchover in a Replica Set Instance <dds_api_0050>`
|
||||
- :ref:`Enabling or Disabling SSL <dds_api_0051>`
|
||||
- :ref:`Modifying a DB Instance Name <dds_api_0053>`
|
||||
- :ref:`Changing a Database Port <dds_api_0054>`
|
||||
- :ref:`Changing a Security Group <dds_api_0055>`
|
||||
- :ref:`Binding an EIP <dds_api_0056>`
|
||||
- :ref:`Unbinding an EIP <dds_api_0057>`
|
||||
- :ref:`Changing a Private IP Address <dds_api_0058>`
|
||||
- :ref:`Enabling Shard or Config IP Addresses <dds_api_0120>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_db_instance
|
||||
restarting_a_db_instance
|
||||
deleting_a_db_instance
|
||||
querying_instances_and_details
|
||||
scaling_up_storage_space
|
||||
adding_nodes_for_a_cluster_instance
|
||||
modifying_db_instance_specifications
|
||||
performing_a_primary_secondary_switchover_in_a_replica_set_instance
|
||||
enabling_or_disabling_ssl
|
||||
modifying_a_db_instance_name
|
||||
changing_a_database_port
|
||||
changing_a_security_group
|
||||
binding_an_eip
|
||||
unbinding_an_eip
|
||||
changing_a_private_ip_address
|
||||
enabling_shard_or_config_ip_addresses
|
||||
@ -0,0 +1,81 @@
|
||||
:original_name: dds_api_0053.html
|
||||
|
||||
.. _dds_api_0053:
|
||||
|
||||
Modifying a DB Instance Name
|
||||
============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to modify a DB instance name.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
The name of the DB instance that is being created or fails to be created cannot be modified.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=============+===========+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+===================+=================+=================+========================================================================================================================================================================================================================+
|
||||
| new_instance_name | Yes | String | Specifies the DB instance name. The instance name can be the same as an existing instance name. |
|
||||
| | | | |
|
||||
| | | | - The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters. |
|
||||
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example request
|
||||
|
||||
PUT https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"new_instance_name": "myNewName"
|
||||
}
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,76 @@
|
||||
:original_name: dds_api_0050.html
|
||||
|
||||
.. _dds_api_0050:
|
||||
|
||||
Performing a Primary/Secondary Switchover in a Replica Set Instance
|
||||
===================================================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to perform a primary/secondary switchover in a replica set instance.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
- This API supports only DDS replica sets.
|
||||
- This operation cannot be performed on frozen or abnormal instances.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switchover
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=============+===========+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Example request
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
====== ====== ======================
|
||||
Name Type Description
|
||||
====== ====== ======================
|
||||
job_id String Indicates the task ID.
|
||||
====== ====== ======================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:202.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
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,80 @@
|
||||
:original_name: dds_api_0057.html
|
||||
|
||||
.. _dds_api_0057:
|
||||
|
||||
Unbinding an EIP
|
||||
================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to unbind an EIP from a node in a DB instance.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
- Frozen instances do not support this operation.
|
||||
- This operation can be performed only on a node with an EIP assigned.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/unbind-eip
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+------------+-----------+-------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+============+===========+===================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+------------+-----------+-------------------------------------------------------------------+
|
||||
| node_id | Yes | Specifies the ID of the node from which the EIP is to be unbound. |
|
||||
+------------+-----------+-------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Example request
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/unbind-eip
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
========= ====== ==========================
|
||||
Name Type Description
|
||||
========= ====== ==========================
|
||||
job_id String Indicates the workflow ID.
|
||||
node_name String Indicates the node name.
|
||||
node_id String Indicates the node ID.
|
||||
========= ====== ==========================
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
||||
"node_id": "52a4c096bb1f455d8d866956a959519eno02",
|
||||
"node_name": "mongodb-8977_mongos_node_1"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
32
api-ref/source/apis_v3.0_recommended/index.rst
Normal file
32
api-ref/source/apis_v3.0_recommended/index.rst
Normal file
@ -0,0 +1,32 @@
|
||||
:original_name: dds_api_description.html
|
||||
|
||||
.. _dds_api_description:
|
||||
|
||||
APIs V3.0 (Recommended)
|
||||
=======================
|
||||
|
||||
- :ref:`Querying the API Version <dds_api_version>`
|
||||
- :ref:`Querying Database Version Information <dds_database_version>`
|
||||
- :ref:`Querying Database Specifications <dds_instance_specification>`
|
||||
- :ref:`Querying the Database Disk Type <dds_api_0039>`
|
||||
- :ref:`DB Instance Management <dds_instance_mgmt>`
|
||||
- :ref:`Connection Management <dds_connect_0001>`
|
||||
- :ref:`Backup and Restoration <dds_backup_restore>`
|
||||
- :ref:`Log Information Queries <dds_api_0092>`
|
||||
- :ref:`Tag Management <dds_tag_mgmt>`
|
||||
- :ref:`Task Management <dds_api_0117>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_the_api_version/index
|
||||
querying_database_version_information
|
||||
querying_database_specifications
|
||||
querying_the_database_disk_type
|
||||
db_instance_management/index
|
||||
connection_management/index
|
||||
backup_and_restoration/index
|
||||
log_information_queries/index
|
||||
tag_management/index
|
||||
task_management/index
|
||||
@ -0,0 +1,28 @@
|
||||
:original_name: dds_api_0092.html
|
||||
|
||||
.. _dds_api_0092:
|
||||
|
||||
Log Information Queries
|
||||
=======================
|
||||
|
||||
- :ref:`Querying Database Slow Logs <dds_api_0093>`
|
||||
- :ref:`Obtaining Links for Downloading Slow Query Logs <dds_api_0094>`
|
||||
- :ref:`Querying Database Error Logs <dds_api_0095>`
|
||||
- :ref:`Obtaining Links for Downloading Error Logs <dds_api_0096>`
|
||||
- :ref:`Setting SQL Audit <dds_api_0097>`
|
||||
- :ref:`Querying SQL Audit Policy <dds_api_0098>`
|
||||
- :ref:`Obtaining the Audit Log List <dds_api_0099>`
|
||||
- :ref:`Obtaining Links for Downloading Audit Logs <dds_api_0100>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_database_slow_logs
|
||||
obtaining_links_for_downloading_slow_query_logs
|
||||
querying_database_error_logs
|
||||
obtaining_links_for_downloading_error_logs
|
||||
setting_sql_audit
|
||||
querying_sql_audit_policy
|
||||
obtaining_the_audit_log_list
|
||||
obtaining_links_for_downloading_audit_logs
|
||||
@ -0,0 +1,86 @@
|
||||
:original_name: dds_api_0100.html
|
||||
|
||||
.. _dds_api_0100:
|
||||
|
||||
Obtaining Links for Downloading Audit Logs
|
||||
==========================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to obtain the link for downloading audit logs.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-links
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Description |
|
||||
+=============+===========+=================================================================================================================================================================================+
|
||||
| project_id | Yes | Specifies the project ID of a tenant in a region. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
|
||||
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+------+-----------+------------------+------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+======+===========+==================+==========================================================================================+
|
||||
| ids | Yes | Array of strings | Specifies the list of audit logs. A maximum of 50 audit log IDs are allowed in the list. |
|
||||
+------+-----------+------------------+------------------------------------------------------------------------------------------+
|
||||
|
||||
- Request example
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/2870a411522849aa901cd4351c96a3b7in02/auditlog-links
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"ids": ["10190012aae94b38a10269b8ad025fc1no02_1607681849871", "12390012aae94b38a10269b8ad025fc1no02_1607681849871"]
|
||||
}
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 3** Parameter description
|
||||
|
||||
+-------+------------------+-----------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+=======+==================+===================================================================================+
|
||||
| links | Array of strings | Indicates the list of audit log download links. The validity period is 5 minutes. |
|
||||
+-------+------------------+-----------------------------------------------------------------------------------+
|
||||
|
||||
- Response example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"links": ["https://obs.domainname.com/ddsbucket.username.1/xxxxxx", "https://obs.domainname.com/ddsbucket.username.2/xxxxxx"]
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
Status Code:200.
|
||||
|
||||
For more information, see :ref:`Status Code <dds_status_code>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
For more information, see :ref:`Error Code <dds_error_code>`.
|
||||
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