Compare commits

..

2 Commits

Author SHA1 Message Date
4de5ce0fb1 Update content 2023-09-08 06:45:57 +00:00
2aaa6b3716 Update content 2023-09-05 07:49:28 +00:00
22 changed files with 93 additions and 411 deletions

View File

@ -128,15 +128,15 @@ Responses
.. table:: **Table 4** datastore field data structure description
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+============================================================================================================================+
| type | String | Indicates the DB engine. |
| | | |
| | | Valid value: **DDS-Community**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
| version | String | Indicates the database of version 3.2, 3.4, 4.0, 4.2, or 4.4. The value is **3.2**, **3.4**, **4.0**, **4.2**, or **4.4**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+==============================================================================================================+
| type | String | Indicates the DB engine. |
| | | |
| | | Valid value: **DDS-Community**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
| version | String | Indicates the database of version 3.2, 3.4, 4.0, or 4.2. The value is **3.2**, **3.4**, **4.0**, or **4.2**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
- Response example

View File

@ -71,7 +71,7 @@ Requests
| | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| | | | |
| | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -368,18 +368,18 @@ Responses
.. table:: **Table 7** datastore field data structure description
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | |
| | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0038__table119482048538:
@ -479,7 +479,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Sharding",
"flavor": [
{
@ -528,7 +528,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "ReplicaSet",
"flavor": [
{
@ -566,7 +566,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Single",
"flavor": [
{

View File

@ -13,7 +13,7 @@ This API is used to kill sessions of an instance node.
Constraints
-----------
- Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
- Community Edition 3.4, 4.0 and 4.2 instances are supported.
- Inactive sessions cannot be terminated.
URI

View File

@ -13,7 +13,7 @@ This API is used to query sessions of instance nodes.
Constraints
-----------
Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
Community Edition 3.4, 4.0 and 4.2 instances are supported.
URI
---

View File

@ -78,7 +78,7 @@ Requests
| | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| | | | |
| | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -120,18 +120,18 @@ Requests
.. table:: **Table 3** datastore field data structure description
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | |
| | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table94791241013:
@ -453,18 +453,18 @@ Responses
.. table:: **Table 8** datastore field data structure description
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | |
| | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table119482048538:
@ -583,7 +583,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Sharding",
"flavor": [
{
@ -637,7 +637,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "ReplicaSet",
"flavor": [
{
@ -680,7 +680,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Single",
"flavor": [
{

View File

@ -16,7 +16,7 @@ Constraints
- Frozen instances do not support this operation.
- DB instances associated with the IPv6 subnet do not support this operation.
- If the IP address is enabled, restart the nodes for the setting to take effect.
- Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported.
- Cluster instances of Community Edition 3.4, 4.0 and 4.2 are supported.
- This function cannot be disabled after being enabled.
URI

View File

@ -102,17 +102,17 @@ Responses
.. table:: **Table 5** RecycleDatastore
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+======================================================================================================================+
| type | String | Database type. The value is **DDS-Community**. |
| | | |
| | | Enumerated values: |
| | | |
| | | - DDS-Community |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| version | String | Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be **3.4, 4.0,** **4.2,** or **4.4**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+========================================================================================================+
| type | String | Database type. The value is **DDS-Community**. |
| | | |
| | | Enumerated values: |
| | | |
| | | - DDS-Community |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| version | String | Database version. Versions 3.4, 4.0, and 4.2 are supported. The value can be **3.4, 4.0,** or **4.2**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
- Response Example

View File

@ -168,7 +168,7 @@ Responses
| | | |
| | | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | String | The disk encryption key ID. This parameter is returned only when the instance disk is encrypted. |
| disk_encryption_id | String | Indicates the disk encryption key ID. This parameter is returned only when the instance disk is encrypted. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | Indicates the enterprise project ID. |
| | | |

View File

@ -14,7 +14,6 @@ APIs V3.0 (Recommended)
- :ref:`Backup and Restoration <dds_backup_restore>`
- :ref:`Log Information Queries <dds_api_0092>`
- :ref:`Tag Management <dds_tag_mgmt>`
- :ref:`Managing Databases and Users <dds_api_0070>`
- :ref:`Task Management <dds_api_0117>`
.. toctree::
@ -30,5 +29,4 @@ APIs V3.0 (Recommended)
backup_and_restoration/index
log_information_queries/index
tag_management/index
managing_databases_and_users/index
task_management/index

View File

@ -1,87 +0,0 @@
:original_name: dds_api_0075.html
.. _dds_api_0075:
Changing the Password of a Database User
========================================
Function
--------
This API is used to change the password of a database user
Constraints
-----------
This operation cannot be performed on frozen or abnormal instances.
URI
---
- URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reset-password
- 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 |
+=================+=================+=================+=========================================================================================================================================================================================+
| user_name | No | String | Specifies the database username. The default value is **"rwuser"**. |
| | | | |
| | | | The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.). |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user_pwd | Yes | String | Specifies the database password. |
| | | | |
| | | | - The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ``~!@#%^*-_=+?`` |
| | | | - Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| db_name | No | String | Specifies the database name. The default value is **"admin"**. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Request example
.. code-block:: text
{
"user_name": "rwuser",
"user_pwd": "******"
}
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>`.

View File

@ -1,14 +0,0 @@
:original_name: dds_api_0070.html
.. _dds_api_0070:
Managing Databases and Users
============================
- :ref:`Changing the Password of a Database User <dds_api_0075>`
.. toctree::
:maxdepth: 1
:hidden:
changing_the_password_of_a_database_user

View File

@ -107,7 +107,7 @@ Responses
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| engine_versions | Array of strings | Database versions |
| | | |
| | | For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2", "4.4"} |
| | | For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2"} |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note::

View File

@ -43,11 +43,11 @@ Responses
.. table:: **Table 2** Parameter description
+----------+------------------+------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+==========+==================+================================================================================================+
| versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, 4.2, and 4.4 are supported. |
+----------+------------------+------------------------------------------------------------------------------------------------+
+----------+------------------+-------------------------------------------------------------------------------------------+
| Name | Type | Description |
+==========+==================+===========================================================================================+
| versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, and 4.2 are supported. |
+----------+------------------+-------------------------------------------------------------------------------------------+
- Response example
@ -58,8 +58,7 @@ Responses
"3.2",
"3.4",
"4.0",
"4.2",
"4.4"
"4.2"
]
}

File diff suppressed because it is too large Load Diff

View File

@ -1,2 +0,0 @@
[html writers]
table-style: table, caption-top

View File

@ -1,4 +0,0 @@
=========================================
Document Database Service - Best Practice
=========================================

View File

@ -1,11 +1,7 @@
sphinx>=2.0.0,!=2.1.0 # BSD
otcdocstheme # Apache-2.0
# releasenotes
reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0
sphinx-minify>=0.0.1 # Apache-2.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
setuptools

View File

@ -31,17 +31,6 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = ''
otcdocs_doc_link = ''
otcdocs_doc_title = ''
otcdocs_doc_type = ''
otcdocs_service_category = 'database'
otcdocs_service_title = 'Document Database Service'
otcdocs_service_type = 'dds'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

View File

@ -8,7 +8,6 @@ Document Database Service (DDS) is a cloud computing-based NoSQL database featur
.. service_card::
:service_type: dds
:environment: internal
:umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS.
:api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values.
:best-practice: To use Document Database Service more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.

99
tox.ini

File diff suppressed because it is too large Load Diff

View File

@ -4,9 +4,5 @@
default-branch: main
templates:
- helpcenter-base-jobs
check:
jobs:
- noop
gate:
jobs:
- noop
- api-ref-hc-int-jobs
- umn-hc-int-jobs