carrier_sip_cluster_details
Creates, updates, deletes, gets or lists a carrier_sip_cluster_details resource.
Overview​
| Name | carrier_sip_cluster_details |
| Type | Resource |
| Id | ovh.telephony.carrier_sip_cluster_details |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the cluster |
zones | array | The availability zones of the cluster |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | billing_account, service_name | Get the cluster details |
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"}}) |
billing_account | string | The name of your billingAccount (wire: billingAccount) |
service_name | string | (wire: serviceName) |
SELECT examples​
- get
Get the cluster details
SELECT
name,
zones
FROM ovh.telephony.carrier_sip_cluster_details
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;