Jump to

• Request
• Response

List default Oracle Cloud Storage container objects.

get

/bdcsce/api/v1.1/clustermgmt/{identityDomainId}/instances/{clusterId}/objectstore/default/files

Request

Path Parameters

• clusterId: string
  Identifier for the Cluster
• identityDomainId: string
  Identity domain ID of the Oracle Cloud Service instance, used for authentication.

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

200 Response

Body ()

Root Schema : PageableObjectStoreReferences

Type: object

Show Source

• container: object SwiftObjectStoreContainerStatus
• count: integer(int32)
  Number of items returned
• endMarker(optional): string
  For a string value, x, returns container names that are less than the marker value.
• hasMore(optional): object hasMore
  Are there more items to fetch
• items(optional): array items
• limit(optional): object limit
  For an integer value n, limits the number of results to n.
• links(optional): array links
  Hyperlinks to other associated resources.
• marker(optional): string
  For a string value, x, returns container names that are greater than the marker value.
• offset(optional): object offset
  The page number. Normally used if you are not specifying a marker or endMarker.
• prefix(optional): string
  Named items in the response begin with this value.

{
    "type":"object",
    "required":[
        "container",
        "count"
    ],
    "properties":{
        "container":{
            "description":"Container the items come from.",
            "$ref":"#/definitions/SwiftObjectStoreContainerStatus"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SwiftObjectStoreFileHeader"
            }
        },
        "limit":{
            "type":"object",
            "description":"For an integer value n, limits the number of results to n."
        },
        "offset":{
            "type":"object",
            "description":"The page number. Normally used if you are not specifying a marker or endMarker."
        },
        "marker":{
            "type":"string",
            "description":"For a string value, x, returns container names that are greater than the marker value."
        },
        "endMarker":{
            "type":"string",
            "description":"For a string value, x, returns container names that are less than the marker value."
        },
        "prefix":{
            "type":"string",
            "description":"Named items in the response begin with this value."
        },
        "hasMore":{
            "type":"object",
            "description":"Are there more items to fetch"
        },
        "links":{
            "type":"array",
            "description":"Hyperlinks to other associated resources.",
            "items":{
                "$ref":"#/definitions/ModelLink"
            }
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Number of items returned"
        }
    }
}

Nested Schema : SwiftObjectStoreContainerStatus

Type: object

Show Source

• availableQuotaBytes(optional): object availableQuotaBytes
  Available quota in bytes.
• bytesUsed(optional): integer(int64)
  Total bytes used in the container.
• containerReadPermission(optional): string
• containerWritePermission(optional): string
• count(optional): integer(int64)
  Number of objects in the container.
• href(optional): string
  Read Only: true

  Hyperlink to the container.
• name(optional): string
  Name of the container.
• path(optional): string
  Path of the container.
• privateURL(optional): string
• publicURL(optional): string
• quotaBytes(optional): object quotaBytes
  Available bytes quota as described by the Object Store.
• storageServerTime(optional): string(date-time)
  Time as described by Object Store.
• timestamp(optional): string(date-time)
  Timestamp of the measurement.
• timestampMs(optional): integer(int64)
  Timestamp, in milliseconds, of the measurement.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the container."
        },
        "path":{
            "type":"string",
            "description":"Path of the container."
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the container."
        },
        "bytesUsed":{
            "type":"integer",
            "format":"int64",
            "description":"Total bytes used in the container."
        },
        "storageServerTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time as described by Object Store."
        },
        "quotaBytes":{
            "type":"object",
            "description":"Available bytes quota as described by the Object Store."
        },
        "containerReadPermission":{
            "type":"string"
        },
        "containerWritePermission":{
            "type":"string"
        },
        "publicURL":{
            "type":"string"
        },
        "privateURL":{
            "type":"string"
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"Timestamp of the measurement."
        },
        "availableQuotaBytes":{
            "type":"object",
            "description":"Available quota in bytes."
        },
        "timestampMs":{
            "type":"integer",
            "format":"int64",
            "description":"Timestamp, in milliseconds, of the measurement."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to the container.",
            "readOnly":true
        }
    }
}

Nested Schema : hasMore

Type: object

Are there more items to fetch

Nested Schema : items

Type: array

Show Source

• [0]: object SwiftObjectStoreFileHeader

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

Nested Schema : limit

Type: object

For an integer value n, limits the number of results to n.

Nested Schema : links

Type: array

Hyperlinks to other associated resources.

Show Source

• [0]: object ModelLink

{
    "type":"array",
    "description":"Hyperlinks to other associated resources.",
    "items":{
        "$ref":"#/definitions/ModelLink"
    }
}

Nested Schema : offset

Type: object

The page number. Normally used if you are not specifying a marker or endMarker.

