REST API for Oracle Private Cloud Appliance Compute Enclave

List Export Sets

get

/20171215/exportSets

Lists the export set resources in the specified compartment.

Request

Supported Media Types

application/json

Query Parameters

availabilityDomain: string

The availability domain of the pod shape.
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.

Default Value: none
id: string

Minimum Length: 1

Maximum Length: 255

Filter results by OCID. Must be an OCID of the correct type for the resouce type.

Default Value: none
lifecycleState: string

The state of a resource.

Allowed Values: [ "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: 0
sortBy: string

The field to sort by. You can provide either value, but not both. When you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order.

Default Value: TIMECREATED

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

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

Default Value: ASC

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

Header Parameters

opc-request-id: string

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

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 ExportSetSummary

Summary information for an export set.

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

Nested Schema : ExportSetSummary

Type: object

Summary information for an export set.

Show Source

availabilityDomain: string

Minimum Length: 1

Maximum Length: 255

The availability domain the export set is in. May be unset as a blank or NULL value. Example: AD-1
compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment that contains the export set.
displayName(required): string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.
id(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the export set.
lifecycleState(required): string

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

The current state of the export set.
timeCreated(required): string(date-time)

The date and time the export set was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z
vcnId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the virtual cloud network (VCN) the export set is in.

{
    "description":"Summary information for an export set.",
    "x-example":"[  {   \"availabilityDomain\": \"pWEh:PHX-AD-2\",   \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",   \"displayName\": \"mount-target-5 - export set\",   \"id\": \"ocid1.exportset.oc1..<var>&lt;unique_ID&gt;</var>\",   \"lifecycleState\": \"ACTIVE\",   \"timeCreated\": \"2017-12-01T22:13:22.534Z\",   \"vcnId\": \"ocid1.vcn.oc1..<var>&lt;unique_ID&gt;</var>\"  },  {   \"availabilityDomain\": \"pWEh:PHX-AD-2\",   \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",   \"displayName\": \"mount-target-6 - export set\",   \"id\": \"ocid1.exportset.oc1..<var>&lt;unique_ID&gt;</var>\",   \"lifecycleState\": \"ACTIVE\",   \"timeCreated\": \"2017-12-01T22:15:20.264Z\",   \"vcnId\": \"ocid1.vcn.oc1..<var>&lt;unique_ID&gt;</var>\"  } ] ",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain the export set is in. May be unset as a blank or NULL value. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the export set.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "id":{
            "description":"The OCID of the export set.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the export set.",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the export set was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "vcnId":{
            "description":"The OCID of the virtual cloud network (VCN) the export set is in.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        }
    },
    "required":[
        "compartmentId",
        "displayName",
        "id",
        "lifecycleState",
        "timeCreated",
        "vcnId"
    ],
    "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"
}