diff --git a/api-ref/source/_static/images/en-us_image_0000001372529646.png b/api-ref/source/_static/images/en-us_image_0000001427231638.png similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001372529646.png rename to api-ref/source/_static/images/en-us_image_0000001427231638.png diff --git a/api-ref/source/_static/images/en-us_image_0000001423128721.jpg b/api-ref/source/_static/images/en-us_image_0000001476990897.jpg similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001423128721.jpg rename to api-ref/source/_static/images/en-us_image_0000001476990897.jpg diff --git a/api-ref/source/_static/images/en-us_image_0000001422968749.gif b/api-ref/source/_static/images/en-us_image_0000001477110589.gif similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001422968749.gif rename to api-ref/source/_static/images/en-us_image_0000001477110589.gif diff --git a/api-ref/source/api/index.rst b/api-ref/source/api/index.rst deleted file mode 100644 index 008af25..0000000 --- a/api-ref/source/api/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: gaussdb_04_0000.html - -.. _gaussdb_04_0000: - -API -=== - -- :ref:`Querying Version Information About a DB Engine ` -- :ref:`Querying Database Specifications ` -- :ref:`Managing DB Instances ` -- :ref:`Managing Parameter Templates ` -- :ref:`Managing Quotas ` -- :ref:`Obtaining Task Information ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - querying_version_information_about_a_db_engine - querying_database_specifications - managing_db_instances/index - managing_parameter_templates/index - managing_quotas/index - obtaining_task_information diff --git a/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst b/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst deleted file mode 100644 index 6553e62..0000000 --- a/api-ref/source/api/managing_db_instances/creating_a_db_instance.rst +++ /dev/null @@ -1,332 +0,0 @@ -:original_name: gaussdb_04_0004.html - -.. _gaussdb_04_0004: - -Creating a DB instance -====================== - -Function --------- - -This API is used to create a GaussDB(for MySQL) DB instance - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - POST https://{*Endpoint*}/mysql/v3/{project_id}/instances - -- Example - - POST https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+============================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - -Request -------- - -.. table:: **Table 2** Parameter description - - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +==========================+=========================================================================================+=================+===========================================================================================================================================================================================================================================+ - | charge_info | No | Object | Billing mode. | - | | | | | - | | | | For details, see :ref:`Table 3 `. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | DB instance name. | - | | | | | - | | | | DB instances of the same type can have same names under the same tenant. | - | | | | | - | | | | The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | Yes | Object | Database information. | - | | | | | - | | | | For details, see :ref:`Table 4 `. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | Yes | String | DB instance type. Currently, only the cluster type is supported. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | Yes | String | Specification code. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | Yes | String | VPC ID. To obtain this value, use either of the following methods: | - | | | | | - | | | | - Method 1: Log in to the VPC console and view the VPC ID on the VPC details page. | - | | | | - Method 2: See "Querying VPCs" in the *Virtual Private Cloud API Reference*. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | Yes | String | Network ID. To obtain this value, use either of the following methods: | - | | | | | - | | | | - Method 1: Log in to the VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | - | | | | - Method 2: See "Querying Subnets" in the *Virtual Private Cloud API Reference*. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | No | String | Security group ID. | - | | | | | - | | | | If the network ACL is enabled for the subnet used by the created DB instance, this parameter is optional. If the network ACL is not enabled, this parameter is mandatory. | - | | | | | - | | | | - Method 1: Log in to VPC console. Choose **Access Control** > **Security Groups** in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page. | - | | | | - Method 2: See "Querying Security Groups" in the *Virtual Private Cloud API Reference*. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | configuration_id | No | String | Parameter template ID. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | password | Yes | String | Database password. | - | | | | | - | | | | Valid value: | - | | | | | - | | | | The password is 8 to 32 characters long and must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (``~!@#%^*-_=+?``). | - | | | | | - | | | | You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | No | Object | Automated backup policy. | - | | | | | - | | | | For details, see :ref:`Table 5 `. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_zone | No | String | UTC time zone. | - | | | | | - | | | | - If this parameter is not specified, UTC is used by default. | - | | | | - If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be **UTC+08:00** rather than **UTC+08:30**. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_mode | Yes | String | AZ type. The value can be **single** or **multi**. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | master_availability_zone | If **availability_zone_mode** is set to **multi**, this parameter is mandatory. | String | Primary AZ. | - | | | | | - | | If **availability_zone_mode** is set to **single**, this parameter cannot be specified. | | | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slave_count | Yes | Integer | Number of read-only nodes from 1 to 9. A DB instance can have a maximum of 15 read-only nodes. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region | Yes | String | Region ID. | - | | | | | - | | | | The value cannot be empty. To obtain this value, see `Regions and Endpoints `__. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory only when the enterprise project is enabled. | - +--------------------------+-----------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _gaussdb_04_0004__table1935491614524: - -.. table:: **Table 3** charge_info field data structure description - - +-----------------+-----------------+-----------------+---------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=====================+ - | charge_mode | Yes | String | Billing mode. | - | | | | | - | | | | Value: **postPaid** | - +-----------------+-----------------+-----------------+---------------------+ - -.. _gaussdb_04_0004__table64243102: - -.. table:: **Table 4** datastore field data structure description - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================================+ - | type | Yes | String | DB engine. Currently, only gaussdb-mysql is supported. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ - | version | Yes | String | DB version. | - | | | | | - | | | | For details about supported DB versions, see section :ref:`Querying Version Information About a DB Engine `. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. _gaussdb_04_0004__table0863181193416: - -.. table:: **Table 5** backup_strategy field data structure description - - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +============+===========+========+=================================================================================================================================+ - | start_time | Yes | String | Automated backup start time. The automatic backup will be triggered within one hour after the time specified by this parameter. | - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. note:: - - The value of **region** in the following is used as an example. - -- Request example - - .. code-block:: text - - { - "charge_info":{ - "charge_mode":"postPaid" - }, - "region":"cn-north-4b", - "name":"gaussdb-2d34", - "datastore":{ - "type":"gaussdb-mysql", - "version":"8.0" - }, - "mode":"Cluster", - "flavor_ref":"gaussdb.mysql.large.4", - "vpc_id":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87", - "subnet_id":"140af7bf-a9da-4dcf-8837-34199fd6d186", - "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902", - "configuration_id":"43570e0de32e40c5a15f831aa5ce4176pr07", - "password":"Gauss_234", - "backup_strategy":{ - "start_time":"17:00-18:00" - }, - "time_zone":"UTC+08:00", - "availability_zone_mode":"single", - "master_availability_zone":"az1pod1", - "slave_count":1, - "enterprise_project_id":"0" - } - -Response --------- - -- Normal response - - .. table:: **Table 6** Parameter description - - +-----------------------+-----------------------+-----------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================+ - | instance | Object | DB instance information. | - | | | | - | | | For details, see :ref:`Table 7 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------+ - | job_id | String | DB instance creation task ID. | - +-----------------------+-----------------------+-----------------------------------------------------------------------+ - - .. _gaussdb_04_0004__table175305610274: - - .. table:: **Table 7** instance field data structure description - - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============================+=======================+========================================================================================================================================================================+ - | id | String | DB instance ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. DB instances of the same type can have same names under the same tenant. | - | | | | - | | | The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_). | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | Object | Database information. | - | | | | - | | | For details, see :ref:`Table 8 `. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | String | DB instance type. Currently, only the cluster type is supported. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | configuration_id | String | Parameter template ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | String | Database port, which is the same as the request parameter. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | Object | Automated backup policy. | - | | | | - | | | For details, see :ref:`Table 9 `. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region | String | Region ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_mode | String | AZ ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | master\_ availability_zone | String | Primary AZ ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Subnet ID. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slave_count | Integer | Number of read-only nodes. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_info | Object | Billing mode. | - | | | | - | | | For details, see :ref:`Table 10 `. | - +----------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0004__table766045720277: - - .. table:: **Table 8** datastore field data structure description - - ======= ====== ============= - Name Type Description - ======= ====== ============= - type String **DB Engine** - version String DB version. - ======= ====== ============= - - .. _gaussdb_04_0004__table81249589270: - - .. table:: **Table 9** backup_strategy field data structure description - - +------------+---------+----------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+=========+========================================================================================+ - | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | - +------------+---------+----------------------------------------------------------------------------------------+ - | keep_days | Integer | Backup retention days. | - +------------+---------+----------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0004__table207147873611: - - .. table:: **Table 10** charge_info field data structure description - - =========== ====== ============= - Name Type Description - =========== ====== ============= - charge_mode String Billing mode. - =========== ====== ============= - -.. note:: - - The values of **region** and **master_availability_zone** are used as examples. - -- Example normal response - - .. code-block:: text - - { - "instance":{ - "id":"5eebbb4c0f9f4a99b42ed1b6334569aain07", - "name":"gaussdb-2d34", - "status":"BUILD", - "datastore":{ - "type":"gaussdb-mysql", - "version":"8.0" - }, - "mode":"Cluster", - "configuration_id": "", - "port":null, - "backup_strategy":{ - "start_time":null, - "keep_days":"7" - }, - "enterprise_project_id": "0", - "region":"aaa", - "availability_zone_mode":"single", - "master_availability_zone":"aaa", - "vpc_id":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87", - "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902", - "subnet_id":"140af7bf-a9da-4dcf-8837-34199fd6d186", - "slave_count":1, - "charge_info":{ - "charge_mode":"postPaid" - } - }, - "job_id":"43672fe5-56bd-47f1-8fd1-595cded08a7c" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst b/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst deleted file mode 100644 index caa7f8f..0000000 --- a/api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst +++ /dev/null @@ -1,75 +0,0 @@ -:original_name: gaussdb_04_0007.html - -.. _gaussdb_04_0007: - -Deleting a DB Instance -====================== - -Function --------- - -This API is used to delete a DB instance. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - DELETE https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id} - -- Example - - DELETE https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01 - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+============================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - ====== ====== ==================================== - Name Type Description - ====== ====== ==================================== - job_id String ID of the DB instance deletion task. - ====== ====== ==================================== - -- Example normal response - - .. code-block:: text - - { - "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_db_instances/index.rst b/api-ref/source/api/managing_db_instances/index.rst deleted file mode 100644 index 9e1ac64..0000000 --- a/api-ref/source/api/managing_db_instances/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: gaussdb_04_0003.html - -.. _gaussdb_04_0003: - -Managing DB Instances -===================== - -- :ref:`Creating a DB instance ` -- :ref:`Querying a DB Instance List ` -- :ref:`Querying Details of a DB Instance ` -- :ref:`Deleting a DB Instance ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - creating_a_db_instance - querying_a_db_instance_list - querying_details_of_a_db_instance - deleting_a_db_instance diff --git a/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst b/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst deleted file mode 100644 index 3bd5d35..0000000 --- a/api-ref/source/api/managing_db_instances/querying_a_db_instance_list.rst +++ /dev/null @@ -1,240 +0,0 @@ -:original_name: gaussdb_04_0005.html - -.. _gaussdb_04_0005: - -Querying a DB Instance List -=========================== - -Function --------- - -This API is used to query a DB instance list according to search criteria. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} - -- Example - - GET https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Mandatory | Description | - +=================+=================+=================+=========================================================================================================================================================================================================================================+ - | project_id | String | Yes | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | No | DB instance ID. | - | | | | | - | | | | The asterisk (``*``) is reserved for the system. If the instance ID starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance ID is used for exact matching. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | No | DB instance name. | - | | | | | - | | | | The asterisk (``*``) is reserved for the system. If the instance name starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance name is used for exact matching. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | No | DB instance type to be queried. Currently, only the cluster type is supported. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore_type | String | No | Database type. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | No | VPC ID. | - | | | | | - | | | | - Method 1: Log in to VPC console and view the VPC ID in the VPC details. | - | | | | - Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | No | Network ID of the subnet. | - | | | | | - | | | | - 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*. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Integer | No | Index position. 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 | Integer | No | Number of records to be queried. The default value is **100**. The value cannot be a negative number. The minimum value is **1** and the maximum value is **100**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================+ - | instances | Array of objects | DB instance information. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | total_count | Integer | Total number of records. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - - .. _gaussdb_04_0005__table2058713718267: - - .. table:: **Table 3** instances field data structure description - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+====================================================================================================================+ - | id | String | DB instance ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | private_ips | List | Private IP address for write. It is a blank string until an ECS is created. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | public_ips | List | Public IP address list. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | port | Integer | Database port number. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | type | String | DB instance type. The value is **Cluster**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | region | String | Region where the DB instance is deployed. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | datastore | Object | Database information. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | - | | | | - | | | The value is empty unless the DB instance creation is complete. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time. The format is the same as that of the **created** field. | - | | | | - | | | The value is empty unless the DB instance creation is complete. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | db_user_name | String | Default username. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Network ID of the subnet. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | String | Specification code. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | flavor_info | Object | Specification description. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | volume | Object | Volume information. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | Object | Backup policy. | - | | | | - | | | For details, see :ref:`Table 7 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | time_zone | String | Time zone. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0005__table187591675262: - - .. table:: **Table 4** datastore field data structure description - - ======= ====== =========== - Name Type Description - ======= ====== =========== - type String DB engine. - version String DB version. - ======= ====== =========== - - .. _gaussdb_04_0005__table14771167122611: - - .. table:: **Table 5** volume field data structure description - - ==== ====== =============== - Name Type Description - ==== ====== =============== - type String Disk type. - size String Used disk size. - ==== ====== =============== - - .. table:: **Table 6** flavor_ref field data structure description - - ===== ====== ================== - Name Type Description - ===== ====== ================== - vcpus String Number of vCPUs. - ram String Memory size in GB. - ===== ====== ================== - - .. _gaussdb_04_0005__table578797132615: - - .. table:: **Table 7** backup_strategy field data structure description - - +------------+--------+----------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+========+========================================================================================+ - | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | - +------------+--------+----------------------------------------------------------------------------------------+ - | keep_days | String | Backup retention days. | - +------------+--------+----------------------------------------------------------------------------------------+ - - .. note:: - - The value of **region** is used as an example in the following response. - -- Example normal response - - .. code-block:: text - - { - "total_count":6, - "instances":[ - { - "id":"d738399de028480fabb2b8120d4e01a4in07", - "status":"ACTIVE", - "name":"oMoS_001", - "port":3306, - "type":"Cluster", - "private_ips": ["192.168.0.142"], - "public_ips": ["10.154.219.187"], - "db_user_name": "root", - "region": "aaa", - "datastore": {"type": "gaussdb-mysql", "version":"8.0"}, - "created": "2018-08-20T02:33:49+0800", - "updated": "2018-08-20T02:33:50+0800", - "volume": { - "type": "POOL", - "used_size": 100 - }, - "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87", - "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186", - "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902", - "flavor_ref":"gaussdb.mysql.c3.small.4", - "backup_strategy": {"start_time": "19:00-20:00", "keep_days": 7} - "charge_info": { - "charge_mode": "postPaid" - }, - "enterprise_project_id": "0", - "time_zone": "", - } - ] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst b/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst deleted file mode 100644 index 2cdaa9c..0000000 --- a/api-ref/source/api/managing_db_instances/querying_details_of_a_db_instance.rst +++ /dev/null @@ -1,305 +0,0 @@ -:original_name: gaussdb_04_0006.html - -.. _gaussdb_04_0006: - -Querying Details of a DB Instance -================================= - -Function --------- - -This API is used to query the details of a specified DB instance. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id} - -- Example - - GET https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Name | Type | Mandatory | Description | - +=================+=================+=================+============================================================================+ - | project_id | String | Yes | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | String | Yes | DB instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================+ - | instance | Object | DB instance information. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - - .. _gaussdb_04_0006__table2058713718267: - - .. table:: **Table 3** instance field data structure description - - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+==================+=============================================================================================+ - | id | String | DB instance ID. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | name | String | DB instance name. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of a tenant in a region. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | type | String | DB instance type. Currently, only the cluster type is supported. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | node_count | Integer | Number of nodes. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | datastore | Object | Database information. For details, see :ref:`Table 4 `. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | backup_used_space | Integer | Used backup space, in GB. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | created | String | DB instance creation time. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | updated | String | DB instance update time. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | public_ips | String | Public IP address of the DB instance. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | private_write_ips | Array of List | Private IP address for write. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | db_user_name | String | Default username. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | port | String | Database port number. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | subnet_id | String | Subnet ID. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | volume | Object | Disk information. For details, see :ref:`Table 8 `. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | backup_strategy | Object | Backup policy. For details, see :ref:`Table 6 `. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | nodes | Arrays of object | Node information. For details, see :ref:`Table 7 `. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | time_zone | String | Time zone. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | az_mode | String | AZ. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - | master_az_code | String | Primary AZ. | - +-----------------------+------------------+---------------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0006__table187591675262: - - .. table:: **Table 4** datastore field data structure description - - ======= ====== =========== - Name Type Description - ======= ====== =========== - type String DB engine. - version String DB version. - ======= ====== =========== - - .. table:: **Table 5** configurations field data structure description - - ==== ====== ======================== - Name Type Description - ==== ====== ======================== - id String Parameter template ID. - name String Parameter template name. - ==== ====== ======================== - - .. _gaussdb_04_0006__table37991653839: - - .. table:: **Table 6** backup_strategy field data structure description - - +------------+---------+----------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+=========+========================================================================================+ - | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | - +------------+---------+----------------------------------------------------------------------------------------+ - | keep_days | Integer | Backup retention days. | - +------------+---------+----------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0006__table5182635134511: - - .. table:: **Table 7** nodes field data structure description - - +------------------+-----------------+-------------------------------------------------------------------------+ - | Name | Type | Description | - +==================+=================+=========================================================================+ - | id | String | Node ID. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | name | Array of object | Node name. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | type | String | Node type, which can be **master** or **slave**. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | status | String | Node status. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | port | Integer | Database port number. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | private_read_ips | Array of String | Private IP address for read. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | volume | Object | Disk information. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | az_code | String | AZ. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | region_code | String | Region where the DB instance is deployed. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | created | String | DB instance creation time. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | updated | String | Update time. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | flavor_ref | String | Specification code. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | max_connections | String | Maximum number of connections. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | vcpus | String | Number of vCPUs. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | ram | String | Memory size in GB. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | need_restart | Boolean | Whether to reboot the DB instance for the modifications to take effect. | - +------------------+-----------------+-------------------------------------------------------------------------+ - | priority | String | Failover priority. | - +------------------+-----------------+-------------------------------------------------------------------------+ - - .. _gaussdb_04_0006__table14771167122611: - - .. table:: **Table 8** volume field data structure description - - ==== ====== ================================================ - Name Type Description - ==== ====== ================================================ - type String Storage type. Currently, only POOL is supported. - used String Used storage size, in GB. - ==== ====== ================================================ - - .. note:: - - The values of **region_code** and **az_code** are used as examples. - -- Example normal response - - .. code-block:: text - - { - "instance": { - "id": "d2cda7b97a39488e8b30e3cea4066204in07", - "name": "gauss-d616-lb07", - "status": "FAILED", - "project_id": "053f533ead80d5102f0cc012e8d468a4", - "enterprise_project_id": "0", - "type": "Cluster", - "charge_info": { - "charge_mode": "postPaid", - "order_id": "" - }, - "node_count": 2, - "datastore": { - "type": "GaussDB(for MySQL)", - "version": "8.0" - }, - "created": "2020-07-21T09:13:56+0800", - "updated": "2020-07-21T09:27:54+0800", - "public_ips": "", - "private_write_ips": [ - "192.168.0.235" - ], - "db_user_name": "root", - "port": "3306", - "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87", - "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186", - "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902", - "backup_strategy": { - "start_time": "00:00-00:00", - "keep_days": "0" - }, - "nodes": [ - { - "id": "799a0f2fa49a4151bf9f7063c1fbba36no07", - "name": "gauss-d616-lb07_node01", - "type": "master", - "status": "FAILED", - "port": 3306, - "private_read_ips": [ - "192.168.0.163" - ], - "volume": { - "type": "POOL", - "used": "0.0" - }, - "az_code": "az1xahz", - "region_code": "cn-xianhz-1", - "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", - "flavor_ref": "taurus.large.4", - "max_connections": null, - "vcpus": "1", - "ram": "4", - "need_restart": false, - "priority": 1 - }, - { - "id": "816459d771c444db9fa4c1d5c173cb1cno07", - "name": "gauss-d616-lb07_node02", - "type": "slave", - "status": "FAILED", - "port": 3306, - "private_read_ips": [ - "192.168.0.160" - ], - "volume": { - "type": "POOL", - "used": "0.0" - }, - "az_code": "az1xahz", - "region_code": "cn-xianhz-1", - "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", - "flavor_ref": "taurus.large.4", - "max_connections": null, - "vcpus": "1", - "ram": "4", - "need_restart": false, - "priority": 1 - } - ], - "time_zone": "UTC+08:00", - "backup_used_space": 0, - "az_mode": "single", - "master_az_code": "az1xahz" - } - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_parameter_templates/index.rst b/api-ref/source/api/managing_parameter_templates/index.rst deleted file mode 100644 index 9288fcd..0000000 --- a/api-ref/source/api/managing_parameter_templates/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: gaussdb_04_0008.html - -.. _gaussdb_04_0008: - -Managing Parameter Templates -============================ - -- :ref:`Querying a Parameter Template ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - querying_a_parameter_template diff --git a/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst b/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst deleted file mode 100644 index fc25af0..0000000 --- a/api-ref/source/api/managing_parameter_templates/querying_a_parameter_template.rst +++ /dev/null @@ -1,119 +0,0 @@ -:original_name: gaussdb_04_0009.html - -.. _gaussdb_04_0009: - -Querying a Parameter Template -============================= - -Function --------- - -This API is used to obtain a parameter template list, including all databases' default and custom parameter templates. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{*project_id*}/configurations - -- Example - - GET https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+============================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================+ - | configurations | Array of objects | Parameter template list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | total_count | Integer | Total number of parameter templates. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - - .. _gaussdb_04_0009__table1324110018258: - - .. table:: **Table 3** configurations field data structure description - - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +========================+=======================+====================================================================================================================+ - | id | String | Parameter template ID. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Parameter template name. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Parameter template description. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | datastore_version_name | String | DB version name. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | datastore_name | String | DB name. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | user_defined | Boolean | Whether the parameter template is a custom template. | - | | | | - | | | - **false**: The parameter template is a default template. | - | | | - **true**: The parameter template is a custom template. | - +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - -- Example normal response - - .. code-block:: text - - { - "configurations":[ - { - "id":"1ad028f5f6b8482483948860feb33339pr07", - "name":"DBS_GaussDB_ParameterTemple_Apply_001", - "description":"GaussDB-Test", - "datastore_version_name":"8.0", - "datastore_name":"gaussdb-mysql", - "created":"2020-04-08 07:12:17", - "updated":"2020-04-08 07:12:17", - "user_defined":true, - } - ] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst b/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst deleted file mode 100644 index 6ad80e9..0000000 --- a/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst +++ /dev/null @@ -1,130 +0,0 @@ -:original_name: gaussdb_04_0012.html - -.. _gaussdb_04_0012: - -Configuring Resource Quotas -=========================== - -Function --------- - -This API is used to set resource quotas for a specified enterprise project. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - POST https://{*Endpoint*}/mysql/v3/{project_id}/quotas - -- Example - - POST https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+============================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | quota_list | Yes | Quota details. A maximum of 10 quota records can be configured at a time. | - | | | | - | | | For details, see :ref:`Table 2 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - -Request -------- - -- Parameter description - - .. _gaussdb_04_0012__table1453814912427: - - .. table:: **Table 2** quota_list field data structure description - - +-----------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=========+==================================================================================================================================================================================================+ - | enterprise_project_id | String | Enterprise project ID. | - +-----------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_quota | Integer | DB instance quantity quota. The value ranges from **0** to **1000**. (If there are already DB instances created, this parameter value must be greater than the number of existing DB instances.) | - +-----------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vcpus_quota | Integer | vCPUs quota. The value ranges from **0** to **3600000**. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.) | - +-----------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ram_quota | Integer | Memory quota in GB. The value ranges from **0** to **19200000**. (If there are already DB instances created, this parameter value must be greater than the used memory size.) | - +-----------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Request example - - .. code-block:: text - - { - "quota_list": [ - { - "enterprise_project_id": "0", - "instance_quota": 1, - "vcpus_quota": 4, - "ram_quota": 8 - } - ] - } - -Response --------- - -- Parameter description - - .. table:: **Table 3** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===================================================================+ - | quota_list | Array of objects | Configured quota information. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - - .. _gaussdb_04_0012__table66531170: - - .. table:: **Table 4** quota_list data structure description - - ===================== ======= ================================== - Name Type Description - ===================== ======= ================================== - enterprise_project_id String Enterprise project ID. - instance_quota Integer Quota of the DB instance quantity. - vcpus_quota Integer Quota of vCPUs. - ram_quota Integer Memory quota in GB. - ===================== ======= ================================== - -- Example response - - .. code-block:: text - - { - "quota_list": [ - { - "enterprise_project_id": "0", - "instance_quota": 1, - "vcpus_quota": 4, - "ram_quota": 8 - } - ] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst b/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst deleted file mode 100644 index ea0afa0..0000000 --- a/api-ref/source/api/managing_quotas/modifying_resource_quotas.rst +++ /dev/null @@ -1,132 +0,0 @@ -:original_name: gaussdb_04_0013.html - -.. _gaussdb_04_0013: - -Modifying Resource Quotas -========================= - -Function --------- - -This API is used to modify the resource quota of a specified enterprise project. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - PUT https://{*Endpoint*}/mysql/v3/{project_id}/quotas - -- Example - - PUT https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+====================================================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ - | quota_list | Yes | Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time. | - | | | | - | | | For details, see :ref:`Table 2 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ - -Request -------- - -- Parameter description - - .. _gaussdb_04_0013__table1252104315240: - - .. table:: **Table 2** quota_list field data structure description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================================================================================================================================================================+ - | enterprise_project_id | String | Enterprise project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_quota | Integer | Quota of the DB instance quantity. The value ranges from **0** to **1000**. (If there are already DB instances created, this parameter value must be greater than or equal to the number of existing DB instances.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vcpus_quota | Integer | Quota of vCPUs. The value ranges from **0** to **3600000**. (If there are already DB instances created, this parameter value must be greater than or equal to the number of used vCPUs.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ram_quota | Integer | Memory quota in GB. | - | | | | - | | | Memory quota in GB. The value ranges from **0** to **19200000**. (If there are already DB instances created, this parameter value must be greater than or equal to the used memory size.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Request example - - .. code-block:: text - - { - "quota_list": [ - { - "enterprise_project_id": "0", - "instance_quota": 1, - "vcpus_quota": 4, - "ram_quota": 8 - } - ] - } - -Response --------- - -- Parameter description - - .. table:: **Table 3** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===================================================================+ - | quota_list | Array of objects | Configured quota information. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - - .. _gaussdb_04_0013__table66531170: - - .. table:: **Table 4** quota_list field data structure description - - ===================== ======= ================================== - Name Type Description - ===================== ======= ================================== - enterprise_project_id String Enterprise project ID. - instance_quota Integer Quota of the DB instance quantity. - vcpus_quota Integer Quota of vCPUs. - ram_quota Integer Memory quota in GB. - ===================== ======= ================================== - -- Example response - - .. code-block:: text - - { - "quota_list": [ - { - "enterprise_project_id": "0", - "instance_quota": 1, - "vcpus_quota": 4, - "ram_quota": 8 - } - ] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_quotas/querying_resource_quotas.rst b/api-ref/source/api/managing_quotas/querying_resource_quotas.rst deleted file mode 100644 index 633fdbd..0000000 --- a/api-ref/source/api/managing_quotas/querying_resource_quotas.rst +++ /dev/null @@ -1,116 +0,0 @@ -:original_name: gaussdb_04_0011.html - -.. _gaussdb_04_0011: - -Querying Resource Quotas -======================== - -Function --------- - -This API is used to obtain the resource quota of a specified enterprise project. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{project_id}/quotas - -- Example - - GET https://{*Endpoint*}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+=========================================================================================================================================================================================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Index position. 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 | Number of records to be queried. The default value is **10**. The value cannot be a negative number. The minimum value is **1** and the maximum value is **100**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -- Parameter description - - .. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===================================================================+ - | quota_list | Array of objects | Quota information list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | total_count | Integer | Number of quota records. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - - .. _gaussdb_04_0011__table66531170: - - .. table:: **Table 3** quota_list field data structure description - - =========================== ======= ================================== - Name Type Description - =========================== ======= ================================== - enterprise_project_id String Enterprise project ID. - instance_quota Integer Quota of the DB instance quantity. - vcpus_quota Integer Quota of vCPUs. - ram_quota Integer Memory quota in GB. - availability_instance_quota Integer Remaining quota of DB instances. - availability_vcpus_quota Integer Remaining quota of vCPU. - availability_ram_quota Integer Remaining memory quota. - =========================== ======= ================================== - -- Example response - - .. code-block:: text - - "quota_list": [ - { - "enterprise_project_id": "0", - "instance_quota": 20, - "vcpus_quota": 20, - "ram_quota": 40, - "availability_instance_quota": 1, - "availability_vcpus_quota ": 4, - "availability_ram_quota": 8 - }, - { - "enterprise_project_id": "d72ebb42-9110-464c-a8e2-f9b9f349f80f", - "instance_quota": 0, - "vcpus_quota": 0, - "ram_quota": 0, - "availability_instance_quota ": 1, - "availability_vcpus_quota ": 4, - "availability_ram_quota ": 8 - } - ], - "total_count": 2 - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/obtaining_task_information.rst b/api-ref/source/api/obtaining_task_information.rst deleted file mode 100644 index 0e4154e..0000000 --- a/api-ref/source/api/obtaining_task_information.rst +++ /dev/null @@ -1,186 +0,0 @@ -:original_name: gaussdb_04_0014.html - -.. _gaussdb_04_0014: - -Obtaining Task Information -========================== - -Function --------- - -This API is used to obtain task information from the task center. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{project_id}/jobs?id={id} - -- Example - - GET https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+============================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | id | Yes | Task ID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - +------+--------+-------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +======+========+===========================================================================================+ - | job | Object | Task information. For details, see :ref:`Table 3 `. | - +------+--------+-------------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0014__table54571314103317: - - .. table:: **Table 3** job field data structure description - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+====================================================================================================================+ - | id | String | Task ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Task name. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Task execution status. | - | | | | - | | | Valid value: | - | | | | - | | | - **Running**: The task is being executed. | - | | | - **Completed**: The task is successfully executed. | - | | | - **Failed**: The task fails to be executed. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | - | | | | - | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | process | String | Task execution progress. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | instance | Object | DB instance on which the task is executed. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | entities | Object | Displayed information varies depending on tasks. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - | fail_reason | String | Task failure information. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0014__table4062895917262: - - .. table:: **Table 4** instances field data structure description - - ==== ====== ================= - Name Type Description - ==== ====== ================= - id String DB instance ID. - name String DB instance name. - ==== ====== ================= - - .. _gaussdb_04_0014__table1014617554138: - - .. table:: **Table 5** entities field data structure description - - +-----------------------+-----------------------+-----------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================+ - | instance | Object | DB instance queried in the task. | - | | | | - | | | For details, see :ref:`Table 6 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------+ - | resource_ids | List | Resource ID involved in a task. | - +-----------------------+-----------------------+-----------------------------------------------------------------------+ - - .. _gaussdb_04_0014__table975183423611: - - .. table:: **Table 6** entities.instance field data structure description - - +-----------+--------+---------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+========+=======================================================================================+ - | endpoint | String | DB instance connection address. | - +-----------+--------+---------------------------------------------------------------------------------------+ - | type | String | DB instance type. | - +-----------+--------+---------------------------------------------------------------------------------------+ - | datastore | Object | DB information. For details, see :ref:`Table 7 `. | - +-----------+--------+---------------------------------------------------------------------------------------+ - - .. _gaussdb_04_0014__table173094268581: - - .. table:: **Table 7** datastore field data structure description - - ======= ====== =========== - Name Type Description - ======= ====== =========== - type String DB engine. - version String DB version. - ======= ====== =========== - - .. table:: **Table 8** entities field data structure description (binding or unbinding an EIP) - - ========= ====== ===================== - Name Type Description - ========= ====== ===================== - public_ip String EIP used in the task. - ========= ====== ===================== - - .. note:: - - In the response example, some tasks in the task center are used as examples. - -- Example normal response - - .. code-block:: text - - { - "job": { - "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", - "name": " RestartGaussDBInstance", - "status": "Completed", - "created": "2018-08-06T10:41:14+0000", - "ended": "2018-08-06T16:41:14+0000", - "process": "", - "instance": { - "id": "a48e43ff268f4c0e879652d65e63d0fbin01", - "name": "DO-NOT-TOUCH-mgr2-gaussdb" - }, - "entities": {} - } - } - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/querying_database_specifications.rst b/api-ref/source/api/querying_database_specifications.rst deleted file mode 100644 index 1338106..0000000 --- a/api-ref/source/api/querying_database_specifications.rst +++ /dev/null @@ -1,142 +0,0 @@ -:original_name: gaussdb_04_0002.html - -.. _gaussdb_04_0002: - -Querying Database Specifications -================================ - -Function --------- - -This API is used to query the database specifications of a specified DB engine version. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{project_id}/flavors/{database}?version_name={version_name}&spec_code={spec_code} - -- Example - - GET https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4 - -- Parameter description - - .. table:: **Table 1** Parameter description - - +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========================+=================+=================+=======================================================================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ - | database | Yes | String | DB engine. Its value can be any of the following and is case-insensitive: | - | | | | | - | | | | - gaussdb-mysql | - +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine `. | - | | | | | - | | | | Currently, only MySQL 8.0 is supported. | - +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ - | availability_zone_mode | Yes | String | AZ type of the specification. The value can be **single** or **multi**. | - +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ - | spec_code | No | String | Specification code. | - +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===================================================================+ - | flavors | Array of objects | DB instance specification list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - - .. _gaussdb_04_0002__table66531170: - - .. table:: **Table 3** flavors field data structure description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================+ - | vcpus | String | Number of vCPUs. For example, the value **1** indicates 1 vCPU. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | ram | Integer | Memory size in gigabyte (GB). | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | type | String | Specification type. The value can be **arm** or **x86**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | id | String | Specification ID. The value must be unique. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | spec_code | String | Resource specification code. For example: gaussdb.mysql.xlarge.x86.4. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | version_name | String | DB version number. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | instance_mode | String | DB instance type. Currently, only the cluster type is supported. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | az_status | Map | Status of the AZ where the specification belongs. Its value can be any of the following: | - | | | | - | | | - **normal**: on sale. | - | | | - **unsupported**: not supported. | - | | | - **sellout**: sold out. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - -- Example normal response - - .. code-block:: text - - { - "flavors":[ - { - "vcpus":"1", - "ram":"4", - "type":"x86" - "id":"3169caaf-6c2f-41d5-aadd-c8fc3d83597e", - "spec_code":"gaussdb.xlarge.x86.4", - "instance_mode":"Cluster", - "version_name": "8.0", - "az_status":{ - "az1":"normal", - "az2":"normal" - } - }, - { - "vcpus":"2", - "ram":"4", - "type":"arm" - "id":"cefb8fab-c9f7-482f-a97c-e8a0c8abe35b", - "spec_code":"gaussdb.mysql.xlarge.x86.2", - "instance_mode":"Cluster", - "version_name": "8.0", - "az_status":{ - "az1":"normal", - "az2":"normal" - } - } - ] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/querying_version_information_about_a_db_engine.rst b/api-ref/source/api/querying_version_information_about_a_db_engine.rst deleted file mode 100644 index 042ece1..0000000 --- a/api-ref/source/api/querying_version_information_about_a_db_engine.rst +++ /dev/null @@ -1,92 +0,0 @@ -:original_name: gaussdb_04_0001.html - -.. _gaussdb_04_0001: - -Querying Version Information About a DB Engine -============================================== - -Function --------- - -This API is used to query the DB version information of a specified DB engine. - -- Learn how to :ref:`authorize and authenticate ` this API before using it. -- Before calling this API, obtain the required :ref:`region and endpoint `. - -URI ---- - -- URI format - - GET https://{*Endpoint*}/mysql/v3/{project_id}/datastores/{database_name} - -- Example - - GET https://{*Endpoint*}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql - -- Parameter description - - .. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ - | Name | Mandatory | Description | - +=======================+=======================+===================================================================================+ - | project_id | Yes | Project ID of a tenant in a region. | - | | | | - | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ - | database_name | Yes | DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ - -Request -------- - -None. - -Response --------- - -- Normal response - - .. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===================================================================+ - | datastores | Array of objects | DB version list. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - - .. _gaussdb_04_0001__table66531170: - - .. table:: **Table 3** datastores field data structure description - - +------+--------+-------------------------------------------------------------------------------+ - | Name | Type | Description | - +======+========+===============================================================================+ - | id | String | DB version ID. Its value is unique. | - +------+--------+-------------------------------------------------------------------------------+ - | name | String | DB version number. Only the major version number with two digits is returned. | - +------+--------+-------------------------------------------------------------------------------+ - -- Example normal response - - .. code-block:: text - - { - "datastores": [{ - "id": "87620726-6802-46c0-9028-a8785e1f1921", - "name": "8.0" - }] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api_overview.rst b/api-ref/source/api_overview.rst index 1c9e176..bf739b6 100644 --- a/api-ref/source/api_overview.rst +++ b/api-ref/source/api_overview.rst @@ -7,18 +7,28 @@ API Overview With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas. -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| Type | Description | -+===============================+===============================================================================================================================================+ -| 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 instance management | Create DB instances, query DB instance lists, query DB instance details, delete DB instances, create read replicas, and delete read replicas. | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter template management | Query parameter templates. | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| Quota management | Query, set, and modify resource quotas. | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| Task information query | Obtain task information about the task center. | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Type | Description | ++===================================+====================================================================================================================================================================================================================+ +| 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 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. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Parameter template management | Query parameter templates. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Quota management | Query, set, and modify resource quotas. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/calling_apis/authentication.rst b/api-ref/source/api_usage_guidelines/authentication.rst similarity index 65% rename from api-ref/source/calling_apis/authentication.rst rename to api-ref/source/api_usage_guidelines/authentication.rst index 0a507ac..c0afdeb 100644 --- a/api-ref/source/calling_apis/authentication.rst +++ b/api-ref/source/api_usage_guidelines/authentication.rst @@ -18,6 +18,32 @@ Token-based Authentication A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. +.. code-block:: + + { + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxx" + } + } + } + } + In :ref:`Making an API Request `, the process of calling the API used to `obtain a user token `__ is described. After a token is obtained, add the **X-Auth-Token** header field must be added to requests to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows: diff --git a/api-ref/source/calling_apis/index.rst b/api-ref/source/api_usage_guidelines/index.rst similarity index 87% rename from api-ref/source/calling_apis/index.rst rename to api-ref/source/api_usage_guidelines/index.rst index 308827b..99b0e49 100644 --- a/api-ref/source/calling_apis/index.rst +++ b/api-ref/source/api_usage_guidelines/index.rst @@ -2,8 +2,8 @@ .. _gaussdb_03_0000: -Calling APIs -============ +API Usage Guidelines +==================== - :ref:`Making an API Request ` - :ref:`Authentication ` diff --git a/api-ref/source/calling_apis/making_an_api_request.rst b/api-ref/source/api_usage_guidelines/making_an_api_request.rst similarity index 99% rename from api-ref/source/calling_apis/making_an_api_request.rst rename to api-ref/source/api_usage_guidelines/making_an_api_request.rst index ecdf93a..d184db5 100644 --- a/api-ref/source/calling_apis/making_an_api_request.rst +++ b/api-ref/source/api_usage_guidelines/making_an_api_request.rst @@ -95,7 +95,7 @@ This part is optional. The body of a request is often sent in a structured forma The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods. -In the case of the API used to `obtain a user token `__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace **username**, **domainname**, **\*******\*** (login password), and **xxxxxxxxxxxxxxxxxx** (project name) with actual values. You can obtain the values from `Regions and Endpoints `__. +In the case of the API used to `obtain a user token `__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace **username**, **domainname**, **\*******\*** (login password), and **xxxxxxxxxxxxxxxxxx** (project name) with actual values. It can be obtained from `Regions and Endpoints `__. .. note:: diff --git a/api-ref/source/calling_apis/response.rst b/api-ref/source/api_usage_guidelines/response.rst similarity index 97% rename from api-ref/source/calling_apis/response.rst rename to api-ref/source/api_usage_guidelines/response.rst index 81d86b9..bfd8033 100644 --- a/api-ref/source/calling_apis/response.rst +++ b/api-ref/source/api_usage_guidelines/response.rst @@ -23,7 +23,7 @@ Similar to a request, a response also has a header, for example, **Content-Type* .. _gaussdb_03_0006__fig4865141011511: -.. figure:: /_static/images/en-us_image_0000001372529646.png +.. figure:: /_static/images/en-us_image_0000001427231638.png :alt: **Figure 1** Header fields of the response to the request for obtaining a user token **Figure 1** Header fields of the response to the request for obtaining a user token diff --git a/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst b/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst new file mode 100644 index 0000000..19e172b --- /dev/null +++ b/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst @@ -0,0 +1,176 @@ +:original_name: gaussdb_06_0003.html + +.. _gaussdb_06_0003: + +Creating a Manual Backup +======================== + +Function +-------- + +This API is used to create a manual backup. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/backups/create + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+===================================================================================================================================================================================+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | Backup name. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Backup description. It contains a maximum of 256 characters and cannot contain the special characters ``(>!<"&'=)`` | + +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 4** Response body parameters + + +-----------+---------------------------------------------------------+---------------------+ + | Parameter | Type | Description | + +===========+=========================================================+=====================+ + | backup | :ref:`backup ` object | Backup information. | + +-----------+---------------------------------------------------------+---------------------+ + | job_id | String | Task ID. | + +-----------+---------------------------------------------------------+---------------------+ + +.. _gaussdb_06_0003__response_backup: + +.. table:: **Table 5** backup + + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================================================================================================================+ + | id | String | Backup ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Backup name. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Backup description. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Backup status. Value: | + | | | | + | | | - **BUILDING**: Backup in progress | + | | | - **COMPLETED**: Backup completed | + | | | - **FAILED**: Backup failed | + | | | - **AVAILABLE**: Backup available | + | | | | + | | | Valid value: | + | | | | + | | | - BUILDING | + | | | - COMPLETED | + | | | - FAILED | + | | | - AVAILABLE | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Backup type. Value: | + | | | | + | | | **manual**: manual full backup | + | | | | + | | | Valid value: | + | | | | + | | | manual | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | DB instance ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Creating a Manual Backup + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create + { + "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07", + "name" : "backup-1", + "description": "Manual backup" + } + +Example Response +---------------- + +**Status code: 201** + +Success. + +.. code-block:: + + { + "backup" : { + "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe", + "name" : "backup-1", + "description": "Manual backup" + "begin_time" : "2020-07-07T01:17:05+0800", + "status" : "BUILDING", + "type" : "manual", + "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07" + }, + "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/backup_management/index.rst b/api-ref/source/apis_recommended/backup_management/index.rst new file mode 100644 index 0000000..8f878be --- /dev/null +++ b/api-ref/source/apis_recommended/backup_management/index.rst @@ -0,0 +1,20 @@ +:original_name: gaussdb_06_0002.html + +.. _gaussdb_06_0002: + +Backup Management +================= + +- :ref:`Creating a Manual Backup ` +- :ref:`Querying Backups ` +- :ref:`Querying an Automated Backup Policy ` +- :ref:`Modifying an Automated Backup Policy ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_manual_backup + querying_backups + querying_an_automated_backup_policy + modifying_an_automated_backup_policy diff --git a/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst b/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst new file mode 100644 index 0000000..9ca2450 --- /dev/null +++ b/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst @@ -0,0 +1,194 @@ +:original_name: gaussdb_06_0006.html + +.. _gaussdb_06_0006: + +Modifying an Automated Backup Policy +==================================== + +Function +-------- + +This API is used to modify an automated backup policy. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +---------------+-----------+------------------------------------------------------------------------------+-----------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+==============================================================================+=======================+ + | backup_policy | Yes | :ref:`MysqlBackupPolicy ` object | Database information. | + +---------------+-----------+------------------------------------------------------------------------------+-----------------------+ + +.. _gaussdb_06_0006__request_mysqlbackuppolicy: + +.. table:: **Table 4** MysqlBackupPolicy + + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============================+=================+=================+=============================================================================================================================================================================================================================+ + | start_time | Yes | String | Backup time window. Automated backups will be triggered during the backup time window. | + | | | | | + | | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | | + | | | | - The **HH** value must be 1 greater than the **hh** value. | + | | | | - The values of **mm** and **MM** must be the same and must be set to **00**. | + | | | | | + | | | | Example value: | + | | | | | + | | | | 21:00-22:00 | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | Yes | Integer | Backup retention days. | + | | | | | + | | | | Value: **1** to **732** | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period | Yes | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | + | | | | | + | | | | Value range: The value is a number separated by commas (,), indicating the days of the week. | + | | | | | + | | | | For example, the value **1,2,3,4** indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday. | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | retention_num_backup_level-1 | No | Integer | Number of retained level-1 backups. The default value is **0**. This parameter is mandatory when the level-1 backup function is enabled. This parameter is unavailable when the level-1 backup function is disabled. Value: | + | | | | | + | | | | - 0 | + | | | | - 1 | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + ============= ====== =================== + Parameter Type Description + ============= ====== =================== + status String Status information. + instance_id String DB instance ID. + instance_name String DB instance name. + ============= ====== =================== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Modifying a backup policy + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update + { + "backup_policy" : { + "keep_days" : 7, + "start_time" : "19:00-20:00", + "period" : "1,2,3,4,5" + } + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "status" : "COMPLETED", + "instance_id" : "ef25188419f941309882d2986b2210b9in07", + "instance_name" : "gauss-mysql" + } + +Response +-------- + +- Normal response + + .. table:: **Table 8** Parameter description + + +-----------------------+-----------------------+-------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================+ + | status | String | Backup status. Value: | + | | | | + | | | - **BUILDING**: Modification in progress | + | | | - **COMPLETED**: Modification completed | + | | | - **FAILED**: Modification failed | + +-----------------------+-----------------------+-------------------------------------------+ + | instance_id | String | DB instance ID. | + +-----------------------+-----------------------+-------------------------------------------+ + | instance_name | String | DB instance name. | + +-----------------------+-----------------------+-------------------------------------------+ + +- Example normal response + + .. code-block:: text + + { + "status": "COMPLETED", + "instance_id": "ef25188419f941309882d2986b2210b9in07", + "instance_name": "gauss-fhc" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst b/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst new file mode 100644 index 0000000..96e073f --- /dev/null +++ b/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst @@ -0,0 +1,134 @@ +:original_name: gaussdb_06_0005.html + +.. _gaussdb_06_0005: + +Querying an Automated Backup Policy +=================================== + +Function +-------- + +This API is used to query an automated backup policy. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/backups/policy + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +---------------+---------------------------------------------------------------------+----------------------------+ + | Parameter | Type | Description | + +===============+=====================================================================+============================+ + | backup_policy | :ref:`BackupPolicy ` object | Backup policy information. | + +---------------+---------------------------------------------------------------------+----------------------------+ + +.. _gaussdb_06_0005__response_backuppolicy: + +.. table:: **Table 4** BackupPolicy + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================================================================+ + | keep_days | Integer | Backup retention days. Value: **1** to **732** | + | | | | + | | | Minimum value: **1** | + | | | | + | | | Maximum value: **732** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | + | | | | + | | | The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + | period | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | + | | | | + | | | Value range: The value is a number separated by commas (,), indicating the days of the week. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "backup_policy" : { + "keep_days" : "7,", + "start_time" : "19:00-20:00", + "period" : "1,2" + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/backup_management/querying_backups.rst b/api-ref/source/apis_recommended/backup_management/querying_backups.rst new file mode 100644 index 0000000..2e677f2 --- /dev/null +++ b/api-ref/source/apis_recommended/backup_management/querying_backups.rst @@ -0,0 +1,212 @@ +:original_name: gaussdb_06_0004.html + +.. _gaussdb_06_0004: + +Querying Backups +================ + +Function +-------- + +This API is used to query backups according to search criteria. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/backups + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================+ + | instance_id | No | String | DB instance ID. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_id | No | String | Backup ID. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_type | No | String | Backup type. Value: | + | | | | | + | | | | **auto**: automated full backup | + | | | | | + | | | | **manual**: manual full backup | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | String | 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 | String | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | No | String | Query start time. The format is "yyyy-mm-ddThh:mm:ssZ". **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | No | String | Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+---------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +=============+=====================================================================+===============================+ + | backups | Array of :ref:`backups ` objects | Backup information. | + +-------------+---------------------------------------------------------------------+-------------------------------+ + | total_count | Long | Total number of backup files. | + +-------------+---------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_06_0004__response_backups: + +.. table:: **Table 5** backups + + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=========================================================================+============================================================================================================================================================================+ + | id | String | Backup ID. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Backup name. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | String | Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Backup status. Value: | + | | | | + | | | - **BUILDING**: Backup in progress | + | | | - **COMPLETED**: Backup completed | + | | | - **FAILED**: Backup failed | + | | | - **AVAILABLE**: Backup available | + | | | | + | | | Valid value: | + | | | | + | | | - BUILDING | + | | | - COMPLETED | + | | | - FAILED | + | | | - AVAILABLE | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | take_up_time | Integer | Backup duration in minutes. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Backup type. Value: | + | | | | + | | | - **auto**: automated full backup | + | | | - **manual**: manual full backup | + | | | | + | | | Valid value: | + | | | | + | | | - auto | + | | | - manual | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Long | Backup size in MB. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | DB instance ID. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description of the backup file. | + +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_06_0004__response_mysqldatastore: + +.. table:: **Table 6** MysqlDatastore + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================================+ + | type | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | version | String | DB version. | + | | | | + | | | To obtain details about supported DB engine versions, call the API for querying the DB engine versions. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "backups" : [ { + "id" : "c0c9f155c7b7423a9d30f0175998b63bbr01", + "name" : "GaussDBforMySQL-gauss-e747-20200705185048266", + "begin_time" : "2020-07-06T10:41:14+0800", + "end_time" : "2020-07-16T10:41:14+0800", + "take_up_time" : 2, + "status" : "COMPLETED", + "type" : "auto", + "size" : 2803, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "instance_id" : "c0c9f155c7b7423a9d30f0175998b63bbr01" + + } ], + "total_count" : 1 + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst b/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst new file mode 100644 index 0000000..4853e25 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst @@ -0,0 +1,123 @@ +:original_name: ExpandGaussMySqlProxy.html + +.. _ExpandGaussMySqlProxy: + +Adding Database Proxy Nodes +=========================== + +Function +-------- + +This API is used to add database proxy nodes. + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. +- Database proxy is unavailable for DB instances in a DeC. + +URI +--- + +POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+==============================================================================================================================================================================+ + | node_num | Yes | Integer | The number of proxy nodes to be added. The value is an integer from 1 to 30. Restrictions: The total number of proxy nodes for an instance is no more than 32. | + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxy_id | No | String | ID of the proxy instance. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, you must configure this parameter. | + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 4** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge + { + "node_num" : 2, + "proxy_id" : "151c14381ac14ecfb9703a745b992677po01" + } + +Example Response +---------------- + +**Status code: 201** + +Success. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst b/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst new file mode 100644 index 0000000..1600b44 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst @@ -0,0 +1,132 @@ +:original_name: SetGaussMySqlProxyWeight.html + +.. _SetGaussMySqlProxyWeight: + +Assigning Read Weights +====================== + +Function +-------- + +This API is used to assign read weights for nodes. Being using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/weight + +.. table:: **Table 1** URI parameters + + +-------------+-----------+--------+-------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=============================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + +-------------+-----------+--------+-------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-------------+-----------+--------+-------------------------------------------------------------+ + | proxy_id | Yes | String | Database proxy ID, which is compliant with the UUID format. | + +-------------+-----------+--------+-------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +----------------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+==================================================================================================================================================================+==========================================+ + | master_weight | No | Integer | Weight of the primary node. | + +----------------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + | readonly_nodes | No | Array of :ref:`TaurusModifyProxyWeightReadonlyNode ` objects | Weight information of the read replicas. | + +----------------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + +.. _setgaussmysqlproxyweight__en-us_topic_0000001362641517_request_taurusmodifyproxyweightreadonlynode: + +.. table:: **Table 4** TaurusModifyProxyWeightReadonlyNode + + ========= ========= ======= =========================== + Parameter Mandatory Type Description + ========= ========= ======= =========================== + id No String Read replica ID. + weight No Integer Weight of the read replica. + ========= ========= ======= =========================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight + { + "master_weight" : 100 + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87c11411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst b/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst new file mode 100644 index 0000000..b2646c4 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst @@ -0,0 +1,121 @@ +:original_name: ChangeGaussMySqlProxySpecification.html + +.. _ChangeGaussMySqlProxySpecification: + +Changing Specifications of a Database Proxy Instance +==================================================== + +Function +-------- + +This API is used to change specifications of a database proxy instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/flavor + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | proxy_id | Yes | String | Database proxy ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + ========== ========= ====== ===================== + Parameter Mandatory Type Description + ========== ========= ====== ===================== + flavor_ref Yes String ID of the new flavor. + ========== ========= ====== ===================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/flavor + { + "flavor_ref" :"gaussdb.proxy.xlarge.x86.2" + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst b/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst new file mode 100644 index 0000000..13ab39e --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst @@ -0,0 +1,120 @@ +:original_name: DeleteGaussMySqlProxy.html + +.. _DeleteGaussMySqlProxy: + +Disabling Database Proxy +======================== + +Function +-------- + +This API is used to disable database proxy. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. +- Database proxy is unavailable for DB instances in a DeC. + +URI +--- + +DELETE /v3/{project_id}/instances/{instance_id}/proxy + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------+-----------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================+=======================================================================================================================================================================+ + | proxy_ids | No | Array of strings | Proxy instance IDs. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, this parameter must be specified. | + +-----------+-----------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy + { + "proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ] + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst b/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst new file mode 100644 index 0000000..2e1d326 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst @@ -0,0 +1,155 @@ +:original_name: CreateGaussMySqlProxy.html + +.. _CreateGaussMySqlProxy: + +Enabling Database Proxy +======================= + +Function +-------- + +This API is used to enable database proxy in ELB mode. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. +- Database proxy is unavailable for DB instances in a DeC. + +URI +--- + +POST /v3/{project_id}/instances/{instance_id}/proxy + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===================+=================+==================================================================================+==============================================================================================================================================================================================================================================================+ + | flavor_ref | Yes | String | Proxy specification code. | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_num | Yes | Integer | Number of proxy instance nodes. The value is an integer from 2 to 32. | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxy_name | No | String | Proxy instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxy_mode | No | String | Proxy instance type. The default type is **readwrite**. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - **readwrite** | + | | | | - **readonly** | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodes_read_weight | No | Array of :ref:`NodesWeight ` objects | Read weight of the node. | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _creategaussmysqlproxy__request_nodesweight: + +.. table:: **Table 4** NodesWeight + + +-----------+-----------+---------+--------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+========================================================+ + | id | No | String | Node ID. | + +-----------+-----------+---------+--------------------------------------------------------+ + | weight | No | Integer | Weight assigned to the node. Value: **0** to **1000**. | + +-----------+-----------+---------+--------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 5** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy + { + "flavor_ref" : "gaussdb.mysql.large.x86.4", + "node_num" : 2, + "proxy_name" : "gaussdb-proxy", + "proxy_mode" : "readonly", + "nodes_read_weight" : [ { + "id" : "45021bf73a244312a3f2af95092feeecno07", + "weight" : 50 + }, { + "id" : "d78a65690cea4af5ad14585e110ff89bno07", + "weight" : 400 + } ] + } + +Example Response +---------------- + +**Status code: 201** + +Success. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/index.rst b/api-ref/source/apis_recommended/database_proxy/index.rst new file mode 100644 index 0000000..8b9e7d9 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/index.rst @@ -0,0 +1,26 @@ +:original_name: topic_300000006.html + +.. _topic_300000006: + +Database Proxy +============== + +- :ref:`Enabling Database Proxy ` +- :ref:`Disabling Database Proxy ` +- :ref:`Querying Database Proxy Instances ` +- :ref:`Querying Database Proxy Specifications ` +- :ref:`Adding Database Proxy Nodes ` +- :ref:`Changing Specifications of a Database Proxy Instance ` +- :ref:`Assigning Read Weights ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + enabling_database_proxy + disabling_database_proxy + querying_database_proxy_instances + querying_database_proxy_specifications + adding_database_proxy_nodes + changing_specifications_of_a_database_proxy_instance + assigning_read_weights diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst new file mode 100644 index 0000000..67097d4 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst @@ -0,0 +1,283 @@ +:original_name: ShowGaussMySqlProxyList.html + +.. _ShowGaussMySqlProxyList: + +Querying Database Proxy Instances +================================= + +Function +-------- + +This API is used to query database proxy instances. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. +- Database proxy is unavailable for DB instances in a DeC. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/proxies + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=======================================================================================================================================================================================================================================+ + | 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 **10**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +------------+--------------------------------------------------------------------------------------------------------------------------------------------+------------------+ + | Parameter | Type | Description | + +============+============================================================================================================================================+==================+ + | proxy_list | Array of :ref:`MysqlShowProxyResponseV3 ` objects | Proxy instances. | + +------------+--------------------------------------------------------------------------------------------------------------------------------------------+------------------+ + +.. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlshowproxyresponsev3: + +.. table:: **Table 5** MysqlShowProxyResponseV3 + + +----------------+----------------------------------------------------------------------------------------------------------------------------+-----------------------------+ + | Parameter | Type | Description | + +================+============================================================================================================================+=============================+ + | proxy | :ref:`MysqlProxyV3 ` object | Proxy instance information. | + +----------------+----------------------------------------------------------------------------------------------------------------------------+-----------------------------+ + | master_node | :ref:`MysqlProxyNodeV3 ` object | Primary node information. | + +----------------+----------------------------------------------------------------------------------------------------------------------------+-----------------------------+ + | readonly_nodes | Array of :ref:`MysqlProxyNodeV3 ` objects | Read replica information. | + +----------------+----------------------------------------------------------------------------------------------------------------------------+-----------------------------+ + +.. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlproxyv3: + +.. table:: **Table 6** MysqlProxyV3 + + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============================+==========================================================================================================================+====================================================================================================+ + | pool_id | String | Proxy instance ID. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | status | String | Operating status of the proxy instance. It can be either of the following: | + | | | | + | | | - **ACTIVE**: The database proxy is normal. | + | | | - **FAILED**: The database proxy fails to be created. | + | | | - **DELETED**: The database proxy is deleted. | + | | | - **ABNORMAL**: The database proxy is abnormal. | + | | | - **ENABLING PROXY**: The database proxy is being enabled. | + | | | - **DISABLING PROXY**: The database proxy is being disabled. | + | | | - **ADDING PROXY NODE**: Nodes are being added to the database proxy. | + | | | - **DELETING READ REPLICAS FROM PROXY**: Read replicas are being removed from the database proxy. | + | | | - **ADDING READ REPLICAS TO PROXY**: Read replicas are being added to the database proxy. | + | | | - **CHANGING WEIGHT**: The weights of read replicas for the database proxy are being changed. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | address | String | Proxy read/write splitting address. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | port | Integer | Proxy port information. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | pool_status | String | Proxy instance status. Value: **ACTIVE**, **ABNORMAL**, **FAILED**, or **DELETED**. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | delay_threshold_in_seconds | Integer | Delay threshold in seconds. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | elb_vip | String | Virtual IP address in ELB mode. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | eip | String | EIP information. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | vcpus | String | Number of vCPUs of the proxy instance. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | ram | String | Memory size of the proxy instance. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | node_num | Integer | Number of proxy nodes. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | mode | String | Primary/standby proxy. The value is **Cluster**. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | nodes | Array of :ref:`MysqlProxyNodes ` objects | Proxy node information. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Proxy specifications. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | name | String | Proxy instance name. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | transaction_split | String | Whether the proxy transaction splitting is enabled. Value: **ON** or **OFF**. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlproxynodes: + +.. table:: **Table 7** MysqlProxyNodes + + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+=========+======================================================================================================================+ + | id | String | Proxy node ID. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | status | String | Proxy node status. Value: **ACTIVE**, **ABNORMAL**, **BUILD**, or **FAILED**. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Proxy node name. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | role | String | Role of the proxy node. It can be **master** or **slave**. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | az_code | String | AZ. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | frozen_flag | Integer | Whether the proxy node is frozen. It can be **0** (unfrozen), **1** (frozen), or **2** (deleted after being frozen). | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ + +.. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlproxynodev3: + +.. table:: **Table 8** MysqlProxyNodeV3 + + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +===================+==================================================================================================================================+==========================+ + | id | String | Node ID. | + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + | instance_id | String | DB instance ID. | + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + | status | String | Node status. | + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + | name | String | Node name. | + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + | weight | Integer | Read weight of the node. | + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + | availability_zone | Array of :ref:`MysqlProxyAvailable ` objects | AZ information. | + +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ + +.. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlproxyavailable: + +.. table:: **Table 9** MysqlProxyAvailable + + =========== ====== =============== + Parameter Type Description + =========== ====== =============== + code String AZ code. + description String AZ description. + =========== ====== =============== + +**Status code: 400** + +.. table:: **Table 10** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxies?offset=0&limit=10 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "proxy_list" : [ { + "proxy" : { + "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01", + "status" : "ACTIVE", + "address" : "192.168.125.69", + "port" : 3306, + "pool_status" : "ACTIVE", + "delay_threshold_in_seconds" : 30, + "elb_vip" : "192.168.125.60", + "eip" : "192.168.125.50", + "vcpus" : 4, + "ram" : 8, + "node_num" : 2, + "mode" : "Cluster", + "nodes" : [ { + "id" : "db53a238a02240c49365e72e284a4890pn01", + "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0", + "role" : "master", + "az_code" : "az1", + "status" : "ACTIVE", + "frozen_flag" : 0 + } ], + "name" : "proxy-name", + "flavor_ref":"gaussdb.proxy.large.x86.2", + "transaction_split":"OFF" + }, + "master_node" : { + "id" : "c01a5645eb2c4fb6a9373542f5366e50no07", + "instance_id" : "096c0fc43e804757b59946b80dc27f8bin07", + "status" : "ACTIVE", + "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", + "weight" : 0, + "availability_zone" : [{ + "code" : "az1", + "description": "AZ1" + }] + }, + "readonly_nodes" : { + "id" : "d23535333138462880bfa1838fdfced2no07", + "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", + "status" : "ACTIVE", + "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02", + "weight" : 100, + "availability_zone" : [{ + "code" : "az1", + "description": "AZ1" + }] + } + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst new file mode 100644 index 0000000..a4f4cb1 --- /dev/null +++ b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst @@ -0,0 +1,154 @@ +:original_name: ShowGaussMySqlProxyFlavors.html + +.. _ShowGaussMySqlProxyFlavors: + +Querying Database Proxy Specifications +====================================== + +Function +-------- + +This API is used to query database proxy specifications. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. +- Database proxy is unavailable for DB instances in a DeC. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/proxy/flavors + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +---------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------+ + | Parameter | Type | Description | + +=====================+==============================================================================================================+==================================+ + | proxy_flavor_groups | Array of :ref:`MysqlProxyFlavorGroups ` objects | Specification group information. | + +---------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------+ + +.. _showgaussmysqlproxyflavors__response_mysqlproxyflavorgroups: + +.. table:: **Table 4** MysqlProxyFlavorGroups + + +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +===============+================================================================================================================+==============================================+ + | group_type | String | Specification group type. It can be **x86**. | + +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | proxy_flavors | Array of :ref:`MysqlProxyComputeFlavor ` objects | Proxy specifications. | + +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _showgaussmysqlproxyflavors__response_mysqlproxycomputeflavor: + +.. table:: **Table 5** MysqlProxyComputeFlavor + + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+============================================================================================================================================================================+ + | vcpus | String | Number of vCPUs. For example, the value **1** indicates 1 vCPU. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_type | String | Database type. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Proxy specification ID. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | Proxy specification code. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_status | Object | AZ status. **key** indicates the AZ ID and **value** indicates the status of the AZ where the proxy specifications reside. The value can be **normal** or **unsupported**. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy/flavors + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "proxy_flavor_groups" : { + "group_type" : "X86", + "proxy_flavors" : { + "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe", + "spec_code" : "gaussdb.proxy.large.x86.2", + "vcpus" : 2, + "ram" : 4, + "db_type" : "Proxy", + "az_status" : { + "az1" : "normal" + }, + "region_status" : "normal" + } + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/index.rst b/api-ref/source/apis_recommended/index.rst new file mode 100644 index 0000000..f93a766 --- /dev/null +++ b/api-ref/source/apis_recommended/index.rst @@ -0,0 +1,34 @@ +:original_name: gaussdb_04_0000.html + +.. _gaussdb_04_0000: + +APIs (Recommended) +================== + +- :ref:`Querying Version Information About a DB Engine ` +- :ref:`Querying Database Specifications ` +- :ref:`Managing DB Instances ` +- :ref:`Backup Management ` +- :ref:`Parameter Template Management ` +- :ref:`Quota Management ` +- :ref:`Database Proxy ` +- :ref:`Log Management ` +- :ref:`Tag Management ` +- :ref:`SQL Statement Concurrency Control ` +- :ref:`Task Center ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_version_information_about_a_db_engine + querying_database_specifications + managing_db_instances/index + backup_management/index + parameter_template_management/index + quota_management/index + database_proxy/index + log_management/index + tag_management/index + sql_statement_concurrency_control/index + task_center/index diff --git a/api-ref/source/apis_recommended/log_management/index.rst b/api-ref/source/apis_recommended/log_management/index.rst new file mode 100644 index 0000000..24ddd34 --- /dev/null +++ b/api-ref/source/apis_recommended/log_management/index.rst @@ -0,0 +1,16 @@ +:original_name: topic_300000007.html + +.. _topic_300000007: + +Log Management +============== + +- :ref:`Querying Database Error Logs ` +- :ref:`Querying Database Slow Logs ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_database_error_logs + querying_database_slow_logs diff --git a/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst b/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst new file mode 100644 index 0000000..d51bb09 --- /dev/null +++ b/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst @@ -0,0 +1,170 @@ +:original_name: ListGaussMySqlErrorLog.html + +.. _ListGaussMySqlErrorLog: + +Querying Database Error Logs +============================ + +Function +-------- + +This API is used to query database error logs. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date}&node_id={node_id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================+ + | start_date | Yes | String | Start time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | | + | | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_date | Yes | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | | + | | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | | + | | | | Only error logs generated within the last month can be queried. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | level | No | String | Log level. The default value is **ALL**. Valid value: | + | | | | | + | | | | - ALL | + | | | | - INFO | + | | | | - WARNING | + | | | | - ERROR | + | | | | - FATAL | + | | | | - NOTE | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_id | Yes | String | Node ID. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +----------------+------------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +================+================================================================================================+==========================+ + | error_log_list | Array of :ref:`MysqlErrorLogList ` objects | Error log details. | + +----------------+------------------------------------------------------------------------------------------------+--------------------------+ + | total_record | Integer | Total number of records. | + +----------------+------------------------------------------------------------------------------------------------+--------------------------+ + +.. _listgaussmysqlerrorlog__response_mysqlerrorloglist: + +.. table:: **Table 5** MysqlErrorLogList + + +-----------------------+-----------------------+-------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================+ + | node_id | String | Node ID. | + +-----------------------+-----------------------+-------------------------+ + | time | String | Time in the UTC format. | + +-----------------------+-----------------------+-------------------------+ + | level | String | Log level. | + | | | | + | | | - ALL | + | | | - INFO | + | | | - WARNING | + | | | - ERROR | + | | | - FATAL | + | | | - NOTE | + +-----------------------+-----------------------+-------------------------+ + | content | String | Error log content. | + +-----------------------+-----------------------+-------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/errorlog?offset=0&limit=1&level=ERROR&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "error_log_list" : [ { + "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", + "time" : "2022-07-17T07:34:33", + "level" : "ERROR", + "content" : "[MY013508] [Repl] do failed: 1" + } ], + "total_record":1 + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst b/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst new file mode 100644 index 0000000..e0c4338 --- /dev/null +++ b/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst @@ -0,0 +1,181 @@ +:original_name: ListGaussMySqlSlowLog.html + +.. _ListGaussMySqlSlowLog: + +Querying Database Slow Logs +=========================== + +Function +-------- + +This API is used to query database slow logs. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date}&node_id={node_id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================+ + | start_date | Yes | String | Start time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | | + | | | | **T** is the separator between calendar and hourly notation of time. **Z** indicates the time zone offset. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_date | Yes | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | | + | | | | **T** is the separator between calendar and hourly notation of time. **Z** indicates the time zone offset. | + | | | | | + | | | | Only error logs generated within the last month can be queried. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | String | Statement type. The default value **All**. If this parameter is left empty, all statement types are queried. Valid value: | + | | | | | + | | | | - ALL | + | | | | - INSERT | + | | | | - UPDATE | + | | | | - SELECT | + | | | | - DELETE | + | | | | - CREATE | + | | | | - DROP | + | | | | - ALTER | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_id | Yes | String | Node ID. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------------+---------------------------------------------------------------------------------------------+---------------------------+ + | Parameter | Type | Description | + +=================+=============================================================================================+===========================+ + | slow_log_list | Array of :ref:`MysqlSlowLogList ` objects | Error log details. | + +-----------------+---------------------------------------------------------------------------------------------+---------------------------+ + | long_query_time | String | Slow query log threshold. | + +-----------------+---------------------------------------------------------------------------------------------+---------------------------+ + | total_record | Integer | Total number of records. | + +-----------------+---------------------------------------------------------------------------------------------+---------------------------+ + +.. _listgaussmysqlslowlog__response_mysqlslowloglist: + +.. table:: **Table 5** MysqlSlowLogList + + ============= ====== =================================== + Parameter Type Description + ============= ====== =================================== + node_id String Node ID. + count String Number of executions. + time String Execution time. + lock_time String Lock wait time. + rows_sent String Number of sent rows. + rows_examined String Number of scanned rows. + database String Database which slow logs belong to. + users String Account. + query_sample String Execution syntax. + type String Statement type. + start_time String Start time in the UTC format. + client_ip String IP address. + ============= ====== =================================== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/slowlog?offset=0&limit=1&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07&type=INSERT + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "slow_log_list" : [ { + "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", + "count" : 1, + "time" : "1.04899 s", + "lock_time" : "0.00003 s", + "rows_sent" : 0, + "rows_examined" : 0, + "database" : "gaussdb-mysql", + "users" : "root", + "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", + "type" : "INSERT", + "start_time" : "2022-07-11T00:00:00+0800", + "client_ip" : "192.*.*.1" + } ], + "long_query_time" : 10, + "total_record" : 1 + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst new file mode 100644 index 0000000..70a91cd --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst @@ -0,0 +1,121 @@ +:original_name: gaussdb_04_0018.html + +.. _gaussdb_04_0018: + +Changing a DB Instance Name +=========================== + +Function +-------- + +This API is used to change a DB instance name. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/instances/{instance_id}/name + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+===========================================================================================================================================================================================================================================================+ + | name | Yes | String | DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + ========= ====== ======================================== + Parameter Type Description + ========= ====== ======================================== + job_id String Task ID for changing a DB instance name. + ========= ====== ======================================== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Changing a DB Instance Name + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name + { + "name" : "gaussdb-name" + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst new file mode 100644 index 0000000..c27ddbd --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst @@ -0,0 +1,133 @@ +:original_name: gaussdb_04_0020.html + +.. _gaussdb_04_0020: + +Changing DB Instance Specifications +=================================== + +Function +-------- + +This API is used to change DB instance specifications. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/instances/{instance_id}/action + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +---------------+-----------+------------------------------------------------------------------------------+-----------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+==============================================================================+===================================+ + | resize_flavor | Yes | :ref:`MysqlResizeFlavor ` object | Specification change information. | + +---------------+-----------+------------------------------------------------------------------------------+-----------------------------------+ + +.. _gaussdb_04_0020__request_mysqlresizeflavor: + +.. table:: **Table 4** MysqlResizeFlavor + + ========= ========= ====== =================== + Parameter Mandatory Type Description + ========= ========= ====== =================== + spec_code Yes String Specification code. + ========= ========= ====== =================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + ========= ====== =============================================== + Parameter Type Description + ========= ====== =============================================== + job_id String Job ID for changing DB instance specifications. + ========= ====== =============================================== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Changing instance specifications + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action + { + "resize_flavor" : { + "spec_code" : "gaussdb.mysql.xlarge.arm.8" + } + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst new file mode 100644 index 0000000..63cd326 --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst @@ -0,0 +1,131 @@ +:original_name: UpdateInstanceMonitor.html + +.. _UpdateInstanceMonitor: + +Changing the Collection Period of Monitoring by Seconds +======================================================= + +Function +-------- + +This API is used to enable and disable Monitoring by Seconds, and change its collection period. Before calling this API, you can: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/instances/{instance_id}/monitor-policy + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================================================================================================================================+ + | monitor_switch | Yes | Boolean | Whether to enable Monitoring by Seconds. **true** indicates that the function is enabled, and **false** indicates that the function is disabled. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period | No | Integer | Collection period. This parameter is available only when **monitor_switch** is set to **true**. The default value is **5s**. This parameter is not displayed when **monitor_switch** is set to **false**. | + | | | | | + | | | | **1**: indicates that the collection period is 1s. **5**: indicates that the collection period is 5s. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - **1** | + | | | | - **5** | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + ========= ====== =============================================== + Parameter Type Description + ========= ====== =============================================== + job_id String Taskflow ID for modifying Monitoring by Seconds + ========= ====== =============================================== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Modifying the collection period of Monitoring by Seconds for an instance. The current collection period to 1s. + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy + { + "monitor_switch" : true, + "period" : 1 + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "6b7dd5d4-4590-4f14-b164-a8737ce071d5" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst new file mode 100644 index 0000000..59ed61b --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst @@ -0,0 +1,383 @@ +:original_name: gaussdb_04_0004.html + +.. _gaussdb_04_0004: + +Creating a DB Instance +====================== + +Function +-------- + +This API is used to create a GaussDB(for MySQL) instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/instances + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+=================+==================================================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | charge_info | No | :ref:`MysqlChargeInfo ` object | Billing mode. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | Yes | String | Region ID. | + | | | | | + | | | | The value cannot be empty. To obtain this value, see `Regions and Endpoints `__. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | DB instance name. | + | | | | | + | | | | DB instances of the same type can have same names under the same tenant. | + | | | | | + | | | | The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | Yes | :ref:`MysqlDatastore ` object | Database information. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | Yes | String | DB instance type. Its value is **Cluster**. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | Yes | String | Specification code. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | VPC ID. To obtain this value, use either of the following methods: | + | | | | | + | | | | - Method 1: Log in to the VPC console and view the VPC ID on the VPC details page. | + | | | | - Method 2: See "Querying VPCs" in the *Virtual Private Cloud API Reference*. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | Yes | String | Network ID. To obtain this value, use either of the following methods: | + | | | | | + | | | | - Method 1: Log in to the VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | + | | | | - Method 2: See "Querying Subnets" in the *Virtual Private Cloud API Reference*. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | No | String | Security group ID. | + | | | | | + | | | | If network ACL is enabled, this parameter cannot be specified. If network ACL is disabled, this parameter is mandatory. | + | | | | | + | | | | - Method 1: Log in to VPC console. Choose **Access Control** > **Security Groups** in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page. | + | | | | - Method 2: See "Querying Security Groups" in the *Virtual Private Cloud API Reference*. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | No | String | Parameter template ID. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | password | Yes | String | Database password. The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (``~!@#$%^*-_=+?,()&``). You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | No | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | No | String | Time zone. The default time zone is UTC. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | Yes | String | AZ type. The value can be **single** or **multi**. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_availability_zone | No | String | Primary AZ. | + | | | | | + | | | | - If **availability_zone_mode** is set to **multi**, this parameter is mandatory. | + | | | | - If **availability_zone_mode** is set to **single**, this parameter cannot be specified. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | slave_count | Yes | Integer | Number of read replicas. A maximum of nine read replicas can be created at a time. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`MysqlTags ` objects | Tag list. DB instances are created based on tag keys and values. | + | | | | | + | | | | - *{key}* indicates the tag key. It must be unique and cannot be empty. | + | | | | - *{value}* indicates the tag value, which can be empty. | + | | | | | + | | | | To create DB instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory when the enterprise project is enabled. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | No | String | Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled. | + +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0004__request_mysqlchargeinfo: + +.. table:: **Table 4** MysqlChargeInfo + + +-----------------+-----------------+-----------------+---------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================+ + | charge_mode | Yes | String | Billing mode. | + | | | | | + | | | | Value: **postPaid** | + +-----------------+-----------------+-----------------+---------------------+ + +.. _gaussdb_04_0004__request_mysqldatastore: + +.. table:: **Table 5** MysqlDatastore + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================+ + | type | Yes | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | version | Yes | String | DB version. | + | | | | | + | | | | For details about supported DB versions, see :ref:`Querying Version Information About a DB Engine `. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0004__request_mysqlbackupstrategy: + +.. table:: **Table 6** MysqlBackupStrategy + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================================+ + | start_time | Yes | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + | | | | | + | | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | | + | | | | - The **HH** value must be 1 greater than the **hh** value. | + | | | | - The values of **mm** and **MM** must be the same and must be set to **00**. | + | | | | | + | | | | Example value: | + | | | | | + | | | | - 21:00-22:00 | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | No | String | Automated backup retention days. Value: 1-732. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0004__request_mysqltags: + +.. table:: **Table 7** MysqlTags + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===============================================================================================================+ + | key | Yes | String | Tag key. It contains a maximum of 36 Unicode characters. | + | | | | | + | | | | The value cannot be an empty string, a space, or left blank. | + | | | | | + | | | | Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + | value | Yes | String | Tag value. It contains a maximum of 43 Unicode characters. | + | | | | | + | | | | It can be an empty string. | + | | | | | + | | | | Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 8** Response body parameters + + +-----------+---------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================+===============================+ + | instance | :ref:`MysqlInstanceResponse ` object | DB instance information. | + +-----------+---------------------------------------------------------------------------------------+-------------------------------+ + | job_id | String | DB instance creation task ID. | + +-----------+---------------------------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_04_0004__response_mysqlinstanceresponse: + +.. table:: **Table 9** MysqlInstanceResponse + + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+===================================================================================+==========================================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | String | DB instance type. Its value is **Cluster**. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | Parameter template ID. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | String | Region ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | String | AZ mode, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_availability_zone | String | Primary AZ ID. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`MysqlChargeInfo ` object | Billing mode. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0004__response_mysqldatastore: + +.. table:: **Table 10** MysqlDatastore + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================================+ + | type | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | version | String | DB version. | + | | | | + | | | To obtain details about supported DB engine versions, call the API for querying the DB engine versions. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0004__response_mysqlbackupstrategy: + +.. table:: **Table 11** MysqlBackupStrategy + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================+ + | start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + | | | | + | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | + | | | #. The **HH** value must be 1 greater than the **hh** value. | + | | | #. The values of **mm** and **MM** must be the same and must be set to **00**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | String | Automated backup retention days. Value: 1-732. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0004__response_mysqlchargeinfo: + +.. table:: **Table 12** MysqlChargeInfo + + =========== ====== ============= + Parameter Type Description + =========== ====== ============= + charge_mode String Billing mode. + =========== ====== ============= + +**Status code: 400** + +.. table:: **Table 13** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 14** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. note:: + + The value of **region** is used as an example. + +Creating a DB instance + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances + { + "name" : "gaussdb-mysql-instance1", + "region" : "br-iaas-odin1", + "charge_info" : { + "charge_mode" : "postPaid" + }, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "mode" : "Cluster", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", + "password" : "xxxxxx", + "backup_strategy" : { + "start_time" : "08:00-09:00" + }, + "availability_zone_mode" : "single", + "slave_count" : 1, + "enterprise_project_id" : 0 + } + +Example Response +---------------- + +**Status code: 201** + +.. note:: + + The values of **region** and **master_availability_zone** are used as examples. + +Success. + +.. code-block:: + + { + "instance" : { + "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07", + "name" : "gaussdb-mysql-instance1", + "region" : "br-iaas-odin1", + "charge_info" : { + "charge_mode" : "postPaid" + }, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "mode" : "Cluster", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", + "backup_strategy" : { + "start_time" : "08:00-09:00", + "keep_days" : 7 + }, + "availability_zone_mode" : "single", + "slave_count" : 1 + }, + "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst b/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst new file mode 100644 index 0000000..70acdc7 --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst @@ -0,0 +1,129 @@ +:original_name: gaussdb_04_0015.html + +.. _gaussdb_04_0015: + +Creating a Read Replica +======================= + +Function +-------- + +This API is used to create a read replica. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +------------+-----------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+===================+======================================================================================================================================================================================================================================================================================================================================================+ + | priorities | Yes | Array of integers | Failover priority of a read replica. Failover priority ranges from 1 for the first priority to 16 for the last priority. This priority determines the order in which read replicas are promoted when recovering from a primary node failure. Read replicas with the same priority have a same probability of being promoted to the new primary node. | + +------------+-----------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================================+ + | instance_id | String | DB instance ID. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | node_names | Array of strings | Node name list | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | job_id | String | Read replica creation task ID. | + | | | | + | | | This parameter is returned only when a pay-per-use read replica is created. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Creating a read replica + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge + { + "priorities" : [ 1, 2 ] + } + +Example Response +---------------- + +**Status code: 201** + +Success. + +.. code-block:: + + { + "instance_id" : "ba62a0b83a1b42bfab275829d86ac0fdin07", + "node_names" : [ "gauss-ccf5_node03" ], + "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst new file mode 100644 index 0000000..f29d1de --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst @@ -0,0 +1,108 @@ +:original_name: gaussdb_04_0007.html + +.. _gaussdb_04_0007: + +Deleting a DB Instance +====================== + +Function +-------- + +This API is used to delete a DB instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +DELETE /v3/{project_id}/instances/{instance_id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07 + +Example Response +---------------- + +**Status code: 500** + +Server error. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst new file mode 100644 index 0000000..3e67b9b --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst @@ -0,0 +1,110 @@ +:original_name: gaussdb_04_0016.html + +.. _gaussdb_04_0016: + +Deleting a Read Replica +======================= + +Function +-------- + +This API is used to delete a read replica. For multi-AZ deployment, the primary node and remaining read replicas must be located in different AZs after read replicas are deleted. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +DELETE /v3/{project_id}/instances/{instance_id}/nodes/{node_id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | node_id | Yes | String | Node ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + job_id String Task ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/nodes/096c0fc43e804757b59946b80dc27f8bin07 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/index.rst b/api-ref/source/apis_recommended/managing_db_instances/index.rst new file mode 100644 index 0000000..5801d8b --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/index.rst @@ -0,0 +1,34 @@ +:original_name: gaussdb_04_0003.html + +.. _gaussdb_04_0003: + +Managing DB Instances +===================== + +- :ref:`Creating a DB Instance ` +- :ref:`Querying DB Instances ` +- :ref:`Deleting a DB Instance ` +- :ref:`Querying Details of a DB Instance ` +- :ref:`Creating a Read Replica ` +- :ref:`Deleting a Read Replica ` +- :ref:`Changing a DB Instance Name ` +- :ref:`Resetting a Database Password ` +- :ref:`Changing DB Instance Specifications ` +- :ref:`Changing the Collection Period of Monitoring by Seconds ` +- :ref:`Querying the Collection Period of Monitoring by Seconds ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_db_instance + querying_db_instances + deleting_a_db_instance + querying_details_of_a_db_instance + creating_a_read_replica + deleting_a_read_replica + changing_a_db_instance_name + resetting_a_database_password + changing_db_instance_specifications + changing_the_collection_period_of_monitoring_by_seconds + querying_the_collection_period_of_monitoring_by_seconds diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst new file mode 100644 index 0000000..3fad33b --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst @@ -0,0 +1,306 @@ +:original_name: gaussdb_04_0005.html + +.. _gaussdb_04_0005: + +Querying DB Instances +===================== + +Function +-------- + +This API is used to query DB instances according to search criteria. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 (``*``). | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | VPC ID. | + | | | | | + | | | | - Method 1: Log in to VPC console and view the VPC ID in the VPC details. | + | | | | - Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | No | String | Network ID of the subnet. | + | | | | | + | | | | - 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*. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ip | No | String | Private IP address. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+-------------------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +=============+=================================================================================================+===============================+ + | instances | Array of :ref:`MysqlInstanceListInfo ` objects | DB instance list information. | + +-------------+-------------------------------------------------------------------------------------------------+-------------------------------+ + | total_count | Integer | Total number of records. | + +-------------+-------------------------------------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_04_0005__response_mysqlinstancelistinfo: + +.. table:: **Table 5** MysqlInstanceListInfo + + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================+========================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ips | Array of strings | Private IP address for write. It is a blank string until an ECS is created. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ips | Array of strings | Public IP addresses. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | DB instance type. The value is **Cluster**. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | String | Region where the DB instance is deployed. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_info | :ref:`MysqlFlavorInfo ` object | Flavor information. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | volume | :ref:`MysqlVolumeInfo ` object | Storage disk information. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`InstanceTagItem ` objects | Tag list. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0005__response_mysqldatastore: + +.. table:: **Table 6** MysqlDatastoreWithKernelVersion + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================================+ + | type | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | version | String | DB version. | + | | | | + | | | To obtain details about supported DB engine versions, call the API for querying the DB engine versions. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | kernel_version | String | Database kernel version. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0005__response_mysqlflavorinfo: + +.. table:: **Table 7** MysqlFlavorInfo + + ========= ====== ================== + Parameter Type Description + ========= ====== ================== + vcpus String Number of vCPUs. + ram String Memory size in GB. + ========= ====== ================== + +.. _gaussdb_04_0005__response_mysqlvolumeinfo: + +.. table:: **Table 8** MysqlVolumeInfo + + ========= ====== ===================== + Parameter Type Description + ========= ====== ===================== + type String Disk type. + size String Used disk size in GB. + ========= ====== ===================== + +.. _gaussdb_04_0005__response_mysqlbackupstrategy: + +.. table:: **Table 9** MysqlBackupStrategy + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================+ + | start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + | | | | + | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | + | | | #. The **HH** value must be 1 greater than the **hh** value. | + | | | #. The values of **mm** and **MM** must be the same and must be set to **00**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | String | Automated backup retention days. Value: 1-732. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0005__response_instancetagitem: + +.. table:: **Table 10** InstanceTagItem + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + key String Tag key. + value String Tag value. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 11** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 12** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying DB instances + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances?id=d738399de028480fabb2b8120d4e01a4in07&name=gaussdb-mysql-instance01&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=3cedfc54-b105-4652-a4e0-847b11576b58&subnet_id=c1cfa53c-65d3-431e-8552-326bf310c7ad&private_ip=192.168.0.142&offset=0&limit=10&tags=Key1=Value1 + +Example Response +---------------- + +**Status code: 200** + +.. note:: + + The value of **region** is used as an example in the following response. + +Success. + +.. code-block:: + + { + "total_count" : 1, + "instances" : [ { + "id" : "d738399de028480fabb2b8120d4e01a4in07", + "name" : "gaussdb-mysql-instance01", + "status" : "ACTIVE", + "port" : 3306, + "type" : "Cluster", + "private_ips" : [ "192.168.0.142" ], + "db_user_name" : "root", + "region" : "aaa", + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0", + "kernel_version" : "2.0.28.7" + }, + "created" : "2018-08-20T02:33:49_0800", + "updated" : "2018-08-20T02:33:49_0800", + "volume" : { + "type" : "POOL", + "size" : 100 + }, + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "flavor_info" : { + "vcpus" : 8, + "ram" : 64 + }, + "backup_strategy" : { + "start_time" : "19:00-20:00", + "keep_days" : 7 + }, + "charge_info" : { + "charge_mode" : "postPaid" + }, + "enterprise_project_id" : 0, + "time_zone" : "UTC", + "tags": [{ + "key":"Key", + "value":"Value1" + }] + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst new file mode 100644 index 0000000..2dba82e --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst @@ -0,0 +1,421 @@ +:original_name: gaussdb_04_0006.html + +.. _gaussdb_04_0006: + +Querying Details of a DB Instance +================================= + +Function +-------- + +This API is used to query the details of a specified DB instance. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+-------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +===========+===========================================================================================+==========================+ + | instance | :ref:`MysqlInstanceInfoDetail ` object | DB instance information. | + +-----------+-------------------------------------------------------------------------------------------+--------------------------+ + +.. _gaussdb_04_0006__response_mysqlinstanceinfodetail: + +.. table:: **Table 4** MysqlInstanceInfoDetail + + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=================================================================================================+========================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of a tenant in a region. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + | | | | + | | | Valid value: | + | | | | + | | | If the value is **BUILD**, the DB instance is being created. | + | | | | + | | | If the value is **ACTIVE**, the DB instance is normal. | + | | | | + | | | If the value is **FAILED**, the DB instance is abnormal. | + | | | | + | | | If the value is **FROZEN**, the DB instance is frozen. | + | | | | + | | | If the value is **MODIFYING**, the DB instance is being scaled up. | + | | | | + | | | If the value is **REBOOTING**, the DB instance is being rebooted. | + | | | | + | | | If the value is **RESTORING**, the DB instance is being restored. | + | | | | + | | | If the value is **MODIFYING INSTANCE TYPE**, the DB instance is changing from primary to standby. | + | | | | + | | | If the value is **SWITCHOVER**, the primary/standby switchover is being performed. | + | | | | + | | | If the value is **MIGRATING**, the DB instance is being migrated. | + | | | | + | | | If the value is **BACKING UP**, the DB instance is being backed up. | + | | | | + | | | If the value is **MODIFYING DATABASE PORT**, the database port is being changed. | + | | | | + | | | If the value is **STORAGE FULL**, the DB instance storage space is full. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | DB instance remarks. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | DB instance type. The value is **Cluster**. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`MysqlInstanceChargeInfo ` object | Billing mode, which is yearly/monthly or pay-per-use (default setting). | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_count | Integer | Number of nodes. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_used_space | Double | Used backup space in GB. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_write_ips | Array of strings | Private IP address for write. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ips | String | Public IP address of the DB instance. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | ID of the parameter template used for creating a DB instance or ID of the latest parameter template that is applied to an instance. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodes | Array of :ref:`MysqlInstanceNodeInfo ` objects | Node information. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_mode | String | AZ type. It can be **single** or **multi**. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_az_code | String | Primary AZ. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintenance_window | String | Maintenance window in the UTC format. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`MysqlTags ` objects | Tags for managing DB instances. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxies | Array of :ref:`MysqlProxyInfo ` objects | Proxy information. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0006__response_mysqlinstancechargeinfo: + +.. table:: **Table 5** MysqlInstanceChargeInfo + + =========== ====== ============= + Parameter Type Description + =========== ====== ============= + charge_mode String Billing mode. + order_id String Order ID. + =========== ====== ============= + +.. _gaussdb_04_0006__response_mysqldatastore: + +.. table:: **Table 6** MysqlDatastoreWithKernelVersion + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================================+ + | type | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | version | String | DB version. | + | | | | + | | | To obtain details about supported DB engine versions, call the API for querying the DB engine versions. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0006__response_mysqlbackupstrategy: + +.. table:: **Table 7** MysqlBackupStrategy + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================+ + | start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + | | | | + | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | + | | | #. The **HH** value must be 1 greater than the **hh** value. | + | | | #. The values of **mm** and **MM** must be the same and must be set to **00**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | String | Automated backup retention days. Value: 1-732. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0006__response_mysqlinstancenodeinfo: + +.. table:: **Table 8** MysqlInstanceNodeInfo + + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================================================================================================+========================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Node name. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Node type, which can be **master** or **slave**. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Node status. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | Integer | Database port. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_read_ips | Array of strings | Private IP address for read of the node. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | volume | :ref:`MysqlInstanceNodeVolumeInfo ` object | Storage disk information. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_code | String | AZ. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_code | String | Region where the DB instance is located. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the DB instance creation is complete. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the DB instance creation is complete. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_id | String | Specification ID. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_connections | String | Maximum number of connections. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus | String | Number of vCPUs. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | need_restart | Boolean | Whether to reboot the DB instance for the parameter modifications to take effect. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | priority | Integer | Failover priority. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0006__response_mysqlinstancenodevolumeinfo: + +.. table:: **Table 9** MysqlInstanceNodeVolumeInfo + + ========= ====== ================================================= + Parameter Type Description + ========= ====== ================================================= + type String Disk type. + used String Used disk size in GB. + size Long Disk size of the yearly/monthly DB instance in GB + ========= ====== ================================================= + +.. _gaussdb_04_0006__response_mysqltags: + +.. table:: **Table 10** MysqlTags + + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==================================================================================================================================================================================================================================+ + | key | String | Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0006__response_mysqlproxyinfo: + +.. table:: **Table 11** MysqlProxyInfo + + ========= ====== =================================== + Parameter Type Description + ========= ====== =================================== + pool_id String Proxy instance ID. + name String Proxy instance name. + address String Proxy read/write splitting address. + ========= ====== =================================== + +**Status code: 400** + +.. table:: **Table 12** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 13** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying instance details + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 + +Example Response +---------------- + +**Status code: 201** + +.. note:: + + The values of **region_code** and **az_code** are used as examples. + +Success. + +.. code-block:: + + { + "instance" : { + "id" : "436aaafb689c4250a9a5bb33cb271e8cin07", + "name" : "gaussdb-mysql-instance01", + "alias" : "", + "status" : "ACTIVE", + "project_id" : "97b026aa9cc4417888c14c84a1ad9860", + "enterprise_project_id" : 0, + "type" : "Cluster", + "charge_info" : { + "charge_mode" : "postPaid", + "order_id" : "" + }, + "node_count" : 2, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0", + "kernel_version" : "2.0.29.1" + }, + "created" : "2022-07-14T16:26:58+0800", + "updated" : "2022-07-18T14:20:33+0800", + "public_ips" : [ "10.154.219.187" ], + "private_write_ips" : [ "192.168.0.142" ], + "db_user_name" : "root", + "port" : 3306, + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "backup_strategy" : { + "start_time" : "19:00-20:00", + "keep_days" : 7 + }, + "nodes" : [ { + "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07", + "name" : "gauss-d616-lb07_node01", + "type" : "master", + "status" : "ACTIVE", + "port" : 3306, + "private_read_ips" : [ "192.168.0.163" ], + "volume" : { + "type" : "POOL", + "used" : 0.07 + }, + "az_code" : "az1", + "region_code" : "br-iaas-odin1", + "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "max_connections" : 1500, + "vcpus" : 1, + "ram" : 4, + "need_restart" : false, + "priority" : 1, + "created" : "2022-07-14T16:26:58+0800", + "updated" : "2022-07-18T09:24:18+0800" + }, { + "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07", + "name" : "gauss-d616-lb07_node02", + "type" : "slave", + "status" : "ACTIVE", + "port" : 3306, + "private_read_ips" : [ "192.168.0.162" ], + "volume" : { + "type" : "POOL", + "used" : 0.07 + }, + "az_code" : "az1", + "region_code" : "br-iaas-odin1", + "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "max_connections" : 1500, + "vcpus" : 1, + "ram" : 4, + "need_restart" : false, + "priority" : 1, + "created" : "2022-07-14T16:26:58+0800", + "updated" : "2022-07-18T09:36:18+0800" + } ], + "time_zone" : "UTC+08:00", + "backup_used_space" : 0.24, + "az_mode" : "single", + "master_az_code" : "az1", + "maintenance_window" : "18:00-22:00", + "tags" : [ ], + "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07", + "dedicated_resource_id" : "", + "proxies" : [ { + "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01", + "address" : "192.168.10.76", + "name" : "proxy-name" + } ] + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst new file mode 100644 index 0000000..8bea6d8 --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst @@ -0,0 +1,116 @@ +:original_name: ShowInstanceMonitorExtend.html + +.. _ShowInstanceMonitorExtend: + +Querying the Collection Period of Monitoring by Seconds +======================================================= + +Function +-------- + +This API is used to query the collection period of Monitoring by Seconds. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/monitor-policy + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==================================================================================================================================================+ + | monitor_switch | Boolean | Whether to enable Monitoring by Seconds. **true** indicates that the function is enabled, and **false** indicates that the function is disabled. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | period | Integer | Collection period. This parameter is returned only when **monitor_switch** is set to **true**. | + | | | | + | | | - **1**: The collection period is 1s. | + | | | - **5**: The collection period is 5s. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying the collection period of Monitoring by Seconds for an instance + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "monitor_switch" : true, + "period" : "1" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst b/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst new file mode 100644 index 0000000..4bdab7e --- /dev/null +++ b/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst @@ -0,0 +1,107 @@ +:original_name: gaussdb_04_0019.html + +.. _gaussdb_04_0019: + +Resetting a Database Password +============================= + +Function +-------- + +This API is used to reset a database password. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/instances/{instance_id}/password + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | password | Yes | String | Database password. The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (``~!@#$%^*-_=+?,()&``). You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid. | + +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Resetting a database password + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password + { + "password" : "Test_345612" + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +None + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/parameter_template_management/index.rst b/api-ref/source/apis_recommended/parameter_template_management/index.rst new file mode 100644 index 0000000..5bcee5c --- /dev/null +++ b/api-ref/source/apis_recommended/parameter_template_management/index.rst @@ -0,0 +1,14 @@ +:original_name: gaussdb_04_0008.html + +.. _gaussdb_04_0008: + +Parameter Template Management +============================= + +- :ref:`Querying Parameter Templates ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_parameter_templates diff --git a/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst b/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst new file mode 100644 index 0000000..c9b080c --- /dev/null +++ b/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst @@ -0,0 +1,168 @@ +:original_name: gaussdb_04_0009.html + +.. _gaussdb_04_0009: + +Querying Parameter Templates +============================ + +Function +-------- + +This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/configurations + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=======================================================================================================================================================================================================================================+ + | 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**. | + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +----------------+-----------------------------------------------------------------------------------------------+--------------------------------------+ + | Parameter | Type | Description | + +================+===============================================================================================+======================================+ + | configurations | Array of :ref:`ConfigurationSummary ` objects | Parameter template information. | + +----------------+-----------------------------------------------------------------------------------------------+--------------------------------------+ + | total_count | Integer | Total number of parameter templates. | + +----------------+-----------------------------------------------------------------------------------------------+--------------------------------------+ + +.. _gaussdb_04_0009__response_configurationsummary: + +.. table:: **Table 5** ConfigurationSummary + + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=======================+====================================================================================================================+ + | id | String | Parameter template ID. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Parameter template name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Parameter template description. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore_version_name | String | Engine version | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore_name | String | Engine name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | user_defined | Boolean | Whether the parameter template is a custom template. | + | | | | + | | | - **false**: The parameter template is a default template. | + | | | - **true**: The parameter template is a custom template. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/configurations + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "total_count" : 1, + "configurations" : [ { + "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", + "name" : "configuration_test", + "description" : "configuration_test", + "datastore_version_name" : "8.0", + "datastore_name" : "GaussDB(for MySQL)", + "created" : "2019-05-15T11:53:34+0000", + "updated" : "2019-05-15T11:53:34+0000", + "user_defined" : true + }, { + "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07", + "name" : "Default-GaussDBforMySQL", + "description" : "Default parameter template for GaussDBforMySQL", + "datastore_version_name" : "8.0", + "datastore_name" : "GaussDB(for MySQL)", + "created" : "2019-05-27T03:38:51+0000", + "updated" : "2019-05-27T03:38:51+0000", + "user_defined" : false + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/querying_database_specifications.rst b/api-ref/source/apis_recommended/querying_database_specifications.rst new file mode 100644 index 0000000..af8a9fa --- /dev/null +++ b/api-ref/source/apis_recommended/querying_database_specifications.rst @@ -0,0 +1,162 @@ +:original_name: gaussdb_04_0002.html + +.. _gaussdb_04_0002: + +Querying Database Specifications +================================ + +Function +-------- + +This API is used to query the database specifications of a specified DB engine version. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/flavors/{database_name}?availability_zone_mode={availability_zone_mode} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | database_name | Yes | String | DB engine. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+=================+=================+=======================================================================================================================+ + | version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine `. | + | | | | | + | | | | Currently, only MySQL 8.0 is supported. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | Yes | String | AZ mode. Its value can be **single** or **multi** and is case-insensitive. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | spec_code | No | String | Specification code. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+---------------------------------------------------------------------------------------+-----------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================+=============================+ + | flavors | Array of :ref:`MysqlFlavorsInfo ` objects | DB instance specifications. | + +-----------+---------------------------------------------------------------------------------------+-----------------------------+ + +.. _gaussdb_04_0002__response_mysqlflavorsinfo: + +.. table:: **Table 5** MysqlFlavorsInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================+ + | vcpus | String | Number of vCPUs. For example, the value **1** indicates 1 vCPU. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | type | String | Specification type. The value can be **arm**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specification ID. The value must be unique. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | Resource specification code. Its value is same as the value of **flavor_ref**. For example: gaussdb.mysql.xlarge.arm.8 | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | version_name | String | DB version number. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | instance_mode | String | DB instance type. Currently, its value can only be **Cluster**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | az_status | Map | Status of the AZ to which the DB instance specifications belong. Its value can be any of the following: | + | | | | + | | | - **normal**: on sale | + | | | - **unsupported**: not supported | + | | | - **sellout**: sold out | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.arm.8&availability_zone_mode=single + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "flavors" : [ { + "vcpus" : "4", + "ram" : "32", + "type" : "arm", + "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", + "spec_code" : "gaussdb.mysql.xlarge.arm.8", + "instance_mode" : "Cluster", + "version_name" : "8.0", + "az_status" : { + "az1" : "normal", + "az2" : "unsupported" + } + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst b/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst new file mode 100644 index 0000000..551cfa5 --- /dev/null +++ b/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst @@ -0,0 +1,123 @@ +:original_name: gaussdb_04_0001.html + +.. _gaussdb_04_0001: + +Querying Version Information About a DB Engine +============================================== + +Function +-------- + +This API is used to query the version information of a specified DB engine. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/datastores/{database_name} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------+ + | database_name | Yes | String | DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------+---------------------------------------------------------------------------------------------------+--------------+ + | Parameter | Type | Description | + +============+===================================================================================================+==============+ + | datastores | Array of :ref:`MysqlEngineVersionInfo ` objects | DB versions. | + +------------+---------------------------------------------------------------------------------------------------+--------------+ + +.. _gaussdb_04_0001__response_mysqlengineversioninfo: + +.. table:: **Table 4** MysqlEngineVersionInfo + + +-----------+--------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===============================================================================+ + | id | String | DB version ID. Its value is unique. | + +-----------+--------+-------------------------------------------------------------------------------+ + | name | String | DB version number. Only the major version number with two digits is returned. | + +-----------+--------+-------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "datastores" : [ { + "id" : "87620726-6802-46c0-9028-a8785e1f1921", + "name" : "8.0" + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst new file mode 100644 index 0000000..e56ecd4 --- /dev/null +++ b/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst @@ -0,0 +1,139 @@ +:original_name: gaussdb_04_0012.html + +.. _gaussdb_04_0012: + +Configuring Resource Quotas +=========================== + +Function +-------- + +This API is used to configure resource quotas for a specified enterprise project. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/quotas + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +------------+-----------+----------------------------------------------------------------------+--------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+======================================================================+====================================================================+ + | quota_list | Yes | Array of :ref:`setQuota ` objects | Quota details. Up to 10 quota records can be configured at a time. | + +------------+-----------+----------------------------------------------------------------------+--------------------------------------------------------------------+ + +.. _gaussdb_04_0012__request_setquota: + +.. table:: **Table 4** setQuota + + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=========================+===========+=========+=========================================================================================================================================================================================+ + | enterprise_project_id | Yes | String | Enterprise project ID. | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | Yes | String | Enterprise project name. | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_quota | Yes | Integer | Quota of the DB instance quantity. Value: **0** to **100000**. (If there are already DB instances created, this parameter value must be greater than the number of existing instances.) | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus_quota | Yes | Integer | Quota of vCPUs. Value: **0** to **2147483646**. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.) | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram_quota | Yes | Integer | Memory quota in GB. Value: **0** to **2147483646**. (If there are already DB instances created, this parameter value must be greater than the used memory size.) | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 5** Response body parameters + + +------------+-----------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +============+=======================================================================+===============================+ + | quota_list | Array of :ref:`setQuota ` objects | Configured quota information. | + +------------+-----------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_04_0012__response_setquota: + +.. table:: **Table 6** setQuota + + ======================= ======= ================================== + Parameter Type Description + ======================= ======= ================================== + enterprise_project_id String Enterprise project ID. + enterprise_project_name String Enterprise project name. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + ======================= ======= ================================== + +Example Request +--------------- + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "enterprise_project_name" : "default", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Example Response +---------------- + +**Status code: 201** + +Success. + +.. code-block:: + + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "enterprise_project_name" : "default", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/api/managing_quotas/index.rst b/api-ref/source/apis_recommended/quota_management/index.rst similarity index 68% rename from api-ref/source/api/managing_quotas/index.rst rename to api-ref/source/apis_recommended/quota_management/index.rst index 1981941..038fcae 100644 --- a/api-ref/source/api/managing_quotas/index.rst +++ b/api-ref/source/apis_recommended/quota_management/index.rst @@ -2,12 +2,13 @@ .. _gaussdb_04_0010: -Managing Quotas -=============== +Quota Management +================ - :ref:`Querying Resource Quotas ` - :ref:`Configuring Resource Quotas ` - :ref:`Modifying Resource Quotas ` +- :ref:`Querying the DB Instance Quotas of a Tenant ` .. toctree:: :maxdepth: 1 @@ -16,3 +17,4 @@ Managing Quotas querying_resource_quotas configuring_resource_quotas modifying_resource_quotas + querying_the_db_instance_quotas_of_a_tenant diff --git a/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst new file mode 100644 index 0000000..1ae9ad9 --- /dev/null +++ b/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst @@ -0,0 +1,161 @@ +:original_name: gaussdb_04_0013.html + +.. _gaussdb_04_0013: + +Modifying Resource Quotas +========================= + +Function +-------- + +This API is used to modify the resource quota of a specified enterprise project. + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/quotas + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +------------+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+======================================================================+====================================================================================================+ + | quota_list | Yes | Array of :ref:`setQuota ` objects | Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time. | + +------------+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. _gaussdb_04_0013__request_setquota: + +.. table:: **Table 4** setQuota + + +-------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=========================+===========+=========+======================================================================================================================================================================================+ + | enterprise_project_id | Yes | String | Enterprise project ID. | + +-------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | Yes | String | Enterprise project name. | + +-------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_quota | Yes | Integer | Quota of the DB instance quantity. Value: **0** to **100000**. (If there are already instances created, this parameter value must be greater than the number of existing instances.) | + +-------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus_quota | Yes | Integer | Quota of vCPUs. Value: **0** to **2147483646**. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.) | + +-------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram_quota | Yes | Integer | Memory quota in GB. Value: **0** to **2147483646**. (If there are already instances created, this parameter value must be greater than the used memory size.) | + +-------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +------------+-----------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +============+=======================================================================+===============================+ + | quota_list | Array of :ref:`setQuota ` objects | Configured quota information. | + +------------+-----------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_04_0013__response_setquota: + +.. table:: **Table 6** setQuota + + ======================= ======= ================================== + Parameter Type Description + ======================= ======= ================================== + enterprise_project_id String Enterprise project ID. + enterprise_project_name String Enterprise project name. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + ======================= ======= ================================== + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "enterprise_project_name" : "default", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "enterprise_project_name" : "default", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst new file mode 100644 index 0000000..626c043 --- /dev/null +++ b/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst @@ -0,0 +1,146 @@ +:original_name: gaussdb_04_0011.html + +.. _gaussdb_04_0011: + +Querying Resource Quotas +======================== + +Function +-------- + +This API is used to obtain the resource quotas of a specified enterprise project. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/quotas + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=========================+===========+========+=================================================================================================================================================================================================================================================================+ + | offset | No | String | 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. Value: **0** to **10000** | + +-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | String | Number of records to be queried. The default value is **10**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | + +-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | No | String | Enterprise project name. | + +-------------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+-----------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +=============+=================================================================+==========================+ + | quota_list | Array of :ref:`quota ` objects | Resource list objects. | + +-------------+-----------------------------------------------------------------+--------------------------+ + | total_count | Integer | Number of quota records. | + +-------------+-----------------------------------------------------------------+--------------------------+ + +.. _gaussdb_04_0011__response_quota: + +.. table:: **Table 5** quota + + =========================== ======= ================================== + Parameter Type Description + =========================== ======= ================================== + enterprise_project_id String Enterprise project ID. + enterprise_project_name String Enterprise project name. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + availability_instance_quota Integer Remaining quota of DB instances. + availability_vcpus_quota Integer Remaining quota of vCPUs. + availability_ram_quota Integer Remaining memory quota. + =========================== ======= ================================== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "enterprise_project_name" : "default", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40, + "availability_instance_quota" : 1, + "availability_vcpus_quota" : 4, + "availability_ram_quota" : 8 + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst b/api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst new file mode 100644 index 0000000..6f2815a --- /dev/null +++ b/api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst @@ -0,0 +1,154 @@ +:original_name: ShowGaussMySqlProjectQuotas.html + +.. _ShowGaussMySqlProjectQuotas: + +Querying the DB Instance Quotas of a Tenant +=========================================== + +Function +-------- + +This API is used to obtain the resource quotas of a specified tenant. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/project-quotas + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================+ + | type | No | String | Resource type used to filter quotas. Its value can be **instance**. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - **instance** | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+-------------------------------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================================================+====================================+ + | quotas | :ref:`project-quotas ` object | Tenant instance quota information. | + +-----------+-------------------------------------------------------------------------------------+------------------------------------+ + +.. _showgaussmysqlprojectquotas__response_project-quotas: + +.. table:: **Table 5** project-quotas + + +-----------+-----------------------------------------------------------------------------------+------------------------+ + | Parameter | Type | Description | + +===========+===================================================================================+========================+ + | resources | Array of :ref:`resource ` objects | Resource list objects. | + +-----------+-----------------------------------------------------------------------------------+------------------------+ + +.. _showgaussmysqlprojectquotas__response_resource: + +.. table:: **Table 6** resource + + +-----------------------+-----------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================+ + | type | String | Quota of a specified type. | + | | | | + | | | - **instance**: indicates the DB instance quota. | + | | | | + | | | Valid value: | + | | | | + | | | - **instance** | + +-----------------------+-----------------------+---------------------------------------------------+ + | used | Integer | Number of created resources. | + +-----------------------+-----------------------+---------------------------------------------------+ + | quota | Integer | Maximum resource quota. | + +-----------------------+-----------------------+---------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "quotas" : { + "resources" : [ { + "type" : "instance,", + "used" : "4,", + "quota" : 50 + } ] + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst new file mode 100644 index 0000000..a61e574 --- /dev/null +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst @@ -0,0 +1,196 @@ +:original_name: SetSqlFilterRule.html + +.. _SetSqlFilterRule: + +Configuring Concurrency Control Rules of SQL Statements +======================================================= + +Function +-------- + +This API is used to configure concurrency control rules of SQL statements. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +PUT /v3/{project_id}/instances/{instance_id}/sql-filter/rules + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +------------------+-----------+------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+==============================================================================================================================+========================================================+ + | sql_filter_rules | Yes | Array of :ref:`NodeSqlFilterRuleInfo ` objects | Concurrency control rules of SQL statements for nodes. | + +------------------+-----------+------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ + +.. _setsqlfilterrule__en-us_topic_0000001374871969_request_nodesqlfilterruleinfo: + +.. table:: **Table 4** NodeSqlFilterRuleInfo + + +-----------+-----------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+======================================================================================================================+=====================================================================================+ + | node_id | Yes | String | Node ID. | + +-----------+-----------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | rules | Yes | Array of :ref:`NodeSqlFilterRule ` objects | Concurrency control rules of SQL statements. The **sql_type** value must be unique. | + +-----------+-----------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + +.. _setsqlfilterrule__en-us_topic_0000001374871969_request_nodesqlfilterrule: + +.. table:: **Table 5** NodeSqlFilterRule + + +-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+====================================================================================================================================+==============================================+ + | sql_type | Yes | String | SQL statement type. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - SELECT | + | | | | - UPDATE | + | | | | - DELETE | + +-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | patterns | Yes | Array of :ref:`NodeSqlFilterRulePattern ` objects | Concurrency control rules of SQL statements. | + +-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _setsqlfilterrule__en-us_topic_0000001374871969_request_nodesqlfilterrulepattern: + +.. table:: **Table 6** NodeSqlFilterRulePattern + + +-----------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+=========+================================================================================================================================================================================================================================================================================+ + | pattern | Yes | String | A concurrency control rule of SQL statements. A rule can consist of up to 128 keywords. The keywords are separated by tildes (~), for example, **select~from~t1**. The rule cannot contain backslashes (\\), commas (,), or double tildes (~~). It cannot end with tildes (~). | + +-----------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_concurrency | Yes | Integer | Maximum number of concurrent SQL statements. Value: a non-negative integer. | + +-----------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 7** Response body parameters + + +-----------+--------+-----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=============================================================================+ + | job_id | String | ID of the task for configuring concurrency control rules of SQL statements. | + +-----------+--------+-----------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Configuring concurrency control rules of SQL statements + +.. code-block:: + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules + { + "sql_filter_rules" : [ { + "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", + "rules" : [ { + "sql_type" : "SELECT", + "patterns" : [ { + "pattern" : "select~from~t1", + "max_concurrency" : 0 + }, { + "pattern" : "select~from~t3~where~id", + "max_concurrency" : 10 + } ] + }, { + "sql_type" : "UPDATE", + "patterns" : [ { + "pattern" : "update~t3~where~id", + "max_concurrency" : 10 + } ] + } ] + }, { + "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07", + "rules" : [ { + "sql_type" : "SELECT", + "patterns" : [ { + "pattern" : "select~from~t3~where~id", + "max_concurrency" : 10 + } ] + }, { + "sql_type" : "DELETE", + "patterns" : [ { + "pattern" : "delete~t3~where~id", + "max_concurrency" : 10 + } ] + } ] + } ] + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst new file mode 100644 index 0000000..6702b08 --- /dev/null +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst @@ -0,0 +1,169 @@ +:original_name: DeleteSqlFilterRule.html + +.. _DeleteSqlFilterRule: + +Deleting Concurrency Control Rules of SQL Statements +==================================================== + +Function +-------- + +This API is used to delete concurrency control rules of SQL statements. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +DELETE /v3/{project_id}/instances/{instance_id}/sql-filter/rules + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+=============================================================================================================================================+========================================================+ + | sql_filter_rules | Yes | Array of :ref:`DeleteNodeSqlFilterRuleInfo ` objects | Concurrency control rules of SQL statements for nodes. | + +------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ + +.. _deletesqlfilterrule__en-us_topic_0000001323271972_request_deletenodesqlfilterruleinfo: + +.. table:: **Table 4** DeleteNodeSqlFilterRuleInfo + + +-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=====================================================================================================================================+==============================================+ + | node_id | Yes | String | Node ID. | + +-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | rules | Yes | Array of :ref:`DeleteNodeSqlFilterRule ` objects | Concurrency control rules of SQL statements. | + +-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _deletesqlfilterrule__en-us_topic_0000001323271972_request_deletenodesqlfilterrule: + +.. table:: **Table 5** DeleteNodeSqlFilterRule + + +-----------------+-----------------+------------------+----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+==============================================+ + | sql_type | Yes | String | SQL statement type. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - SELECT | + | | | | - UPDATE | + | | | | - DELETE | + +-----------------+-----------------+------------------+----------------------------------------------+ + | patterns | Yes | Array of strings | Concurrency control rules of SQL statements. | + +-----------------+-----------------+------------------+----------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 6** Response body parameters + + +-----------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==========================================================================+ + | job_id | String | ID of the task for deleting concurrency control rules of SQL statements. | + +-----------+--------+--------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Deleting concurrency control rules of SQL statements + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules + { + "sql_filter_rules" : [ { + "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", + "rules" : [ { + "sql_type" : "SELECT", + "patterns" : [ "select~from~t1", "select~from~t2" ] + }, { + "sql_type" : "UPDATE", + "patterns" : [ "udpate~t3~where~id" ] + } ] + }, { + "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07", + "rules" : [ { + "sql_type" : "SELECT", + "patterns" : [ "select~from~t1", "select~from~t2" ] + }, { + "sql_type" : "DELETE", + "patterns" : [ "delete~t3~where~id" ] + } ] + } ] + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst new file mode 100644 index 0000000..a6f0a54 --- /dev/null +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst @@ -0,0 +1,18 @@ +:original_name: topic_300000012.html + +.. _topic_300000012: + +SQL Statement Concurrency Control +================================= + +- :ref:`Configuring Concurrency Control Rules of SQL Statements ` +- :ref:`Querying Concurrency Control Rules of SQL Statements ` +- :ref:`Deleting Concurrency Control Rules of SQL Statements ` + +.. 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 diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst new file mode 100644 index 0000000..c2a9c1c --- /dev/null +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst @@ -0,0 +1,176 @@ +:original_name: ShowSqlFilterRule.html + +.. _ShowSqlFilterRule: + +Querying Concurrency Control Rules of SQL Statements +==================================================== + +Function +-------- + +This API is used to query concurrency control rules of SQL statements. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules?node_id={node_id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+=======================================================================================================================================================================================================+ + | node_id | Yes | String | Node ID. | + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | String | SQL statement type. The value can be **SELECT**, **UPDATE**, and **DELETE** (case-insensitive). If this parameter is not specified, concurrency control rules of all types of statements are queried. | + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +==================+================================================================================================================+==============================================+ + | node_id | String | Node ID. | + +------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | sql_filter_rules | Array of :ref:`SqlFilterRule ` objects | Concurrency control rules of SQL statements. | + +------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _showsqlfilterrule__en-us_topic_0000001323591588_response_sqlfilterrule: + +.. table:: **Table 5** SqlFilterRule + + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================================================================+==============================================+ + | sql_type | String | SQL statement type. | + | | | | + | | | Valid value: | + | | | | + | | | - SELECT | + | | | - UPDATE | + | | | - DELETE | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | patterns | Array of :ref:`SqlFilterRulePattern ` objects | Concurrency control rules of SQL statements. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _showsqlfilterrule__en-us_topic_0000001323591588_response_sqlfilterrulepattern: + +.. table:: **Table 6** SqlFilterRulePattern + + =============== ======= ============================================= + Parameter Type Description + =============== ======= ============================================= + pattern String A concurrency control rule of SQL statements. + max_concurrency Integer Maximum number of concurrent SQL statements. + =============== ======= ============================================= + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying concurrency control rules of SQL statements + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules?node_id=c01a5645eb2c4fb6a9373542f5366e50no07 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", + "sql_filter_rules" : [ { + "sql_type" : "SELECT", + "patterns" : [ { + "pattern" : "select~from~t1", + "max_concurrency" : 0 + }, { + "pattern" : "select~from~t2~where~id", + "max_concurrency" : 10 + } ] + }, { + "sql_type" : "UDPATE", + "patterns" : [ { + "pattern" : "update~t1", + "max_concurrency" : 0 + }, { + "pattern" : "update~t2~where~id", + "max_concurrency" : 10 + } ] + }, { + "sql_type" : "DELETE", + "patterns" : [ { + "pattern" : "delete~from", + "max_concurrency" : 0 + } ] + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst b/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst new file mode 100644 index 0000000..e6ec89f --- /dev/null +++ b/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst @@ -0,0 +1,149 @@ +:original_name: BatchTagAction.html + +.. _BatchTagAction: + +Adding or Deleting Tags in Batches +================================== + +Function +-------- + +This API is used to add tags to or delete tags from a specified DB instance in batches. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +POST /v3/{project_id}/instances/{instance_id}/tags/action + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------------+------------------------------------------------------------------------------------------------+-----------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+================================================================================================+=================+ + | action | Yes | String | Action. Value: | + | | | | | + | | | | - **create** | + | | | | - **delete** | + +-----------------+-----------------+------------------------------------------------------------------------------------------------+-----------------+ + | tags | Yes | Array of :ref:`TagItem ` objects | Tag list. | + +-----------------+-----------------+------------------------------------------------------------------------------------------------+-----------------+ + +.. _batchtagaction__en-us_topic_0000001200000942_request_tagitem: + +.. table:: **Table 4** TagItem + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================================================================================================================================================+ + | key | Yes | String | Tag key. It contains a maximum of 36 Unicode characters and cannot be null, an empty string, or a space. Only digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-) are allowed. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value | No | String | Tag value. It contains a maximum of 43 Unicode characters. It can be an empty string but cannot be a space. Only digits, uppercase letters, lowercase letters, underscores (_), periods (.), and hyphens (-) are allowed. | + | | | | | + | | | | - If **action** is set to **create**, this parameter is mandatory. | + | | | | - If **action** is set to **delete** and **value** is specified, tags are deleted by key and value. If **value** is not specified, tags are deleted by key. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +- Adding tags + + .. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action + { + "action" : "create", + "tags" : [ { + "key" : "key1", + "value" : "value1" + }, { + "key" : "key2", + "value" : "value2" + } ] + } + +- Deleting tags + + .. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action + { + "action" : "delete", + "tags" : [ { + "key" : "key1" + }, { + "key" : "key2", + "value" : "value2" + } ] + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +None + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/tag_management/index.rst b/api-ref/source/apis_recommended/tag_management/index.rst new file mode 100644 index 0000000..89a0207 --- /dev/null +++ b/api-ref/source/apis_recommended/tag_management/index.rst @@ -0,0 +1,18 @@ +:original_name: topic_300000009.html + +.. _topic_300000009: + +Tag Management +============== + +- :ref:`Querying Resource Tags ` +- :ref:`Querying Project Tags ` +- :ref:`Adding or Deleting Tags in Batches ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_resource_tags + querying_project_tags + adding_or_deleting_tags_in_batches diff --git a/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst b/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst new file mode 100644 index 0000000..56dd91b --- /dev/null +++ b/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst @@ -0,0 +1,138 @@ +:original_name: ListProjectTags.html + +.. _ListProjectTags: + +Querying Project Tags +===================== + +Function +-------- + +This API is used to query all tags of instances in a specified project. Before using this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/tags + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=======================================================================================================================================================================================================================================+ + | 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**. | + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+----------------------------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +=============+================================================================================================================+==========================+ + | total_count | Integer | Total number of records. | + +-------------+----------------------------------------------------------------------------------------------------------------+--------------------------+ + | tags | Array of :ref:`ProjectTagItem ` objects | Tag list. | + +-------------+----------------------------------------------------------------------------------------------------------------+--------------------------+ + +.. _listprojecttags__en-us_topic_0000001199680970_response_projecttagitem: + +.. table:: **Table 5** ProjectTagItem + + ========= ================ =========== + Parameter Type Description + ========= ================ =========== + key String Tag key. + values Array of strings Tag value. + ========= ================ =========== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying tags in a specified project + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/tags?offset=0&limit=2 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "total_count" : 2, + "tags" : [ { + "key" : "key1", + "values" : [ "value1", "value2" ] + }, { + "key" : "key2", + "values" : [ "value3", "value4" ] + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst b/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst new file mode 100644 index 0000000..c1b13d7 --- /dev/null +++ b/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst @@ -0,0 +1,140 @@ +:original_name: ListInstanceTags.html + +.. _ListInstanceTags: + +Querying Resource Tags +====================== + +Function +-------- + +This API is used to query tags of a specified instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/tags + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=======================================================================================================================================================================================================================================+ + | 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**. | + +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+-------------------------------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +=============+===================================================================================================================+==========================+ + | total_count | Integer | Total number of records. | + +-------------+-------------------------------------------------------------------------------------------------------------------+--------------------------+ + | tags | Array of :ref:`ResourceTagItem ` objects | Tag list. | + +-------------+-------------------------------------------------------------------------------------------------------------------+--------------------------+ + +.. _listinstancetags__en-us_topic_0000001244760821_response_resourcetagitem: + +.. table:: **Table 5** ResourceTagItem + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + key String Tag key. + value String Tag value. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying resource tags + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "total_count" : 2, + "tags" : [ { + "key" : "key1", + "value" : "value1" + }, { + "key" : "key2", + "value" : "value2" + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/task_center/index.rst b/api-ref/source/apis_recommended/task_center/index.rst new file mode 100644 index 0000000..f3af17f --- /dev/null +++ b/api-ref/source/apis_recommended/task_center/index.rst @@ -0,0 +1,14 @@ +:original_name: gaussdb_04_0014.html + +.. _gaussdb_04_0014: + +Task Center +=========== + +- :ref:`Obtaining Information About a Task with a Specified ID ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + obtaining_information_about_a_task_with_a_specified_id diff --git a/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst b/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst new file mode 100644 index 0000000..53cfc64 --- /dev/null +++ b/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst @@ -0,0 +1,199 @@ +:original_name: ShowGaussMySqlJobInfo.html + +.. _ShowGaussMySqlJobInfo: + +Obtaining Information About a Task with a Specified ID +====================================================== + +Function +-------- + +This API is used to obtain task information from the task center. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +Constraints +----------- + +- This API is used to query asynchronous tasks of the last one month in the task center. +- After a job is generated, it takes several seconds to query the job ID. + +URI +--- + +GET /v3/{project_id}/jobs?id={id} + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +.. table:: **Table 2** Query parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + id Yes String Task ID. + ========= ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameter + + +-----------+-----------------------------------------------------------------------------------+-------------------+ + | Parameter | Type | Description | + +===========+===================================================================================+===================+ + | job | :ref:`GetJobInfoDetail ` object | Task information. | + +-----------+-----------------------------------------------------------------------------------+-------------------+ + +.. _showgaussmysqljobinfo__response_getjobinfodetail: + +.. table:: **Table 5** GetJobInfoDetail + + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===================================================================================================+========================================================================================================================================================================+ + | id | String | Task ID. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Task name. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Task execution status. | + | | | | + | | | Value: | + | | | | + | | | - **Running**: The task is being executed. | + | | | - **Completed**: The task is successfully executed. | + | | | - **Failed**: The task fails to be executed. | + | | | | + | | | Valid value: | + | | | | + | | | - **Running** | + | | | - **Completed** | + | | | - **Failed** | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the DB instance creation is complete. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ended | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the DB instance creation is complete. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | process | String | Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, **""** is returned. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance | :ref:`GetJobInstanceInfoDetail ` object | DB instance information of the task with the specified ID. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | entities | Object | Displayed information varies depending on tasks. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fail_reason | String | Task failure information. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showgaussmysqljobinfo__response_getjobinstanceinfodetail: + +.. table:: **Table 6** GetJobInstanceInfoDetail + + ========= ====== ================= + Parameter Type Description + ========= ====== ================= + id String DB instance ID. + name String DB instance name. + ========= ====== ================= + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 + +Example Response +---------------- + +**Status code: 200** + +.. note:: + + In the response example, some tasks in the task center are used as examples. + +Success. + +.. code-block:: + + { + "job" : { + "id" : "a9767ede-fe0f-4888-9003-e843a4c90514", + "name" : "CreateMysqlInstance", + "status" : "Completed", + "created" : "2018-08-06T10:41:14+0800", + "ended" : "2018-08-06T16:41:14+0000", + "process" : "", + "instance" : { + "id" : "a48e43ff268f4c0e879652d65e63d0fbin07", + "name" : "DO-NOT-TOUCH-mgr2-mysql-single" + }, + "entities" : { + "instance" : { + "endpoint" : "192.168.1.203:3306", + "type" : "Cluster", + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + } + }, + "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ] + } + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst b/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst new file mode 100644 index 0000000..a0ee939 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst @@ -0,0 +1,179 @@ +:original_name: gaussdb_11_0022.html + +.. _gaussdb_11_0022: + +Creating a Manual Backup +======================== + +Function +-------- + +This API is used to create a manual backup. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + POST https://{endpoint}/mysql/v3/{project_id}/backups/create + +- Example + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==============================================================================================================================================================+ + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | Backup name. | + | | | | | + | | | | The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Backup description. It contains a maximum of 256 characters and cannot contain the special characters ``(>!<"&'=)`` | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameter + + +-----------+--------------------------------------------------------------------------------------+---------------------+ + | Parameter | Type | Description | + +===========+======================================================================================+=====================+ + | backup | :ref:`backup ` object | Backup information. | + +-----------+--------------------------------------------------------------------------------------+---------------------+ + +.. _gaussdb_11_0022__en-us_topic_0000001181562672_response_backup: + +.. table:: **Table 5** backup + + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================================================================================================================+ + | id | String | Backup ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Backup name. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | descriprion | String | Backup description. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Backup status | + | | | | + | | | Valid value: | + | | | | + | | | - **BUILDING**: Backup in progress | + | | | - **COMPLETED**: Backup completed | + | | | - **FAILED**: Backup failed | + | | | - **AVAILABLE**: Backup available | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Backup type. Value: | + | | | | + | | | Valid value: | + | | | | + | | | **manual**: manual full backup | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | DB instance ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Creating a Manual Backup + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create + { + "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", + "name": "backup-1", + "description": "manual backup" + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "backup" : { + "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe", + "name" : "backup-1", + "description": "Manual backup" + "begin_time" : "2020-07-07T01:17:05+0200", + "status" : "BUILDING", + "type" : "manual", + "instance_id" : "ef25188419f941309882d2986b2210b9in07" + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/backup_management/index.rst b/api-ref/source/apis_unavailable_soon/backup_management/index.rst new file mode 100644 index 0000000..003d70e --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/backup_management/index.rst @@ -0,0 +1,20 @@ +:original_name: gaussdb_11_0021.html + +.. _gaussdb_11_0021: + +Backup Management +================= + +- :ref:`Creating a Manual Backup ` +- :ref:`Querying Backups ` +- :ref:`Querying an Automated Backup Policy ` +- :ref:`Modifying the Backup Policy ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_manual_backup + querying_backups + querying_an_automated_backup_policy + modifying_the_backup_policy diff --git a/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst b/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst new file mode 100644 index 0000000..adc5344 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst @@ -0,0 +1,178 @@ +:original_name: gaussdb_11_0025.html + +.. _gaussdb_11_0025: + +Modifying the Backup Policy +=========================== + +Function +-------- + +This API is used to modify the backup policy. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update + +- Example + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | No | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +---------------+-----------+-----------------------------------------------------------------------------------------------------------+-----------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+===========================================================================================================+=======================+ + | backup_policy | Yes | :ref:`MysqlBackupPolicy ` object | Database information. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------+-----------------------+ + +.. _gaussdb_11_0025__en-us_topic_0000001181402750_request_mysqlbackuppolicy: + +.. table:: **Table 4** MysqlBackupPolicy + + +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============================+=================+=================+===================================================================================================================================================+ + | start_time | Yes | String | Backup time window. Automated backups will be triggered during the backup time window. | + | | | | | + | | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | | + | | | | - The **HH** value must be 1 greater than the **hh** value. | + | | | | - The values of **mm** and **MM** must be the same and must be set to **00**. | + | | | | | + | | | | Example value: | + | | | | | + | | | | **21:00-22:00** | + +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | Yes | Integer | Backup retention days. | + +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | period | Yes | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | + | | | | | + | | | | Value range: The value is a number separated by commas (,), indicating the days of the week. | + | | | | | + | | | | For example, the value **1,2,3,4** indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday. | + +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | retention_num_backup_level1 | No | Integer | Number of retained level-1 backups. The default value is **0**. This parameter is valid when the level-1 backup function is enabled. Valid value: | + | | | | | + | | | | - **0** | + | | | | - **1** | + +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+-------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================+ + | status | String | Backup status. Value: | + | | | | + | | | - **BUILDING**: Modification in progress | + | | | - **COMPLETED**: Modification completed | + | | | - **FAILED**: Modification failed | + +-----------------------+-----------------------+-------------------------------------------+ + | instance_id | String | DB instance ID. | + +-----------------------+-----------------------+-------------------------------------------+ + | instance_name | String | DB instance name. | + +-----------------------+-----------------------+-------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Modifying the backup policy + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update + { + "backup_policy" : { + "keep_days" : 7, + "start_time" : "19:00-20:00", + "period" : "1,2,3,4,5" + } + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "status" : "COMPLETED", + "instance_id" : "ef25188419f941309882d2986b2210b9in07", + "instance_name" : "gauss-mysql" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst b/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst new file mode 100644 index 0000000..cb95bf6 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst @@ -0,0 +1,138 @@ +:original_name: gaussdb_11_0024.html + +.. _gaussdb_11_0024: + +Querying an Automated Backup Policy +=================================== + +Function +-------- + +This API is used to query an automated backup policy. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | Yes | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +---------------+--------------------------------------------------------------------------------------------------+----------------------------+ + | Parameter | Type | Description | + +===============+==================================================================================================+============================+ + | backup_policy | :ref:`BackupPolicy ` object | Backup policy information. | + +---------------+--------------------------------------------------------------------------------------------------+----------------------------+ + +.. _gaussdb_11_0024__en-us_topic_0000001226563879_response_backuppolicy: + +.. table:: **Table 4** BackupPolicy + + +------------+---------+---------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+=========+===================================================================================================+ + | keep_days | Integer | Backup retention days. | + +------------+---------+---------------------------------------------------------------------------------------------------+ + | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | + +------------+---------+---------------------------------------------------------------------------------------------------+ + | period | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | + +------------+---------+---------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: + + get https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "backup_policy" : { + "keep_days" : "7,", + "start_time" : "19:00-20:00", + "period" : "1,2" + + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst b/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst new file mode 100644 index 0000000..9815403 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst @@ -0,0 +1,210 @@ +:original_name: gaussdb_11_0023.html + +.. _gaussdb_11_0023: + +Querying Backups +================ + +Function +-------- + +This API is used to query backups according to search criteria. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin \_time}&end_time={end_time} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | No | DB instance ID. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_id | String | No | Backup ID. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_type | String | No | Backup type. Value: | + | | | | | + | | | | - **auto**: automated full backup | + | | | | - **manual**: manual full backup | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | String | No | 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 | String | No | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | No | Query start time. The format is "yyyy-mm-ddThh:mm:ssZ". | + | | | | | + | | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | String | No | Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. | + | | | | | + | | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+--------------------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +=============+==================================================================================================+===============================+ + | backups | Array of :ref:`backups ` objects | Backup information. | + +-------------+--------------------------------------------------------------------------------------------------+-------------------------------+ + | total_count | Long | Total number of backup files. | + +-------------+--------------------------------------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_11_0023__en-us_topic_0000001181244186_response_backups: + +.. table:: **Table 4** backups + + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+======================================================================================================+====================================================================================================================+ + | id | String | Backup ID. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Backup name. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | end_time | String | Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Backup status. Value: | + | | | | + | | | - **BUILDING**: Backup in progress | + | | | - **COMPLETED**: Backup completed | + | | | - **FAILED**: Backup failed | + | | | - **AVAILABLE**: Backup available | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | take_up_time | Integer | Backup duration in minutes. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | type | String | Backup type. Value: | + | | | | + | | | - **auto**: automated full backup | + | | | - **manual**: manual full backup | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | size | Double | Backup size in MB. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | DB instance ID. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Description of the backup file. | + +-----------------------+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0023__en-us_topic_0000001181244186_response_mysqldatastore: + +.. table:: **Table 5** MysqlDatastore + + +-----------+--------+------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+============================================================+ + | type | String | DB engine. Currently, only **gaussdb-mysql** is supported. | + +-----------+--------+------------------------------------------------------------+ + | version | String | DB version. | + +-----------+--------+------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=ba62a0b83a1b42bfab275829d86ac0fdin07&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0200&end_time=2020-07-16T10:41:14+0200 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "backups" : [ { + "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", + "name" : "GaussDBforMySQL-gauss-e747-20200705185048266", + "begin_time" : "2018-08-06T12:41:14+0200", + "end_time" : "2018-08-06T12:45:14+0200", + "take_up_time" : 2, + "status" : "COMPLETED", + "type" : "auto", + "size" : 2803, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01" + + } ], + "total_count" : 1 + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/index.rst b/api-ref/source/apis_unavailable_soon/index.rst new file mode 100644 index 0000000..6adf611 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/index.rst @@ -0,0 +1,26 @@ +:original_name: gaussdb_11_0000.html + +.. _gaussdb_11_0000: + +APIs (Unavailable Soon) +======================= + +- :ref:`Querying Version Information About a DB Engine ` +- :ref:`Querying Database Specifications ` +- :ref:`Instance Management ` +- :ref:`Backup Management ` +- :ref:`Parameter Template Management ` +- :ref:`Quota Management ` +- :ref:`Obtaining Information About a Task with a Specified ID ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_version_information_about_a_db_engine + querying_database_specifications + instance_management/index + backup_management/index + parameter_template_management/index + quota_management/index + obtaining_information_about_a_task_with_a_specified_id diff --git a/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst b/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst new file mode 100644 index 0000000..6ca3c6c --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst @@ -0,0 +1,136 @@ +:original_name: gaussdb_11_0018.html + +.. _gaussdb_11_0018: + +Changing a DB Instance Name +=========================== + +Function +-------- + +This API is used to change a DB instance name. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/name + +- Example + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | Yes | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==============================================================================================================================================================+ + | name | Yes | String | DB instance name. | + | | | | | + | | | | Instances of the same type can have same names under the same tenant. | + | | | | | + | | | | The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameter + + ========= ====== =============================================== + Parameter Type Description + ========= ====== =============================================== + job_id String ID of the task for changing a DB instance name. + ========= ====== =============================================== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Changing a DB Instance Name + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name + { + "name" : "gaussdb-name" + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst b/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst new file mode 100644 index 0000000..eebfc69 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst @@ -0,0 +1,138 @@ +:original_name: gaussdb_11_0020.html + +.. _gaussdb_11_0020: + +Changing DB Instance Specifications +=================================== + +Function +-------- + +This API is used to change DB instance specifications. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/action + +- Example + + POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | No | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +---------------+-----------+-----------------------------------------------------------------------------------------------------------+-----------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+===========================================================================================================+===================================+ + | resize_flavor | Yes | :ref:`MysqlResizeFlavor ` object | Specification change information. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------+-----------------------------------+ + +.. _gaussdb_11_0020__en-us_topic_0000001181084216_request_mysqlresizeflavor: + +.. table:: **Table 4** MysqlResizeFlavor + + ========= ========= ====== =================== + Parameter Mandatory Type Description + ========= ========= ====== =================== + spec_code Yes String Specification code. + ========= ========= ====== =================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+======================================================================================================================================================+ + | job_id | String | Job ID for changing DB instance specifications. This parameter is returned only when you change the specifications of a pay-per-use DB instance. | + +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | order_id | String | Order ID for changing DB instance specifications. This parameter is returned only when you change the specification of a yearly/monthly DB instance. | + +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Changing instance specifications + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action + { + "resize_flavor" : { + "spec_code" : "taurus.large.4" + } + } + +Example Response +---------------- + +None + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst new file mode 100644 index 0000000..b3dc44f --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst @@ -0,0 +1,433 @@ +:original_name: gaussdb_11_0004.html + +.. _gaussdb_11_0004: + +Creating a DB Instance +====================== + +Function +-------- + +This API is used to create a GaussDB(for MySQL) instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + POST https://{endpoint}/mysql/v3/{project_id}/instances + +- Example + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+=========================================================================================+===============================================================================================================+===========================================================================================================================================================================================================================================+ + | charge_info | No | :ref:`MysqlChargeInfo ` object | Billing mode, which is pay-per-use (default setting). | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | Yes | String | Region ID. | + | | | | | + | | | | The value cannot be empty. To obtain this value, see `Regions and Endpoints `__. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | DB instance name. | + | | | | | + | | | | Instances of the same type can have same names under the same tenant. | + | | | | | + | | | | The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | Yes | :ref:`MysqlDatastore ` object | Database information. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | Yes | String | DB instance type, which is case-insensitive. Currently, only the cluster type is supported. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | Yes | String | Specification code. For details, see :ref:`Querying Database Specifications `. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | VPC ID. To obtain this value, use either of the following methods: | + | | | | | + | | | | - Method 1: Log in to the VPC console and view the VPC ID on the VPC details page. | + | | | | - Method 2: See "Querying VPCs" in the *Virtual Private Cloud API Reference*. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | Yes | String | Network ID. To obtain this value, use either of the following methods: | + | | | | | + | | | | - Method 1: Log in to the VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | + | | | | - Method 2: See "Querying Subnets" in the *Virtual Private Cloud API Reference*. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | No | String | Security group ID. | + | | | | | + | | | | If the network ACL is enabled for the subnet used by the created instance, this parameter is optional. If the network ACL is not enabled, this parameter is mandatory. | + | | | | | + | | | | - Method 1: Log in to VPC console. Choose **Access Control** > **Security Groups** in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page. | + | | | | - Method 2: See "Querying Security Groups" in the *Virtual Private Cloud API Reference*. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | No | String | Parameter template ID. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | password | Yes | String | Database password. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (``~!@#%^*-_=+?``). | + | | | | | + | | | | You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | No | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | No | String | UTC time zone. | + | | | | | + | | | | - If this parameter is not specified, UTC is used by default. | + | | | | - If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be **UTC+08:00** rather than **UTC+08:30**. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | Yes | String | AZ type. The value can be **Single** or **multi**. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_availability_zone | If **availability_zone_mode** is set to **multi**, this parameter is mandatory. | String | Primary AZ. | + | | | | | + | | If **availability_zone_mode** is set to **single**, this parameter cannot be specified. | | | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | slave_count | Yes | Integer | Number of created read replicas. Value: **1** to **9**. An instance contains up to 15 read replicas. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`MysqlTags ` objects | Tag list. Instances are created based on tag keys and values. | + | | | | | + | | | | - *{key}* indicates the tag key. It must be unique and cannot be empty. | + | | | | - *{value}* indicates the tag value, which can be empty. | + | | | | | + | | | | To create instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory when the enterprise project is enabled. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | No | String | Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled. | + +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_request_mysqlchargeinfo: + +.. table:: **Table 4** MysqlChargeInfo + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | charge_mode | Yes | String | Billing mode. | + | | | | | + | | | | Value: **postPaid** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | period_type | No | String | Subscription period. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - **month**: The service is subscribed by month. | + | | | | - **year**: The service is subscribed by year. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter is valid and mandatory if **charge_mode** is set to **prePaid**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | period_num | No | Integer | Subscription duration. This parameter is valid and mandatory if **charge_mode** is set to **prePaid**. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - When **period_type** is set to **month**, the parameter value ranges from **1** to **9**. | + | | | | - When **period_type** is set to **year**, the parameter value ranges from **1** to **3**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_request_mysqldatastore: + +.. table:: **Table 5** MysqlDatastore + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================+ + | type | Yes | String | DB engine. Currently, only gaussdb-mysql is supported. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | version | Yes | String | DB version. | + | | | | | + | | | | For details about supported DB versions, see :ref:`Querying Version Information About a DB Engine `. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_request_mysqlbackupstrategy: + +.. table:: **Table 6** MysqlBackupStrategy + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================================+ + | start_time | Yes | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + | | | | | + | | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | | + | | | | - The **HH** value must be 1 greater than the **hh** value. | + | | | | - The values of **mm** and **MM** must be the same and must be set to **00**. | + | | | | | + | | | | Example value: | + | | | | | + | | | | 21:00-22:00 | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | No | String | Automated backup retention days. Value: **1**\ ``-``\ **732**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 7** MysqlVolume + + +-----------------+-----------------+-----------------+------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================+ + | size | Yes | Integer | Disk size. The default value is 40 GB. | + | | | | | + | | | | Value: **40** to **128000**. The value must be a multiple of 10. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_request_mysqltags: + +.. table:: **Table 8** MysqlTags + + +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+========================================================================================================================================================================================================================+ + | key | Yes | String | Tag key. It contains a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. | + +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value | Yes | String | Tag value. It contains a maximum of 43 Unicode characters. It can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed. | + +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 9** Response body parameters + + +-----------------------+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================================================+======================================================================================+ + | instance | :ref:`MysqlInstanceResponse ` object | Instance information. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ + | job_id | String | DB instance creation task ID. | + | | | | + | | | This parameter is returned only when pay-per-use DB instances are created. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ + | order_id | String | Order ID. This parameter is returned only when yearly/monthly instances are created. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_response_mysqlinstanceresponse: + +.. table:: **Table 10** MysqlInstanceResponse + + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+================================================================================================================+===============================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. Instances of the same type can have same names under the same tenant. | + | | | | + | | | The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Instance status. Value: **creating**. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | String | DB instance type. Currently, only the cluster type is supported. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | Parameter template ID. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | String | Region ID, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | String | AZ mode, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_availability_zone | String | Primary AZ ID. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code, which is the same as the request parameter. | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`MysqlChargeInfo ` object | Billing mode, which is yearly/monthly or pay-per-use (default setting). | + +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_response_mysqldatastore: + +.. table:: **Table 11** MysqlDatastore + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + type String DB engine. + version String DB version. + ========= ====== =========== + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_response_mysqlbackupstrategy: + +.. table:: **Table 12** MysqlBackupStrategy + + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+=================================================================================================================================+ + | start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | String | Backup retention days. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0004__en-us_topic_0000001226682425_response_mysqlchargeinfo: + +.. table:: **Table 13** MysqlChargeInfo + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================+ + | charge_mode | String | Billing mode. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | period_type | String | Subscription period. | + | | | | + | | | Valid value: | + | | | | + | | | - **month**: The service is subscribed by month. | + | | | - **year**: The service is subscribed by year. | + | | | | + | | | This parameter is valid and mandatory only when **charge_mode** is set to **prePaid**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | period_num | Integer | Subscription duration, which is calculated by month. | + | | | | + | | | This parameter is valid when **charge_mode** is set to **prePaid** (this parameter is valid only for yearly/monthly instances). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 14** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 15** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. note:: + + The value of **region** in the following is used as an example. + +Creating a DB instance + +.. code-block:: + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances + + { + "name" : "gaussdb-mysql-instance1", + "region" : "xxxx", + "charge_info" : { + "charge_mode" : "postPaid" + }, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "mode" : "Cluster", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", + "password" : "xxxxx", + "backup_strategy" : { + "start_time" : "08:00-09:00" + }, + "availability_zone_mode" : "single", + "slave_count" : 1, + "enterprise_project_id" : 0 + } + +Example Response +---------------- + +.. note:: + + The values of **region** and **master_availability_zone** are used as examples. + +**Status code: 201** + +Success. + +.. code-block:: + + { + "instance" : { + "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07", + "name" : "gaussdb-mysql-instance1", + "region" : "xxxx", + "charge_info" : { + "charge_mode" : "postPaid" + }, + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "mode" : "Cluster", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", + "backup_strategy" : { + "start_time" : "08:00-09:00", + "keep_days" : 7 + }, + "availability_zone_mode" : "single", + "slave_count" : 1 + }, + "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst new file mode 100644 index 0000000..84d45b8 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst @@ -0,0 +1,142 @@ +:original_name: gaussdb_11_0015.html + +.. _gaussdb_11_0015: + +Creating a Read Replica +======================= + +Function +-------- + +This API is used to create a read replica. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge + +- Example + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+===================+==========================================================================================================================+ + | priorities | Yes | Array of integers | Read replica failover priority ranging from 1 to 16. The total number of the primary node and read replicas is up to 16. | + +------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | instance_id | String | DB instance ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | node_names | Array of strings | Node name list | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | job_id | String | ID of the task for creating a DB instance. | + | | | | + | | | This parameter is returned only when pay-per-use DB instances are created. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | order_id | String | Order ID. This parameter is returned only when yearly/monthly instances are created. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Creating a read replica + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge + { + "priorities" : [ 1, 2 ] + } + +Example Response +---------------- + +**Status code: 201** + +Success. + +.. code-block:: + + { + "instance_id" : "f381d0b539e644df8f5b0d3a62129515in07", + "node_names" : [ "gauss-ccf5_node03" ], + "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst new file mode 100644 index 0000000..6aa9c6d --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst @@ -0,0 +1,119 @@ +:original_name: gaussdb_11_0007.html + +.. _gaussdb_11_0007: + +Deleting a DB Instance +====================== + +Function +-------- + +This API is used to delete a DB instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id} + +- Example + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========= ====== ========================================== + Parameter Type Description + ========= ====== ========================================== + job_id String ID of the task for deleting a DB instance. + ========= ====== ========================================== + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01 + +Example Response +---------------- + +**Status code: 500** + +Server error. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst new file mode 100644 index 0000000..4988d7c --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst @@ -0,0 +1,121 @@ +:original_name: gaussdb_11_0016.html + +.. _gaussdb_11_0016: + +Deleting a Read Replica +======================= + +Function +-------- + +This API is used to delete a read replica. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id} + +- Example + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | node_id | Yes | Read-only node ID, which is compliant with the UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========= ====== =========================================== + Parameter Type Description + ========= ====== =========================================== + job_id String ID of the task for deleting a read replica. + ========= ====== =========================================== + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01/nodes/ss62c18799854a919bab633874c159dfin55 + +Example Response +---------------- + +**Status code: 500** + +Server error. + +.. code-block:: + + { + "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/index.rst b/api-ref/source/apis_unavailable_soon/instance_management/index.rst new file mode 100644 index 0000000..8c952cc --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/index.rst @@ -0,0 +1,30 @@ +:original_name: gaussdb_11_0003.html + +.. _gaussdb_11_0003: + +Instance Management +=================== + +- :ref:`Creating a DB Instance ` +- :ref:`Querying DB Instances ` +- :ref:`Querying Details of a DB Instance ` +- :ref:`Deleting a DB Instance ` +- :ref:`Creating a Read Replica ` +- :ref:`Deleting a Read Replica ` +- :ref:`Changing a DB Instance Name ` +- :ref:`Resetting a Database Password ` +- :ref:`Changing DB Instance Specifications ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_db_instance + querying_db_instances + querying_details_of_a_db_instance + deleting_a_db_instance + creating_a_read_replica + deleting_a_read_replica + changing_a_db_instance_name + resetting_a_database_password + changing_db_instance_specifications diff --git a/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst b/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst new file mode 100644 index 0000000..a567180 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst @@ -0,0 +1,324 @@ +:original_name: gaussdb_11_0005.html + +.. _gaussdb_11_0005: + +Querying DB Instances +===================== + +Function +-------- + +This API is used to query instances according to search criteria. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | No | DB instance ID. | + | | | | | + | | | | The asterisk (``*``) is reserved for the system. If the instance ID starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance ID is used for exact matching. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | No | DB instance name. | + | | | | | + | | | | The asterisk (``*``) is reserved for the system. If the instance name starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance name is used for exact matching. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | No | DB instance type to be queried. Its value is **Cluster**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore_type | String | No | DB type. Currently, only gaussdb-mysql is supported. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | No | VPC ID. | + | | | | | + | | | | - Method 1: Log in to the VPC console and view the VPC ID on the VPC details page. | + | | | | - Method 2: See "Querying VPCs" in the *Virtual Private Cloud API Reference*. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | No | Network ID of the subnet. | + | | | | | + | | | | - Method 1: Log in to the VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | + | | | | - Method 2: See section "Querying Subnets" under "APIs" or section "Querying Networks" under "OpenStack Neutron APIs" in the *Virtual Private Cloud API Reference*. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Integer | No | 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 | Integer | No | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+------------------------------------------------------------------------------------------------------------------------------+----------------------------+ + | Parameter | Type | Description | + +=============+==============================================================================================================================+============================+ + | instances | Array of :ref:`MysqlInstanceListInfo ` objects | Instance list information. | + +-------------+------------------------------------------------------------------------------------------------------------------------------+----------------------------+ + | total_count | Integer | Total number of records. | + +-------------+------------------------------------------------------------------------------------------------------------------------------+----------------------------+ + +.. _gaussdb_11_0005__en-us_topic_0000001181084214_response_mysqlinstancelistinfo: + +.. table:: **Table 4** MysqlInstanceListInfo + + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==================================================================================================================+=====================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | private_ips | Array of strings | Private IP address for write. It is a blank string until an ECS is created. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | public_ips | Array of strings | Public IP addresses. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | type | String | DB instance type. The value is **Cluster**. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | region | String | Region where the DB instance is deployed. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the instance creation is complete. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. | + | | | | + | | | The value is empty unless the instance creation is complete. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | flavor_info | :ref:`MysqlFlavorInfo ` object | Specification description. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | volume | :ref:`MysqlVolumeInfo ` object | Storage disk information. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Backup policy. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`MysqlChargeInfo ` object | Billing mode, which is yearly/monthly or pay-per-use (default setting). | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`InstanceTagItem ` objects | Tag list. | + +-----------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0005__en-us_topic_0000001181084214_response_mysqldatastore: + +.. table:: **Table 5** MysqlDatastore + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================================+ + | type | String | DB engine. Currently, only **gaussdb-mysql** is supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | version | String | DB version. | + | | | | + | | | To obtain details about supported DB engine versions, call the API for querying the DB engine versions. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | kernel_version | String | Database kernel version. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0005__en-us_topic_0000001181084214_response_mysqlflavorinfo: + +.. table:: **Table 6** MysqlFlavorInfo + + ========= ====== ================== + Parameter Type Description + ========= ====== ================== + vcpus String Number of vCPUs. + ram String Memory size in GB. + ========= ====== ================== + +.. _gaussdb_11_0005__response_mysqlvolumeinfo: + +.. table:: **Table 7** MysqlVolumeInfo + + ========= ====== ===================== + Parameter Type Description + ========= ====== ===================== + type String Disk type. + size String Used disk size in GB. + ========= ====== ===================== + +.. _gaussdb_11_0005__en-us_topic_0000001181084214_response_mysqlbackupstrategy: + +.. table:: **Table 8** MysqlBackupStrategy + + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+=================================================================================================================================+ + | start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | String | Backup retention days. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0005__en-us_topic_0000001181084214_response_mysqlchargeinfo: + +.. table:: **Table 9** MysqlChargeInfo + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | charge_mode | String | Billing mode. | + | | | | + | | | Value: **postPaid** | + +-----------------------+-----------------------+-----------------------+ + +.. _gaussdb_11_0005__en-us_topic_0000001181084214_response_instancetagitem: + +.. table:: **Table 10** InstanceTagItem + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + key String Tag key. + value String Tag value. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 11** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 12** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying DB Instances + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 + +Example Response +---------------- + +.. note:: + + The value of **region** is used as an example in the following response. + +**Status code: 200** + +Success. + +.. code-block:: + + { + "total_count" : 1, + "instances" : [ { + "id" : "ed7cc6166ec24360a5ed5c5c9c2ed726in01", + "name" : "gaussdb-mysql-instance01", + "status" : "ACTIVE", + "port" : 3306, + "type" : "Cluster", + "private_ips" : [ "192.168.0.142" ], + "db_user_name" : "root", + "region" : "br-iaas-odin1", + "datastore" : { + "type" : "gaussdb-mysql", + "version" : "8.0" + }, + "created" : "2018-08-20T02:33:49_0800", + "updated" : "2018-08-20T02:33:49_0800", + "volume" : { + "type" : "POOL", + "used_size" : 100 + }, + "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", + "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", + "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", + "flavor_ref" : "gaussdb.mysql.c3.small.4", + "flavor_info" : { + "vcpus" : 8, + "ram" : 16 + }, + "backup_strategy" : { + "start_time" : "19:00-20:00", + "keep_days" : 7 + }, + "charge_info" : { + "charge_mode" : "postPaid" + }, + "enterprise_project_id" : 0, + "time_zone" : "UTC", + "tags" : [ ] + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst new file mode 100644 index 0000000..f7dbd86 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst @@ -0,0 +1,388 @@ +:original_name: gaussdb_11_0006.html + +.. _gaussdb_11_0006: + +Querying Details of a DB Instance +================================= + +Function +-------- + +This API is used to query the details of a specified DB instance. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | Yes | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 3** Response body parameter + + +-----------+------------------------------------------------------------------------------------------------------------------------+-----------------------+ + | Parameter | Type | Description | + +===========+========================================================================================================================+=======================+ + | instance | :ref:`MysqlInstanceInfoDetail ` object | Instance information. | + +-----------+------------------------------------------------------------------------------------------------------------------------+-----------------------+ + +.. _gaussdb_11_0006__en-us_topic_0000001226443923_response_mysqlinstanceinfodetail: + +.. table:: **Table 4** MysqlInstanceInfoDetail + + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================================================================+=====================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of a tenant in a region. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. Valid value: | + | | | | + | | | If the value is **BUILD**, the DB instance is being created. | + | | | | + | | | If the value is **ACTIVE**, the DB instance is normal. | + | | | | + | | | If the value is **FAILED**, the DB instance is abnormal. | + | | | | + | | | If the value is **FROZEN**, the DB instance is frozen. | + | | | | + | | | If the value is **MODIFYING**, the DB instance is being scaled up. | + | | | | + | | | If the value is **REBOOTING**, the DB instance is being rebooted. | + | | | | + | | | If the value is **RESTORING**, the DB instance is being restored. | + | | | | + | | | If the value is **MODIFYING INSTANCE TYPE**, the DB instance is changing from primary to standby. | + | | | | + | | | If the value is **SWITCHOVER**, the primary/standby switchover is being performed. | + | | | | + | | | If the value is **MIGRATING**, the DB instance is being migrated. | + | | | | + | | | If the value is **BACKING UP**, the DB instance is being backed up. | + | | | | + | | | If the value is **MODIFYING DATABASE PORT**, the database port is being changed. | + | | | | + | | | If the value is **STORAGE FULL**, the instance storage space is full. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Instance type. The value is **Cluster**. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_count | Integer | Number of nodes. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_used_space | Double | Used backup space in GB. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the instance creation is complete. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the instance creation is complete. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_write_ips | Array of strings | Private IP address for write. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ips | String | Public IP address of the instance. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | ID of the parameter template used for creating an instance or ID of the latest parameter template that is applied to an instance. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Backup policy. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodes | Array of :ref:`MysqlInstanceNodeInfo ` objects | Node information. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_mode | String | AZ type. It can be **single** or **multi**. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_az_code | String | Primary AZ. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintenance_window | String | Maintenance window in the UTC format. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`MysqlTags ` objects | Tags for managing instances. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0006__en-us_topic_0000001226443923_response_mysqldatastore: + +.. table:: **Table 5** MysqlDatastore + + +----------------+--------+--------------------------------------------------------+ + | Parameter | Type | Description | + +================+========+========================================================+ + | type | String | DB engine. Currently, only gaussdb-mysql is supported. | + +----------------+--------+--------------------------------------------------------+ + | version | String | DB version. | + +----------------+--------+--------------------------------------------------------+ + | kernel_version | String | Database kernel version. | + +----------------+--------+--------------------------------------------------------+ + +.. _gaussdb_11_0006__response_mysqlvolumeinfo: + +.. table:: **Table 6** MysqlInatanceNodeVolumeInfo + + ========= ====== ===================== + Parameter Type Description + ========= ====== ===================== + type String Disk type. + used String Used disk size in GB. + ========= ====== ===================== + +.. _gaussdb_11_0006__en-us_topic_0000001226443923_response_mysqlbackupstrategy: + +.. table:: **Table 7** MysqlBackupStrategy + + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+=================================================================================================================================+ + | start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | String | Backup retention days. | + +------------+--------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0006__en-us_topic_0000001226443923_response_mysqlinstancenodeinfo: + +.. table:: **Table 8** MysqlInstanceNodeInfo + + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================================================================+================================================================================+ + | id | String | DB instance ID. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | name | String | Node name. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | type | String | Node type, which can be **master** or **slave**. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | status | String | Node status. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | port | Integer | Database port. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | private_read_ips | Array of strings | Private IP address for read of the node. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | volume | :ref:`Table 6 ` object | Storage disk information. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | az_code | String | AZ. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | region_code | String | Region where the instance is located. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | created | String | DB instance creation time. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | updated | String | Update time. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | max_connections | String | Maximum number of connections. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | vcpus | String | Number of vCPUs. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | need_restart | Boolean | Whether to reboot the instance for the parameter modifications to take effect. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | priotiry | Integer | Failover priority. | + +------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. _gaussdb_11_0006__en-us_topic_0000001226443923_response_mysqltags: + +.. table:: **Table 9** MysqlTags + + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==================================================================================================================================================================================================================================+ + | key | String | Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 10** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying details of a DB instance + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/d2cda7b97a39488e8b30e3cea4066204in07 + +Example Response +---------------- + +.. note:: + + The values of **region_code** and **az_code** are used as examples. + +**Status code: 201** + +Success. + +.. code-block:: + + { + "instance": { + "id": "d2cda7b97a39488e8b30e3cea4066204in07", + "name": "gauss-d616-lb07", + "status": "FAILED", + "project_id": "053f533ead80d5102f0cc012e8d468a4", + "enterprise_project_id": "0", + "type": "Cluster", + "charge_info": { + "charge_mode": "postPaid", + "order_id": "" + }, + "node_count": 2, + "datastore": { + "type": "GaussDB(for MySQL)", + "version": "8.0" + }, + "created": "2020-07-21T09:13:56+0200", + "updated": "2020-07-21T09:27:54+0200", + "public_ips": "", + "private_write_ips": [ + "192.168.0.235" + ], + "db_user_name": "root", + "port": "3306", + "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87", + "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186", + "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902", + "backup_strategy": { + "start_time": "00:00-00:00", + "keep_days": "0" + }, + "nodes": [ + { + "id": "799a0f2fa49a4151bf9f7063c1fbba36no07", + "name": "gauss-d616-lb07_node01", + "type": "master", + "status": "FAILED", + "port": 3306, + "private_read_ips": [ + "192.168.0.163" + ], + "volume": { + "type": "POOL", + "used": "0.0" + }, + "az_code": "cn-cmcc1a-01", + "region_code": "cn-cmcc1", + "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", + "flavor_ref": "gaussdb.mysql.4xlarge.arm.8", + "max_connections": null, + "vcpus": "16", + "ram": "128", + "need_restart": false, + "priority": 1 + }, + { + "id": "816459d771c444db9fa4c1d5c173cb1cno07", + "name": "gauss-d616-lb07_node02", + "type": "slave", + "status": "FAILED", + "port": 3306, + "private_read_ips": [ + "192.168.0.160" + ], + "volume": { + "type": "POOL", + "used": "0.0" + }, + "az_code": "cn-cmcc1a-01", + "region_code": "cn-cmcc1", + "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", + "flavor_ref": "gaussdb.mysql.4xlarge.arm.8", + "max_connections": null, + "vcpus": "16", + "ram": "128", + "need_restart": false, + "priority": 1 + } + ], + "time_zone": "UTC+08:00", + "backup_used_space": 0, + "az_mode": "single", + "master_az_code": "cn-cmcc1a-01", + "maintenance_window": "18:00-22:00" + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst b/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst new file mode 100644 index 0000000..f1188db --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst @@ -0,0 +1,120 @@ +:original_name: gaussdb_11_0019.html + +.. _gaussdb_11_0019: + +Resetting a Database Password +============================= + +Function +-------- + +This API is used to reset a database password. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/password + +- Example + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Name | Type | Mandatory | Description | + +=================+=================+=================+============================================================================+ + | project_id | String | Yes | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | String | No | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | No | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameter + + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================================================================================================================================================================================+ + | password | Yes | String | Database password. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (``~!@#$%^*-_=+?,()&``). | + | | | | | + | | | | You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Resetting a database password + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password + { + "password" : "Test_345612" + } + +Example Response +---------------- + +{} + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst b/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst new file mode 100644 index 0000000..8a69f4f --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst @@ -0,0 +1,233 @@ +:original_name: gaussdb_11_0032.html + +.. _gaussdb_11_0032: + +Obtaining Information About a Task with a Specified ID +====================================================== + +Function +-------- + +This API is used to obtain task information from the task center. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/jobs?id={id} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | id | Yes | Task ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+----------------------------------------------------------------------------------------------------------+-------------------+ + | Parameter | Type | Description | + +===========+==========================================================================================================+===================+ + | job | :ref:`GetJobInfoDetail ` object | Task information. | + +-----------+----------------------------------------------------------------------------------------------------------+-------------------+ + +.. _gaussdb_11_0032__en-us_topic_0000001181084222_response_getjobinfodetail: + +.. table:: **Table 4** GetJobInfoDetail + + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==========================================================================================================================+=================================================================================================================================================+ + | id | String | Task ID. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Task name. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Task execution status. | + | | | | + | | | Valid value: | + | | | | + | | | - **Running**: The task is being executed. | + | | | - **Completed**: The task is successfully executed. | + | | | - **Failed**: The task fails to be executed. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the instance creation is complete. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | ended | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the instance creation is complete. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | process | String | Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, **""** is returned. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance | :ref:`GetJobInstanceInfoDetail ` object | Instance information of the task with the specified ID. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | entities | :ref:`Table 6 ` object | Displayed information varies depending on tasks. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | fail_reason | String | Task failure information. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0032__en-us_topic_0000001181084222_response_getjobinstanceinfodetail: + +.. table:: **Table 5** GetJobInstanceInfoDetail + + ========= ====== ================= + Parameter Type Description + ========= ====== ================= + id String DB instance ID. + name String DB instance name. + ========= ====== ================= + +.. _gaussdb_11_0032__table1014617554138: + +.. table:: **Table 6** entities field data structure description + + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================+ + | instance | Object | DB instance queried in the task. | + | | | | + | | | For details, see :ref:`Table 7 `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + | resource_ids | List | Resource ID involved in a task. | + +-----------------------+-----------------------+-----------------------------------------------------------------------+ + +.. _gaussdb_11_0032__table975183423611: + +.. table:: **Table 7** entities.instance field data structure description + + +-----------+--------+---------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+========+=======================================================================================+ + | endpoint | String | DB instance connection address. | + +-----------+--------+---------------------------------------------------------------------------------------+ + | type | String | DB instance type. | + +-----------+--------+---------------------------------------------------------------------------------------+ + | datastore | Object | DB information. For details, see :ref:`Table 8 `. | + +-----------+--------+---------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0032__table173094268581: + +.. table:: **Table 8** datastore field data structure description + + ======= ====== =========== + Name Type Description + ======= ====== =========== + type String DB engine. + version String DB version. + ======= ====== =========== + +.. table:: **Table 9** entities field data structure description (binding or unbinding an EIP) + + ========= ====== ========================== + Name Type Description + ========= ====== ========================== + public_ip String EIP bound to the instance. + ========= ====== ========================== + +**Status code: 400** + +.. table:: **Table 10** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 + +Example Response +---------------- + +.. note:: + + In the response example, some tasks in the task center are used as examples. + +**Status code: 200** + +Success. + +.. code-block:: + + { + "job": { + "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", + "name": " RestartGaussDBInstance", + "status": "Completed", + "created": "2018-08-06T10:41:14+0000", + "ended": "2018-08-06T16:41:14+0000", + "process": "", + "instance": { + "id": "a48e43ff268f4c0e879652d65e63d0fbin01", + "name": "DO-NOT-TOUCH-mgr2-gaussdb" + }, + "entities": {} + } + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/parameter_template_management/index.rst b/api-ref/source/apis_unavailable_soon/parameter_template_management/index.rst new file mode 100644 index 0000000..1b0e1b0 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/parameter_template_management/index.rst @@ -0,0 +1,14 @@ +:original_name: gaussdb_11_0026.html + +.. _gaussdb_11_0026: + +Parameter Template Management +============================= + +- :ref:`Querying Parameter Templates ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_parameter_templates diff --git a/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst b/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst new file mode 100644 index 0000000..71a4b1c --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst @@ -0,0 +1,173 @@ +:original_name: gaussdb_11_0027.html + +.. _gaussdb_11_0027: + +Querying Parameter Templates +============================ + +Function +-------- + +This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{*project_id*}/configurations?offset={offset}&limit={limit} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations?offset=0&limit=100 + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +----------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ + | Parameter | Type | Description | + +================+============================================================================================================================+======================================+ + | configurations | Array of :ref:`ConfigurationSummary ` objects | Parameter template information. | + +----------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ + | total_count | Integer | Total number of parameter templates. | + +----------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ + +.. _gaussdb_11_0027__en-us_topic_0000001181084218_response_configurationsummary: + +.. table:: **Table 4** ConfigurationSummary + + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=======================+====================================================================================================================+ + | id | String | Parameter template ID. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Parameter template name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Parameter template description. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore_version_name | String | DB version name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | datastore_name | String | DB name. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + | user_defined | Boolean | Whether the parameter template is a custom template. | + | | | | + | | | - **false**: The parameter template is a default template. | + | | | - **true**: The parameter template is a custom template. | + +------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "total_count" : 1, + "configurations" : [ { + "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", + "name" : "configuration_test", + "description" : "configuration_test", + "datastore_version_name" : "8.0", + "datastore_name" : "GaussDB(for MySQL)", + "created" : "2019-05-15T11:53:34+0000", + "updated" : "2019-05-15T11:53:34+0000", + "user_defined" : true + }, { + "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07", + "name" : "Default-GaussDBforMySQL", + "description" : "Default parameter template for GaussDBforMySQL", + "datastore_version_name" : "8.0", + "datastore_name" : "GaussDB(for MySQL)", + "created" : "2019-05-27T03:38:51+0000", + "updated" : "2019-05-27T03:38:51+0000", + "user_defined" : false + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst b/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst new file mode 100644 index 0000000..f513987 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst @@ -0,0 +1,170 @@ +:original_name: gaussdb_11_0002.html + +.. _gaussdb_11_0002: + +Querying Database Specifications +================================ + +Function +-------- + +This API is used to query the database specifications of a specified DB engine version. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&availability_zone_mode={availability_zone_mode} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql + +- Parameter description + + .. table:: **Table 1** Parameter description + + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========================+=================+=================+=======================================================================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | database_name | Yes | String | DB engine. Its value is case-insensitive and can be: | + | | | | | + | | | | gaussdb-mysql | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | version_name | No | String | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine `. | + | | | | | + | | | | Currently, only MySQL 8.0 is supported. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | Yes | String | AZ mode. Its value can be **single** or **multi** and is case-insensitive. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | spec_code | No | String | Specification code. | + +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 202** + +.. table:: **Table 3** Response body parameter + + +-----------+--------------------------------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +===========+====================================================================================================================+==========================+ + | flavors | Array of :ref:`MysqlFlavorsInfo ` objects | Instance specifications. | + +-----------+--------------------------------------------------------------------------------------------------------------------+--------------------------+ + +.. _gaussdb_11_0002__en-us_topic_0000001181244182_response_mysqlflavorsinfo: + +.. table:: **Table 4** MysqlFlavorsInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================================+ + | vcpus | String | Number of vCPUs. For example, the value **1** indicates 1 vCPU. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | type | String | Specification type. The value can be **arm**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | id | String | Specification ID. The value must be unique. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | spec_code | String | Resource specification code. Its value is same as the value of **flavor_ref**. | + | | | | + | | | For example, **gaussdb.mysql.4xlarge.arm.8** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | version_name | String | DB version number. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | instance_mode | String | DB instance type. Its value is **Cluster**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + | az_status | Map | Status of the AZ where the specification belongs. Its value can be any of the following: | + | | | | + | | | - **normal**: on sale | + | | | - **unsupported**: not supported | + | | | - **sellout**: sold out | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql + +Example Response +---------------- + +**Status code: 202** + +Success. + +.. code-block:: + + { + "flavors" : [ { + "vcpus" : "16", + "ram" : "128", + "type" : "arm", + "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", + "spec_code" : "gaussdb.mysql.4xlarge.arm.8", + "instance_mode" : "Cluster", + "version_name" : "8.0", + "az_status" : { + "az1" : "normal" + } + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst b/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst new file mode 100644 index 0000000..555133c --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst @@ -0,0 +1,134 @@ +:original_name: gaussdb_11_0001.html + +.. _gaussdb_11_0001: + +Querying Version Information About a DB Engine +============================================== + +Function +-------- + +This API is used to query the version information of a specified DB engine. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/datastores/{database_name} + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+===================================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | database_name | Yes | DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameter + + +------------+--------------------------------------------------------------------------------------+--------------+ + | Parameter | Type | Description | + +============+======================================================================================+==============+ + | datastores | Array of :ref:`MysqlEngineVersionInfo ` objects | DB versions. | + +------------+--------------------------------------------------------------------------------------+--------------+ + +.. _gaussdb_11_0001__table8490145919445: + +.. table:: **Table 4** MysqlEngineVersionInfo + + +-----------+--------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===============================================================================+ + | id | String | DB version ID. Its value is unique. | + +-----------+--------+-------------------------------------------------------------------------------+ + | name | String | DB version number. Only the major version number with two digits is returned. | + +-----------+--------+-------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "datastores" : [ { + "id" : "87620726-6802-46c0-9028-a8785e1f1921", + "name" : "8.0" + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst b/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst new file mode 100644 index 0000000..c1aebdf --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst @@ -0,0 +1,135 @@ +:original_name: gaussdb_11_0030.html + +.. _gaussdb_11_0030: + +Configuring Enterprise Project Resource Quotas of a Tenant +========================================================== + +Function +-------- + +This API is used to configure resource quotas for a specified enterprise project. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + POST https://{endpoint}/mysql/v3/{project_id}/quotas + +- Example + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameter + + +------------+-----------+---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+===================================================================================================+====================================================================+ + | quota_list | Yes | Array of :ref:`setQuota ` objects | Quota details. Up to 10 quota records can be configured at a time. | + +------------+-----------+---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + +.. _gaussdb_11_0030__en-us_topic_0000001181562674_request_setquota: + +.. table:: **Table 4** setQuota + + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+===================================================================================================================================================================================================+ + | enterprise_project_id | Yes | String | Enterprise project ID. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_quota | Yes | Integer | Quota of the DB instance quantity. The value ranges from **0** to **1000**. (If there are already instances created, this parameter value must be greater than the number of existing instances.) | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus_quota | Yes | Integer | Quota of vCPUs. Value: **0** to **3600000**. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.) | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram_quota | Yes | Integer | Memory quota in GB. Value: **0** to **19200000**. (If there are already instances created, this parameter value must be greater than the used memory size.) | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameter + + +------------+----------------------------------------------------------------------------------------------------+------------------------+ + | Parameter | Type | Description | + +============+====================================================================================================+========================+ + | quota_list | Array of :ref:`setQuota ` objects | Resource list objects. | + +------------+----------------------------------------------------------------------------------------------------+------------------------+ + +.. _gaussdb_11_0030__en-us_topic_0000001181562674_response_setquota: + +.. table:: **Table 6** setQuota + + ===================== ======= ================================== + Parameter Type Description + ===================== ======= ================================== + enterprise_project_id String Enterprise project ID. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + ===================== ======= ================================== + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/quota_management/index.rst b/api-ref/source/apis_unavailable_soon/quota_management/index.rst new file mode 100644 index 0000000..c120d80 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/quota_management/index.rst @@ -0,0 +1,18 @@ +:original_name: gaussdb_11_0028.html + +.. _gaussdb_11_0028: + +Quota Management +================ + +- :ref:`Querying Enterprise Project Resource Quotas of a Tenant ` +- :ref:`Configuring Enterprise Project Resource Quotas of a Tenant ` +- :ref:`Modifying Enterprise Project Resource Quotas of a Tenant ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_enterprise_project_resource_quotas_of_a_tenant + configuring_enterprise_project_resource_quotas_of_a_tenant + modifying_enterprise_project_resource_quotas_of_a_tenant diff --git a/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst b/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst new file mode 100644 index 0000000..992085f --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst @@ -0,0 +1,167 @@ +:original_name: gaussdb_11_0031.html + +.. _gaussdb_11_0031: + +Modifying Enterprise Project Resource Quotas of a Tenant +======================================================== + +Function +-------- + +This API is used to modify the resource quotas of a specified enterprise project. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + PUT https://{endpoint}/mysql/v3/{project_id}/quotas + +- Example + + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=======================+=======================+============================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------------+-----------------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameter + + +------------+-----------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+===================================================================================================+====================================================================================================+ + | quota_list | Yes | Array of :ref:`setQuota ` objects | Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time. | + +------------+-----------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. _gaussdb_11_0031__en-us_topic_0000001181244188_request_setquota: + +.. table:: **Table 4** setQuota + + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+====================================================================================================================================================================================+ + | enterprise_project_id | Yes | String | Enterprise project ID. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_quota | Yes | Integer | Quota of the DB instance quantity. Value: **0** to **1000**. (If there are already instances created, this parameter value must be greater than the number of existing instances.) | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus_quota | Yes | Integer | Quota of vCPUs. Value: **0** to **3600000**. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.) | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram_quota | Yes | Integer | Memory quota in GB. Value: **0** to **19200000**. (If there are already instances created, this parameter value must be greater than the used memory size.) | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +------------+----------------------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +============+====================================================================================================+===============================+ + | quota_list | Array of :ref:`setQuota ` objects | Configured quota information. | + +------------+----------------------------------------------------------------------------------------------------+-------------------------------+ + +.. _gaussdb_11_0031__en-us_topic_0000001181244188_response_setquota: + +.. table:: **Table 6** setQuota + + ===================== ======= ================================== + Parameter Type Description + ===================== ======= ================================== + enterprise_project_id String Enterprise project ID. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + ===================== ======= ================================== + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40 + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst b/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst new file mode 100644 index 0000000..82e8e24 --- /dev/null +++ b/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst @@ -0,0 +1,151 @@ +:original_name: gaussdb_11_0029.html + +.. _gaussdb_11_0029: + +Querying Enterprise Project Resource Quotas of a Tenant +======================================================= + +Function +-------- + +This API is used to obtain the resource quotas of a specified enterprise project. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +- URI format + + GET https://{endpoint}/mysql/v3/{project_id}/quotas + +- Example + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas + +- Parameter description + + .. table:: **Table 1** Parameter description + + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Description | + +=========================+=======================+=======================================================================================================================================================================================================================================+ + | project_id | Yes | Project ID of a tenant in a region. | + | | | | + | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | 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 | Number of records to be queried. The default value is **10**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | No | Enterprise project name. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=========================================================================================================================================================================================+ + | X-Auth-Token | Yes | String | User token. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. | + +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+----------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +=============+==============================================================================================+==========================+ + | quota_list | Array of :ref:`quota ` objects | Quota information list. | + +-------------+----------------------------------------------------------------------------------------------+--------------------------+ + | total_count | Integer | Number of quota records. | + +-------------+----------------------------------------------------------------------------------------------+--------------------------+ + +.. _gaussdb_11_0029__en-us_topic_0000001181402752_response_quota: + +.. table:: **Table 4** quota + + =========================== ======= ================================== + Parameter Type Description + =========================== ======= ================================== + enterprise_project_id String Enterprise project ID. + enterprise_project_name String Enterprise project name. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + availability_instance_quota Integer Remaining quota of DB instances. + availability_vcpus_quota Integer Remaining quota of vCPUs. + availability_ram_quota Integer Remaining memory quota. + =========================== ======= ================================== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "quota_list" : [ { + "enterprise_project_id" : "0", + "enterprise_project_name" : "default", + "instance_quota" : 20, + "vcpus_quota" : 20, + "ram_quota" : 40, + "availability_instance_quota" : 1, + "availability_vcpus_quota" : 4, + "availability_ram_quota" : 8 + } ] + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index dfa5a25..7fdd9fc 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -9,82 +9,302 @@ The following table describes error codes. .. table:: **Table 1** Error codes - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | Error Code | Response Code | Description | - +============+===============+=================================================================================================+ - | DBS.200040 | 400 | The DB engine type must be specified. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.200041 | 400 | Invalid DB engine type. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.200051 | 500 | Invalid deployment mode. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.200910 | 400 | The maximum number of read replicas has been reached. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280203 | 400 | This is a weak password. Please enter a strong password. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280216 | 400 | Invalid backup start time. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280227 | 400 | The new storage space must be greater than the current storage and must be a multiple of 10 GB. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280234 | 400 | Invalid DB instance name. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280235 | 400 | Invalid database type. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280236 | 400 | Invalid database version. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280237 | 400 | DB engine information must be specified. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280238 | 400 | The DB engine or version is not supported. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280242 | 400 | Storage space is out of range. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280243 | 400 | Invalid region. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280247 | 400 | Invalid VPC ID. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280248 | 400 | Invalid subnet ID. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280260 | 400 | Invalid AZ. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280266 | 400 | Storage space must be a multiple of 10. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280288 | 400 | Invalid specification code. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280305 | 400 | Invalid security group. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280311 | 400 | Storage space must be specified. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280342 | 400 | Invalid cluster mode. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280365 | 400 | Invalid billing mode. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280431 | 400 | Invalid billing period. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280433 | 400 | Invalid enterprise project ID. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280434 | 400 | Invalid specification code | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280447 | 400 | Invalid time zone. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280448 | 400 | The storage type is sold out. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280450 | 400 | The DB instance specifications are sold out. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280462 | 400 | Invalid auto renewal parameter. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280463 | 400 | Invalid auto payment parameter. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280464 | 400 | Primary AZ cannot be defined in a single AZ. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280465 | 400 | Invalid password. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280466 | 400 | Invalid read replica quantity. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280467 | 400 | Invalid read replica failover priority. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280468 | 400 | Invalid DB instance type. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280470 | 400 | The primary node and read replicas must be located in different AZs. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ - | DBS.280471 | 500 | CBC error. | - +------------+---------------+-------------------------------------------------------------------------------------------------+ + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Status Code | Error Code | Error Message | Description | Troubleshooting | + +=============+============+=======================================================================================+========================================================================================+=========================================================================================================================================================================+ + | 400 | DBS.200001 | Parameter error. | Parameter error. | Check whether the transferred parameters or URLs are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200004 | Parameter error. | Parameter error. | Check whether the transferred parameters or URLs are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200006 | The request is null. Enter a request parameter. | The request is null. Enter a request parameter. | Check whether any mandatory request parameter is empty. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200021 | Invalid DB instance name. | Invalid DB instance name. | Check whether the instance name is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200023 | Storage space is out of range. | The storage space is out of range. | Check whether the storage space exceeds the allowed range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200024 | Invalid region. | Invalid region. | Check whether the region is correct and whether the region is available. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200025 | Invalid AZ. | Invalid AZ. | Check whether the AZ name is correct and whether the AZ is available. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200026 | Invalid storage type. | Invalid storage type. | Check whether the storage type is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200027 | Storage space must be a multiple of 10. | Storage space must be a multiple of 10. | Check whether the storage space is a multiple of 10. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200040 | The DB engine or version is not supported. | The DB engine or version is not supported. | Check whether the DB engine and version match and meet the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200041 | Invalid database version. | Invalid database version. | Check whether the database version is supported. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200042 | The DB engine does not exist. | The DB engine does not exist. | Check whether the DB engine is supported by GaussDB. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200043 | Invalid synchronize model. | Invalid synchronize model. | Check whether the HA synchronization model meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200048 | Invalid VPC ID. | Invalid VPC ID. | Check whether the VPC ID and name are correct and meet the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200049 | Invalid subnet ID. | Invalid subnet ID. | Check whether the subnet ID and name are correct and meet the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200051 | Invalid HA mode. | Invalid HA mode. | Check whether the HA mode meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200052 | Invalid database root password. | Invalid database root password. | Check whether the username and password match and whether the password meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200053 | The selected specifications do not exist. | The selected specifications do not exist. | Check whether the specifications are correct and available in the current AZ. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200054 | Invalid specifications. | Invalid specifications. | Check whether the specifications are correct and available in the current AZ. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200056 | The maximum number of nodes has been reached. | The maximum number of nodes has been reached. | Check whether the number of instance nodes reaches the upper limit. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200063 | Invalid cluster mode. | Invalid cluster mode. | Check whether the cluster mode is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200086 | This operation is not allowed by the DB instance status. | This operation is not allowed by the DB instance status. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200087 | The number of tags added for the DB instance has reached the quota. | The number of tags added for the DB instance has reached the quota. | Check whether the number of tags for the DB instance exceeds the upper limit. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200098 | The tag already exists. | The tag already exists. | Check whether the tag exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200302 | Storage space must be a multiple of 10. | Storage space must be a multiple of 10. | Check whether the storage space is a multiple of 10. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200306 | The new storage space must be greater than or equal to the original storage space. | The new storage space must be at least the original storage space. | Check whether the storage space exceeds the upper limit. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200461 | The parameter value is out of range. | The parameter value is out of range. | Check whether the port is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200504 | Invalid database version. | Invalid database version. | Check whether the database version is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200543 | The job does not exist. | The task does not exist. | Check whether the task ID is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200823 | The database does not exist. | The database does not exist. | Check whether the input database does not exist. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.200824 | The database account does not exist. | The database account does not exist. | Check whether the database account exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201014 | This operation is not allowed by the DB instance status. | This operation is not allowed by the DB instance status. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201101 | Invalid backup cycle. | Invalid backup cycle. | Check whether the backup cycle meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201103 | Invalid backup start time. | Invalid backup start time. | Check whether the start time meets the requirement. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201106 | Invalid retention days. | Invalid retention days. | Check whether the backup retention period meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201203 | The backup file does not exist. | The backup file does not exist. | Check whether the backup exists and matches the instance. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201207 | The DB engine or version is not supported. | The DB engine or version is not supported. | Check whether the DB engine is supported by GaussDB. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.201208 | The operation is not allowed by the backup status. | The operation is not allowed by the backup status. | Check whether the status of the backup is **Completed**. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212002 | Incorrect parameter group quota. | Incorrect parameter template quota. | The parameter template quota exceeds the upper limit. Delete unnecessary parameter templates and create a new one. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212003 | Operation not allowed. | The operation is not allowed. | Default parameter templates cannot be reset or deleted. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212004 | Parameter group update error. | The parameter template fails to be updated. | Check whether the parameter values to be changed are valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212005 | The node does not belong to the group. | The node does not belong to the group. | Check whether the instance ID or node ID is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212007 | The DB engine does not exist. | The DB engine does not exist. | Check whether the DB engine exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212008 | The DB engine is not supported. | The DB engine is not supported. | Check whether the DB engine is supported by GaussDB. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212009 | Task processing failed. | The task fails to be processed. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212010 | The parameter group is being applied. | The parameter template is being applied. | Perform the operation after the application is complete. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212011 | Application failed. | Failed to apply the parameter template. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212012 | The parameter does not exist. | The parameter does not exist. | Check whether the parameter to be modified is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212014 | The node does not have a default parameter group. | The node does not have a default parameter template. | Check whether the node ID or parameter template ID is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212015 | Partial success. | Partial success. | Check whether the parameters to be modified are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212016 | Parameter update failed. | Parameter update failed. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212017 | Invalid parameter. | Parameter error. | Check whether the parameter name is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212025 | Update failed. | Update failed. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212030 | Parameter error. | Parameter error. | The parameter template name already exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212032 | The parameter template has been applied. | The parameter template has been applied. | The parameter template has been applied and cannot be deleted. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.212037 | Parameters are incorrectly set. | Parameters are incorrectly configured. | Check whether the parameter values are valid or within the valid range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.270024 | Proxy instance does not exist. | Proxy instance does not exist. | Check whether the tenant has the proxy instance, whether the input proxy instance ID is correct, and whether the proxy instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.270025 | Invalid weight. | Invalid weight. | Check whether the weight format and range are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.270026 | Invalid proxy mode. | The database proxy type is invalid. | Check whether the database proxy type is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.270027 | Select a proxy instance. | No database proxy instance is specified. | Check whether the database proxy instance ID is null. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280001 | Parameter error. | Parameter error. | Check whether the transferred parameters or URLs are correct and meet the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280127 | Invalid backup description. | Invalid backup description. | Check whether the backup description is correct and meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280128 | The database name does not exist. | The database name does not exist. | Check whether the tenant has the DB instance, whether the DB instance name or ID is correct, and whether the DB instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280203 | This is a weak password. Please enter a strong password. | This is a weak password. Enter a strong password. | Password is too easy to guess. Change it to a strong password. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280204 | Invalid parameter. | Invalid parameter. | Check whether the parameter values are valid or within the valid range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280214 | The backup does not exist. | The backup does not exist. | Check whether the backup retention period is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280216 | Invalid backup start time. | Invalid backup start time. | Check whether the backup start time meets the requirements and whether the requirements between the backup start time and end time are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280235 | Invalid database type. | Invalid database type. | Check whether the DB engine is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280237 | Datastore not specified. | Datastore is not specified. | Check whether the DB engine is supported by GaussDB. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280238 | The DB engine or version is not supported. | The DB engine or version is not supported. | Check whether the DB engine and version match and meet the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280239 | Invalid specifications. | Invalid specifications. | Check whether the specification code is correct, whether the specifications exist in the current AZ, and whether the specifications are supported. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280241 | Invalid storage type. | Invalid storage type. | Check whether the storage type is correct and meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280242 | Storage space is out of range. | The storage space is out of range. | Check whether the specified storage space is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280246 | Invalid database root password. | Invalid database root password. | Check whether the username and password match and whether the password meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280250 | Invalid backup retention days. | Invalid backup retention days. | Check whether the backup data retention period is valid or within the valid range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280251 | Invalid backup cycle. | Invalid backup cycle. | Check whether the backup cycle is valid or within the valid range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280253 | Invalid backup start time. | Invalid backup start time. | Check whether the backup start time meets the requirements and whether the requirements between the backup start time and end time are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280260 | Invalid AZ mode. | Invalid AZ mode. | Check whether the AZ mode is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280270 | The parameter does not exist. | The parameter does not exist. | Check whether the parameters to be modified are correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280271 | The parameter value is out of range. | The parameter value is out of range. | Check whether the parameter value is within the valid range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280272 | The tag key must be unique. | The tag key must be unique. | Check whether the new tag exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280277 | Invalid object name. | Invalid backup name. | Check whether the backup name is correct and meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280285 | Invalid AZ. | Invalid AZ. | Check whether the AZ name is correct and whether the AZ is available. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280288 | Invalid FlavorRef. | Invalid flavor. | Check whether the flavor ID is null or a null string. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280311 | Invalid storage space size. | Invalid storage space. | Check whether the specified storage space is correct and meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280325 | Invalid storage information. | Invalid storage information. | Check whether the storage space or type is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280342 | Invalid cluster mode. | Invalid cluster mode. | Check whether the instance mode is correct and whether the instance mode matches the instance ID. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280364 | Invalid database port. | Invalid database port. | Check whether the database port is available. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280402 | Invalid HA mode. | Invalid HA mode. | Check whether the HA mode meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280404 | Invalid DB instance ID or node ID format. | Invalid DB instance ID. | Check whether the instance ID is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280434 | Invalid specification code. | Invalid specification code. | Check whether the specification code complies with the rules, whether the specification exists, and whether the specification is available. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280439 | Invalid records. Enter a positive integer less than 100. | Invalid value. Enter a positive integer of no more than 100. | Check whether the number of queried records is within the valid range. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280448 | The storage type is sold out. | The storage type is sold out. | Check whether the current storage type is available. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280449 | Operation not allowed on frozen objects. | Operation not allowed on frozen objects. | Check whether the instance is frozen and whether the current operation can be performed when the instance is frozen. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.280450 | The DB instance specifications are sold out. | The DB instance specifications are sold out. | Change the AZ or contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.290000 | Parameter error. | Parameter error. | Check whether the transferred parameters or URLs are correct and meet the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 400 | DBS.290001 | Invalid parameter letter case. | Invalid parameter letter case. | Check whether the parameter letter case is correct and meets the requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.200010 | The DB instance ID or user ID may be null, or the operation is not authorized. | The DB instance ID or user ID may be null, or the operation is not authorized. | Check whether the input parameters are correct, whether the instance exists, and whether the tenant has unauthorized operations. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.200044 | Resource not found or permission denied. | Resource not found or permission denied. | Check whether the parameters are correctly configured, whether the access resources exist, and whether the tenant has the access permission. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.200604 | The DB instance ID or user ID may be null, or the operation is not authorized. | The DB instance ID or user ID may be null, or the operation is not authorized. | Check whether the input parameters are correct, whether the instance exists, and whether the tenant has unauthorized operations. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.200810 | You are not allowed to create databases on read replicas. | You are not allowed to create databases on read replicas. | Create databases on the primary node. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.200819 | You are not allowed to delete database users on read replicas. | You are not allowed to delete database users on read replicas. | Database users cannot be deleted from read replicas. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.201003 | Resource not found or permission denied. | Resource not found or permission denied. | Check whether the parameters are correctly configured, whether the access resources exist, and whether the tenant has the access permission. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.280015 | Resource not found or permission denied. | Resource not found or permission denied. | Check whether the parameters are correctly configured, whether the access resources exist, and whether the tenant has the access permission. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 403 | DBS.280056 | Invalid token. | Invalid token. | Check whether the instance belongs to the tenant and whether the token has been obtained again. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200002 | The DB instance does not exist. | The DB instance does not exist. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200008 | The ECS information of the DB instance cannot be found. | The ECS information of the DB instance cannot be found. | Check whether the parameters are correctly configured and whether the instance status is normal. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200013 | The original DB instance does not exist. | The original DB instance does not exist. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200045 | The DB instance does not exist. | The DB instance does not exist. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200050 | The security group does not exist or does not belong to the VPC. | The security group does not exist or does not belong to the VPC. | Check whether the security group ID is valid, whether the security group exists, and whether the private IP address for read of the node belongs to the security group. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200408 | The DB instance does not exist. | The instance does not exist or has been deleted. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200470 | The region or AZ does not exist. | The region or AZ does not exist. | Check whether the AZ is correct. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200501 | The subnet does not exist or does not belong to the VPC. | The subnet does not exist or does not belong to the VPC. | Check whether the subnet ID and name exist and whether the subnet belongs to the VPC. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200503 | The VPC does not exist or does not belong to the user. | The VPC does not exist or does not belong to the user. | Check whether the tenant has the VPC. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.200602 | The DB instance does not exist. | The DB instance does not exist. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.201010 | The backup information does not exist. | The backup information does not exist. | Check whether the backup exists and matches the instance. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.201028 | The DB instance does not exist. | The instance does not exist or has been deleted. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.212001 | The parameter group does not exist. | The parameter template does not exist. | Check whether the parameter template exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.290002 | The selected specifications do not exist. | The selected specifications do not exist. | Check whether the specifications are correct and available in the current AZ. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.290005 | The DB instance does not exist. | The DB instance does not exist. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.290011 | The DB instance does not exist. | The DB instance does not exist. | Check whether the instance and its ID are correct and whether the instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 404 | DBS.290013 | Resource not found. | Resource not found. | Check whether the transferred parameters are correct and whether the DB instance exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200011 | Another operation is being performed on the DB instance or the DB instance is faulty. | Another operation is being performed on the DB instance or the DB instance is faulty. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200019 | Another operation is being performed on the DB instance or the DB instance is faulty. | Another operation is being performed on the DB instance or the DB instance is faulty. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200022 | The DB instance name already exists. | The DB instance name already exists. | Check whether the instance name exists. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200047 | Another operation is being performed on the DB instance or the DB instance is faulty. | Another operation is being performed on the DB instance or the DB instance is faulty. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200316 | This operation cannot be performed because the DB instance status is Storage full. | This operation cannot be performed because the DB instance status is **Storage full**. | Adjust the storage space. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200826 | The database name already exists. | The database name already exists. | Check whether the database name is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200827 | The database user already exists. | The database user already exists. | Check whether the database user is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.200828 | You are not allowed to create a database built-in account. | You are not allowed to create a database built-in account. | Check whether the database user is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.201202 | Another operation is being performed on the DB instance or the DB instance is faulty. | Another operation is being performed on the DB instance or the DB instance is faulty. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.201205 | Backup is in progress, please wait. | Backup is in progress. | Try again after the backup is complete. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.212006 | Another operation is being performed on the DB instance or the DB instance is faulty. | Another operation is being performed on the DB instance or the DB instance is faulty. | Check whether the instance status or the ongoing operation on the instance conflicts with the request. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 409 | DBS.280406 | Operation not allowed by the DB instance type or status. | Operation not allowed by the DB instance type or status. | Check whether the instance type and instance status meet requirements. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 413 | DBS.200046 | The number of DB instances has reached the quota. | The number of DB instances has reached the quota. | Contact the database administrator to adjust the quota. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 413 | DBS.290003 | The number of DB instances has reached the quota. | The number of DB instances has reached the quota. | Contact the database administrator to adjust the quota. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 422 | DBS.212019 | The parameter cannot be processed. | The parameter cannot be processed. | Check whether the parameter is valid. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.108000 | Server failure. | Server failure. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.108002 | Server failure. | Server failure. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.108005 | Server failure. | Server failure. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.200005 | Server failure. | Server failure. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.200208 | Server failure. | Server failure. | Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.200811 | Failed to create the database. | Failed to create the database. | Check whether resources are insufficient and then contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.200821 | Failed to modify database user permissions. | Failed to modify database user permissions. | This operation is not allowed in the current instance status. Try again later. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.213002 | Failed to process the request. | Failed to process the request. | Internal service error. Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.213004 | Failed to process the request. | Failed to process the request. | Internal service error. Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.290006 | Failed to process the request. | Failed to process the request. | Internal service error. Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 500 | DBS.290015 | Failed to process the request. | Failed to process the request. | Internal service error. Contact customer service. | + +-------------+------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst b/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst index c83fa50..19312e8 100644 --- a/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst +++ b/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst @@ -20,168 +20,268 @@ Monitoring Metrics .. table:: **Table 1** Monitoring metrics - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | Metric | Name | Description | Value Range | Remarks | - +================================================+================================================+===================================================================================================+====================+======================================================+ - | gaussdb_mysql001_cpu_util | CPU Usage | CPU usage of the monitored object | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql002_mem_util | Memory Usage | Memory usage of the monitored object | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql004_bytes_in | Network Input Throughput | Incoming traffic in bytes per second | >=0 Bytes/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql005_bytes_out | Network Output Throughput | Outgoing traffic in bytes per second | >=0 Bytes/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql006_conn_count | Total Connections | Total number of connections that attempt to connect to the MySQL server | >=0 Counts | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql007_conn_active_count | Current Active Connections | Number of current active connections | >=0 Counts | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql008_qps | QPS | Query times of SQL statements (including storage procedures) per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql009_tps | TPS | Execution times of submitted and rollback transactions per second | >=0 Transactions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql010_innodb_buf_usage | Buffer Pool Usage | Ratio of dirty data to all data in the InnoDB buffer | 0-1 | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql011_innodb_buf_hit | Buffer Pool Hit Ratio | Ratio of read hits to read requests in the InnoDB buffer | 0-100% | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql012_innodb_buf_dirty | Buffer Pool Dirty Block Ratio | Ratio of used pages to total pages in the InnoDB buffer | 0-1 | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql013_innodb_reads | InnoDB Read Throughput | Number of read bytes per second in the InnoDB buffer | >=0 Bytes/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql014_innodb_writes | InnoDB Write Throughput | Number of write bytes per second in the InnoDB buffer | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql017_innodb_log_write_req_count | InnoDB Log Write Requests per Second | Number of InnoDB log write requests per second | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql020_temp_tbl_count | Temporary Tables | Number of temporary tables automatically created on hard disks when MySQL statements are executed | >=0 Counts | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql028_comdml_del_count | DELETE Statements per Second | Number of DELETE statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql029_comdml_ins_count | INSERT Statements per Second | Number of INSERT statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql030_comdml_ins_sel_count | INSERT_SELECT Statements per Second | Number of INSERT_SELECT statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql031_comdml_rep_count | REPLACE Statements per Second | Number of REPLACE statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql032_comdml_rep_sel_count | REPLACE_SELECTION Statements per Second | Number of REPLACE_SELECTION statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql033_comdml_sel_count | SELECT Statements per Second | Number of SELECT statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql034_comdml_upd_count | UPDATE Statements per Second | Number of UPDATE statements executed per second | >=0 Executions/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql035_innodb_del_row_count | Row Delete Frequency | Number of rows deleted from the InnoDB table per second | >=0 Rows/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql036_innodb_ins_row_count | Row Insert Frequency | Number of rows inserted into the InnoDB table per second | >=0 Rows/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql037_innodb_read_row_count | Row Read Frequency | Number of rows read from the InnoDB table per second | >=0 Rows/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql038_innodb_upd_row_count | Row Update Frequency | Number of rows updated into the InnoDB table per second | >=0 Rows/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql048_disk_used_size | Used Storage Space | Used storage space of the monitored object | 0-4000 GB | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql072_conn_usage | Connection Usage | Percent of used MySQL connections to the total number of connections | 0~100% | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql074_slow_queries | Slow Query Logs | Number of MySQL slow query logs generated per minute | >=0 Counts/Minute | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql077_replication_delay | Replication Delay | Data replication delay between the primary node and read replicas | >=0 s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql104_dfv_write_delay | Storage Write Latency | Average latency of writing data to the storage layer in a specified period | >=0 ms | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql105_dfv_read_delay | Storage Read Latency | Average latency of reading data from the storage layer in a specified period | >=0 ms | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql106_innodb_row_lock_current_waits | InnoDB Row Locks | Number of row locks being waited by operations on the InnoDB table | >=0 Counts | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql107_comdml_ins_and_ins_sel_count | INSERT and INSERT_SELECT Statements per Second | Number of INSERT and INSERT_SELECT statements executed per second | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql108_com_commit_count | COMMIT Statements per Second | Number of COMMIT statements executed per second | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql109_com_rollback_count | ROLLBACK Statements per Second | Number of ROLLBACK statements executed per second | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql110_innodb_bufpool_reads | InnoDB Storage Layer Read Requests per Second | Number of times that InnoDB reads data from the storage layer per second | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ - | gaussdb_mysql111_innodb_bufpool_read_requests | InnoDB Read Requests per Second | Number of InnoDB read requests per second | >=0 Counts/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +------------------------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------+------------------------------------------------------+ + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | Metric | Name | Description | Value Range | Remarks | + +====================================================+================================================+=============================================================================================================================================================+=================+======================================================+ + | gaussdb_mysql001_cpu_util | CPU Usage | CPU usage of the monitored object | 0-100% | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql002_mem_util | Memory Usage | Memory usage of the monitored object | 0-100% | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql004_bytes_in | Network Input Throughput | Incoming traffic in bytes per second | >=0 bytes/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql005_bytes_out | Network Output Throughput | Outgoing traffic in bytes per second | >=0 bytes/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql006_conn_count | Total Connections | Total number of connections that connect to the MySQL server | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql007_conn_active_count | Current Active Connections | Number of active connections | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql008_qps | QPS | Query times of SQL statements (including DDL, DML, SHOW, SET statements and storage procedures) per second | >=0 times/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql009_tps | TPS | Execution times of submitted and rollback transactions per second | >=0 times/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql010_innodb_buf_usage | Buffer Pool Usage | Ratio of used pages to total pages in the InnoDB buffer | 0-1 | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql011_innodb_buf_hit | Buffer Pool Hit Ratio | Ratio of read hits to read requests in the InnoDB buffer | 0-1 | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql012_innodb_buf_dirty | Buffer Pool Dirty Block Ratio | Ratio of dirty data to all data in the InnoDB buffer | 0-1 | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql013_innodb_reads | InnoDB Read Throughput | Number of read bytes per second in the InnoDB buffer | >=0 bytes/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql014_innodb_writes | InnoDB Write Throughput | Number of write bytes per second in the InnoDB buffer | >=0 bytes/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql017_innodb_log_write_req_count | InnoDB Log Write Requests per Second | Number of InnoDB log write requests per second | >=0 times/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql020_temp_tbl_count | Temporary Tables | Number of temporary tables automatically created on hard disks when MySQL statements are executed | >= 0 counts | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql028_comdml_del_count | DELETE Statements per Second | Number of DELETE statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql029_comdml_ins_count | INSERT Statements per Second | Number of INSERT statements executed per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql030_comdml_ins_sel_count | INSERT_SELECT Statements per Second | Number of INSERT_SELECT statements executed per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql031_comdml_rep_count | REPLACE Statements per Second | Number of REPLACE statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql032_comdml_rep_sel_count | REPLACE_SELECTION Statements per Second | Number of REPLACE_SELECTION statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql033_comdml_sel_count | SELECT Statements per Second | Number of SELECT statements executed per second | >=0 Counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql034_comdml_upd_count | UPDATE Statements per Second | Number of UPDATE statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql035_innodb_del_row_count | Row Delete Frequency | Number of rows deleted from the InnoDB table per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql036_innodb_ins_row_count | Row Insert Frequency | Number of rows inserted into the InnoDB table per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql037_innodb_read_row_count | Row Read Frequency | Number of rows read from the InnoDB table per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql038_innodb_upd_row_count | Row Update Frequency | Number of rows updated into the InnoDB table per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql048_disk_used_size | Used Storage Space | Used storage space of the monitored object | 0 GB-128 TB | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql072_conn_usage | Connection Usage | Percent of used MySQL connections to the total number of connections | 0-100% | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql074_slow_queries | Slow Query Logs | Number of MySQL slow query logs generated per minute | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql077_replication_delay | Replication Delay | Data replication delay between the primary node and read replicas | >=0 ms | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql104_dfv_write_delay | Storage Write Latency | Average latency of writing data to the storage layer in a specified period | >=0 ms | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql105_dfv_read_delay | Storage Read Latency | Average latency of reading data from the storage layer in a specified period | >=0 ms | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql106_innodb_row_lock_current_waits | InnoDB Row Locks | Number of row locks being waited by operations on the InnoDB table | >= 0 counts | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql107_comdml_ins_and_ins_sel_count | INSERT and INSERT_SELECT Statements per Second | Number of INSERT and INSERT_SELECT statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql108_com_commit_count | COMMIT Statements per Second | Number of COMMIT statements executed per second | >=0 Counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql109_com_rollback_count | ROLLBACK Statements per Second | Number of ROLLBACK statements executed per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql110_innodb_bufpool_reads | InnoDB Storage Layer Read Requests per Second | Number of times that InnoDB reads data from the storage layer per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql111_innodb_bufpool_read_requests | InnoDB Read Requests per Second | Number of InnoDB read requests per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql114_innodb_bufpool_read_ahead | InnoDB Bufpool Read Ahead | Number of pages read into the InnoDB buffer pool by the read-ahead background thread | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql115_innodb_bufpool_read_ahead_evicted | InnoDB Bufpool Read Ahead Evicted | Number of pages read into the InnoDB buffer pool by the read-ahead background thread that were subsequently evicted without having been accessed by queries | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql116_innodb_bufpool_read_ahead_rnd | InnoDB Bufpool Read Ahead Rnd | Number of random read-aheads initiated by InnoDB | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql117_innodb_pages_read | InnoDB Pages Read | Number of pages read from the InnoDB buffer pool by operations on InnoDB tables | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql118_innodb_pages_written | InnoDB Pages Written | Number of pages written by operations on InnoDB tables | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql019_innodb_log_writess | InnoDB Log Writes | Number of physical writes to the InnoDB redo log file | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql342_iostat_iops_write | I/O Write IOPS | Number of disk writes per second | >=0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql344_iostat_iops_read | I/O Read IOPS | Number of disk reads per second | >=0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql346_iostat_throughput_write | I/O Write Bandwidth | Disk write bandwidth per second | >=0 bytes/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql348_iostat_throughput_read | I/O Read Bandwidth | Disk read bandwidth per second | >=0 bytes/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql119_disk_used_ratio | Disk Usage | Disk usage of the monitored object | 0-100% | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql120_innodb_buffer_pool_bytes_data | Total Bytes of Buffer Pool | Total number of bytes in the InnoDB buffer pool containing data | >=0 bytes | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql121_innodb_row_lock_time | Row Lock Time | Total time spent in acquiring row locks for InnoDB tables | >=0 ms | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql122_innodb_row_lock_waits | Row Lock Waits | Number of times operations on InnoDB tables had to wait for a row lock | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql123_sort_range | Sorts Using Ranges | Number of sorts that were done using ranges | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql124_sort_rows | Sorted Rows | Number of sorted rows | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql125_sort_scan | Sorts by Scanning Tables | Number of sorts that were done by scanning tables. | >=0 Counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql126_table_open_cache_hits | Hits for Open Tables Cache Lookups | Number of hits for open tables cache lookups | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql127_table_open_cache_misses | Misses for Open Tables Cache Lookups | Number of misses for open tables cache lookups | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql128_long_trx_count | Long-Running Transactions | Number of long transactions that are not closed | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 150 s | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ Dimension --------- -========================= ============================================ +========================= =========================================== Key Value -========================= ============================================ -gaussdb_mysql_instance_id GaussDB (for MySQL) instance ID. -gaussdb_mysql_node_id Node ID of the GaussDB (for MySQL) instance. -========================= ============================================ +========================= =========================================== +gaussdb_mysql_instance_id GaussDB(for MySQL) instance ID. +gaussdb_mysql_node_id Node ID of the GaussDB(for MySQL) instance. +========================= =========================================== diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst index c03b2d1..66990cd 100644 --- a/api-ref/source/appendix/obtaining_a_project_id.rst +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -60,7 +60,7 @@ Obtain a Project ID from the Console On the **My Credentials** page, view project IDs in the project list. - .. figure:: /_static/images/en-us_image_0000001423128721.jpg + .. figure:: /_static/images/en-us_image_0000001476990897.jpg :alt: **Figure 1** Viewing project IDs **Figure 1** Viewing project IDs diff --git a/api-ref/source/appendix/status_codes.rst b/api-ref/source/appendix/status_codes.rst index 727eb55..cf23706 100644 --- a/api-ref/source/appendix/status_codes.rst +++ b/api-ref/source/appendix/status_codes.rst @@ -5,9 +5,9 @@ Status Codes ============ -Status code list: +The following table describes status codes. -.. table:: **Table 1** Status Code +.. table:: **Table 1** Status codes +-----------------------+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Status Code | Message | Description | diff --git a/api-ref/source/before_you_start/api_calling.rst b/api-ref/source/before_you_start/api_calling.rst index d5add04..e6feb4a 100644 --- a/api-ref/source/before_you_start/api_calling.rst +++ b/api-ref/source/before_you_start/api_calling.rst @@ -5,4 +5,4 @@ API Calling =========== -GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs `. +GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`API Usage Guidelines `. diff --git a/api-ref/source/before_you_start/concepts.rst b/api-ref/source/before_you_start/concepts.rst index edf7788..09f66a7 100644 --- a/api-ref/source/before_you_start/concepts.rst +++ b/api-ref/source/before_you_start/concepts.rst @@ -11,9 +11,9 @@ Concepts - IAM User - An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys). + An IAM domain is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys). - API authentication requires information such as the account name, username, and password. + API authentication requires information such as the domain name, username, and password. - Region @@ -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. - .. figure:: /_static/images/en-us_image_0000001422968749.gif + .. figure:: /_static/images/en-us_image_0000001477110589.gif :alt: **Figure 1** Project isolating model **Figure 1** Project isolating model diff --git a/api-ref/source/before_you_start/overview.rst b/api-ref/source/before_you_start/overview.rst index 5ace8db..d0ab13a 100644 --- a/api-ref/source/before_you_start/overview.rst +++ b/api-ref/source/before_you_start/overview.rst @@ -5,6 +5,12 @@ Overview ======== +GaussDB(for MySQL) is a MySQL-compatible, enterprise-grade distributed database service. It uses a compute-storage decoupled architecture and supports up to 128 TB of storage. With GaussDB(for MySQL), there is no need to do sharding, and no need to worry about data loss. It provides superior performance of commercial databases at the price of open-source databases. + +.. note:: + + Data Function Virtualization (DFV) is a high-performance and high-reliability distributed storage system that is vertically integrated with databases. Storage clusters are deployed in pools to improve storage utilization. + This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see :ref:`API Overview `. -If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see "What Is GaussDB(for MySQL)?" in the *GaussDB(for MySQL) User Guide*. +If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see `Introduction `__ in *GaussDB(for MySQL) User Guide*. diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 75d9734..490dc68 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,13 +5,56 @@ Change History ============== -+-----------------------------------+-------------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+=====================================================================================+ -| 2022-10-30 | This issue is the second official release. | -| | | -| | - Optimized the content in :ref:`Querying a Parameter Template `. | -| | - Optimized the content in :ref:`Querying a DB Instance List `. | -+-----------------------------------+-------------------------------------------------------------------------------------+ -| 2020-05-30 | This issue is the first official release. | -+-----------------------------------+-------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+===========================================================================================================================+ +| 2023-04-06 | Modified the following content: | +| | | +| | - Deleted the **backup_level** parameter in :ref:`Querying Backups `. | +| | - Deleted the **retention_num_backup_level1** parameter in :ref:`Querying an Automated Backup Policy `. | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| 2022-11-30 | Modified the following content: | +| | | +| | - Added :ref:`Querying Version Information About a DB Engine `. | +| | - Added :ref:`Querying Database Specifications `. | +| | - Added :ref:`Deleting a DB Instance `. | +| | - Added :ref:`Querying Details of a DB Instance `. | +| | - Added :ref:`Creating a Read Replica `. | +| | - Added :ref:`Deleting a Read Replica `. | +| | - Added :ref:`Changing a DB Instance Name `. | +| | - Added :ref:`Resetting a Database Password `. | +| | - Added :ref:`Changing DB Instance Specifications `. | +| | - Added :ref:`Creating a Manual Backup `. | +| | - Added :ref:`Querying Backups `. | +| | - Added :ref:`Querying an Automated Backup Policy `. | +| | - Added :ref:`Modifying an Automated Backup Policy `. | +| | - Added :ref:`Querying Parameter Templates `. | +| | - Added :ref:`Querying Resource Quotas `. | +| | - Added :ref:`Configuring Resource Quotas `. | +| | - Added :ref:`Modifying Resource Quotas `. | +| | - Added :ref:`Querying the DB Instance Quotas of a Tenant `. | +| | - Added :ref:`Querying Database Proxy Specifications `. | +| | - Added :ref:`Enabling Database Proxy `. | +| | - Added :ref:`Disabling Database Proxy `. | +| | - Added :ref:`Adding Database Proxy Nodes `. | +| | - Added :ref:`Querying Database Proxy Instances `. | +| | - Added :ref:`Changing Specifications of a Database Proxy Instance `. | +| | - Added :ref:`Assigning Read Weights `. | +| | - Added :ref:`Querying Database Error Logs `. | +| | - Added :ref:`Querying Database Slow Logs `. | +| | - Added :ref:`Querying Resource Tags `. | +| | - Added :ref:`Querying Project Tags `. | +| | - Added :ref:`Adding or Deleting Tags in Batches `. | +| | - Added :ref:`Configuring Concurrency Control Rules of SQL Statements `. | +| | - Added :ref:`Querying Concurrency Control Rules of SQL Statements `. | +| | - Added :ref:`Deleting Concurrency Control Rules of SQL Statements `. | +| | - Added :ref:`Obtaining Information About a Task with a Specified ID `. | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| 2020-12-09 | Modified the following content: | +| | | +| | Optimized the content for API usage. | +| | | +| | Modified the **spec_code description** parameter in :ref:`Querying Database Specifications `. | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| 2020-05-30 | This issue is the first official release. | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 687eafc..56f0702 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -18,7 +18,7 @@ import os import sys extensions = [ - 'otcdocstheme' + 'otcdocstheme', ] otcdocs_auto_name = False diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index c42ed2e..1242e47 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -7,7 +7,8 @@ GaussDB (for MySQL) - API Reference before_you_start/index api_overview - calling_apis/index - api/index + api_usage_guidelines/index + apis_recommended/index + apis_unavailable_soon/index appendix/index change_history