Nested Schema : availableQuotaBytes

Type: object

Available quota in bytes.

Nested Schema : quotaBytes

Type: object

Available bytes quota as described by the Object Store.

Nested Schema : SwiftObjectStoreFileHeader

Type: object

Show Source

• bareName(optional): string
  Bare name as described by the Object Store.
• bytes(optional): integer(int64)
  Size of the file as described by the Object Store or File System where it is located.
• containerName(optional): string
  Name container that has this file..
• contentType(optional): string
  Content Type, if identifiable.
• directory(optional): boolean
  Default Value: false

  True if this object represents a pseudo directory.
• hash(optional): string
  The MD5 checksum value of the object content.
• lastModifiedAt(optional): string(date-time)
  Timestamp when the file was created
• name(optional): string
  Name of the file.
• ociRef(optional): string
  OCI URI that can be used to reference this object using the OCI HDFS Driver
• path(optional): string
  Path of the file as described by the Object Store or File System where it is located.
• swift2dRef(optional): string
  Swift2D URI that can be used to reference this object with the Stocator Driver.
• swiftRef(optional): string
  Swift URI that can be used to reference this object with the Hadoop Openstack Driver.
• swiftServiceName(optional): string
  Service Name that .

{
    "type":"object",
    "properties":{
        "containerName":{
            "type":"string",
            "description":"Name container that has this file.."
        },
        "swiftServiceName":{
            "type":"string",
            "description":"Service Name that ."
        },
        "name":{
            "type":"string",
            "description":"Name of the file."
        },
        "path":{
            "type":"string",
            "description":"Path of the file as described by the Object Store or File System where it is located."
        },
        "lastModifiedAt":{
            "type":"string",
            "format":"date-time",
            "description":"Timestamp when the file was created"
        },
        "bytes":{
            "type":"integer",
            "format":"int64",
            "description":"Size of the file as described by the Object Store or File System where it is located."
        },
        "bareName":{
            "type":"string",
            "description":"Bare name as described by the Object Store."
        },
        "contentType":{
            "type":"string",
            "description":"Content Type, if identifiable."
        },
        "hash":{
            "type":"string",
            "description":"The MD5 checksum value of the object content."
        },
        "ociRef":{
            "type":"string",
            "description":"OCI URI that can be used to reference this object using the OCI HDFS Driver"
        },
        "swift2dRef":{
            "type":"string",
            "description":"Swift2D URI that can be used to reference this object with the Stocator Driver."
        },
        "swiftRef":{
            "type":"string",
            "description":"Swift URI that can be used to reference this object with the Hadoop Openstack Driver."
        },
        "directory":{
            "type":"boolean",
            "description":"True if this object represents a pseudo directory.",
            "default":false
        }
    }
}

Nested Schema : ModelLink

Type: object

Show Source

• href: string
  The URI of the linked resource
• mediaType(optional): string
  The media type to apply to the URI
• method(optional): string
  The method to apply to the URI
• profile(optional): string
  The profile
• rel: string
  Relation link
• templated(optional): object templated
  Is the URI a template

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI of the linked resource"
        },
        "rel":{
            "type":"string",
            "description":"Relation link"
        },
        "method":{
            "type":"string",
            "description":"The method to apply to the URI"
        },
        "templated":{
            "type":"object",
            "description":"Is the URI a template"
        },
        "mediaType":{
            "type":"string",
            "description":"The media type to apply to the URI"
        },
        "profile":{
            "type":"string",
            "description":"The profile"
        }
    }
}

Nested Schema : templated

Type: object

Is the URI a template

400 Response

List of errors related to the request.

Body ()

Root Schema : schema

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

The Oracle Cloud Storage was not found.

500 Response

An internal error occurred.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  detail
• instance(optional): string
  instance
• o:errorCode(optional): string
  Read Only: true

  error code
• o:errorDetails(optional): array o:errorDetails
  Read Only: true

  error details
• o:errorPath(optional): string
  Read Only: true

  error path
• status: integer(int32)
  status
• title: string
  title
• type(optional): string
  Read Only: true

  RFC Link

{
    "type":"object",
    "required":[
        "status",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"title"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"status"
        },
        "detail":{
            "type":"string",
            "description":"detail"
        },
        "instance":{
            "type":"string",
            "description":"instance"
        },
        "o:errorCode":{
            "type":"string",
            "description":"error code",
            "readOnly":true
        },
        "o:errorPath":{
            "type":"string",
            "description":"error path",
            "readOnly":true
        },
        "o:errorDetails":{
            "type":"array",
            "description":"error details",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "type":{
            "type":"string",
            "description":"RFC Link",
            "readOnly":true
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Read Only: true

error details

Show Source

• [0]: object Error

{
    "type":"array",
    "description":"error details",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top