Obtaining Parameter Information of a Specified DB Instance
Function
This API is used to obtain parameter information of a specified DB instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/instances/{instance_id}/configurations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID, which is compliant with the UUID format. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
limit |
No |
Integer |
Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
configurations |
ParameterConfigurationInfo object |
Parameter information. |
total_count |
Long |
Total number of parameters. |
parameter_values |
Array of ParameterValuesInfo objects |
Parameter object. |
Parameter |
Type |
Description |
---|---|---|
datastore_version_name |
String |
DB version name. |
datastore_name |
String |
Database name. |
created |
String |
Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. |
updated |
String |
Update time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Parameter name. |
value |
String |
Parameter value. |
restart_required |
Boolean |
Whether the instance needs to be rebooted.
|
readonly |
Boolean |
Whether the instance is read-only
|
value_range |
String |
Parameter value range. If the parameter type is integer, the value is 0 or 1. If the parameter type is boolean, the value is true or false. |
type |
String |
Parameter type.
|
description |
String |
Parameter description. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
Obtaining parameter information of a specified DB instance
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations
Example Response
Status code: 200
Success.
{ "configurations" : { "datastore_version_name" : 2.0, "datastore_name" : "taurus", "created" : "2022-10-29T09:38:36+0000", "updated" : "2022-10-29T09:38:36+0000" }, "total_count" : 125, "parameter_values" : [ { "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. }, { "name" : "auto_increment_offset", "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. } ] }
Status Code
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