dadrobna/gaussdb-mysql
1
0
Fork 0
forked from docs/gaussdb-mysql
Code Pull Requests Activity

Compare commits

merge into: dadrobna:propose-gaussdb_mysql_api-ref-815
Branches Tags
dadrobna:main
dadrobna:propose-gaussdb_mysql_api-ref-1162
dadrobna:propose-gaussdb_mysql_umn-1161
dadrobna:propose-gaussdb_mysql_umn-1090
dadrobna:propose-gaussdb_mysql_api-ref-1089
dadrobna:propose-gaussdb_mysql_api-ref-1067
dadrobna:zuul-tox-update
dadrobna:update_config_pdf
dadrobna:propose-gaussdb_mysql_umn-963
dadrobna:minify_sphinx_gitea
dadrobna:minify_sphinx_internal
dadrobna:propose-gaussdb_mysql_umn-943
dadrobna:propose-gaussdb_mysql_api-ref-942
dadrobna:propose-gaussdb_mysql_api-ref-928
dadrobna:propose-gaussdb_mysql_api-ref-926
dadrobna:propose-gaussdb_mysql_umn-834
dadrobna:propose-gaussdb_mysql_api-ref-834
dadrobna:propose-gaussdb_mysql_umn-833
dadrobna:propose-gaussdb_mysql_api-ref-833
dadrobna:constraints
dadrobna:propose-gaussdb_mysql_api-ref-815
dadrobna:propose-gaussdb_mysql_api-ref-546
dadrobna:propose-gaussdb_mysql_umn-769
dadrobna:propose-gaussdb_mysql_umn-773
dadrobna:propose-gaussdb_mysql_api-ref-773
dadrobna:propose-gaussdb_mysql_api-ref-769
dadrobna:service_based_view
dadrobna:propose-gaussdb_mysql_umn-569
dadrobna:propose-gaussdb_mysql_api-ref-569
dadrobna:tox4-cleanup
dadrobna:tox4
dadrobna:propose-gaussdb_mysql_umn-497
dadrobna:propose-gaussdb_mysql_api-ref-497
dadrobna:propose-gaussdb_mysql_umn-270
dadrobna:propose-gaussdb_mysql_api-ref-271
dadrobna:x4
dadrobna:x2
dadrobna:propose-gaussdb_mysql_umn-412
dadrobna:propose-gaussdb_mysql_api-ref-412
dadrobna:confpy-2
dadrobna:propose-gaussdb_mysql_umn-371
dadrobna:propose-gaussdb_mysql_api-ref-371
dadrobna:zuul
dadrobna:propose-gaussdb_mysql_api-ref-199
...
pull from: dadrobna:main
Branches Tags
dadrobna:propose-gaussdb_mysql_api-ref-1162
dadrobna:main
dadrobna:propose-gaussdb_mysql_umn-1161
dadrobna:propose-gaussdb_mysql_umn-1090
dadrobna:propose-gaussdb_mysql_api-ref-1089
dadrobna:propose-gaussdb_mysql_api-ref-1067
dadrobna:zuul-tox-update
dadrobna:update_config_pdf
dadrobna:propose-gaussdb_mysql_umn-963
dadrobna:minify_sphinx_gitea
dadrobna:minify_sphinx_internal
dadrobna:propose-gaussdb_mysql_umn-943
dadrobna:propose-gaussdb_mysql_api-ref-942
dadrobna:propose-gaussdb_mysql_api-ref-928
dadrobna:propose-gaussdb_mysql_api-ref-926
dadrobna:propose-gaussdb_mysql_umn-834
dadrobna:propose-gaussdb_mysql_api-ref-834
dadrobna:propose-gaussdb_mysql_umn-833
dadrobna:propose-gaussdb_mysql_api-ref-833
dadrobna:constraints
dadrobna:propose-gaussdb_mysql_api-ref-815
dadrobna:propose-gaussdb_mysql_api-ref-546
dadrobna:propose-gaussdb_mysql_umn-769
dadrobna:propose-gaussdb_mysql_umn-773
dadrobna:propose-gaussdb_mysql_api-ref-773
dadrobna:propose-gaussdb_mysql_api-ref-769
dadrobna:service_based_view
dadrobna:propose-gaussdb_mysql_umn-569
dadrobna:propose-gaussdb_mysql_api-ref-569
dadrobna:tox4-cleanup
dadrobna:tox4
dadrobna:propose-gaussdb_mysql_umn-497
dadrobna:propose-gaussdb_mysql_api-ref-497
dadrobna:propose-gaussdb_mysql_umn-270
dadrobna:propose-gaussdb_mysql_api-ref-271
dadrobna:x4
dadrobna:x2
dadrobna:propose-gaussdb_mysql_umn-412
dadrobna:propose-gaussdb_mysql_api-ref-412
dadrobna:confpy-2
dadrobna:propose-gaussdb_mysql_umn-371
dadrobna:propose-gaussdb_mysql_api-ref-371
dadrobna:zuul
dadrobna:propose-gaussdb_mysql_api-ref-199

