Obtaining the Parameter Template of a Specified DB Instance
Function
This API is used to obtain information about the parameter template of a specified DB instance.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
- The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.
URI
- URI format
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
instance_id
Yes
Definition
Instance ID.
Constraints
N/A
Range
N/A
Default Value
N/A
Request
Response
- Normal response
Table 2 Parameters Parameter
Type
Description
datastore_version_name
String
Definition
Indicates the database version name.
Range
N/A
datastore_name
String
Definition
Indicates the database name.
Range
N/A
created
String
Definition
Indicates the creation time.
Range
The value is 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. For example, in the Beijing time zone, the time zone offset is shown as +0800.
updated
String
Definition
Indicates the update time.
Range
The value is 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. For example, in the Beijing time zone, the time zone offset is shown as +0800.
configuration_parameters
Array of objects
Definition
Indicates the parameters defined by users based on the default parameter templates.
For details, see Table 3.
Table 3 configuration_parameters field data structure description Parameter
Type
Description
name
String
Definition
Indicates the parameter name.
Range
N/A
value
String
Definition
Indicates the parameter value.
Range
N/A
restart_required
Boolean
Definition
Indicates whether a reboot is required.
Range
- false: A reboot is not required.
- true: A reboot is required.
readonly
Boolean
Definition
Indicates whether the parameter is read-only.
Range
- false: The parameter is not read-only.
- true: The parameter is read-only.
value_range
String
Definition
Indicates the parameter value range.
Range
If the parameter type is integer, the value is 0 or 1. If the type is boolean, the value is true or false.
type
String
Definition
Indicates the parameter type.
Range
The value can be string, integer, boolean, list, or float.
description
String
Definition
Indicates the parameter description.
Range
N/A
- Example normal response
{ "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2018-10-11 11:40:44", "updated": "2018-10-11 11:40:44", "configuration_parameters": [{ "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": false, "value_range": "1-65535", "type": "integer", "description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column. }] }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot