fault_domains
Creates, updates, deletes, gets or lists a fault_domains resource.
Overview​
| Name | fault_domains |
| Type | Resource |
| Id | oci.identity.fault_domains |
Fields​
The following fields are returned by SELECT queries:
- list
A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become<br />unavailable in its entirety either due to hardware failure such as Top-of-rack (TOR) switch failure or due to<br />planned software maintenance such as security updates that reboot your instances.<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the Fault Domain. |
name | string | The name of the Fault Domain. |
availabilityDomain | string | The name of the availabilityDomain where the Fault Domain belongs. |
compartmentId | string | The OCID of the compartment. Currently only tenancy (root) compartment can be provided. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | compartmentId, availabilityDomain, region | Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another<br />of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).<br />See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).<br /> |
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 |
|---|---|---|
availabilityDomain | string | The name of the availabilityDomain. |
compartmentId | string | The OCID of the compartment (remember that the tenancy is simply the root compartment). |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
SELECT examples​
- list
Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another<br />of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).<br />See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).<br />
SELECT
id,
name,
availabilityDomain,
compartmentId
FROM oci.identity.fault_domains
WHERE compartmentId = '{{ compartmentId }}' -- required
AND availabilityDomain = '{{ availabilityDomain }}' -- required
AND region = '{{ region }}' -- required
;