REST API for Oracle Private Cloud Appliance Compute Enclave

List DHCP Options

get

/20160918/dhcps

List the sets of DHCP options in the specified VCN and specified compartment. If the VCN OCID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment. The response includes the default set of options that automatically comes with each VCN, plus any other sets that you have created.

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

A filter to return only resources that match the entire display name given.
lifecycleState: string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
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: 0
sortBy: string

The optional field to sort the results by.

Allowed Values: [ "TIMECREATED", "NAME" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Default Value: ASC

Allowed Values: [ "ASC", "DESC" ]
vcnId: string

Minimum Length: 1

Maximum Length: 255

The OCID of the VCN.

Response

Supported Media Types

application/json

200 Response

The list is being retrieved.

Headers

opc-next-page: string

For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
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 : schema

Type: array

Show Source

Array of: object DhcpOptions

A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set: DhcpDnsOption - Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN. DhcpSearchDomainOption - Lets you specify a search domain name to use for DNS queries.

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

Nested Schema : DhcpOptions

Type: object

A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set: DhcpDnsOption - Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN. DhcpSearchDomainOption - Lets you specify a search domain name to use for DNS queries.

Show Source

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment containing the set of DHCP options.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
domainNameType: string

Allowed Values: [ "SUBNET_DOMAIN", "VCN_DOMAIN", "CUSTOM_DOMAIN" ]

The search domain name type of DHCP options
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
id(required): string

Minimum Length: 1

Maximum Length: 255

OCID for the set of DHCP options.
lifecycleState(required): string

Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]

The current state of the set of DHCP options.
options(required): array options

The collection of individual DHCP options.
timeCreated(required): string(date-time)

Date and time the set of DHCP options was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
vcnId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the VCN the set of DHCP options belongs to.

{
    "description":"A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set: DhcpDnsOption - Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN. DhcpSearchDomainOption - Lets you specify a search domain name to use for DNS queries.",
    "x-obmcs-splat":{
        "resourceKind":"dhcp-option",
        "adLocality":"regional"
    },
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the set of DHCP options.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "id":{
            "description":"OCID for the set of DHCP options.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the set of DHCP options.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "options":{
            "description":"The collection of individual DHCP options.",
            "items":{
                "$ref":"#/definitions/DhcpOption"
            },
            "type":"array"
        },
        "timeCreated":{
            "description":"Date and time the set of DHCP options was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "vcnId":{
            "description":"The OCID of the VCN the set of DHCP options belongs to.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "domainNameType":{
            "description":"The search domain name type of DHCP options",
            "enum":[
                "SUBNET_DOMAIN",
                "VCN_DOMAIN",
                "CUSTOM_DOMAIN"
            ],
            "type":"string"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "options",
        "lifecycleState",
        "timeCreated",
        "vcnId"
    ],
    "x-example":"{   \"compartmentId\" : \"ocid1.compartment.oc1..&lt;unique_ID&gt;\",   \"displayName\" : \"MyDhcpOptions\",   \"id\" : \"ocid1.dhcpoptions.oc1.phx.&lt;unique_ID&gt;\",   \"lifecycleState\" : \"AVAILABLE\",   \"options\" : [{     \"type\" : \"DomainNameServer\",     \"customDnsServers\" : [\"203.0.113.7\"],     \"serverType\":\"CustomDnsServer\"   }],   \"timeCreated\" : \"2016-12-17T01:31:50.047Z\",   \"vcnId\" : \"ocid1.vcn.oc1.phx.&lt;unique_ID&gt;\" } ",
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : options

Type: array

The collection of individual DHCP options.

Show Source

Array of: object DhcpOption

Discriminator: type

A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.

{
    "description":"The collection of individual DHCP options.",
    "items":{
        "$ref":"#/definitions/DhcpOption"
    },
    "type":"array"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : DhcpOption

Type: object

Discriminator: type

A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.

Show Source

type(required): string

The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

{
    "description":"A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).",
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "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"
}

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