Querying Details About a Parameter Template
Function
This API is used to query details about a parameter template based on the parameter template ID. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
GET /v3.1/{project_id}/configurations/{config_id}
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 |
config_id |
Yes |
String |
Definition Parameter template ID. 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 |
Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A |
X-Language |
No |
String |
Definition Language. Constraints N/A Range
Default Value en-us |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Parameter template ID. Range N/A |
name |
String |
Definition Parameter template name. Range N/A |
description |
String |
Definition Parameter template description. Range N/A |
engine_version |
String |
Definition Engine version. Range N/A |
instance_mode |
String |
Definition Deployment model. Range
|
created_at |
String |
Definition Creation time in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800. Range N/A |
updated_at |
String |
Definition Modification time in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800. Range N/A |
configuration_parameters |
Array of objects |
Definition Parameter details. For details about the parameters, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition Name of a specific parameter. Range N/A |
value |
String |
Definition Value of a specific parameter. Range N/A |
need_restart |
Boolean |
Definition Whether the instance needs to be rebooted. Range
|
readonly |
Boolean |
Definition Whether the parameter is read-only. Range
|
value_range |
String |
Definition Parameter value range. Range N/A |
data_type |
String |
Definition Parameter type. Range The value can be string, integer, boolean, list, all, or float. |
description |
String |
Definition Parameter description. Range N/A |
Example Request
Querying details about a parameter template
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14
Example Response
Parameter template details queried.
{
"id": "3ca44134a16d4bbab8eb701e025b19f7pr14",
"name": "GaussDB_2b87a799-515",
"description": "ParamGroup for instance.",
"engine_version": "V2.0-2.3",
"instance_mode": "ha",
"created_at": "2022-08-05T08:15:07+0800",
"updated_at": "2022-08-09T03:06:52+0800",
"configuration_parameters": [
{
"name": "audit_system_object",
"value": "12294",
"need_restart": false,
"readonly": false,
"value_range": "1-65536",
"data_type": "integer",
"description": "This parameter determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include DATABASE, USER, SCHEMA, and TABLE. You can change the value of this parameter to audit only the operations on required database objects. In scenarios where a standby node is forcibly elected as primary, you are advised to set audit_system_object to the maximum value and audit all DDL objects. Improper modification of this parameter will cause loss of DDL audit logs. Contact the customer service to change the parameter value."
}
]
}
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