+
+
API Calling
+RDS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.
+Endpoints
+An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
+ +Querying API Versions
Function
This API is used to query the currently supported RDS API versions.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
Request
None
+Response
- Normal response
Table 1 Parameter description Name
@@ -97,7 +99,8 @@String
Its value is self, indicating that href is a local link.
+The values are as follows, depending on the version:
+- V3
- V1
- V1.0
- Abnormal response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/en-us_topic_0032347779.html b/docs/rds/api-ref/en-us_topic_0032347779.html index 4c3b9de2..0a9d26e9 100644 --- a/docs/rds/api-ref/en-us_topic_0032347779.html +++ b/docs/rds/api-ref/en-us_topic_0032347779.html @@ -2,24 +2,23 @@Error Code
For details, see Error Codes.
Querying a Specified API Version
Function
This API is used to query the specified API version.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format -
- Example
- Parameter description
-
Table 1 Parameter description Name
+Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
versionId
+versionId
Yes
+Yes
Specifies the API version. It is case-sensitive.
+Specifies the API version. It is case-sensitive.
For details, see id in Table 2 in section Querying API Versions.
Request
None
+Response
- Normal response
Table 2 Parameter description Name
@@ -145,9 +147,11 @@- Abnormal response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/en-us_topic_0032347780.html b/docs/rds/api-ref/en-us_topic_0032347780.html index c3093ad1..babb6068 100644 --- a/docs/rds/api-ref/en-us_topic_0032347780.html +++ b/docs/rds/api-ref/en-us_topic_0032347780.html @@ -7,7 +7,7 @@diff --git a/docs/rds/api-ref/en-us_topic_0032347785.html b/docs/rds/api-ref/en-us_topic_0032347785.html index 66c30ecf..3090c416 100644 --- a/docs/rds/api-ref/en-us_topic_0032347785.html +++ b/docs/rds/api-ref/en-us_topic_0032347785.html @@ -74,7 +74,7 @@-Parent topic: Before You Start+Parent topic: Before You StartString
Specifies the DB instance name.
-The DB instance name of the same type must be unique for the same tenant.
+DB instances of the same type can have same names under the same tenant.
Valid value:
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 (_).
String
Specifies the DB instance name.
-The DB instance name of the same type must be unique for the same tenant.
+DB instances of the same type can have same names under the same tenant.
Valid value:
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 (_).
String
Specifies the database version.
-- MySQL databases support 5.6 and 5.7. Example value: 5.7
- PostgreSQL databases support 9.5, 9.6, 10, and 11. Example value: 9.6
- Microsoft SQL Server databases support 2014 SP2 SE. Example value: 2014_SP2_SE
- MySQL databases support 5.6, 5.7 and 8.0. Example value: 5.7
- PostgreSQL databases support 9.5, 9.6, 10, 11, 12 and 13. Example value: 9.6
- Microsoft SQL Server databases support 2014 SE, 2016 SE, 2016 EE, 2017 SE and 2017 EE. Example value: 2016 SE
For details about supported database versions, see section Database Version Queries.
2021-02-24
+2022-10-30
+Modified the following content:
+- Modified the Constraints and some parameter descriptions in Manually Switching Primary/Standby DB Instances.
- Added Description.
- Modified the Request example and some parameter descriptions in Obtaining Links for Downloading Slow Query Logs.
2022-10-21
+Modified the following content:
+- Move the example to section Request.
- Added the status code for successful request in the Status Code section.
2022-08-09
+Modified the following content:
+- Added Stopping an Instance.
- Added Starting an Instance.
2022-03-22
+Modified the following content:
+Supported PostgreSQL 13.
+2021-07-29
+Modified the following content:
+- Added the collation parameter to the request and response in Creating a DB Instance.
- Added the collation parameter to the request and response in Restoring Data to a New DB Instance.
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.
2021-05-25
+Modified the following content:
+Modified API restrictions in Obtaining Task Information.
+2021-02-24
Modified the following content:
Supported v3 APIs in Adding Tags in Batches, Deleting Tags in Batches, and Querying Project Tags.
diff --git a/docs/rds/api-ref/en-us_topic_0037147509.html b/docs/rds/api-ref/en-us_topic_0037147509.html index ffc49b65..f8b01b58 100644 --- a/docs/rds/api-ref/en-us_topic_0037147509.html +++ b/docs/rds/api-ref/en-us_topic_0037147509.html @@ -65,7 +65,7 @@String
Specifies the DB instance name.
-The DB instance name of the same type must be unique for the same tenant.
+DB instances of the same type can have same names under the same tenant.
Valid value:
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 (_).
- Creating a DB Instance
+ - Stopping an Instance
+
+ - Starting an Instance
+
+ - Changing a DB Instance Name
+ - Changing DB Instance Specifications
- Scaling Up Storage Space of a DB Instance
@@ -18,6 +24,20 @@ - Querying Details About DB Instances
+ - Binding and Unbinding an EIP
+
+ - Changing the Failover Priority
+
+ - Manually Switching Primary/Standby DB Instances
+
+ - Changing the Data Synchronize Model of Primary/Standby DB Instances
+
+ - Migrating a Standby DB Instance
+
+ - Configuring the Maintenance Window
+
+ - Querying the Available SQL Server Character Set
+
diff --git a/docs/rds/api-ref/en-us_topic_0056887472.html b/docs/rds/api-ref/en-us_topic_0056887472.html index 5bf3c667..e202b975 100644 --- a/docs/rds/api-ref/en-us_topic_0056887472.html +++ b/docs/rds/api-ref/en-us_topic_0056887472.html @@ -8,6 +8,18 @@- Querying Database Slow Logs
+
- Obtaining Slow Query Log Statistics
+
+- Obtaining Links for Downloading Slow Query Logs
+
+- Setting SQL Audit
+
+- Querying the Policy for SQL Audit Logs
+
+- Obtaining an Audit Log List
+
+- Obtaining the Link for Downloading an Audit Log
+diff --git a/docs/rds/api-ref/en-us_topic_0056889804.html b/docs/rds/api-ref/en-us_topic_0056889804.html index c873c0b6..3ecd2548 100644 --- a/docs/rds/api-ref/en-us_topic_0056889804.html +++ b/docs/rds/api-ref/en-us_topic_0056889804.html @@ -75,7 +75,7 @@String
Specifies the DB instance name.
-The DB instance name of the same type must be unique for the same tenant.
+DB instances of the same type can have same names under the same tenant.
Valid value:
The value must be 4 to 64 characters in length and start with a letter. It can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
String
Specifies the DB instance name.
-The DB instance name of the same type must be unique for the same tenant.
+DB instances of the same type can have same names under the same tenant.
Valid value:
The value must be 4 to 64 characters in length and start with a letter. It can contain only letters, digits, underscores (_), and hyphens (-).
String
Specifies the database version.
-- MySQL databases support 5.6 and 5.7. Example value: MySQL-5.7
- PostgreSQL databases support 9.5, 9.6, 10, and 11. Example value: PostgreSQL-9.6
- MySQL databases support 5.6, 5.7 and 8.0. Example value: 5.7
- PostgreSQL databases support 9.5, 9.6, 10, 11, 12 and 13. Example value: 9.6
For details about supported database versions, see section Database Version Queries.
Specifies the password of the database user.
The value cannot be empty and should contain 8 to 32 characters, including uppercase and lowercase letters, digits, and the following special characters: ~!@#%^*-_=+?
+If provided password will be considered by system as weak, you will receive an error and you should provide stronger password.
databases
diff --git a/docs/rds/api-ref/en-us_topic_0057306831.html b/docs/rds/api-ref/en-us_topic_0057306831.html index 273c0beb..8d025373 100644 --- a/docs/rds/api-ref/en-us_topic_0057306831.html +++ b/docs/rds/api-ref/en-us_topic_0057306831.html @@ -2,14 +2,14 @@Querying an API Version List (Compatible with OpenStack)
-Function
This API is used to query the currently supported RDS API version list.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
Request
None
+Request
None
Response
- Normal response
Table 1 Parameter description Name
@@ -133,9 +133,11 @@- Abnormal Response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/en-us_topic_0057306832.html b/docs/rds/api-ref/en-us_topic_0057306832.html index ac9a76d8..34b1068f 100644 --- a/docs/rds/api-ref/en-us_topic_0057306832.html +++ b/docs/rds/api-ref/en-us_topic_0057306832.html @@ -2,7 +2,7 @@Querying a Specified API Version Information (Compatible with OpenStack)
Function
This API is used to query the specified API version.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
-URI
- URI format
Method: GET
@@ -131,9 +131,11 @@ - Abnormal response
For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/en-us_topic_0240111720.html b/docs/rds/api-ref/en-us_topic_0240111720.html deleted file mode 100644 index 62c04d00..00000000 --- a/docs/rds/api-ref/en-us_topic_0240111720.html +++ /dev/null @@ -1,12 +0,0 @@ - - -Endpoints
--An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
- --- diff --git a/docs/rds/api-ref/en-us_topic_0240111777.html b/docs/rds/api-ref/en-us_topic_0240111777.html deleted file mode 100644 index 2bc07c19..00000000 --- a/docs/rds/api-ref/en-us_topic_0240111777.html +++ /dev/null @@ -1,11 +0,0 @@ - - ---Parent topic: Before You Start-API Calling
--RDS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.
--- diff --git a/docs/rds/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/rds/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be..37942803 100644 Binary files a/docs/rds/api-ref/public_sys-resources/icon-arrowdn.gif and b/docs/rds/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/rds/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/rds/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d16..6aaaa11c 100644 Binary files a/docs/rds/api-ref/public_sys-resources/icon-arrowrt.gif and b/docs/rds/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/rds/api-ref/rds_00_0001.html b/docs/rds/api-ref/rds_00_0001.html index b0e5d903..86d35fbb 100644 --- a/docs/rds/api-ref/rds_00_0001.html +++ b/docs/rds/api-ref/rds_00_0001.html @@ -32,6 +32,13 @@--Parent topic: Before You Start-Query the DB specifications of a specified DB engine version.
RDS APIs (v3)
+DB Storage Type Queries
+Query the storage type of a specified DB engine version.
+RDS APIs (v3)
DB Instance Management
@@ -39,6 +46,13 @@Manage DB instances, including creating a DB instance, adjusting instance storage space, rebooting a DB instance, deleting a DB instance, obtaining a DB instance list, and obtaining detailed information of a specified DB instance.
RDS APIs (v3)
+Database Security
+Improve database security, including configuring SSL data encryption, changing database ports, modifying security groups, and changing private IP addresses.
+RDS APIs (v3)
Parameter Configuration
@@ -60,6 +74,34 @@Obtain log information, including querying database error logs and querying database slow logs.
RDS APIs (v3)
+Database and Account Management (MySQL)
+Create and query databases, create, query, and accounts, grant accounts permissions, and revoke permissions of accounts.
+RDS APIs (v3)
+Database and Account Management (PostgreSQL)
+Create and query databases, and create and query accounts.
+RDS APIs (v3)
+Database and Account Management (Microsoft SQL Server)
+Create and query databases, create, query, and delete accounts, and grant and revoke permissions to accounts
+RDS APIs (v3)
+Recycle Bin
+Set a recycling policy.
+RDS APIs (v3)
Tag Management
diff --git a/docs/rds/api-ref/rds_00_0004.html b/docs/rds/api-ref/rds_00_0004.html index 572b17d0..4ab23eb8 100644 --- a/docs/rds/api-ref/rds_00_0004.html +++ b/docs/rds/api-ref/rds_00_0004.html @@ -5,7 +5,7 @@diff --git a/docs/rds/api-ref/rds_00_0005.html b/docs/rds/api-ref/rds_00_0005.html index bc74c2b9..b0d53126 100644 --- a/docs/rds/api-ref/rds_00_0005.html +++ b/docs/rds/api-ref/rds_00_0005.html @@ -7,12 +7,12 @@-Parent topic: Before You Start+Parent topic: Before You Start- Region
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
- AZ
AZs are physically isolated locations in a region, but are interconnected through an internal network for enhanced application availability.
- Project
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 1 Project isolating model+
Figure 1 Project isolating model
diff --git a/docs/rds/api-ref/rds_00_0006.html b/docs/rds/api-ref/rds_00_0006.html index fdaa7c32..44c70e07 100644 --- a/docs/rds/api-ref/rds_00_0006.html +++ b/docs/rds/api-ref/rds_00_0006.html @@ -39,7 +39,7 @@-Parent topic: Before You Start+Parent topic: Before You Startdiff --git a/docs/rds/api-ref/rds_01_0002.html b/docs/rds/api-ref/rds_01_0002.html index 0fc98ef4..ceaa0fb4 100644 --- a/docs/rds/api-ref/rds_01_0002.html +++ b/docs/rds/api-ref/rds_01_0002.html @@ -2,24 +2,23 @@-Parent topic: Before You Start+Parent topic: Before You StartCreating a DB Instance
Function
This API is used to create a single RDS DB instance, primary/standby DB instances, or a read replica.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format -
- Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
- Parameter description
-
Table 1 Parameter description Name
+-Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
Valid value:
The value cannot be empty and should contain 8 to 32 characters, including uppercase and lowercase letters, digits, and the following special characters: ~!@#%^*-_=+?
You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking.
+If provided password will be considered by system as weak, you will receive an error and you should provide stronger password.
backup_strategy
@@ -130,7 +130,7 @@String
Specifies the specification code. The value cannot be empty.
-For details, see spec_code in Table 3 in section Querying Database Specifications.
+For details, see spec_code in Table 3 in section Querying Database Specifications.
volume
@@ -183,6 +183,16 @@- 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 Virtual Private Cloud API Reference.
data_vip
+No
+String
+Specifies the private IP address of a DB instance. You can use the following methods to obtain the private IP address:
+- Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the subnet CIDR block on the displayed page.
- Method 2: See the "Querying Subnets" section under "APIs" in the Virtual Private Cloud API Reference.
security_group_id
Yes
@@ -203,11 +213,21 @@For details, see Table 8.
collation
+No
+String
+This parameter applies only to Microsoft SQL Server DB instances.
+Value range: character sets queried in Querying the Available SQL Server Character Set.
+@@ -867,9 +896,10 @@ "instance": { "id": "dsfae23fsfdsae3435in01", "name": "trove-instance-rep2", + "status": "BUILD", "datastore": { "type": "MySQL", - "version": "5.6" + "version": "8.0" }, "flavor_ref": "rds.mysql.s1.large", "volume": { @@ -898,10 +928,11 @@Table 3 Parameter description (Only Microsoft SQL Server 2017 EE supports read replicas and does not support single DB instances.) Name
++Table 3 Parameter for Replica creation (Only Microsoft SQL Server 2017 EE supports read replicas and does not support single DB instances.) Name
Mandatory
String
Specifies the DB instance name.
-The DB instance name of the same type must be unique for the same tenant.
+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 (_).
String
Specifies the specification code. The value cannot be empty.
-For details, see spec_code in Table 3 in section Querying Database Specifications.
+For details, see spec_code in Table 3 in section Querying Database Specifications.
volume
@@ -328,7 +348,7 @@String
Specifies the database version.
-- MySQL databases support 5.6, 5.7, and 8.0. Example value: 5.7
- PostgreSQL databases support PostgreSQL 1.0 (Enhanced Edition), 9.5, 9.6, 10, 11, and 12. Example value: 9.6
- Microsoft SQL Server databases only support 2014 SE, 2016 SE, 2016 EE, 2017 SE, and 2017 EE. Example value: 2014_SE
- MySQL databases support 5.6, 5.7, and 8.0. Example value: 5.7
- PostgreSQL databases support 9.5, 9.6, 10, 11, 12 and 13. Example value: 9.6
- Microsoft SQL Server databases only support 2014 SE, 2016 SE, 2016 EE, 2017 SE and 2017 EE. Example value: 2014_SE
For details about supported database versions, see section Querying Version Information About a DB Engine.
String
Specifies the DB instance type. The value is Ha (primary/standby DB instances) and is case-insensitive.
+Specifies the primary/standby or cluster instance type. The value is Ha (case-insensitive).
replication_mode
@@ -403,7 +423,7 @@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.
-NOTICE:Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
+NOTICE:Primary/standby DB instances and Cluster DB instances of Microsoft SQL Server do not support disabling the automated backup policy.
- Request example
Creating a single DB instance:
{ "name": "rds-instance-rep2", "datastore": { "type": "MySQL", - "version": "5.6" + "version": "8.0" }, "flavor_ref": "rds.mysql.s1.large", "volume": { @@ -505,7 +527,7 @@ "name": "rds-instance-rep2", "datastore": { "type": "MySQL", - "version": "5.6" + "version": "8.0" }, "ha": { "mode": "ha", @@ -661,7 +683,7 @@String
Indicates the specification code. The value cannot be empty.
-For details, see spec_code in Table 3 in section Querying Database Specifications.
+For details, see spec_code in Table 3 in section Querying Database Specifications.
volume
@@ -718,6 +740,13 @@For details, see Table 15.
collation
+String
+Indicates the collation set for Microsoft SQL Server.
+{ "instance":{ "id": "dsfae23fsfdsae3435in01", - "name": "trove-instance-rep2", + "name": "trove-instance-rep2", + "status": "BUILD", "datastore": { "type": "MySQL", - "version": "5.6" + "version": "8.0" }, "ha": { "mode": "ha", @@ -935,7 +966,12 @@{ "instance":{ "id": "dsfae23fsfdsae3435in01", - "name": "trove-instance-rep2", + "name": "trove-instance-rep2", + "status": "BUILD", + "datastore": { + "type": "PostgreSQL", + "version": 13 + }, "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "ULTRAHIGH", @@ -948,7 +984,10 @@ "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": "8635", - "configuration_id": "452408-44c5-94be-305145fg" + "configuration_id": "452408-44c5-94be-305145fg", + "charge_info": { + "charge_mode": "postPaid" + } }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" @@ -956,9 +995,11 @@- Abnormal Response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_01_0003.html b/docs/rds/api-ref/rds_01_0003.html index a1a2c2a8..4d2b75c4 100644 --- a/docs/rds/api-ref/rds_01_0003.html +++ b/docs/rds/api-ref/rds_01_0003.html @@ -2,32 +2,31 @@Deleting a DB Instance
Function
This API is used to delete a DB instance.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01
- Parameter description
-
Table 1 Parameter description Name
+Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the DB instance ID compliant with the UUID format.
+Specifies the DB instance ID compliant with the UUID format.
Request
None
+Request
+Response
- Normal response
Table 2 Parameter description Name
@@ -62,9 +64,11 @@- Abnormal response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_01_0004.html b/docs/rds/api-ref/rds_01_0004.html index e5d2f2b2..14857f2e 100644 --- a/docs/rds/api-ref/rds_01_0004.html +++ b/docs/rds/api-ref/rds_01_0004.html @@ -2,108 +2,105 @@Querying Details About DB Instances
Function
This API is used to query DB instances according to search criteria.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/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
- Querying all DB instances
https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances
- - Querying DB instances based on specified conditions
https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10
-
- Querying all DB instances
- Parameter description
-+ + + +
Table 1 Parameter description Name
+@@ -529,6 +590,56 @@Table 1 Parameter description Name
Type
+Type
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
String
+String
Yes
+Yes
Specifies the project ID of a tenant in a region.
+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
+id
String
+String
No
+No
Specifies the DB instance ID.
+Specifies the DB instance ID.
The asterisk (*) is reserved for the system. If the 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 instance ID. The value cannot contain only asterisks (*).
name
+name
String
+String
No
+No
Specifies the DB instance name.
+Specifies the 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
+type
String
+String
No
+No
Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
+Specifies the instance type based query. The value is Single, Ha, or Replica, which correspond to single instance, primary/standby instances, and read replica, respectively.
datastore_type
+datastore_type
String
+String
No
+No
Specifies the database type. Its value can be any of the following and is case-sensitive:
+Specifies the database type. Its value can be any of the following and is case-sensitive:
- MySQL
- PostgreSQL
- SQLServer
vpc_id
+vpc_id
String
+String
No
+No
Specifies the VPC ID.
+Specifies the 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
+subnet_id
String
+String
No
+No
Specifies the network ID of the subnet.
+Specifies the 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 Virtual Private Cloud API Reference.
offset
+offset
Integer
+Integer
No
+No
Specifies the 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 must be a positive number.
+Specifies the 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 must be a positive number.
limit
+limit
Integer
+Integer
No
+No
Specifies the 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.
+Specifies the 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
+Request
+- Example
- Querying all DB instances
GET https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances
+ - Querying DB instances based on search criteria
GET https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002
+
- Querying all DB instances
Response
- Normal response
@@ -398,6 +452,13 @@
Table 2 Parameter description Name
@@ -181,6 +183,14 @@If the value is MIGRATING, the instance is being migrated.
If the value is BACKING UP, the instance is being backed up.
If the value is MODIFYING DATABASE PORT, the database port is being changed.
+If the value is SHUTDOWN, the DB instance is stopped.
+ +alias
+String
+Indicates the DB instance alias.
private_ips
@@ -282,6 +292,20 @@Indicates the security group ID.
cpu
+String
+Indicates the number of CPUs. For example, the value 1 indicates 1 vCPU.
+mem
+String
+Indicates the memory size in GB.
+flavor_ref
String
@@ -342,6 +366,13 @@Indicates the disk encryption key ID.
enterprise_project_id
+String
+Indicates the enterprise project ID.
+time_zone
String
@@ -349,6 +380,29 @@Indicates the time zone.
charge_info
+Object
+Indicates the billing information, which is pay-per-use.
+For details, see Table 10.
+tags
+Array of objects
+Indicates the tag list. If there is no tag in the list, an empty array is returned.
+For details, see Table 11.
+associated_with_ddm
+Boolean
+Indicates whether a DDM instance has been associated.
+Indicates the database version.
complete_version
+String
+Indicates the complete version number. This parameter is returned only when the DB engine is PostgreSQL.
+
- Example normal responseQuery DB instances based on specified conditions.-
{ "instances": [{ "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01", @@ -662,9 +773,11 @@- Abnormal Response
For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_01_0009.html b/docs/rds/api-ref/rds_01_0009.html index 3c5f73f5..68ec1288 100644 --- a/docs/rds/api-ref/rds_01_0009.html +++ b/docs/rds/api-ref/rds_01_0009.html @@ -2,12 +2,11 @@Obtaining Task Information
-Function
This API is used to obtain task information of the task center.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
Constraints
- 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.
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
- URI format -
- Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514
- Parameter description
Table 1 Parameter description Name
@@ -38,7 +37,10 @@ -Request
None
+Request
+Response
- Normal response
Table 2 Parameter description Name
@@ -470,9 +472,11 @@- Abnormal Response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_01_0101.html b/docs/rds/api-ref/rds_01_0101.html index e985178c..99edf9a3 100644 --- a/docs/rds/api-ref/rds_01_0101.html +++ b/docs/rds/api-ref/rds_01_0101.html @@ -2,36 +2,35 @@Changing DB Instance Specifications
Function
This API is used to change DB instance specifications.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
Services will be interrupted for 5 to 10 minutes when you change DB instance specifications. Exercise caution when performing this operation.
Constraints
- The new DB instance specifications must be different from the original DB instance specifications.
- The instance class can be modified only for DB instances whose status is Available.
- The specifications of a DB instance can be changed only to the specifications of the same DB instance type. (For example, the specifications of a single DB instance cannot be changed to those of primary/standby DB instances.)
URI
- URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
- Parameter description
-
Table 1 Parameter description Name
++Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the DB instance ID.
+Specifies the DB instance ID.
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
+
- Request example
{ "resize_flavor": { "spec_code": "rds.pg.c2.medium" @@ -119,9 +120,11 @@ } - Abnormal Response
For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_01_0102.html b/docs/rds/api-ref/rds_01_0102.html index 37626d29..3f15615a 100644 --- a/docs/rds/api-ref/rds_01_0102.html +++ b/docs/rds/api-ref/rds_01_0102.html @@ -2,34 +2,33 @@Scaling Up Storage Space of a DB Instance
Function
This API is used to scale up storage space of a DB instance.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
Constraints
- The sizes of the primary and standby DB instances are the same. When you scale the primary DB instance, its standby DB instance is also scaled.
- The DB instances can be scaled when they are in the Available state.
URI
- URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
- Parameter description
-
Table 1 Parameter description Name
+Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the DB instance ID.
+Specifies the DB instance ID.
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
+
- Request example
{ "enlarge_volume": { "size": 400 @@ -94,19 +95,19 @@ }
Response
- Normal response
-
Table 4 Parameter description Name
+Table 4 Parameter description Name
Type
+Type
Description
+Description
job_id
+job_id
String
+String
Indicates the task ID.
+Indicates the task ID.
- Abnormal Response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_01_0103.html b/docs/rds/api-ref/rds_01_0103.html index 7e26c8ff..97e94e02 100644 --- a/docs/rds/api-ref/rds_01_0103.html +++ b/docs/rds/api-ref/rds_01_0103.html @@ -2,34 +2,31 @@Changing a Single DB Instance to Primary/Standby DB Instances
-Function
This API is used to change a single DB instance to primary/standby DB instances.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
Constraints
- Single DB instances with certain specifications cannot be changed to primary/standby DB instances.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
- Parameter description
-
Table 1 Parameter description Name
+Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the DB instance ID.
+Specifies the DB instance ID.
Request
- Parameter description
-
Table 2 Parameter description Name
+-Table 2 Parameter description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
single_to_ha
+single_to_ha
Yes
+Yes
Object
+Object
For details, see Table 3.
+For details, see Table 3.
Table 3 single_to_ha field data structure description Name
+Table 3 single_to_ha field data structure description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
az_code_new_node
+az_code_new_node
Yes
+Yes
String
+String
Specifies the AZ code of the DB instance node.
+Specifies the AZ code of the DB instance node.
password
+password
No
+No
String
+String
This parameter is mandatory only when a Microsoft SQL Server DB instance type is changed from single to primary/standby.
+This parameter is mandatory only when a Microsoft SQL Server DB instance type is changed from single to primary/standby.
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
+
- Request example
{ "single_to_ha": { "az_code_new_node": "az2xahz", @@ -128,9 +127,11 @@ } - Abnormal Response
For details, see Abnormal Request Results.
diff --git a/docs/rds/api-ref/rds_03_0005.html b/docs/rds/api-ref/rds_03_0005.html index a7ae91b5..8d916a29 100644 --- a/docs/rds/api-ref/rds_03_0005.html +++ b/docs/rds/api-ref/rds_03_0005.html @@ -147,13 +147,12 @@Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_03_0002.html b/docs/rds/api-ref/rds_03_0002.html index 8fc2547c..21c1fa4d 100644 --- a/docs/rds/api-ref/rds_03_0002.html +++ b/docs/rds/api-ref/rds_03_0002.html @@ -31,7 +31,7 @@ }Obtain a Project ID from the Console
- Register yourself on the management console and log in to it.
- Move your pointer over the username and select My Credentials in the displayed drop-down list.
On the My Credentials page, view project IDs in the project list.
-Figure 1 Viewing project IDs+
Figure 1 Viewing project IDs
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
-(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. If the request body contains Chinese characters, these characters must be coded in UTF-8.
+(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. If the request body contains full-width characters, these characters must be coded in UTF-8.
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.- The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
-Content-Type: application/json +
Content-Type: application/json { "auth": { diff --git a/docs/rds/api-ref/rds_03_0006.html b/docs/rds/api-ref/rds_03_0006.html index 326fd3b4..d0418738 100644 --- a/docs/rds/api-ref/rds_03_0006.html +++ b/docs/rds/api-ref/rds_03_0006.html @@ -7,7 +7,7 @@Response Header
Similar to a request, a response also has a header, for example, Content-Type.
Figure 1 shows the response header for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
- +(Optional) Response Body
This part is optional. The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
The following is part of the response body for the API used to obtain a user token.{ diff --git a/docs/rds/api-ref/rds_04_0002.html b/docs/rds/api-ref/rds_04_0002.html new file mode 100644 index 00000000..5a79e9fd --- /dev/null +++ b/docs/rds/api-ref/rds_04_0002.html @@ -0,0 +1,210 @@ + + +Querying the Storage Type of a Database
+++Function
This API is used to query the storage type of a specified DB engine version.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+URI
- URI format
GET https://{Endpoint}/v3/{project_id}/storage-type/{database_name}?version_name={version_name}
+
- 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.
+database_name
+Yes
+Specifies the DB engine name. Its value can be any of the following and is case-insensitive:
+- MySQL
- PostgreSQL
- SQLServer
version_name
+Yes
+Specifies the database version. For details about how to obtain the database version, see section Querying Version Information About a DB Engine.
+
+Request
+ ++Response
- Normal response
++ +
+Table 2 Parameter description Name
+Type
+Description
+storage_type
+Array of objects
+Indicates the DB instance specifications information list.
+For details, see Table 3.
+dsspool_info
+Array of objects
+Indicates the dsspool specifications information list.
+For details, see Table 4.
+NOTE:+Only Dedicated Cloud (DeC) users are supported.
++ +
+Table 3 storage_type field data structure description Name
+Type
+Description
+name
+String
+Indicates the storage type. Its value can be any of the following:
+- COMMON: SATA storage.
- ULTRAHIGH: SSD storage.
az_status
+Map<String, String>
+Indicates the specification status in an AZ. Its value can be any of the following:
+- normal: indicates that the specifications in the AZ are available.
- unsupported: indicates that the specifications are not supported by the AZ.
- sellout: indicates that the specifications in the AZ are sold out.
support_compute_group_type
+List<String>
+Indicates the performance specifications. Its value can be any of the following:
+- normal: general-enhanced
- normal2: general-enhanced II
- armFlavors: Kunpeng general-enhanced
- highPerformancePrivilegeEdition: Ultra-high I/O (advanced)
+
+Table 4 dsspool_info field data structure description Name
+Type
+Description
+az_name
+String
+Indicates the name of the AZ where dsspool is located.
+free_capacity_gb
+String
+Indicates the available capacity of dsspool.
+dsspool_volume_type
+String
+Indicates the dsspool volume type.
+dsspool_id
+String
+Indicates the dsspool ID.
+dsspool_status
+String
+Indicates the dsspool status. Its value can be any of the following:
+- available
- deploying
- enlarging
- frozen
- sellout
- Example normal response
{ + "storage_type": [{ + "name": "COMMON", + "az_status": { + "az1": "normal", + "az2": "normal", + }, + "support_compute_group_type": [ + "normal", + "normal2", + "armFlavors" + ] + }, + { + "name": "ULTRAHIGH", + "az_status": { + "az1": "normal", + "az2": "normal" + }, + "support_compute_group_type": [ + "normal", + "normal2", + "armFlavors" + ] + } + ] + "dsspool_info": [] +}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0005.html b/docs/rds/api-ref/rds_05_0005.html new file mode 100644 index 00000000..5bc27453 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0005.html @@ -0,0 +1,90 @@ + + +++Parent topic: API v3 (Recommended)+Changing a DB Instance Name
+++Function
This API is used to change a DB instance name.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+ + +Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the DB instance name.
+DB instances of the same type can have same names under the same tenant.
+The parameter must be 4 to 64 characters long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).
+
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/name
+
- Request example
{ + "name": "Test_2345674" +}+
- Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0009.html b/docs/rds/api-ref/rds_05_0009.html new file mode 100644 index 00000000..397fdd77 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0009.html @@ -0,0 +1,111 @@ + + +++Parent topic: DB Instance Management+Binding and Unbinding an EIP
+++Function
This API is used to bind an EIP to a DB instance for public access or unbind an EIP from the DB instance as required.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
An EIP cannot be bound to or unbound from a DB instance that is being created, modified, restored, or rebooted.
++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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+public_ip
+No
+String
+When is_bind is true, public_ip is mandatory.
+Specifies the EIP to be bound. The value must be in the standard IP address format.
+public_ip_id
+No
+String
+When is_bind is true, public_ip_id is mandatory.
+Specifies the EIP ID. The value must be in the standard UUID format.
+is_bind
+Yes
+Boolean
+- true: Bind an EIP.
- false: Unbind an EIP.
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/public-ip
+
- Request example
{ + "public_ip":"10.145.51.214", + "public_ip_id":"8403e9cd-a7fa-4288-8b15-c7ceac1etest", + "is_bind":true +}+
+Response
- Normal response +
- Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0010.html b/docs/rds/api-ref/rds_05_0010.html new file mode 100644 index 00000000..35207c91 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0010.html @@ -0,0 +1,73 @@ + + +++Parent topic: DB Instance Management+Querying the Available SQL Server Character Set
+++Function
This API is used to query the SQL Server character set list.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+URI
- URI format +
- 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.
+
+Request
++Response
- Normal response
++
+Table 2 Parameter description Name
+Type
+Description
+charSets
+List<String>
+Indicates the character set information list.
+
- Example normal response
{ + "charSets": ["Chinese_PRC_CI_AS", "SQL_Latin1_General_CP1_CI_AS", "French_BIN", "Chinese_PRC_Stroke_BIN", "Chinese_PRC_CI_AI"] +}+ - Abnormal Response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+ +Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0012.html b/docs/rds/api-ref/rds_05_0012.html new file mode 100644 index 00000000..e0b88af1 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0012.html @@ -0,0 +1,90 @@ + + +++Parent topic: DB Instance Management+Changing the Failover Priority
+++Function
This API is used to change the failover priority for primary/standby DB instances to meet different service requirements. You can select Reliability First or Availability First.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- This API is supported for primary/standby and cluster DB instances.
- The failover priority cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, creating users, or deleting users.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+repairStrategy
+Yes
+String
+Specifies the failover priority. Valid value:
+- reliability: Data reliability is preferentially ensured during the failover to minimize the amount of lost data. It is recommended for services that require high data consistency.
- availability: Data availability is preferentially ensured during the failover to recover services quickly. It is recommended for services that have high requirements on the database online duration.
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover/strategy
+
- Request example
{ + "repairStrategy": "availability" +}+
+Response
+- Example normal response
{}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0013.html b/docs/rds/api-ref/rds_05_0013.html new file mode 100644 index 00000000..489472ef --- /dev/null +++ b/docs/rds/api-ref/rds_05_0013.html @@ -0,0 +1,96 @@ + + +++Parent topic: DB Instance Management+Manually Switching Primary/Standby DB Instances
+++Function
This API is used to manually switch primary/standby DB instances as required.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- This API is supported for primary/standby and cluster DB instances.
- Primary/standby DB instances cannot be manually switched if they are in any of the following statuses:
- For MySQL, PostgreSQL and SQLServer: creating, rebooting, upgrading, changing instance class, restoring, changing port, or creating database account
- For MySQL: deleting database account
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
+- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover
+
- Request example
{}+
+Response
- Normal response
++
+Name
+Description
+workflowId
+Indicates the workflow ID.
+For details about how to query this parameter, see Obtaining Task Information.
+instanceId
+Indicates the DB instance ID.
+nodeId
+Indicates former slave node that becomes a master node.
+
- Example normal response
{ + "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a", + "instanceId":"794c38e5309344818f4b33b86ebce9b4in03", + "nodeId":"b94ba815747040f1b0d641cd13364a06no03" +}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0014.html b/docs/rds/api-ref/rds_05_0014.html new file mode 100644 index 00000000..d3489820 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0014.html @@ -0,0 +1,122 @@ + + +++Parent topic: DB Instance Management+Changing the Data Synchronize Model of Primary/Standby DB Instances
+++Function
This API is used to change the data synchronize model of primary/standby DB instances based on service requirements.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- This API is supported for MySQL and PostgreSQL.
- This API is supported for primary/standby DB instances only.
- The synchronize model cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, changing instance class, creating users, or deleting users.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+mode
+Yes
+String
+Specifies the synchronize model.
+For MySQL, the value can be any of the following:
+- async: asynchronous
- semisync: semi-synchronous
For PostgreSQL, the value can be any of the following:+- async: asynchronous
- sync: synchronous
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover/mode
+
- Request example
{ + "mode": "semisync" +}+
+Response
- Normal response
++
+Name
+Description
+workflowId
+Indicates the workflow ID.
+For details about how to query this parameter, see Obtaining Task Information.
+instanceId
+Indicates the DB instance ID.
+replicationMode
+Indicates the replication mode.
+
- Example normal response
{ + "instanceId": "c8a7d0abe94840dda99bc437e9442982in01", + "replicationMode": "semisync", + "workflowId": "7b55d6ca-dc8e-4844-a9da-6c53a1506db3" +}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0015.html b/docs/rds/api-ref/rds_05_0015.html new file mode 100644 index 00000000..cc7c6931 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0015.html @@ -0,0 +1,116 @@ + + +++Parent topic: DB Instance Management+Migrating a Standby DB Instance
+++Function
This API is used to migrate a standby DB instance based on service requirements.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- This API is supported for MySQL and PostgreSQL.
- This API is supported for primary/standby DB instances only.
- The standby DB instance cannot be migrated if the primary DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, changing port, creating users, or deleting users.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+nodeId
+Yes
+String
+Specifies the ID of the standby DB instance.
+azCode
+Yes
+String
+Specifies the code of the AZ to which the standby DB instance is to be migrated.
+
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/migrateslave
+
- Request example
{ + "nodeId": "0119b1068b874cb4a5202989a06b6094no01", + "azCode": "az2xahz" +}+
+Response
- Normal response
++
+Name
+Description
+workflowId
+Indicates the workflow ID.
+For details about how to query this parameter, see Obtaining Task Information.
+
- Example normal response
{ + "workflowId":"7b55d6ca-dc8e-4844-a9da-6c53a1506db3" +}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0016.html b/docs/rds/api-ref/rds_05_0016.html new file mode 100644 index 00000000..44627235 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0016.html @@ -0,0 +1,99 @@ + + +++Parent topic: DB Instance Management+Configuring the Maintenance Window
+++Function
This API is used to change the maintenance window as required. To prevent service interruption, the maintenance window should fall within the off-peak hours.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+start_time
+Yes
+String
+Specifies the start time.
+The value must be a valid value in the "HH:MM" format. The current time is in the UTC format.
+end_time
+Yes
+String
+Specifies the end time.
+The value must be a valid value in the "HH:MM" format. The current time is in the UTC format.
+NOTE:+The interval between the start time and end time must be four hours.
+
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ops-window
+
- Request example
{ + "start_time": "22:00", + "end_time":"02:00" +}+
+Response
- Example normal response
{}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0017.html b/docs/rds/api-ref/rds_05_0017.html new file mode 100644 index 00000000..1b66dfba --- /dev/null +++ b/docs/rds/api-ref/rds_05_0017.html @@ -0,0 +1,92 @@ + + +++Parent topic: DB Instance Management+Configuring SSL
++Secure Socket Layer (SSL) is an encryption-based Internet security protocol for establishing an encrypted link between a server and a client. It provides authenticated Internet connections to ensure the privacy and integrity of online communications. SSL:
+- Authenticates users and servers, ensuring that data is sent to the correct clients and servers.
- Encrypts data, preventing it from being intercepted during transmission.
- Ensures data integrity during transmission.
Clients using versions earlier than 5.1 have SSL compatibility issues. By default, SSL is disabled for new RDS for MySQL instances. If your client has no SSL compatibility issues, you can enable SSL. Enabling SSL will increase the network connection response time and CPU resource consumption. Before configuring it, evaluate any potential impacts on service performance.
++Function
This API is used to configure SSL to encrypt connections.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- SSL cannot be configured when a DB instance is being created, rebooted, or upgraded, its specifications are being modified, or database users are being created or deleted.
- This API is supported for MySQL only.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+ssl_option
+Yes
+boolean
+Specifies whether to enable SSL.
+- true: SSL is enabled.
- false: SSL is disabled.
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl
+
- Request example
{ + "ssl_option": true +}+
+Response
- Example normal response
{}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0018.html b/docs/rds/api-ref/rds_05_0018.html new file mode 100644 index 00000000..4ec40d23 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0018.html @@ -0,0 +1,109 @@ + + +++Parent topic: Database Security+Changing a Database Port
+++Function
This API is used to change a database port.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- Changing of port will affect RDS instance access. Relevant Security group rules will need to be adapted. Also access from application/ECS side will need to change accordingly.
- The database port cannot be changed when a DB instance is being created or rebooted, its specifications are being modified, database users are being created or deleted, or backups are being created for the DB instance.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+port
+Yes
+Integer
+Specifies port information for all DB engines.
+- The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).
- The PostgreSQL database port ranges from 2100 to 9500.
- The Microsoft SQL Server database port is 1433 or ranges from 2100 to 9500 (excluding 5355 and 5985).
The default values is as follows:
+- The default value of MySQL is 3306.
- The default value of PostgreSQL is 5432.
- The default value of Microsoft SQL Server is 1433.
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/port
+
- Request example
{ + "port": 8836 +}+
+Response
- Normal response
++
+Name
+Description
+workflowId
+Indicates the workflow ID.
+For details about how to query this parameter, see Obtaining Task Information.
+
- Example normal response
{ + "workflowId":"83abc7bc-2c70-4534-8565-351187b37715" +}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0019.html b/docs/rds/api-ref/rds_05_0019.html new file mode 100644 index 00000000..669e82d2 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0019.html @@ -0,0 +1,107 @@ + + +++Parent topic: Database Security+Changing a Security Group
+++Function
This API is used to change the security group 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
- Changing of Security Group will affect RDS instances access.
Relevant Security group rules will need to be adapted. Also access from application/ECS side will need to change accordingly.
+ - The security group cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, changing instance class, creating users, or deleting users.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+security_group_id
+Yes
+String
+Specifies the security group ID.
+
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/security-group
+
- Request example
{ + "security_group_id": "23423kljlj432lk0sdf0234eaa" +}+
+Response
- Normal response
++
+Name
+Description
+workflowId
+Indicates the workflow ID.
+For details about how to query this parameter, see Obtaining Task Information.
+
- Example normal response
{ + "workflowId":"83abc7bc-2c70-4534-8565-351187b37715" +}+ - Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0020.html b/docs/rds/api-ref/rds_05_0020.html new file mode 100644 index 00000000..cb01be59 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0020.html @@ -0,0 +1,107 @@ + + +++Parent topic: Database Security+Changing a Private IP Address
+++Function
This API is used to change the private IP address 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
- Changing of Private IP Address might affect RDS instances access. Relevant Security group rules will need to be adapted. Also access from application/ECS side will need to change accordingly.
- The private IP address of a DB instance cannot be changed when the instance is being created, rebooted, or upgraded, its specifications are being modified, or database users are being created or deleted.
+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.
+instance_id
+Yes
+Specifies the DB instance ID.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+new_ip
+Yes
+String
+Indicates the private IP address.
+
- Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ip
+
- Request example
{ + "new_ip": "192.168.0.213" +}+
+Response
- Normal response
++
+Name
+Description
+workflowId
+Indicates the workflow ID.
+For details about how to query this parameter, see Obtaining Task Information.
+
- Example normal response
{ + "workflowId":"83abc7bc-2c70-4534-8565-351187b37715" +}+
- Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_05_0025.html b/docs/rds/api-ref/rds_05_0025.html new file mode 100644 index 00000000..f7b55be8 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0025.html @@ -0,0 +1,86 @@ + + +++Parent topic: Database Security+Stopping an Instance
+++Function
This API is used to stop a pay-per-use DB instance. The instance can be stopped for up to seven days.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- This API is supported for MySQL and PostgreSQL DB engines.
- If you stop a primary instance, read replicas (if there are any) will also be stopped. They are stopped for up to seven days. You cannot stop a read replica without stopping the primary instance.
- A stopped instance will not be moved to the recycle bin after being deleted.
- If you do not manually start your stopped DB instance after seven days, your DB instance is automatically started during the next maintenance window.
- After an instance is stopped, the ECS is no longer billed. Other resources, including EIPs, storage resources, and backups, are still billed.
- An instance cannot be stopped if it is in any of the following statuses:
Creating, rebooting, scaling up, changing instance class, restoring, and changing port
+
+URI
+- Parameter description
++
+Table 1 Parameter description Name
+Mandatory
+Description
+project_id
+Yes
+Project ID of a tenant in a region.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+instance_id
+Yes
+Instance ID.
+
+Request
- Parameter description +
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/action/shutdown
+
- Request example
{}+
+Response
- Normal response
++
+Table 2 Parameter description Name
+Type
+Description
+job_id
+String
+Job 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.
+++ diff --git a/docs/rds/api-ref/rds_05_0026.html b/docs/rds/api-ref/rds_05_0026.html new file mode 100644 index 00000000..76c2a701 --- /dev/null +++ b/docs/rds/api-ref/rds_05_0026.html @@ -0,0 +1,85 @@ + + +++Parent topic: DB Instance Management+Starting an Instance
+++Function
This API is used to start a DB instance. You can stop your instance temporarily to save money. After stopping your instance, you can restart it to begin using it again.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Constraints
- This API is supported for MySQL and PostgreSQL DB engines.
- If you start a primary instance, read replicas (if there are any) will also be started.
- Only instances in Stopped state can be started.
+URI
+- Parameter description
++
+Table 1 Parameter description Name
+Mandatory
+Description
+project_id
+Yes
+Project ID of a tenant in a region.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+instance_id
+Yes
+Instance ID.
+
+Request
- Parameter description +
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/action/startup
+
- Request example
{}+
+Response
- Normal response
++
+Table 2 Parameter description Name
+Type
+Description
+job_id
+String
+Job 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.
+++ diff --git a/docs/rds/api-ref/rds_05_0039.html b/docs/rds/api-ref/rds_05_0039.html new file mode 100644 index 00000000..400bc66b --- /dev/null +++ b/docs/rds/api-ref/rds_05_0039.html @@ -0,0 +1,221 @@ + + +++Parent topic: DB Instance Management+Obtaining Links for Downloading Slow Query Logs
+++Function
This API is used to obtain links for downloading slow query logs.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
+Description
You need to do this API in two steps:
+For MySQL and PostgreSQL:
+- Sent empty object "{}" in request body, in order to initiate exporting of download link.
- Repeat 1 with same "{}" to receive download link.
For SQLServer:
+- Sent "file_name": "SQLTrace.trc" in request body, in order to initiate exporting of download link.
- Repeat 1 with same "file_name": "SQLTrace.trc" to receive download link.
+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.
+instance_id
+Yes
+Specifies the ID of the DB instance to be queried.
+
+Request
- Parameter description
++
+Table 2 Parameter description Name
+Mandatory
+Type
+Description
+file_name
+No
+String
+Specifies the name of the file to be downloaded.
+This parameter is mandatory for SQL Server.
+The value is SQLTrace.trc
+
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog-download
+ - Request example
+
step 1 request:
+{}+step 2 request:
+{}+For SQLServer:
+step 1 request:
+{ + "file_name":"SQLTrace.trc" +}+step 2 request:
+{ + "file_name":"SQLTrace.trc" +}+
+Response
- Normal response
++ +
+Table 3 Parameter description Name
+Type
+Description
+list
+List
+Indicates the links for downloading slow query logs. For details, see Table 4.
+status
+String
+Indicates the status of generating links for downloading slow query logs.
+- FINISH: The download link has been generated.
- CREATING: A file is being generated and the download link is to be prepared.
- FAILED: Log files fail to be prepared.
count
+Integer
+Indicates the number of links for downloading slow query logs.
++
+Table 4 linkInfo field data structure description Name
+Type
+Description
+workflow_id
+String
+Indicates the workflow ID.
+file_name
+String
+Indicates the name of the generated file for downloading slow query logs.
+status
+String
+Indicates the generation status of the current link.
+- EXPORTING: The download link is being generated.
- SUCCESS: The download link is successfully generated.
- FAILED: The download link failed to be generated.
file_size
+String
+Indicates the file size.
+file_link
+String
+Indicates the download link.
+This link is valid for 5 minutes.
+create_at
+Long
+Indicates the generation time.
+ - Example normal responseGenerating the link for downloading slow query logs:+
{ + "list": [ + { + "workflow_id": "0202bf1a-4181-48b9-bdd8-27ea4cef05b2", + "file_name": "054bc98b0a80d39b1faec01373f2f339_slowlog_download_20211117091141667", + "status": "EXPORTING", + "create_at": 1637140301659 + } + ], + "status": "CREATING", + "count": 1 +}+Link for downloading slow query logs obtained successfully:+{ + "list": [ + { + "workflow_id": "0202bf1a-4181-48b9-bdd8-27ea4cef05b2", + "file_name": "054bc98b0a80d39b1faec01373f2f339_slowlog_download_20211117091141667", + "status": "SUCCESS", + "file_size": "922", + "file_link": "https://rdsbucket.opxxx.svc.rds.xxxxx", + "create_at": 1637140315066 + } + ], + "status": "FINISH", + "count": 1 +}+
- Abnormal response
For details, see Abnormal Request Results.
+
+Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
+Error Code
For details, see Error Codes.
+++ diff --git a/docs/rds/api-ref/rds_06_0001.html b/docs/rds/api-ref/rds_06_0001.html index 68e4293c..38796416 100644 --- a/docs/rds/api-ref/rds_06_0001.html +++ b/docs/rds/api-ref/rds_06_0001.html @@ -2,32 +2,31 @@++Parent topic: Log Information Queries+Querying Version Information About a DB Engine
Function
This API is used to query the database version information of a specified DB engine.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/datastores/{database_name}
- - Example
https://rds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/mysql
- Parameter description
-
Table 1 Parameter description Name
+Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
database_name
+database_name
Yes
+Yes
Specifies the DB engine. Its value can be any of the following and is case-insensitive:
+Specifies the DB engine. Its value can be any of the following and is case-insensitive:
- MySQL
- PostgreSQL
- SQLServer
Request
None
+Request
+Response
- Normal response
Table 2 Parameter description Name
@@ -101,9 +103,11 @@- Abnormal response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_06_0002.html b/docs/rds/api-ref/rds_06_0002.html index 84ae5ebe..9693161b 100644 --- a/docs/rds/api-ref/rds_06_0002.html +++ b/docs/rds/api-ref/rds_06_0002.html @@ -2,10 +2,9 @@Querying Database Specifications
Function
This API is used to query the database specifications of a specified DB engine version.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/flavors/{database_name}?version_name={version_name}
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/mysql?version_name=5.7
- Parameter description
Table 1 Parameter description Name
@@ -56,7 +55,10 @@ -Request
None
+Request
+Response
- Normal response
-
Table 2 Parameter description Name
@@ -72,90 +74,138 @@Array of objects
Indicates the DB instance specifications information list.
-For details, see Table 3.
+For details, see Table 3.
Table 3 flavors field data structure description Name
+-Table 3 flavors field data structure description Name
Type
+Type
Description
+Description
vcpus
+vcpus
String
+String
Indicates the CPU size. For example, the value 1 indicates 1 vCPU.
+Indicates the CPU size. For example, the value 1 indicates 1 vCPU.
ram
+ram
Integer
+Integer
Indicates the memory size in GB.
+Indicates the memory size in GB.
spec_code
+id
String
+String
Indicates the resource specification code. Use rds.mysql.m1.xlarge.rr as an example.
-- rds: indicates the RDS product.
- mysql: indicates the DB engine.
- m1.xlarge: indicates the high memory performance specifications.
- rr: indicates the read replica (.ha indicates primary/standby DB instances).
Indicates the specification ID, which is unique.
instance_mode
+spec_code
String
+String
Indicates the DB instance type. Its value can be any of the following:
-- ha: indicates primary/standby DB instances.
- replica: indicates read replicas.
- single: indicates single DB instances.
Indicates the resource specification code. Use rds.mysql.m1.xlarge.rr as an example.
+- rds: indicates the RDS product.
- mysql: indicates the DB engine.
- m1.xlarge: indicates the high memory performance specifications.
- rr: indicates the read replica (.ha indicates primary/standby DB instances).
az_status
+version_name
Map<String, String>
+Array
Indicates the status of the AZ to which the DB instance specifications belong. Its value can be any of the following:
-- normal: indicates that the AZ is on sale.
- unsupported: indicates that the DB instance specifications are not supported by the AZ.
- sellout: indicates that the DB instance specifications are sold out.
Indicates the database version.
+Example value for MySQL: ["5.6","5.7","8.0"]
+instance_mode
+String
+Indicates the DB instance type. Its value can be any of the following:
+- ha: indicates primary/standby DB instances.
- replica: indicates read replicas.
- single: indicates single DB instances.
az_status
+Map<String, String>
+Indicates the specification status in an AZ. Its value can be any of the following:
+- normal: indicates that the specifications in the AZ are available.
- unsupported: indicates that the specifications are not supported by the AZ.
- sellout: indicates that the specifications in the AZ are sold out.
az_desc
+Map<String, String>
+Indicates the description of the AZ to which the specifications belong.
+group_type
+String
+Indicates the performance specifications. Its value can be any of the following:
+- normal: general-enhanced
- Example normal response
{ +- Example normal response
{ "flavors": [{ - "vcpus": "1", - "ram": 2, - "spec_code": "rds.mysql.c2.medium.ha", - "instance_mode": "ha", - "az_status": { - "az1": "normal", - "az2": "normal" + "vcpus": "1", + "ram": 2, + "id":"2988b9cc-2aac-3a94-898c-14666702f129", + "spec_code": "rds.mysql.c2.medium.ha", + "version_name": ["5.6","5.7","8.0"], + "instance_mode": "ha", + "az_status": { + "az1": "normal", + "az2": "normal" + }, + "az_desc": { + "az1": "az1", + "az2": "az2" + }, + "group_type": "normal" + }, + { + "vcpus": "1", + "ram": 2, + "id":"2988b9cc-2aac-3a94-898c-14666702f130", + "spec_code": "rds.mysql.c2.medium.rr", + "version_name": ["5.6","5.7","8.0"], + "instance_mode": "replica", + "az_status": { + "az1": "normal", + "az2": "normal" + }, + "az_desc": { + "az1": "az1", + "az2": "az2" + }, + "group_type": "normal" } - }, { - "vcpus": "1", - "ram": 2, - "spec_code": "rds.mysql.c2.medium.rr", - "instance_mode": "replica", - "az_status": { - "az1": "normal", - "az2": "normal" - } - }] + ] } - Abnormal response
For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_06_0003.html b/docs/rds/api-ref/rds_06_0003.html index fab170c9..bda74263 100644 --- a/docs/rds/api-ref/rds_06_0003.html +++ b/docs/rds/api-ref/rds_06_0003.html @@ -2,14 +2,13 @@Rebooting a DB Instance
Function
This API is used to reboot a DB instance.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
The RDS DB instance will be unavailable during the reboot process. Exercise caution when performing this operation.
Constraints
The DB instance cannot reboot when it is being created, scaled, backed up, restored, or its instance class or port is being changed.
-URI
- URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
- Parameter description
Table 1 Parameter description Name
@@ -64,6 +63,8 @@
- Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
+
- Request example
{ "restart": {} }@@ -95,9 +96,11 @@ - Abnormal Response
For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_06_0004.html b/docs/rds/api-ref/rds_06_0004.html index 190b853f..b93195bc 100644 --- a/docs/rds/api-ref/rds_06_0004.html +++ b/docs/rds/api-ref/rds_06_0004.html @@ -2,10 +2,9 @@Querying Database Error Logs
Function
This API is used to query the latest 2000 database error logs.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date}
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/errorlog?offset=1&limit=10&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800&level=ALL
- Parameter description
Table 1 Parameter description Name
@@ -75,7 +74,10 @@ -Request
None
+Request
+Response
- Normal response
Table 2 Parameter description Name
@@ -153,9 +155,11 @@- Abnormal Response
-For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/rds/api-ref/rds_06_0005.html b/docs/rds/api-ref/rds_06_0005.html index a9238867..d0ee1053 100644 --- a/docs/rds/api-ref/rds_06_0005.html +++ b/docs/rds/api-ref/rds_06_0005.html @@ -2,72 +2,69 @@Querying Database Slow Logs
-Function
This API is used to query the latest 2000 database slow query logs.
-- Learn how to authorize and authenticate this API before using it.
- Before calling this API, obtain the required region and endpoint.
Constraints
Only the MySQL DB instances are supported.
+- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date}
- - Example
https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog?offset=1&limit=10&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800&type=INSERT
- Parameter description
-
Table 1 Parameter description Name
+Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
+Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the ID of the queried DB instance.
+Specifies the ID of the queried DB instance.
start_date
+start_date
Yes
+Yes
Specifies the start date in the "yyyy-mm-ddThh:mm:ssZ" format.
+Specifies the start date 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
+end_date
Yes
+Yes
Specifies the end time in the "yyyy-mm-ddThh:mm:ssZ" format.
+Specifies the 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. You can only query slow logs generated within a month.
offset
+offset
No
+No
Specifies the page offset, such as 1, 2, 3, or 4. The parameter value is 1 by default if it is not specified.
+Specifies the page offset, such as 1, 2, 3, or 4. The parameter value is 1 by default if it is not specified.
limit
+limit
No
+No
Specifies the number of records on a page. Its value range is from 1 to 100. The parameter value is 10 by default if it is not specified.
+Specifies the number of records on a page. Its value range is from 1 to 100. The parameter value is 10 by default if it is not specified.
type
+type
No
+No
Specifies the statement type. If it is left blank, all statement types are queried. Valid value:
+Specifies the statement type. If it is left blank, all statement types are queried. Valid value:
- INSERT
- UPDATE
- SELECT
- DELETE
- CREATE
Request
None
+Request
+Response
- Normal response
-
Table 2 Parameter description
- Abnormal Response
- Normal response
- Example normal response
- Normal response
- Abnormal response
- Example
- Parameter description
-
- Abnormal Response
- Example
- Example
- Abnormal Response
- Normal response
- Abnormal Response
- Abnormal response
- Normal response
- Abnormal Response
- Abnormal response
- Normal response
