REST API for Oracle Private Cloud Appliance Compute Enclave

CreateSteeringPolicyAttachment

post

/20180115/steeringPolicyAttachments

Create a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain. The attachment is automatically placed into the same compartment as the domain's zone.

Request

Supported Media Types

application/json

Query Parameters

scope: string

Specifies to operate only on resources that have a matching DNS scope.

Allowed Values: [ "GLOBAL", "PRIVATE" ]

Header Parameters

opc-request-id: string

Minimum Length: 1

Maximum Length: 98

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so that the request can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Details for creating a new steering policy attachment.

Root Schema : CreateSteeringPolicyAttachmentDetails

Type: object

The body for defining an attachment between a steering policy and a domain. Avoid entering confidential information when you supply string values using the API.

Show Source

displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name for the steering policy attachment. Does not need to be unique and can be changed. Avoid entering confidential information.
domainName(required): string

The attached domain within the attached zone.
steeringPolicyId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the attached steering policy.
zoneId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the attached zone.

{
    "description":"The body for defining an attachment between a steering policy and a domain. Avoid entering confidential information when you supply string values using the API.",
    "type":"object",
    "properties":{
        "steeringPolicyId":{
            "description":"The OCID of the attached steering policy.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "zoneId":{
            "description":"The OCID of the attached zone.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "domainName":{
            "description":"The attached domain within the attached zone.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name for the steering policy attachment. Does not need to be unique and can be changed. Avoid entering confidential information.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        }
    },
    "required":[
        "steeringPolicyId",
        "zoneId",
        "domainName"
    ]
}

Response

Supported Media Types

application/json

201 Response

A response containing a single steering policy attachment object.

Headers

ETag: string

The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource.
Location: string

The full URI of the resource related to the request.
opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
opc-work-request-id: string

Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

Root Schema : SteeringPolicyAttachment

Type: object

An attachment between a steering policy and a domain. An attachment constructs DNS responses using its steering policy instead of the records at its defined domain. Only records of the policy's covered rtype are blocked at the domain. A domain can have a maximum of one attachment covering any given rtype. Avoid entering confidential information when you supply string values using the API.

Show Source

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment containing the steering policy attachment.
displayName(required): string

Minimum Length: 1

Maximum Length: 255

A user-friendly name for the steering policy attachment. Does not need to be unique and can be changed. Avoid entering confidential information.
domainName(required): string

The attached domain within the attached zone.
id(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the resource.
lifecycleState(required): string

Allowed Values: [ "CREATING", "ACTIVE", "DELETING" ]

The current state of the resource.
rtypes(required): array 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.
self(required): string(url)

The canonical absolute URL of the resource.
steeringPolicyId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the attached steering policy.
timeCreated(required): string(date-time)

The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z
zoneId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the attached zone.

{
    "description":"An attachment between a steering policy and a domain. An attachment constructs DNS responses using its steering policy instead of the records at its defined domain. Only records of the policy's covered rtype are blocked at the domain. A domain can have a maximum of one attachment covering any given rtype. Avoid entering confidential information when you supply string values using the API.",
    "type":"object",
    "required":[
        "steeringPolicyId",
        "zoneId",
        "domainName",
        "displayName",
        "rtypes",
        "compartmentId",
        "self",
        "id",
        "timeCreated",
        "lifecycleState"
    ],
    "properties":{
        "steeringPolicyId":{
            "description":"The OCID of the attached steering policy.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "zoneId":{
            "description":"The OCID of the attached zone.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "domainName":{
            "description":"The attached domain within the attached zone.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name for the steering policy attachment. Does not need to be unique and can be changed. Avoid entering confidential information.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "rtypes":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing the steering policy attachment.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "self":{
            "description":"The canonical absolute URL of the resource.",
            "type":"string",
            "format":"url"
        },
        "id":{
            "description":"The OCID of the resource.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z ",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the resource.",
            "type":"string",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING"
            ]
        }
    }
}

Nested Schema : rtypes

Type: array

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.

Show Source

Array of: string

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

422 Response

Unprocessable Entity

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}