REST API for Oracle Private Cloud Appliance Compute Enclave

Get information about the specified steering policy attachment

get

/20180115/steeringPolicyAttachments/{steering_policy_attachment_id}

Request

Supported Media Types

application/json

Path Parameters

steeringPolicyAttachmentId(required): string

The OCID of the target steering policy attachment.

Query Parameters

scope: string

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

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

Header Parameters

If-Modified-Since: string

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
if-none-match: string

Minimum Length: 0

Maximum Length: 1

Pattern: ^[*]$

The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etag
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.

Response

Supported Media Types

application/json

200 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.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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"
    }
}

304 Response

Not Modified

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}