14 Commits
propose-ga ... main

Author SHA1 Message Date
proposalbot
64583fb92e Changes to gaussdb_mysql_umn from docs/doc-exports#1161 (gaussdbmysql_umn_202404 
Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-05-13 09:16:04 +00:00
proposalbot
44fbd5b9e4 Changes to gaussdb_mysql_umn from docs/doc-exports#1090 (gaussdbmysql_umn 
Modif

Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-03-06 11:06:21 +00:00
proposalbot
fee5a51d20 Changes to gaussdb_mysql_api-ref from docs/doc-exports#1089 (gaussdbmysql_api 
A

Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-03-06 09:44:35 +00:00
proposalbot
d68598b383 Changes to gaussdb_mysql_api-ref from docs/doc-exports#1067 (Update Pictures. 
U

Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-02-22 09:20:49 +00:00
tischrei
7813a5cde0 Update tox.ini && conf.py file 
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
 2024-01-17 14:32:52 +00:00
Gode, Sebastian
a0032cce8c Update tox.ini && conf.py file 
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
 2024-01-17 11:19:33 +00:00
proposalbot
059006b93e Changes to gaussdb_mysql_umn from docs/doc-exports#963 (gaussdb 
Modified the fo

Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-11-27 14:22:44 +00:00
Gode, Sebastian
99e6eec515 Update tox.ini && conf.py file 
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
 2023-11-14 13:39:15 +00:00
proposalbot
1dd141d7b4 Changes to gaussdb_mysql_api-ref from docs/doc-exports#942 (Modified the respons 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-11-07 10:27:36 +00:00
proposalbot
2419e4279d Changes to gaussdb_mysql_umn from docs/doc-exports#943 (Added specifications (2 
Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-11-07 10:23:57 +00:00
proposalbot
632e92a69a Changes to gaussdb_mysql_api-ref from docs/doc-exports#926 (Added the total_coun 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-10-23 12:34:12 +00:00
Hasko, Vladimir
fdd2844b19 fix sphinx problems with constraints 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-08-10 15:23:30 +00:00
proposalbot
228d6e6791 Changes to gaussdb_mysql_umn from docs/doc-exports#545 (gaussdb UMN 20221230 ver 
Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-07-19 12:30:39 +00:00
proposalbot
f209269d91 Changes to gaussdb_mysql_api-ref from docs/doc-exports#815 (gaussdbmysql_api 
ga

Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-07-19 07:07:02 +00:00
156 changed files with 1451 additions and 1110 deletions
Show Stats Expand all files Collapse all files

BIN
api-ref/source/_static/images/en-us_image_0000001476990897.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 136 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001477110589.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 51 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001828921437.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 120 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001828922089.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 350 KiB

48
api-ref/source/api_overview.rst
View File

