Skip to main content

service_infos

Creates, updates, deletes, gets or lists a service_infos resource.

Overview​

Nameservice_infos
TypeResource
Idovh.dedicated_ceph.service_infos

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
service_idinteger (wire: serviceId)
can_delete_at_expirationbooleanIndicates that the service can be set up to be deleted at expiration (wire: canDeleteAtExpiration)
contact_adminstring (wire: contactAdmin)
contact_billingstring (wire: contactBilling)
contact_techstring (wire: contactTech)
creationstring (date)
domainstring
engaged_up_tostring (date) (wire: engagedUpTo)
expirationstring (date)
possible_renew_periodarrayAll the possible renew period of your service in month (wire: possibleRenewPeriod)
renewobjectWay of handling the renew
renewal_typestringDetailed renewal type of a service (automaticForcedProduct, automaticV2012, automaticV2014, automaticV2016, manual, oneShot, option) (wire: renewalType)
statusstringservice.StateEnum (autorenewInProgress, expired, inCreation, ok, pendingDebt, unPaid)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameReturns contacts, creation and expiration dates, and renewal settings.
updateupdateservice_nameChanges how the service renews; renew is the only editable field.

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.

NameDatatypeDescription
api_hoststringThe 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"}})
service_namestringService name (wire: serviceName)

SELECT examples​

Returns contacts, creation and expiration dates, and renewal settings.

SELECT
service_id,
can_delete_at_expiration,
contact_admin,
contact_billing,
contact_tech,
creation,
domain,
engaged_up_to,
expiration,
possible_renew_period,
renew,
renewal_type,
status
FROM ovh.dedicated_ceph.service_infos
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples​

Changes how the service renews; renew is the only editable field.

UPDATE ovh.dedicated_ceph.service_infos
SET
renew = '{{ renew }}'
WHERE
service_name = '{{ service_name }}' --required;