sub_services
Creates, updates, deletes, gets or lists a sub_services resource.
Overview​
| Name | sub_services |
| Type | Resource |
| Id | ovh.pack_xdsl.sub_services |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | number | |
domain | string | |
type | string | Service name (domain, emailPro, exchangeAccount, exchangeIndividual, exchangeOrganization, grt10ho, grt20m10ho, grt20m4ho, grt4ho, grt5m10ho, grt5m4ho, grtAlt, grtDsp, grtFt, grtKosc, grtOvh, hostedEmail, modem, overTheBoxHardware, overTheBoxService, voipAlias, voipBillingAccount, voipEcoFax, voipLine, voipTrunk, xdslAccess) |
Service link to the pack
| Name | Datatype | Description |
|---|---|---|
id | number | |
domain | string | |
type | string | Service name (domain, emailPro, exchangeAccount, exchangeIndividual, exchangeOrganization, grt10ho, grt20m10ho, grt20m4ho, grt4ho, grt5m10ho, grt5m4ho, grtAlt, grtDsp, grtFt, grtKosc, grtOvh, hostedEmail, modem, overTheBoxHardware, overTheBoxService, voipAlias, voipBillingAccount, voipEcoFax, voipLine, voipTrunk, xdslAccess) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain, pack_name | Get a service contained in an xDSL pack. Returns the ID, domain and type of a service of the pack. Its unpack terms come from keepServiceTerms. | |
list | select | pack_name | x_pagination_mode | List the services contained in an xDSL pack. Returns the domains of the services of the pack. Get a service for its type and unpack terms. |
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"}}) |
domain | string | |
pack_name | string | The internal name of your pack (wire: packName) |
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
Get a service contained in an xDSL pack. Returns the ID, domain and type of a service of the pack. Its unpack terms come from keepServiceTerms.
SELECT
id,
domain,
type
FROM ovh.pack_xdsl.sub_services
WHERE domain = '{{ domain }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;
List the services contained in an xDSL pack. Returns the domains of the services of the pack. Get a service for its type and unpack terms.
SELECT
id,
domain,
type
FROM ovh.pack_xdsl.sub_services
WHERE pack_name = '{{ pack_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;