@ -7,28 +7,26 @@ API Overview
With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas. With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Type | Description | | Type | Description |
+===================================+====================================================================================================================================================================================================================+ +===============================+====================================================================================================================================================================================================================+
| DB engine version query | Query the DB version information of a specified DB engine. | | DB engine version query | Query the DB version information of a specified DB engine. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB specifications query | Query the DB specifications of a specified DB engine version. | | DB specifications query | Query the DB specifications of a specified DB engine version. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB instance management | Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications. | | DB instance management | Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Backup management | Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies. | | Backup management | Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter template management | Query parameter templates. | | Parameter template management | Query parameter templates. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Quota management | Query, set, and modify resource quotas. | | Quota management | Query, set, and modify resource quotas. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database proxy | Query database proxy information and specifications, and enable or disable database proxy. | | Database proxy | Query database proxy information and specifications, and enable or disable database proxy. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Log management | Obtain log information, including database error logs and slow logs. | | Log management | Obtain log information, including database error logs and slow logs. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Tag management | Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags. | | Tag management | Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| SQL statement concurrency control | Query, configure and delete concurrency control rules of SQL statements. | | Task center | Obtain task information about the task center. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Task center | Obtain task information about the task center. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

107
api-ref/source/apis_recommended/backup_management/deleting_a_manual_backup.rst Normal file
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis_recommended/backup_management/index.rst
View File

