configs
Creates, updates, deletes, gets or lists a configs resource.
Overview​
| Name | configs |
| Type | Resource |
| Id | ovh.hosting_private_database.configs |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
task_id | integer | Configuration linked task id (wire: taskId) |
details | array | Configuration details |
last_update | string (date-time) | Configuration last update (wire: lastUpdate) |
status | string | Configuration status (applied, updating) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Returns the configuration parameters with their current, default and available values, and whether the last update is applied. | |
update | exec | serviceName, parameters | Updates the given configuration parameters as key-value pairs. Returns the configuration, whose status stays at updating until the change is applied. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
serviceName | string | Service name |
service_name | string | Service name (wire: serviceName) |
SELECT examples​
- get
Returns the configuration parameters with their current, default and available values, and whether the last update is applied.
SELECT
task_id,
details,
last_update,
status
FROM ovh.hosting_private_database.configs
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- update
Updates the given configuration parameters as key-value pairs. Returns the configuration, whose status stays at updating until the change is applied.
EXEC ovh.hosting_private_database.configs.update
@serviceName='{{ serviceName }}' --required
@@json=
'{
"parameters": "{{ parameters }}"
}'
;