zone_options
Creates, updates, deletes, gets or lists a zone_options resource.
Overview​
| Name | zone_options |
| Type | Resource |
| Id | ovh.domain.zone_options |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | The option name |
DNS zone option
| Name | Datatype | Description |
|---|---|---|
name | string | The option name |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, zone_name | Returns a zone option: its name. | |
list | select | zone_name | x_pagination_mode | Returns the names of the zone options. |
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"}}) |
name | string | Name |
zone_name | string | Zone name (wire: zoneName) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Returns a zone option: its name.
SELECT
name
FROM ovh.domain.zone_options
WHERE name = '{{ name }}' -- required
AND zone_name = '{{ zone_name }}' -- required
;
Returns the names of the zone options.
SELECT
name
FROM ovh.domain.zone_options
WHERE zone_name = '{{ zone_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;