dns.oracle.com/v1beta1
Back to API Reference
APIVersion: dns.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes dns.oracle.com/v1beta1.
Resources
SteeringPolicy
Manage OCI DNS steering policies.
Plural: steeringpolicies
Scope: Namespaced
APIVersion: dns.oracle.com/v1beta1
Sample: Sample (config/samples/dns_v1beta1_steeringpolicy.yaml)
Packages: Not currently exposed by a customer-visible package.
Spec
SteeringPolicySpec defines the desired state of SteeringPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
answers |
The set of all answers that can potentially issue from the steering policy. |
list[object] |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the steering policy. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information. |
string |
Yes |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
healthCheckMonitorId |
The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy. Note: To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see Managing Health Checks (https://docs.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). |
string |
No |
- |
- |
rules |
The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request. The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response. |
list[object] |
No |
- |
- |
template |
A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management's rules in a different order to produce the desired results when answering DNS queries. Example: The FAILOVER template determines answers by filtering the policy's answers using the FILTER rule first, then the following rules in succession: HEALTH, PRIORITY, and LIMIT. This gives the domain dynamic failover capability. It is strongly recommended to use a template other than CUSTOM when creating a steering policy. All templates require the rule order to begin with an unconditional FILTER rule that keeps answers contingent upon answer.isDisabled != true, except for CUSTOM. A defined HEALTH rule must follow the FILTER rule if the policy references a healthCheckMonitorId. The last rule of a template must must be a LIMIT rule. For more information about templates and code examples, see Traffic Management API Guide (https://docs.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). Template Types * FAILOVER - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy. * LOAD_BALANCE - Distributes web traffic to specified endpoints based on defined weights. * ROUTE_BY_GEO - Answers DNS queries based on the query's geographic location. For a list of geographic locations to route by, see Traffic Management Geographic Locations (https://docs.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). * ROUTE_BY_ASN - Answers DNS queries based on the query's originating ASN. * ROUTE_BY_IP - Answers DNS queries based on the query's IP address. * CUSTOM - Allows a customized configuration of rules. |
string |
Yes |
- |
- |
ttl |
The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. |
integer |
No |
- |
- |
Spec.answers[]
Back to SteeringPolicy spec
SteeringPolicyAnswer defines nested fields for SteeringPolicy.Answer.
| Field |
Description |
Type |
Required |
Default |
Enum |
isDisabled |
Set this property to true to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled. Example: "rules": [ { "ruleType": "FILTER", "defaultAnswerData": [ { "answerCondition": "answer.isDisabled != true", "shouldKeep": true } ] }, |
boolean |
No |
- |
- |
name |
A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name. Example: "rules": [ { "ruleType": "FILTER", "defaultAnswerData": [ { "answerCondition": "answer.name == 'server 1'", "shouldKeep": true } ] } ] |
string |
Yes |
- |
- |
pool |
The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's pool property can be referenced in answerCondition properties of rules using answer.pool. Example: "rules": [ { "ruleType": "FILTER", "defaultAnswerData": [ { "answerCondition": "answer.pool == 'US East Servers'", "shouldKeep": true } ] } ] |
string |
No |
- |
- |
rdata |
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types (https://docs.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). |
string |
Yes |
- |
- |
rtype |
The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types (https://docs.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). |
string |
Yes |
- |
- |
Spec.rules[]
Back to SteeringPolicy spec
SteeringPolicyRule defines nested fields for SteeringPolicy.Rule.
| Field |
Description |
Type |
Required |
Default |
Enum |
cases |
An array of caseConditions. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query. |
list[object] |
No |
- |
- |
defaultAnswerData |
Defines a default set of answer conditions and values that are applied to an answer when cases is not defined for the rule, or a matching case does not have any matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed. |
list[object] |
No |
- |
- |
defaultCount |
Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. |
integer |
No |
- |
- |
description |
A user-defined description of the rule's purpose or behavior. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
ruleType |
- |
string |
No |
- |
- |
Spec.rules[].cases[]
Back to SteeringPolicy spec
SteeringPolicyRuleCase defines nested fields for SteeringPolicy.Rule.Case.
| Field |
Description |
Type |
Required |
Default |
Enum |
answerData |
An array of SteeringPolicyFilterAnswerData objects. |
list[object] |
No |
- |
- |
caseCondition |
An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet 192.0.2.0/24 you could use a caseCondition expression query.client.address in ('192.0.2.0/24') to define a case that matches queries from that office. |
string |
No |
- |
- |
Spec.rules[].cases[].answerData[]
Back to SteeringPolicy spec
SteeringPolicyRuleCaseAnswerData defines nested fields for SteeringPolicy.Rule.Case.AnswerData.
| Field |
Description |
Type |
Required |
Default |
Enum |
answerCondition |
An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. |
string |
No |
- |
- |
shouldKeep |
Keeps the answer only if the value is true. |
boolean |
No |
- |
- |
Spec.rules[].defaultAnswerData[]
Back to SteeringPolicy spec
SteeringPolicyRuleDefaultAnswerData defines nested fields for SteeringPolicy.Rule.DefaultAnswerData.
| Field |
Description |
Type |
Required |
Default |
Enum |
answerCondition |
An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. |
string |
No |
- |
- |
shouldKeep |
Keeps the answer only if the value is true. |
boolean |
No |
- |
- |
Status
SteeringPolicyStatus defines the observed state of SteeringPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
answers |
The set of all answers that can potentially issue from the steering policy. |
list[object] |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the steering policy. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
healthCheckMonitorId |
The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy. Note: To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see Managing Health Checks (https://docs.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). |
string |
No |
- |
- |
id |
The OCID of the resource. |
string |
No |
- |
- |
lifecycleState |
The current state of the resource. |
string |
No |
- |
- |
rules |
The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request. The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response. |
list[object] |
No |
- |
- |
self |
The canonical absolute URL of the resource. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
template |
A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management's rules in a different order to produce the desired results when answering DNS queries. Example: The FAILOVER template determines answers by filtering the policy's answers using the FILTER rule first, then the following rules in succession: HEALTH, PRIORITY, and LIMIT. This gives the domain dynamic failover capability. It is strongly recommended to use a template other than CUSTOM when creating a steering policy. All templates require the rule order to begin with an unconditional FILTER rule that keeps answers contingent upon answer.isDisabled != true, except for CUSTOM. A defined HEALTH rule must follow the FILTER rule if the policy references a healthCheckMonitorId. The last rule of a template must must be a LIMIT rule. For more information about templates and code examples, see Traffic Management API Guide (https://docs.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). Template Types * FAILOVER - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy. * LOAD_BALANCE - Distributes web traffic to specified endpoints based on defined weights. * ROUTE_BY_GEO - Answers DNS queries based on the query's geographic location. For a list of geographic locations to route by, see Traffic Management Geographic Locations (https://docs.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). * ROUTE_BY_ASN - Answers DNS queries based on the query's originating ASN. * ROUTE_BY_IP - Answers DNS queries based on the query's IP address. * CUSTOM - Allows a customized configuration of rules. |
string |
No |
- |
- |
timeCreated |
The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
ttl |
The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. |
integer |
No |
- |
- |
Status.answers[]
Back to SteeringPolicy status
SteeringPolicyAnswer defines nested fields for SteeringPolicy.Answer.
| Field |
Description |
Type |
Required |
Default |
Enum |
isDisabled |
Set this property to true to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled. Example: "rules": [ { "ruleType": "FILTER", "defaultAnswerData": [ { "answerCondition": "answer.isDisabled != true", "shouldKeep": true } ] }, |
boolean |
No |
- |
- |
name |
A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name. Example: "rules": [ { "ruleType": "FILTER", "defaultAnswerData": [ { "answerCondition": "answer.name == 'server 1'", "shouldKeep": true } ] } ] |
string |
Yes |
- |
- |
pool |
The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's pool property can be referenced in answerCondition properties of rules using answer.pool. Example: "rules": [ { "ruleType": "FILTER", "defaultAnswerData": [ { "answerCondition": "answer.pool == 'US East Servers'", "shouldKeep": true } ] } ] |
string |
No |
- |
- |
rdata |
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types (https://docs.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). |
string |
Yes |
- |
- |
rtype |
The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types (https://docs.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). |
string |
Yes |
- |
- |
Status.rules[]
Back to SteeringPolicy status
SteeringPolicyRule defines nested fields for SteeringPolicy.Rule.
| Field |
Description |
Type |
Required |
Default |
Enum |
cases |
An array of caseConditions. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query. |
list[object] |
No |
- |
- |
defaultAnswerData |
Defines a default set of answer conditions and values that are applied to an answer when cases is not defined for the rule, or a matching case does not have any matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed. |
list[object] |
No |
- |
- |
defaultCount |
Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. |
integer |
No |
- |
- |
description |
A user-defined description of the rule's purpose or behavior. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
ruleType |
- |
string |
No |
- |
- |
Status.rules[].cases[]
Back to SteeringPolicy status
SteeringPolicyRuleCase defines nested fields for SteeringPolicy.Rule.Case.
| Field |
Description |
Type |
Required |
Default |
Enum |
answerData |
An array of SteeringPolicyFilterAnswerData objects. |
list[object] |
No |
- |
- |
caseCondition |
An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet 192.0.2.0/24 you could use a caseCondition expression query.client.address in ('192.0.2.0/24') to define a case that matches queries from that office. |
string |
No |
- |
- |
Status.rules[].cases[].answerData[]
Back to SteeringPolicy status
SteeringPolicyRuleCaseAnswerData defines nested fields for SteeringPolicy.Rule.Case.AnswerData.
| Field |
Description |
Type |
Required |
Default |
Enum |
answerCondition |
An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. |
string |
No |
- |
- |
shouldKeep |
Keeps the answer only if the value is true. |
boolean |
No |
- |
- |
Status.rules[].defaultAnswerData[]
Back to SteeringPolicy status
SteeringPolicyRuleDefaultAnswerData defines nested fields for SteeringPolicy.Rule.DefaultAnswerData.
| Field |
Description |
Type |
Required |
Default |
Enum |
answerCondition |
An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. |
string |
No |
- |
- |
shouldKeep |
Keeps the answer only if the value is true. |
boolean |
No |
- |
- |
Status.status
Back to SteeringPolicy status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to SteeringPolicy status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to SteeringPolicy status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to SteeringPolicy status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
SteeringPolicyAttachment
Manage OCI DNS steering policy attachments.
Plural: steeringpolicyattachments
Scope: Namespaced
APIVersion: dns.oracle.com/v1beta1
Sample: Sample (config/samples/dns_v1beta1_steeringpolicyattachment.yaml)
Packages: Not currently exposed by a customer-visible package.
Spec
SteeringPolicyAttachmentSpec defines the desired state of SteeringPolicyAttachment.
| Field |
Description |
Type |
Required |
Default |
Enum |
displayName |
A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information. |
string |
No |
- |
- |
domainName |
The attached domain within the attached zone. |
string |
Yes |
- |
- |
steeringPolicyId |
The OCID of the attached steering policy. |
string |
Yes |
- |
- |
zoneId |
The OCID of the attached zone. Must be a public zone. |
string |
Yes |
- |
- |
Status
SteeringPolicyAttachmentStatus defines the observed state of SteeringPolicyAttachment.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the steering policy attachment. |
string |
No |
- |
- |
displayName |
A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information. |
string |
No |
- |
- |
domainName |
The attached domain within the attached zone. |
string |
No |
- |
- |
id |
The OCID of the resource. |
string |
No |
- |
- |
lifecycleState |
The current state of the resource. |
string |
No |
- |
- |
rtypes |
The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy. |
list[string] |
No |
- |
- |
self |
The canonical absolute URL of the resource. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
steeringPolicyId |
The OCID of the attached steering policy. |
string |
No |
- |
- |
timeCreated |
The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
zoneId |
The OCID of the attached zone. Must be a public zone. |
string |
No |
- |
- |
Status.status
Back to SteeringPolicyAttachment status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to SteeringPolicyAttachment status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to SteeringPolicyAttachment status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to SteeringPolicyAttachment status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
TsigKey
Manage OCI DNS TSIG keys.
Plural: tsigkeys
Scope: Namespaced
APIVersion: dns.oracle.com/v1beta1
Sample: Sample (config/samples/dns_v1beta1_tsigkey.yaml)
Packages: Not currently exposed by a customer-visible package.
Spec
TsigKeySpec defines the desired state of TsigKey.
| Field |
Description |
Type |
Required |
Default |
Enum |
algorithm |
TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635 (https://tools.ietf.org/html/rfc4635#section-2). |
string |
Yes |
- |
- |
compartmentId |
The OCID of the compartment containing the TSIG key. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
name |
A globally unique domain name identifying the key for a given pair of hosts. |
string |
Yes |
- |
- |
secret |
A base64 string encoding the binary shared secret. |
string |
Yes |
- |
- |
Status
TsigKeyStatus defines the observed state of TsigKey.
| Field |
Description |
Type |
Required |
Default |
Enum |
algorithm |
TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635 (https://tools.ietf.org/html/rfc4635#section-2). |
string |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the TSIG key. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID of the resource. |
string |
No |
- |
- |
lifecycleState |
The current state of the resource. |
string |
No |
- |
- |
name |
A globally unique domain name identifying the key for a given pair of hosts. |
string |
No |
- |
- |
self |
The canonical absolute URL of the resource. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
timeCreated |
The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
timeUpdated |
The date and time the resource was last updated, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
Status.status
Back to TsigKey status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to TsigKey status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to TsigKey status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to TsigKey status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
View
Manage OCI DNS views.
Plural: views
Scope: Namespaced
APIVersion: dns.oracle.com/v1beta1
Sample: Sample (config/samples/dns_v1beta1_view.yaml)
Packages: Not currently exposed by a customer-visible package.
Spec
ViewSpec defines the desired state of View.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the owning compartment. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
The display name of the view. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
Status
ViewStatus defines the observed state of View.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the owning compartment. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
The display name of the view. |
string |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID of the view. |
string |
No |
- |
- |
isProtected |
A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the resource. |
string |
No |
- |
- |
self |
The canonical absolute URL of the resource. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
timeCreated |
The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
timeUpdated |
The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
Status.status
Back to View status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to View status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to View status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to View status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
Zone
Manage OCI DNS zones.
Plural: zones
Scope: Namespaced
APIVersion: dns.oracle.com/v1beta1
Sample: Sample (config/samples/dns_v1beta1_zone.yaml)
Packages: Not currently exposed by a customer-visible package.
Spec
ZoneSpec defines the desired state of Zone.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the zone. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
dnssecState |
The state of DNSSEC on the zone. For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the KskDnssecKeyVersion data. You can find the DS data in the dsData attribute of the KskDnssecKeyVersion. Then, use the PromoteZoneDnssecKeyVersion operation to promote the KskDnssecKeyVersion. New KskDnssecKeyVersions are generated annually, a week before the existing KskDnssecKeyVersion's expiration. To rollover a KskDnssecKeyVersion, you must replace the parent zone's DS record containing the old KskDnssecKeyVersion data with the data from the new KskDnssecKeyVersion. To remove the old DS record without causing service disruption, wait until the old DS record's TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the PromoteZoneDnssecKeyVersion operation must be called. Metrics are emitted in the oci_dns namespace daily for each KskDnssecKeyVersion indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the PromoteZoneDnssecKeyVersion operation can be called. Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency. For more information, see DNSSEC (https://docs.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm). |
string |
No |
- |
- |
dynectMigrationDetails |
ZoneDynectMigrationDetails defines nested fields for Zone.DynectMigrationDetails. |
object |
No |
- |
- |
externalDownstreams |
External secondary servers for the zone. This field is currently not supported when zoneType is SECONDARY or scope is PRIVATE. |
list[object] |
No |
- |
- |
externalMasters |
External master servers for the zone. externalMasters becomes a required parameter when the zoneType value is SECONDARY. |
list[object] |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
migrationSource |
- |
string |
No |
- |
- |
name |
The name of the zone. Global zone names must be unique across all other zones within the realm. Private zone names must be unique within their view. Unicode characters will be converted into punycode, see RFC 3492 (https://tools.ietf.org/html/rfc3492). |
string |
Yes |
- |
- |
resolutionMode |
The resolution mode of a zone defines behavior related to how query responses can be handled. |
string |
No |
- |
- |
scope |
The scope of the zone. |
string |
No |
- |
- |
viewId |
This value will be null for zones in the global DNS. |
string |
No |
- |
- |
zoneType |
The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones. |
string |
No |
- |
- |
Spec.dynectMigrationDetails
Back to Zone spec
ZoneDynectMigrationDetails defines nested fields for Zone.DynectMigrationDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
customerName |
DynECT customer name the zone belongs to. |
string |
Yes |
- |
- |
httpRedirectReplacements |
A map of fully-qualified domain names (FQDNs) to an array of MigrationReplacement objects. |
map[string, list[object]] |
No |
- |
- |
password |
DynECT API password for the provided username. |
string |
Yes |
- |
- |
username |
DynECT API username to perform the migration with. |
string |
Yes |
- |
- |
Spec.dynectMigrationDetails.httpRedirectReplacements{}
Back to Zone spec
No documented fields in the checked-in CRD schema.
Spec.externalDownstreams[]
Back to Zone spec
ZoneExternalDownstream defines nested fields for Zone.ExternalDownstream.
| Field |
Description |
Type |
Required |
Default |
Enum |
address |
The server's IP address (IPv4 or IPv6). |
string |
Yes |
- |
- |
port |
The server's port. Port value must be a value of 53, otherwise omit the port value. |
integer |
No |
- |
- |
tsigKeyId |
The OCID of the TSIG key. A TSIG key is used to secure DNS messages (in this case, zone transfers) between two systems that both have the (shared) secret. |
string |
No |
- |
- |
Spec.externalMasters[]
Back to Zone spec
ZoneExternalMaster defines nested fields for Zone.ExternalMaster.
| Field |
Description |
Type |
Required |
Default |
Enum |
address |
The server's IP address (IPv4 or IPv6). |
string |
Yes |
- |
- |
port |
The server's port. Port value must be a value of 53, otherwise omit the port value. |
integer |
No |
- |
- |
tsigKeyId |
The OCID of the TSIG key. |
string |
No |
- |
- |
Status
ZoneStatus defines the observed state of Zone.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the zone. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
dnssecConfig |
ZoneDnssecConfig defines nested fields for Zone.DnssecConfig. |
object |
No |
- |
- |
dnssecState |
The state of DNSSEC on the zone. For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the KskDnssecKeyVersion data. You can find the DS data in the dsData attribute of the KskDnssecKeyVersion. Then, use the PromoteZoneDnssecKeyVersion operation to promote the KskDnssecKeyVersion. New KskDnssecKeyVersions are generated annually, a week before the existing KskDnssecKeyVersion's expiration. To rollover a KskDnssecKeyVersion, you must replace the parent zone's DS record containing the old KskDnssecKeyVersion data with the data from the new KskDnssecKeyVersion. To remove the old DS record without causing service disruption, wait until the old DS record's TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the PromoteZoneDnssecKeyVersion operation must be called. Metrics are emitted in the oci_dns namespace daily for each KskDnssecKeyVersion indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the PromoteZoneDnssecKeyVersion operation can be called. Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency. For more information, see DNSSEC (https://docs.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm). |
string |
No |
- |
- |
externalDownstreams |
External secondary servers for the zone. This field is currently not supported when zoneType is SECONDARY or scope is PRIVATE. |
list[object] |
No |
- |
- |
externalMasters |
External master servers for the zone. externalMasters becomes a required parameter when the zoneType value is SECONDARY. |
list[object] |
No |
- |
- |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID of the zone. |
string |
No |
- |
- |
isProtected |
A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the zone resource. |
string |
No |
- |
- |
name |
The name of the zone. |
string |
No |
- |
- |
nameservers |
The authoritative nameservers for the zone. |
list[object] |
No |
- |
- |
resolutionMode |
The resolution mode of a zone defines behavior related to how query responses can be handled. |
string |
No |
- |
- |
scope |
The scope of the zone. |
string |
No |
- |
- |
self |
The canonical absolute URL of the resource. |
string |
No |
- |
- |
serial |
The current serial of the zone. As seen in the zone's SOA record. |
integer (int64) |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
timeCreated |
The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. Example: 2016-07-22T17:23:59:60Z |
string |
No |
- |
- |
version |
Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived. |
string |
No |
- |
- |
viewId |
The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view. |
string |
No |
- |
- |
zoneTransferServers |
The OCI nameservers that transfer the zone data with external nameservers. |
list[object] |
No |
- |
- |
zoneType |
The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones. |
string |
No |
- |
- |
Status.dnssecConfig
Back to Zone status
ZoneDnssecConfig defines nested fields for Zone.DnssecConfig.
| Field |
Description |
Type |
Required |
Default |
Enum |
kskDnssecKeyVersions |
A read-only array of key signing key (KSK) versions. |
list[object] |
No |
- |
- |
zskDnssecKeyVersions |
A read-only array of zone signing key (ZSK) versions. |
list[object] |
No |
- |
- |
Status.dnssecConfig.kskDnssecKeyVersions[]
Back to Zone status
ZoneDnssecConfigKskDnssecKeyVersion defines nested fields for Zone.DnssecConfig.KskDnssecKeyVersion.
| Field |
Description |
Type |
Required |
Default |
Enum |
algorithm |
The signing algorithm used for the key. |
string |
No |
- |
- |
dsData |
An array of data for DS records corresponding with this key version. An entry will exist for each supported DS digest algorithm. |
list[object] |
No |
- |
- |
keyTag |
The key tag associated with the DnssecKeyVersion. This key tag will be present in the RRSIG and DS records associated with the key material for this DnssecKeyVersion. For more information about key tags, see RFC 4034 (https://tools.ietf.org/html/rfc4034). |
integer |
No |
- |
- |
lengthInBytes |
The length of the corresponding private key in bytes, expressed as an integer. |
integer |
No |
- |
- |
predecessorDnssecKeyVersionUuid |
When populated, this is the UUID of the DnssecKeyVersion that this DnssecKeyVersion will replace or has replaced. |
string |
No |
- |
- |
successorDnssecKeyVersionUuid |
When populated, this is the UUID of the DnssecKeyVersion that will replace, or has replaced, this DnssecKeyVersion. |
string |
No |
- |
- |
timeActivated |
The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeCreated |
The date and time the key version was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeExpired |
The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if PromoteZoneDnssecKeyVersion has not been called on this DnssecKeyVersion's successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeInactivated |
The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) DnssecKeyVersion, this is populated after PromoteZoneDnssecKeyVersion has been called on its successor DnssecKeyVersion. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timePromoted |
The date and time the key version was promoted expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timePublished |
The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeUnpublished |
The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) DnssecKeyVersion, this is populated after PromoteZoneDnssecKeyVersion has been called on its successor DnssecKeyVersion. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
uuid |
The UUID of the DnssecKeyVersion. |
string |
No |
- |
- |
Status.dnssecConfig.kskDnssecKeyVersions[].dsData[]
Back to Zone status
ZoneDnssecConfigKskDnssecKeyVersionDsData defines nested fields for Zone.DnssecConfig.KskDnssecKeyVersion.DsData.
| Field |
Description |
Type |
Required |
Default |
Enum |
digestType |
The type of the digest associated with the rdata. |
string |
No |
- |
- |
rdata |
Presentation-format DS record data that must be added to the parent zone. For more information about RDATA, see Supported DNS Resource Record Types (https://docs.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) |
string |
No |
- |
- |
Status.dnssecConfig.zskDnssecKeyVersions[]
Back to Zone status
ZoneDnssecConfigZskDnssecKeyVersion defines nested fields for Zone.DnssecConfig.ZskDnssecKeyVersion.
| Field |
Description |
Type |
Required |
Default |
Enum |
algorithm |
The signing algorithm used for the key. |
string |
No |
- |
- |
keyTag |
The key tag associated with the DnssecKeyVersion. This key tag will be present in the RRSIG and DS records associated with the key material for this DnssecKeyVersion. For more information about key tags, see RFC 4034 (https://tools.ietf.org/html/rfc4034). |
integer |
No |
- |
- |
lengthInBytes |
The length of the corresponding private key in bytes, expressed as an integer. |
integer |
No |
- |
- |
predecessorDnssecKeyVersionUuid |
When populated, this is the UUID of the DnssecKeyVersion that this DnssecKeyVersion will replace or has replaced. |
string |
No |
- |
- |
successorDnssecKeyVersionUuid |
When populated, this is the UUID of the DnssecKeyVersion that will replace, or has replaced, this DnssecKeyVersion. |
string |
No |
- |
- |
timeActivated |
The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeCreated |
The date and time the key version was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeExpired |
The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if PromoteZoneDnssecKeyVersion has not been called on this DnssecKeyVersion's successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeInactivated |
The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) DnssecKeyVersion, this is populated after PromoteZoneDnssecKeyVersion has been called on its successor DnssecKeyVersion. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timePromoted |
The date and time the key version was promoted expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timePublished |
The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
timeUnpublished |
The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) DnssecKeyVersion, this is populated after PromoteZoneDnssecKeyVersion has been called on its successor DnssecKeyVersion. Example: 2016-07-22T17:23:59:00Z |
string |
No |
- |
- |
uuid |
The UUID of the DnssecKeyVersion. |
string |
No |
- |
- |
Status.externalDownstreams[]
Back to Zone status
ZoneExternalDownstream defines nested fields for Zone.ExternalDownstream.
| Field |
Description |
Type |
Required |
Default |
Enum |
address |
The server's IP address (IPv4 or IPv6). |
string |
Yes |
- |
- |
port |
The server's port. Port value must be a value of 53, otherwise omit the port value. |
integer |
No |
- |
- |
tsigKeyId |
The OCID of the TSIG key. A TSIG key is used to secure DNS messages (in this case, zone transfers) between two systems that both have the (shared) secret. |
string |
No |
- |
- |
Status.externalMasters[]
Back to Zone status
ZoneExternalMaster defines nested fields for Zone.ExternalMaster.
| Field |
Description |
Type |
Required |
Default |
Enum |
address |
The server's IP address (IPv4 or IPv6). |
string |
Yes |
- |
- |
port |
The server's port. Port value must be a value of 53, otherwise omit the port value. |
integer |
No |
- |
- |
tsigKeyId |
The OCID of the TSIG key. |
string |
No |
- |
- |
Status.nameservers[]
Back to Zone status
ZoneNameserver defines nested fields for Zone.Nameserver.
| Field |
Description |
Type |
Required |
Default |
Enum |
hostname |
The hostname of the nameserver. |
string |
No |
- |
- |
Status.status
Back to Zone status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Zone status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Zone status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Zone status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
Status.zoneTransferServers[]
Back to Zone status
ZoneTransferServer defines nested fields for Zone.ZoneTransferServer.
| Field |
Description |
Type |
Required |
Default |
Enum |
address |
The server's IP address (IPv4 or IPv6). |
string |
No |
- |
- |
isTransferDestination |
A Boolean flag indicating whether or not the server is a zone data transfer destination. |
boolean |
No |
- |
- |
isTransferSource |
A Boolean flag indicating whether or not the server is a zone data transfer source. |
boolean |
No |
- |
- |
port |
The server's port. |
integer |
No |
- |
- |