@ -9,6 +9,7 @@ Backup Management
- :ref:`Querying Backups <gaussdb_06_0004>` - :ref:`Querying Backups <gaussdb_06_0004>`
- :ref:`Querying an Automated Backup Policy <gaussdb_06_0005>` - :ref:`Querying an Automated Backup Policy <gaussdb_06_0005>`
- :ref:`Modifying an Automated Backup Policy <gaussdb_06_0006>` - :ref:`Modifying an Automated Backup Policy <gaussdb_06_0006>`
- :ref:`Deleting a Manual Backup <deletegaussmysqlbackup>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -18,3 +19,4 @@ Backup Management
querying_backups querying_backups
querying_an_automated_backup_policy querying_an_automated_backup_policy
modifying_an_automated_backup_policy modifying_an_automated_backup_policy
deleting_a_manual_backup

3
api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst
View File

@ -12,7 +12,6 @@ This API is used to enable database proxy in ELB mode. Before using this API:
- Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
- Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
- Database proxy is unavailable for DB instances in a DeC.
URI URI
--- ---
@ -62,6 +61,8 @@ Request Parameters
| | | | - **readonly** | | | | | - **readonly** |
+-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nodes_read_weight | No | Array of :ref:`NodesWeight <creategaussmysqlproxy__request_nodesweight>` objects | Read weight of the node. | | nodes_read_weight | No | Array of :ref:`NodesWeight <creategaussmysqlproxy__request_nodesweight>` objects | Read weight of the node. |
| | | | |
| | | | If **proxy_mode** is set to **readonly**, you can assign weights only for read replicas. |
+-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _creategaussmysqlproxy__request_nodesweight: .. _creategaussmysqlproxy__request_nodesweight:

2
api-ref/source/apis_recommended/index.rst
View File

@ -14,7 +14,6 @@ APIs (Recommended)
- :ref:`Database Proxy <topic_300000006>` - :ref:`Database Proxy <topic_300000006>`
- :ref:`Log Management <topic_300000007>` - :ref:`Log Management <topic_300000007>`
- :ref:`Tag Management <topic_300000009>` - :ref:`Tag Management <topic_300000009>`
- :ref:`SQL Statement Concurrency Control <topic_300000012>`
- :ref:`Task Center <gaussdb_04_0014>` - :ref:`Task Center <gaussdb_04_0014>`
.. toctree:: .. toctree::
@ -30,5 +29,4 @@ APIs (Recommended)
database_proxy/index database_proxy/index
log_management/index log_management/index
tag_management/index tag_management/index
sql_statement_concurrency_control/index
task_center/index task_center/index

52
api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst
View File

@ -30,35 +30,29 @@ GET /v3/{project_id}/instances
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================================================================================================================================================================================================================================+ +================+===========+=========+==========================================================================================================================================================================================================================================================================================================+
| id | No | String | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). | | id | No | String | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | No | String | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). | | name | No | String | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | No | String | DB instance type to be queried. Currently, its value can only be **Cluster**. | | type | No | String | DB instance type to be queried. Currently, its value can only be **Cluster**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. | | datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | No | String | VPC ID. | | vpc_id | No | String | VPC ID. |
| | | | | +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - Method 1: Log in to VPC console and view the VPC ID in the VPC details. | | subnet_id | No | String | Network ID of the subnet. |
| | | | - Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*. | +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | private_ip | No | String | Private IP address. |
| subnet_id | No | String | Network ID of the subnet. | +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | | | offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
| | | | - Method 1: Log in to VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the *Virtual Private Cloud API Reference*. | | limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| private_ip | No | String | Private IP address. | | tags | No | String | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | String | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

5
api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst
View File

@ -13,6 +13,11 @@ This API is used to configure resource quotas for a specified enterprise project
- Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
- Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
Precautions
-----------
Before using this API, ensure that the enterprise project has been enabled and you have the **gaussdb:quota:modify** permission.
URI URI
--- ---

5
api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst
View File

@ -13,6 +13,11 @@ This API is used to modify the resource quota of a specified enterprise project.
- Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
- Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
Precautions
-----------
Before using this API, ensure that the enterprise project has been enabled and you have the **gaussdb:quota:modify** permission.
URI URI
--- ---

3
api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst
View File

@ -132,7 +132,8 @@ Success.
"availability_instance_quota" : 1, "availability_instance_quota" : 1,
"availability_vcpus_quota" : 4, "availability_vcpus_quota" : 4,
"availability_ram_quota" : 8 "availability_ram_quota" : 8
} ] } ],
"total_count":1
} }
Status Code Status Code

196
api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst
View File

File diff suppressed because it is too large Load Diff

169
api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst
View File

File diff suppressed because it is too large Load Diff

18
api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst
View File

@ -1,18 +0,0 @@
:original_name: topic_300000012.html
.. _topic_300000012:
SQL Statement Concurrency Control
=================================
- :ref:`Configuring Concurrency Control Rules of SQL Statements <setsqlfilterrule>`
- :ref:`Querying Concurrency Control Rules of SQL Statements <showsqlfilterrule>`
- :ref:`Deleting Concurrency Control Rules of SQL Statements <deletesqlfilterrule>`
.. toctree::
:maxdepth: 1
:hidden:
configuring_concurrency_control_rules_of_sql_statements
querying_concurrency_control_rules_of_sql_statements
deleting_concurrency_control_rules_of_sql_statements

176
api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst
View File

File diff suppressed because it is too large Load Diff

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

@ -60,7 +60,7 @@ Obtain a Project ID from the Console
On the **My Credentials** page, view project IDs in the project list. On the **My Credentials** page, view project IDs in the project list.
.. figure:: /_static/images/en-us_image_0000001476990897.jpg .. figure:: /_static/images/en-us_image_0000001828922089.png
:alt: **Figure 1** Viewing project IDs :alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs **Figure 1** Viewing project IDs

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

@ -28,7 +28,7 @@ Concepts
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
.. figure:: /_static/images/en-us_image_0000001477110589.gif .. figure:: /_static/images/en-us_image_0000001828921437.png
:alt: **Figure 1** Project isolating model :alt: **Figure 1** Project isolating model
**Figure 1** Project isolating model **Figure 1** Project isolating model

130
api-ref/source/change_history.rst
View File

File diff suppressed because it is too large Load Diff

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

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/gaussdb-mysql'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/gaussdb-mysql/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'database'
otcdocs_service_title = 'GaussDB (for MySQL)'
otcdocs_service_type = 'gaussdb_mysql'
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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

4
doc/requirements.txt
View File

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

11
doc/source/conf.py
View File

@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/gaussdb-mysql'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' 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 = 'GaussDB (for MySQL)'
otcdocs_service_type = 'gaussdb_mysql'
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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

48
tox.ini
View File

File diff suppressed because it is too large Load Diff

0
umn/source/_static/images/en-us_image_0000001400783488.png → umn/source/_static/images/en-us_image_0000001212611256.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1004 B

After

Width:  |  Height:  |  Size: 1004 B

BIN
umn/source/_static/images/en-us_image_0000001352059444.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

0
umn/source/_static/images/en-us_image_0000001401103264.png → umn/source/_static/images/en-us_image_0000001352219096.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

BIN
umn/source/_static/images/en-us_image_0000001352219100.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1004 B

0
umn/source/_static/images/en-us_image_0000001451343129.png → umn/source/_static/images/en-us_image_0000001352219136.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

0
umn/source/_static/images/en-us_image_0000001400623516.png → umn/source/_static/images/en-us_image_0000001352378996.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 299 B

After

Width:  |  Height:  |  Size: 299 B

0
umn/source/_static/images/en-us_image_0000001401103272.png → umn/source/_static/images/en-us_image_0000001352379000.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

0
umn/source/_static/images/en-us_image_0000001400943256.png → umn/source/_static/images/en-us_image_0000001352379004.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

0
umn/source/_static/images/en-us_image_0000001400783432.png → umn/source/_static/images/en-us_image_0000001352379036.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 234 B

After

Width:  |  Height:  |  Size: 234 B

0
umn/source/_static/images/en-us_image_0000001451103529.png → umn/source/_static/images/en-us_image_0000001352379040.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

0
umn/source/_static/images/en-us_image_0000001451103469.png → umn/source/_static/images/en-us_image_0000001352379048.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 409 B

After

Width:  |  Height:  |  Size: 409 B

0
umn/source/_static/images/en-us_image_0000001400783516.png → umn/source/_static/images/en-us_image_0000001352379056.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

0
umn/source/_static/images/en-us_image_0000001400623556.png → umn/source/_static/images/en-us_image_0000001352538852.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 295 B

After

Width:  |  Height:  |  Size: 295 B

0
umn/source/_static/images/en-us_image_0000001401103224.png → umn/source/_static/images/en-us_image_0000001352538904.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 296 B

After

Width:  |  Height:  |  Size: 296 B

BIN
umn/source/_static/images/en-us_image_0000001400271265.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
umn/source/_static/images/en-us_image_0000001400391461.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1004 B

0
umn/source/_static/images/en-us_image_0000001451183145.png → umn/source/_static/images/en-us_image_0000001402858817.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

0
umn/source/_static/images/en-us_image_0000001401103308.png → umn/source/_static/images/en-us_image_0000001402858853.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 295 B

After

Width:  |  Height:  |  Size: 295 B

0
umn/source/_static/images/en-us_image_0000001451183185.png → umn/source/_static/images/en-us_image_0000001402858861.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

0
umn/source/_static/images/en-us_image_0000001451103533.png → umn/source/_static/images/en-us_image_0000001402858869.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 299 B

After

Width:  |  Height:  |  Size: 299 B

0
umn/source/_static/images/en-us_image_0000001451183161.png → umn/source/_static/images/en-us_image_0000001402979141.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 480 B

After

Width:  |  Height:  |  Size: 480 B

0
umn/source/_static/images/en-us_image_0000001400783456.png → umn/source/_static/images/en-us_image_0000001402979149.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

0
umn/source/_static/images/en-us_image_0000001451343169.png → umn/source/_static/images/en-us_image_0000001402979157.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 296 B

After

Width:  |  Height:  |  Size: 296 B

0
umn/source/_static/images/en-us_image_0000001451103505.png → umn/source/_static/images/en-us_image_0000001403138681.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 295 B

After

Width:  |  Height:  |  Size: 295 B

0
umn/source/_static/images/en-us_image_0000001400943340.png → umn/source/_static/images/en-us_image_0000001403138685.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 234 B

After

Width:  |  Height:  |  Size: 234 B

0
umn/source/_static/images/en-us_image_0000001451023297.png → umn/source/_static/images/en-us_image_0000001403138693.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 203 B

After

Width:  |  Height:  |  Size: 203 B

Some files were not shown because too many files have changed in this diff Show More