Obtaining the Parameters of a Specified Instance (v3.1)
Function
This API is used to obtain parameters of a specified DB instance. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
GET /v3.1/{project_id}/instances/{instance_id}/configurations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A |
instance_id |
Yes |
String |
Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of the token is that of X-Subject-Token in the response header. |
X-Language |
No |
String |
Language. Default value: en-us Range:
|
Response Parameters
Parameter |
Type |
Description |
---|---|---|
datastore_version |
String |
Engine version. |
datastore_name |
String |
Engine name. |
created |
String |
Creation time in the yyyy-MM-dd HH:mm:ss format. |
updated |
String |
Update time in the yyyy-MM-ddHH:mm:ss format. |
configuration_parameters |
Array of objects |
Parameters defined by users based on the default parameter templates. For details, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Parameter name. |
value |
String |
Parameter value. |
restart_required |
Boolean |
Whether a reboot is required after the parameter is modified. |
value_range |
String |
Parameter value range. |
type |
String |
Parameter type. The value can be string, integer, boolean, list, or float. Range:
|
description |
String |
Parameter description. |
Example Request
Querying parameters of a specified instance
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations
Example Response
{
"created": "2022-04-11 10:46:59",
"updated": "2022-04-11 10:46:59",
"datastore_version": "2.0",
"datastore_name": "GaussDB",
"configuration_parameters": [
{
"name": "audit_system_object",
"value": "12295",
"type": "integer",
"description": "Determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include databases, users, schemas, and tables. You can change the parameter value to audit only the operations on required database objects. During a forcible primary/standby failover, set audit_system_object to the maximum value and audit all DDL objects. If the parameter value is incorrectly changed, DDL audit logs will be lost. Contact customer service personnel to change it.",
"restart_required": false,
"value_range": "0-2097151"
}
]
}
Status Codes
- Normal
- Abnormal
For details, see Status Codes.
Error Codes
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