multipart_uploads
Creates, updates, deletes, gets or lists a multipart_uploads resource.
Overview​
| Name | multipart_uploads |
| Type | Resource |
| Id | oci.object_storage.multipart_uploads |
Fields​
The following fields are returned by SELECT queries:
- list
Multipart uploads provide efficient and resilient uploads, especially for large objects. Multipart uploads also accommodate<br />objects that are too large for a single upload operation. With multipart uploads, individual parts of an object can be<br />uploaded in parallel to reduce the amount of time you spend uploading. Multipart uploads can also minimize the impact<br />of network failures by letting you retry a failed part upload instead of requiring you to retry an entire object upload.<br />See [Using Multipart Uploads](/Content/Object/Tasks/usingmultipartuploads.htm).<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized,<br />talk to an administrator. If you are an administrator who needs to write policies to give users access, see<br />[Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br />
| Name | Datatype | Description |
|---|---|---|
bucket | string | The bucket in which the in-progress multipart upload is stored. |
namespace | string | The Object Storage namespace in which the in-progress multipart upload is stored. |
object | string | The object name of the in-progress multipart upload. |
storageTier | string | The storage tier that the object is stored in. (Standard, InfrequentAccess, Archive) (x-obmcs-top-level-enum: #/definitions/StorageTier) |
timeCreated | string (date-time) | The date and time the upload was created, as described in [RFC 2616](https:​//tools.ietf.org/html/rfc2616#section-14.29). |
uploadId | string | The unique identifier for the in-progress multipart upload. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | namespaceName, bucketName, region | limit, page, opc-client-request-id | Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.<br /> |
create | insert | namespaceName, bucketName, region, object | if-match, if-none-match, opc-client-request-id, opc-sse-customer-algorithm, opc-sse-customer-key, opc-sse-customer-key-sha256, opc-sse-kms-key-id | Starts a new multipart upload to a specific object in the given bucket in the given namespace.<br /><br />See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)<br />for object naming requirements.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
bucketName | string | The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1 |
namespaceName | string | The Object Storage namespace used for the request. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
if-match | string | The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource. |
if-none-match | string | The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the resource already exists. |
limit | integer | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). |
opc-client-request-id | string | The client request ID for tracing. |
opc-sse-customer-algorithm | string | The optional header that specifies "AES256" as the encryption algorithm. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). |
opc-sse-customer-key | string | The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). |
opc-sse-customer-key-sha256 | string | The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). |
opc-sse-kms-key-id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. |
page | string | For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). |
SELECT examples​
- list
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.<br />
SELECT
bucket,
namespace,
object,
storageTier,
timeCreated,
uploadId
FROM oci.object_storage.multipart_uploads
WHERE namespaceName = '{{ namespaceName }}' -- required
AND bucketName = '{{ bucketName }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-client-request-id = '{{ opc-client-request-id }}'
;
INSERT examples​
- create
- Manifest
Starts a new multipart upload to a specific object in the given bucket in the given namespace.<br /><br />See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)<br />for object naming requirements.<br />
INSERT INTO oci.object_storage.multipart_uploads (
cacheControl,
contentDisposition,
contentEncoding,
contentLanguage,
contentType,
metadata,
object,
storageTier,
namespaceName,
bucketName,
region,
if-match,
if-none-match,
opc-client-request-id,
opc-sse-customer-algorithm,
opc-sse-customer-key,
opc-sse-customer-key-sha256,
opc-sse-kms-key-id
)
SELECT
'{{ cacheControl }}',
'{{ contentDisposition }}',
'{{ contentEncoding }}',
'{{ contentLanguage }}',
'{{ contentType }}',
'{{ metadata }}',
'{{ object }}' /* required */,
'{{ storageTier }}',
'{{ namespaceName }}',
'{{ bucketName }}',
'{{ region }}',
'{{ if-match }}',
'{{ if-none-match }}',
'{{ opc-client-request-id }}',
'{{ opc-sse-customer-algorithm }}',
'{{ opc-sse-customer-key }}',
'{{ opc-sse-customer-key-sha256 }}',
'{{ opc-sse-kms-key-id }}'
RETURNING
bucket,
namespace,
object,
storageTier,
timeCreated,
uploadId
;
# Description fields are for documentation purposes
- name: multipart_uploads
props:
- name: namespaceName
value: "{{ namespaceName }}"
description: Required parameter for the multipart_uploads resource.
- name: bucketName
value: "{{ bucketName }}"
description: Required parameter for the multipart_uploads resource.
- name: region
value: "{{ region }}"
description: Required parameter for the multipart_uploads resource.
- name: cacheControl
value: "{{ cacheControl }}"
description: |
The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and
HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs
that read the object determine what to do based on the value provided.
For example, you could use this header to identify objects that require caching restrictions.
- name: contentDisposition
value: "{{ contentDisposition }}"
description: |
The optional Content-Disposition header that defines presentational information for the object to be
returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object
Storage behavior. Programs that read the object determine what to do based on the value provided.
For example, you could use this header to let users download objects with custom filenames in a browser.
- name: contentEncoding
value: "{{ contentEncoding }}"
description: |
The optional Content-Encoding header that defines the content encodings that were applied to the object to
upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the
object determine what to do based on the value provided. For example, you could use this header to determine
what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of
the object.
- name: contentLanguage
value: "{{ contentLanguage }}"
description: |
The optional Content-Language header that defines the content language of the object to upload. Specifying
values for this header has no effect on Object Storage behavior. Programs that read the object determine what
to do based on the value provided. For example, you could use this header to identify and differentiate objects
based on a particular language.
- name: contentType
value: "{{ contentType }}"
description: |
The optional Content-Type header that defines the standard MIME type format of the object to upload.
Specifying values for this header has no effect on Object Storage behavior. Programs that read the object
determine what to do based on the value provided. For example, you could use this header to identify and
perform special operations on text only objects.
- name: metadata
value: "{{ metadata }}"
description: |
Arbitrary string keys and values for the user-defined metadata for the object.
Keys must be in "opc-meta-*" format. Avoid entering confidential information.
- name: object
value: "{{ object }}"
description: |
The name of the object to which this multi-part upload is targeted. Avoid entering confidential information.
Example: test/object1.log
- name: storageTier
value: "{{ storageTier }}"
description: |
The storage tier that the object should be stored in. If not specified, the object will be stored in
the same storage tier as the bucket.
valid_values: ['Standard', 'InfrequentAccess', 'Archive']
- name: if-match
value: "{{ if-match }}"
description: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.
description: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.
- name: if-none-match
value: "{{ if-none-match }}"
description: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the resource already exists.
description: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the resource already exists.
- name: opc-client-request-id
value: "{{ opc-client-request-id }}"
description: The client request ID for tracing.
description: The client request ID for tracing.
- name: opc-sse-customer-algorithm
value: "{{ opc-sse-customer-algorithm }}"
description: The optional header that specifies "AES256" as the encryption algorithm. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).
description: The optional header that specifies "AES256" as the encryption algorithm. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).
- name: opc-sse-customer-key
value: "{{ opc-sse-customer-key }}"
description: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).
description: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).
- name: opc-sse-customer-key-sha256
value: "{{ opc-sse-customer-key-sha256 }}"
description: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).
description: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. For more information, see [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).
- name: opc-sse-kms-key-id
value: "{{ opc-sse-kms-key-id }}"
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.