capabilities_plans
Creates, updates, deletes, gets or lists a capabilities_plans resource.
Overview​
| Name | capabilities_plans |
| Type | Resource |
| Id | ovh.public_cloud_database.capabilities_plans |
Fields​
The following fields are returned by SELECT queries:
- list
A service plan available for database services
| Name | Datatype | Description |
|---|---|---|
name | string | Name of the plan |
backup_retention | string (duration) | Automatic backup retention duration (wire: backupRetention) |
description | string | Description of the plan |
lifecycle | object | Lifecycle information of the plan |
order | integer | Display order |
tags | array | Display tags |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | project_id | x_pagination_cursor, x_pagination_size | Returns the plans available for Databases services, with their description and automatic backup retention. (Beta version) |
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"}}) |
project_id | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
x_pagination_cursor | string | Pagination cursor (wire: X-Pagination-Cursor) |
x_pagination_size | integer | Pagination size (wire: X-Pagination-Size) |
SELECT examples​
- list
Returns the plans available for Databases services, with their description and automatic backup retention. (Beta version)
SELECT
name,
backup_retention,
description,
lifecycle,
order,
tags
FROM ovh.public_cloud_database.capabilities_plans
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;