diff --git a/docs/rds/api-ref/en-us_topic_0032347785.html b/docs/rds/api-ref/en-us_topic_0032347785.html index 4193229b1..d48d2a66a 100644 --- a/docs/rds/api-ref/en-us_topic_0032347785.html +++ b/docs/rds/api-ref/en-us_topic_0032347785.html @@ -308,7 +308,7 @@
Specifies the volume type.
Its value can be any of the following and is case-sensitive:
-- COMMON: indicates the SATA type.
- ULTRAHIGH: indicates the SSD type.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
size
@@ -461,7 +461,7 @@ }, "flavorRef": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4", "volume": { - "type": "ULTRAHIGH", + "type": "CLOUDSSD", "size": 100 }, "region": "eu-de", @@ -491,7 +491,7 @@ }, "flavorRef": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4", "volume": { - "type": "ULTRAHIGH", + "type": "CLOUDSSD", "size": 100 }, "region": "eu-de", @@ -877,7 +877,7 @@ }, "dbPort": 3306, "volume": { - "type": "ULTRAHIGH", + "type": "CLOUDSSD", "size": 100 }, "dataStoreInfo": null, @@ -917,7 +917,7 @@ "id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4" }, "volume": { - "type": "ULTRAHIGH", + "type": "CLOUDSSD", "size": 100 }, "dbPort": 3306, @@ -965,7 +965,7 @@ "id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4" }, "volume": { - "type": "ULTRAHIGH", + "type": "CLOUDSSD", "size": 100 }, "dbPort": 3306, diff --git a/docs/rds/api-ref/en-us_topic_0032488244.html b/docs/rds/api-ref/en-us_topic_0032488244.html index 8eb2748ba..85844aa7d 100644 --- a/docs/rds/api-ref/en-us_topic_0032488244.html +++ b/docs/rds/api-ref/en-us_topic_0032488244.html @@ -8,10 +8,15 @@2024-12-12
+2025-10-30
+- Added Restoring Data to an Existing DB Instance.
- Added Querying Storage Usage of a DB Instance.
- Added Changing the Description of a DB Instance.
- Added Obtaining the Replication Status of a DB Instance.
- Added Querying Available Instance Classes for a DB Instance.
- Added Enabling TDE for a DB Instance (RDS for SQL Server).
- Added Querying TDE Status of a DB Instance (RDS for SQL Server).
- Added Obtaining the SSL Certificate Download Address.
- Added Changing a Floating IP Address.
- Added Replicating a Parameter Template.
- Added Deleting Manual Backups in Batches (RDS for SQL Server).
- Added Showing Original Logs.
- Added Querying Slow Query Log Files (SQL Server).
- Added Obtaining Links for Downloading Error Logs (RDS for PostgreSQL).
- Added Adding a SQL Throttling Rule for a Database.
- Added Deleting a SQL Throttling Rule.
- Added Modifying a SQL Throttling Rule.
- Added Querying SQL Throttling RuleQuerying SQL Throttling Rule.
- Added Enabling or Disabling a SQL Throttling Rule or Disabling All SQL Throttling Rules.
- Added Enabling Database Proxy.
- Added Querying Database Proxies.
- Added Querying Database Proxy Specifications.
- Added Configuring the Routing Policy for a Database Proxy.
- Added Disabling Database Proxy.
- Added Adding Host Addresses for MSDTC.
- Added Querying MSDTC Hosts.
- Added Querying Resource Quotas.
- Added Querying Tags of a DB Instance.
- Added Querying Scheduled Tasks.
- Added Querying Instant Tasks.
- Added Obtaining Task Information of a Specified DB Instance in a Specified Time Range (RDS for SQL Server).
2024-12-12
Modified the following content:
-- Added constraints in Querying Database Slow Logs.
- Modified constraints in Setting an Automated Backup Policy
- Added constraints in Querying Database Slow Logs.
- Modified constraints in Setting an Automated Backup Policy.
2024-08-15
@@ -47,7 +52,7 @@2023-04-20
Modified the following content:
-Added Upgrading a Minor Version.
+2023-03-08
@@ -95,13 +100,13 @@2021-07-07
Modified the following content:
-- Added Querying the Storage Type of a Database.
- Added Changing a DB Instance Name.
- Added Binding and Unbinding an EIP.
- Added Changing the Failover Priority.
- Added Manually Switching Primary/Standby DB Instances.
- Added Changing the Data Synchronize Model of Primary/Standby DB Instances.
- Added Migrating a Standby DB Instance.
- Added Configuring the Maintenance Window.
- Added Configuring SSL.
- Added Changing a Database Port.
- Added Changing a Security Group.
- Added Changing a Private IP Address.
- Added Obtaining Slow Query Log Statistics.
- Added Obtaining Links for Downloading Slow Query Logs.
- Added Setting SQL Audit.
- Added Querying the Policy for SQL Audit Logs.
- Added Obtaining an Audit Log List.
- Added Obtaining the Link for Downloading an Audit Log.
- Added Modifying Recycling Policy.
- Added Querying the Storage Type of a Database.
- Added Changing a DB Instance Name.
- Added Binding and Unbinding an EIP.
- Added Changing the Failover Priority.
- Added Manually Switching Primary/Standby DB Instances.
- Added Changing the Data Synchronize Model of Primary/Standby DB Instances.
- Added Migrating a Standby DB Instance.
- Added Configuring the Maintenance Window.
- Added Configuring SSL.
- Added Changing a Database Port.
- Added Changing a Security Group.
- Added Changing a Floating IP Address.
- Added Obtaining Slow Query Log Statistics.
- Added Obtaining Links for Downloading Slow Query Logs.
- Added Setting SQL Audit.
- Added Querying the Policy for SQL Audit Logs.
- Added Obtaining an Audit Log List.
- Added Obtaining the Link for Downloading an Audit Log.
- Added Modifying Recycling Policy.
2021-05-25
Modified the following content:
-Modified API restrictions in Obtaining Task Information.
+Modified API restrictions in Obtaining Information About a Task with a Specified ID.
2021-02-24
@@ -161,7 +166,7 @@2018-12-29
Modified the following content:
-- Added v3 APIs in section Creating a DB Instance.
- Added v3 APIs in section Deleting a DB Instance.
- Added v3 APIs in section Querying DB Instances.
- Added v3 APIs in section Obtaining a Parameter Template List.
- Added v3 APIs in section Creating a Parameter Template.
- Added v3 APIs in section Modifying a Parameter Template.
- Added v3 APIs in section Applying a Parameter Template.
- Added v3 APIs in section Modifying Parameters of a Specified DB Instance.
- Added v3 APIs in section Obtaining the Parameter Template of a Specified DB Instance.
- Added v3 APIs in section Obtaining Parameters in a Specified Parameter Template.
- Added v3 APIs in section Deleting a Parameter Template.
- Added v3 APIs in section Setting an Automated Backup Policy.
- Added v3 APIs in section Obtaining an Automated Backup Policy.
- Added v3 APIs in section Creating a Manual Backup.
- Added v3 APIs in section Obtaining Details About Backups.
- Added v3 APIs in section Obtaining the Link for Downloading a Backup File.
- Added v3 APIs in section Deleting a Manual Backup.
- Added v3 APIs in section Querying the Restoration Time Range.
- Added v3 APIs in section Restoring Data to a New DB Instance.
- Added v3 APIs in section Restoring Data to an Existing or Original DB Instance.
- Added v3 APIs in section Obtaining Task Information.
- Added v3 API abnormal response description in section Abnormal Request Results.
- Added v3 error codes in the DBS.XXXXXX format in section Error Codes.
- Added v3 APIs in section Creating a DB Instance.
- Added v3 APIs in section Deleting a DB Instance.
- Added v3 APIs in section Querying DB Instances.
- Added v3 APIs in section Obtaining a Parameter Template List.
- Added v3 APIs in section Creating a Parameter Template.
- Added v3 APIs in section Modifying a Parameter Template.
- Added v3 APIs in section Applying a Parameter Template.
- Added v3 APIs in section Modifying Parameters of a Specified DB Instance.
- Added v3 APIs in section Obtaining the Parameter Template of a Specified DB Instance.
- Added v3 APIs in section Obtaining Parameters in a Specified Parameter Template.
- Added v3 APIs in section Deleting a Parameter Template.
- Added v3 APIs in section Setting an Automated Backup Policy.
- Added v3 APIs in section Obtaining an Automated Backup Policy.
- Added v3 APIs in section Creating a Manual Backup.
- Added v3 APIs in section Obtaining Details About Backups.
- Added v3 APIs in section Obtaining the Link for Downloading a Backup File.
- Added v3 APIs in section Deleting a Manual Backup.
- Added v3 APIs in section Querying the Restoration Time Range.
- Added v3 APIs in section Restoring Data to a New DB Instance.
- Added v3 APIs in section Restoring Data to an Existing or Original DB Instance.
- Added v3 APIs in section Obtaining Information About a Task with a Specified ID.
- Added v3 API abnormal response description in section Abnormal Request Results.
- Added v3 error codes in the DBS.XXXXXX format in section Error Codes.
2018-06-28
diff --git a/docs/rds/api-ref/en-us_topic_0056887470.html b/docs/rds/api-ref/en-us_topic_0056887470.html index aadcb52d5..bf554bac5 100644 --- a/docs/rds/api-ref/en-us_topic_0056887470.html +++ b/docs/rds/api-ref/en-us_topic_0056887470.html @@ -12,8 +12,22 @@+
+
+
+
+
+
+
@@ -40,10 +54,18 @@
+
+
+
+
+
+
@@ -20,6 +22,8 @@
+
+
+
+
diff --git a/docs/rds/api-ref/en-us_topic_0056889804.html b/docs/rds/api-ref/en-us_topic_0056889804.html index 14643e136..8f33867c5 100644 --- a/docs/rds/api-ref/en-us_topic_0056889804.html +++ b/docs/rds/api-ref/en-us_topic_0056889804.html @@ -376,9 +376,7 @@
Specifies the volume type.
Its value can be any of the following and is case-sensitive:
-- COMMON: indicates the SATA type.
- ULTRAHIGH: indicates the SSD type.
In the Trove API, this parameter is optional in the request. If this parameter is not contained in the request, its value is COMMON by default. If this parameter is specified, the volume type must be set to a value supported by the old API.
-- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
size
diff --git a/docs/rds/api-ref/rds_01_0002.html b/docs/rds/api-ref/rds_01_0002.html index 1536b8d36..265bd79df 100644 --- a/docs/rds/api-ref/rds_01_0002.html +++ b/docs/rds/api-ref/rds_01_0002.html @@ -371,7 +371,7 @@String
Specifies the database version.
-- MySQL databases support 5.7 and 8.0. Example value: 5.7
- PostgreSQL databases support 12, 13, 14, 15, 16 and 17. Example value: 13
- Microsoft SQL Server databases only support 2017_SE, 2017_EE, 2019_SE, 2019_EE, 2022_SE and 2022_EE. Example value: 2017_SE
- MySQL databases support 5.7 and 8.0. Example value: 5.7
- PostgreSQL databases support 12, 13, 14, 15, 16 and 17. Example value: 13
- Microsoft SQL Server databases only support 2017_SE, 2017_EE, 2019_SE, 2019_EE, 2022_SE and 2022_EE. Example value: 2017_SE
For details about supported database versions, see section Querying Version Information About a DB Engine.
Integer
Specifies the retention days for specific backup files.
-The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.
-Primary/standby DB instances and Cluster DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
-The value range is from 1 to 732. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.
Specifies the volume type.
Its value can be any of the following and is case-sensitive:
-- COMMON: SATA storage.
- ULTRAHIGH: ultra-high I/O storage.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
- The MySQL and PostgreSQL DB engines support the following volume types: CLOUDSSD and ESSD. ESSD is not supported for Single instance types for MySQL and PostgreSQL.
- The SQL Server engine supports the following volume types: COMMON, ULTRAHIGH, and ESSD.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
size
@@ -885,7 +881,7 @@Integer
Indicates the retention days for specific backup files.
-The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.
+The value range is from 1 to 732. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.
If backup_strategy in the request body is empty, 7 is returned for keep_days by default.
Indicates the volume type.
Its value can be any of the following and is case-sensitive:
-- COMMON: SATA storage.
- ULTRAHIGH: ultra-high I/O storage.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
size
diff --git a/docs/rds/api-ref/rds_01_0009.html b/docs/rds/api-ref/rds_01_0009.html deleted file mode 100644 index 68ec12885..000000000 --- a/docs/rds/api-ref/rds_01_0009.html +++ /dev/null @@ -1,487 +0,0 @@ - - -Obtaining Task Information
-Function
This API is used to obtain task information of the task center.
-- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
Constraints
- RDS jobs are asynchronous. After a job is generated, it takes several seconds to query the job ID.
- This API is used to query only asynchronous tasks in the task center within one month.
- Information of the following asynchronous tasks can be obtained: creating single or primary/standby DB instances, creating read replicas, changing single DB instances to primary/standby instances, switching primary/standby DB instances, scaling up storage space, and binding or unbinding EIPs.
URI
-- Parameter description
--
-Table 1 Parameter description Name
-Mandatory
-Description
-project_id
-Yes
-Specifies the project ID of a tenant in a region.
-For details about how to obtain the project ID, see Obtaining a Project ID.
-id
-Yes
-Specifies the task ID.
-
Request
- -Response
- Normal response
-- -
-Table 2 Parameter description Name
-Type
-Description
-id
-String
-Indicates the task ID.
-name
-String
-Indicates the task name.
-status
-String
-Indicates the task execution status.
-Value:-- Running: The task is being executed.
- Completed: The task is successfully executed.
- Failed: The task fails to be executed.
created
-String
-Indicates the 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
-Indicates the task execution progress.
-NOTE:-The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
-instance
-Object
-Indicates information of the DB instance on which the task is executed.
-For details, see Table 3.
-entities
-Object
-The displayed information varies depending on the tasks.
-Refer to the following:
- -NOTE:-For asynchronous tasks without the entities field description, {} is returned.
-fail_reason
-String
-Indicates the error information displayed when a task failed.
-- -
-Table 3 instances field data structure description Name
-Type
-Description
-id
-String
-Indicates the DB instance ID.
-name
-String
-Indicates the DB instance name.
-- -
-Table 4 entities field data structure description (creating DB instances, changing single DB instances to primary/standby, or creating read replicas) Name
-Type
-Description
-instance
-Object
-Indicates the DB instance information to be implemented by a task.
-For details, see Table 5.
-resource_ids
-List<String>
-Indicates the resource ID involved in a task.
-- -
-Table 5 entities.instance field data structure description Name
-Type
-Description
-endpoint
-String
-Indicates the DB instance connection address.
-type
-String
-The value is Single, Ha, or Replica, indicating the single DB instance, primary/standby DB instances, and read replica, respectively.
-datastore
-Object
-Data structure. For details, see Table 6.
-replica_of
-String
-Indicates the primary DB instance ID. This parameter is returned only when a read replica is created.
-- -
-Table 6 datastore field data structure description Name
-Type
-Description
-type
-String
-Indicates the DB engine.
-version
-String
-Indicates the database version.
-- -
-Table 7 entities field data structure description (resizing a DB instance) Name
-Type
-Description
-volume
-Object
-Indicates the resized disk information.
-For details, see Table 8.
-resource_ids
-List<String>
-Indicates the resource ID involved in a task.
-- -
-Table 8 volume field data structure description Name
-Type
-Description
-type
-String
-Indicates the volume type.
-original_size
-String
-Indicates the original disk size of the DB instance.
-target_size
-String
-Indicates the target disk size of the DB instance.
-- -
-Table 9 entities field data structure description (binding/unbinding EIPs or enabling/disabling remote access) Name
-Type
-Description
-public_ip
-String
-Indicates the EIP implemented by the task.
--
-Table 10 entities field data structure description (primary/standby switchover) Name
-Type
-Description
-switch_strategy
-String
-Indicates the primary/standby switchover policy.
--
In the response example, some tasks in the task center are used as examples.
-
- Example normal responseCreating a DB instance:-
{ - "job": { - "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", - "name": "CreateMysqlSingleHAInstance", - "status": "Completed", - "created": "2018-08-06T10:41:14+0000", - "process": "", - "instance": { - "id": "a48e43ff268f4c0e879652d65e63d0fbin01", - "name": "DO-NOT-TOUCH-mgr2-mysql-single" - }, - "entities": { - "instance": { - "endpoint": "192.168.1.203:3306", - "type": "Single", - "datastore": { - "type": "mysql", - "version": "5.7" - } - }, - "resource_id": ["a48e43ff268f4c0e879652d65e63d0fbin01.vm", "a48e43ff268f4c0e879652d65e63d0fbin01.volume"] - } - } -}-Creating a read replica:-{ - "job": { - "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", - "name": " CreateMysqlReplicaInstance", - "status": "Completed", - "created": "2018-08-06T10:41:14+0000", - "process": "", - "instance": { - "id": "288caaa9d05f4ec1a1f58de2e0945685in01", - "name": "mysql-replica" - }, - "entities": { - "instance": { - "endpoint": "192.168 .1 .203: 3306", - "type": "replica", - "datastore": { - "type": "mysql", - "version": "5.7" - }, - "replica_of": "a48e43ff268f4c0e879652d65e63d0fbin01" - }, - "resource_ids": ["288caaa9d05f4ec1a1f58de2e0945685in01.vm", "288caaa9d05f4ec1a1f58de2e0945685in01.volume"] - } - } -}-Binding an EIP:-{ - "job": { - "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", - "name": "MysqlBindEIP", - "status": "Completed", - "created": "2018-08-06T10:41:14+0000", - "process": "", - "instance": { - "id": "a48e43ff268f4c0e879652d65e63d0fbin01", - "name": "DO-NOT-TOUCH-mgr2-mysql-single" - }, - "entities": { - "public_ip": "10.154 .218 .254" - } - } -}-Rebooting a DB instance:-{ - "job": { - "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", - "name": " RestartMysqlInstance", - "status": "Completed", - "created": "2018-08-06T10:41:14+0000", - "process": "", - "instance": { - "id": "a48e43ff268f4c0e879652d65e63d0fbin01", - "name": "DO-NOT-TOUCH-mgr2-mysql-single" - }, - "entities": {} - } -}-Task being executed:-{ - "job": { - "id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886", - "name": "CreateMysqlSingleHAInstance"," status": "Running", - "created": "2018-08-06T10:41:14+0000", - "process": "60 % ", - "instance": { - "id": "a48e43ff268f4c0e879652d65e63d0fbin01", - "name": "DO-NOT-TOUCH-mgr2-mysql-single" - }, - "entities": { - "instance": { - "type": "Single", - "datastore": { - "type": "mysql", - "version": "5.7" - } - } - } - } -}-Task fails to be executed:-{ - "job": { - "id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886", - "name": "CreateMysqlSingleHAInstance", - "status": "Failed", - "created": "2018-08-06T10:41:14+0000", - "process": "", - "instance": { - "id": "a48e43ff268f4c0e879652d65e63d0fbin01", - "name": "DO-NOT-TOUCH-mgr2-mysql-single" - }, - "entities": { - "instance": { - "type": "Single", - "datastore": { - "type": "mysql", - "version": "5.7" - } - } - }, - "fail_reason": "createVM failed." - } -}- - Abnormal Response
For details, see Abnormal Request Results.
-
Status Code
- Normal -
- Abnormal
For details, see Status Codes.
-
Error Code
For details, see Error Codes.
-Changing the Storage Type of a DB Instance
+Function
This API is used to change the storage type of a DB instance.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
Constraints
- The storage type of an instance can be changed only when the instance is in the Available state.
- Changing the storage type may affect storage performance, so the storage type should be changed during off-peak hours.
- If the storage type of a read replica is different from that of its associated DB instance, the data synchronization may be affected. To change the storage type of a DB instance, change that of its read replica (if any) first to ensure that the storage type of the read replica is the same as that of the DB instance.
URI
+- Parameter description
++
+Table 1 URI Parameters Parameter
+Mandatory
+Description
+project_id
+Yes
+Project ID of a tenant in a region.
+To obtain the value, see Obtaining a Project ID.
+instance_id
+Yes
+Instance ID.
+
Request
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+The content type. +The default value is application/json. + |
+
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. +The user token is a response to the API used to obtain a user token. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
change_volume + |
+Yes + |
+Object + |
+Target storage type. +For details, see Table 4. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
volume_code + |
+Yes + |
+Integer + |
+Specification code of the target storage type. +
|
+
Example Request
Change the storage type of an RDS for MySQL primary/standby DB instance to ESSD.
+POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
+
+{
+ "change_volume": {
+ "volume_code": "rds.mysql.volume.essd.ha"
+ }
+}
+Response
- Normal response
++
+Table 5 Response body parameters Parameter
+Type
+Description
+job_id
+String
+Task ID.
+
- Example normal response
{ + "job_id": "2b414788a6004883a02390e2eb0ea227" +}+ - Abnormal response
For details, see Abnormal Request Results.
+
Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
Error Code
For details, see Error Codes.
+String
Indicates the storage type. Its value can be any of the following:
-- COMMON: SATA storage.
- ULTRAHIGH: ultra-high I/O storage.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
- CLOUDSSD: cloud SSD storage.
- ESSD: extreme SSD storage.
az_status
@@ -107,7 +107,7 @@List<String>
Indicates the performance specifications. Its value can be any of the following:
-- normal: general-enhanced
- general: general-purpose
- dedicated:
- For the MySQL DB engine: dedicated
- For PostgreSQL and SQL Server DB engines: dedicated, which is only supported for cloud SSDs
- normal: general-enhanced. Suitable for websites and web applications that require high database computing and network performance.
- general: general-purpose. Suitable for scenarios that have high requirements on cost-effectiveness.
- dedicated: Suitable for core database scenarios such as e-commerce, gaming, finance, government, and enterprise applications.
- For the MySQL DB engine: dedicated
- For PostgreSQL and SQL Server DB engines: dedicated, which is only supported for cloud SSDs