Querying Parameter Templates
Function
This API is used to query parameter templates, including all databases' default and custom parameter templates. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/configurations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID of a tenant in a region. To obtain this 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition: Index offset. The query starts from the next piece of data indexed by this parameter. Constraints: The value cannot be a negative number. Range: ≥0 Default value: 0 |
limit |
No |
Integer |
Definition: Number of records to be queried. Constraints: The value cannot be a negative number. Range: 1–100 Default value: 100 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints: N/A Range: N/A Default value: N/A |
X-Language |
No |
String |
Definition: Request language type. Constraints: N/A Range:
Default value: en-us |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
configurations |
Array of ConfigurationSummary objects |
Definition: Parameter template information. |
total_count |
Integer |
Definition: Total number of parameter templates. Range: ≥0 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Parameter template ID. Range: The value can contain 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. |
name |
String |
Definition: Parameter template name. Range: N/A |
datastore_version_name |
String |
Definition: DB version. Range: 8.0 |
datastore_name |
String |
Definition: Database name. Range: GaussDB(for MySQL) |
created |
String |
Definition: Time when the parameter template was created. The format is "yyyy-MM-ddTHH:mm:ssZ". 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. Range: N/A |
updated |
String |
Definition: Time when the parameter template was updated. The format is "yyyy-MM-ddTHH:mm:ssZ". 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. Range: N/A |
user_defined |
Boolean |
Definition: Whether the parameter template is a custom template. Range:
|
description |
String |
Definition: Parameter template description. Range: N/A |
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
Querying parameter templates
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations
Example Response
Status code: 200
Success.
{ "total_count" : 1, "configurations" : [ { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "configuration_test", "description" : "configuration_test", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-15T11:53:34+0000", "updated" : "2019-05-15T11:53:34+0000", "user_defined" : true }, { "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07", "name" : "Default-GaussDBforMySQL", "description" : "Default parameter template for GaussDBforMySQL", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-27T03:38:51+0000", "updated" : "2019-05-27T03:38:51+0000", "user_defined" : false } ] }
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.