Jump to

• Request
• Response

ListSteeringPolicyAttachments

get

/20180115/steeringPolicyAttachments

Lists the steering policy attachments in the specified compartment.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  The displayName of a resource.
• domain: string
  Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
• domainContains: string
  Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
• id: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of a resource.
• lifecycleState: string
  The state of a resource.

  Default Value: ACTIVE
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
• scope: string
  Specifies to operate only on resources that have a matching DNS scope.

  Allowed Values: [ "GLOBAL", "PRIVATE" ]
• sortBy: string
  The field by which to sort steering policy attachments. If unspecified, defaults to timeCreated.

  Default Value: timeCreated

  Allowed Values: [ "displayName", "timeCreated", "domainName" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed Values: [ "ASC", "DESC" ]
• steeringPolicyId: string
  Search by steering policy OCID. The result matches any resource whose steering policy OCID matches the provided value.
• timeCreatedGreaterThanOrEqualTo: string(date-time)
  An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created on or after the indicated time.
• timeCreatedLessThan: string(date-time)
  An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created before the indicated time.
• zoneId: string
  Search by zone OCID. The result matches any resource whose zone OCID matches the provided value.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response containing a list of steering policy attachments.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• 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-total-items: integer
  The total number of items that match the query.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SteeringPolicyAttachmentSummary
  An attachment between a steering policy and a domain.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SteeringPolicyAttachmentSummary"
    }
}

Nested Schema : SteeringPolicyAttachmentSummary

Type: object

An attachment between a steering policy and a domain.

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.",
    "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.

Body ()

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.

Body ()

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

404 Response

Not Found

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top