package spec.proto.extension.v1.s3
Get desktop application:
View/edit binary Protocol Buffers messages
service ObjectStorageService
oss.proto:18ObjectStorageService is an abstraction for blob storage or so called "object storage", such as alibaba cloud OSS, such as AWS S3. You invoke ObjectStorageService API to do some CRUD operations on your binary file, e.g. query my file, delete my file, etc.
rpc PutObject (stream , )
oss.proto:23Object CRUD API Adds an object to a bucket. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
message
oss.proto:233PutObjectInput
string store_name = 1
Required. The name of oss store.
bytes body = 2
Object data.
string bucket = 3
The bucket name to which the PUT action was initiated This member is required.
string key = 4
Object key for which the PUT action was initiated. This member is required.
string acl = 5
The canned ACL to apply to the object,different oss provider have different acl type
bool bucket_key_enabled = 6
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
string cache_control = 7
Can be used to specify caching behavior along the request/reply chain.
string content_disposition = 8
Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1).
string content_encoding = 9
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11).
int64 expires = 10
The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21).
string server_side_encryption = 11
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
string signed_url = 12
Specify the signed url of object, user can put object with signed url without ak、sk
map<string, string> meta = 13
A map of metadata to store with the object in S3.
map<string, string> tagging = 14
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
string storage_class = 15
Storage class options.
int64 content_length = 16
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically
message
oss.proto:282PutObjectOutput
bool bucket_key_enabled = 1
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
string etag = 2
Entity tag for the uploaded object.
string expiration = 3
If the expiration is configured for the object
string request_charged = 4
If present, indicates that the requester was successfully charged for the request.
string version_id = 5
Version of the object.
map<string, string> metadata = 6
The metadata returned from OSS.
rpc GetObject (, stream )
oss.proto:26Retrieves objects. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
message
oss.proto:121GetObjectInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Key of the object to get This member is required
string expected_bucket_owner = 4
The account ID of the expected bucket owner
string if_match = 5
Return the object only if its entity tag (ETag) is the same as the one specified
int64 if_modified_since = 6
Return the object only if it has been modified since the specified time
string if_none_match = 7
Return the object only if its entity tag (ETag) is different from the one specified
int64 if_unmodified_since = 8
Return the object only if it has not been modified since the specified time
int64 part_number = 9
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
int64 start = 10
Downloads the specified range bytes of an object start is used to specify the location where the file starts
int64 end = 11
end is used to specify the location where the file end
string request_payer = 12
Confirms that the requester knows that they will be charged for the request.
string response_cache_control = 13
Sets the Cache-Control header of the response.
string response_content_disposition = 14
Sets the Content-Disposition header of the response
string response_content_encoding = 15
Sets the Content-Encoding header of the response
string response_content_language = 16
Sets the Content-Language header of the response
string response_content_type = 17
Sets the Content-Type header of the response
string response_expires = 18
Sets the Expires header of the response
string sse_customer_algorithm = 19
Specifies the algorithm to use to when decrypting the object (for example,AES256)
string sse_customer_key = 20
Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header
string sse_customer_key_md5 = 21
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321 Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
string version_id = 22
VersionId used to reference a specific version of the object
string accept_encoding = 23
Specify Accept-Encoding, aws not supported now
string signed_url = 24
Specify the signed url of object, user can get object with signed url without ak、sk
message
oss.proto:183GetObjectOutput
bytes body = 1
Object data.
string cache_control = 2
Specifies caching behavior along the request/reply chain.
string content_disposition = 3
Specifies presentational information for the object.
string content_encoding = 4
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
string content_language = 5
The language the content is in.
int64 content_length = 6
Size of the body in bytes.
string content_range = 7
The portion of the object returned in the response.
string content_type = 8
A standard MIME type describing the format of the object data.
bool delete_marker = 9
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
string etag = 10
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
string expiration = 11
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.
string expires = 12
The date and time at which the object is no longer cacheable.
int64 last_modified = 13
Creation date of the object.
string version_id = 14
Version of the object.
int64 tag_count = 15
The number of tags, if any, on the object.
string storage_class = 16
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
int64 parts_count = 17
The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.
map<string, string> metadata = 18
A map of metadata to store with the object in S3. Map keys will be normalized to lower-case.
rpc DeleteObject (, )
oss.proto:29Delete objects. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
message
oss.proto:299DeleteObjectInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name to which the DEL action was initiated This member is required.
string key = 3
Object key for which the DEL action was initiated. This member is required.
string request_payer = 4
Confirms that the requester knows that they will be charged for the request.
string version_id = 5
VersionId used to reference a specific version of the object.
message
oss.proto:315DeleteObjectOutput
bool delete_marker = 1
Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
string request_charged = 2
If present, indicates that the requester was successfully charged for the request.
string version_id = 3
Returns the version ID of the delete marker created as a result of the DELETE operation.
map<string, string> metadata = 4
The metadata returned from OSS.
rpc CopyObject (, )
oss.proto:32Creates a copy of an object that is already stored in oss server. Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_CopyObject.html
message
oss.proto:420CopyObjectInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The name of the destination bucket. When using this action with an access point This member is required.
string key = 3
The key of the destination object. This member is required.
optional copy_source = 4
CopySource
map<string, string> tagging = 5
The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.
int64 expires = 6
The date and time at which the object is no longer cacheable.
string metadata_directive = 7
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
map<string, string> metadata = 8
A map of metadata to store with the object in S3.
message
oss.proto:453CopyObjectOutput
optional copy_object_result = 1
Container for all response elements.
string version_id = 2
Version ID of the newly created copy.
string expiration = 3
If the object expiration is configured, the response includes this header.
map<string, string> metadata = 4
The metadata returned from OSS.
rpc DeleteObjects (, )
oss.proto:35Delete multiple objects from a bucket. Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_DeleteObjects.html
message
oss.proto:483DeleteObjectsInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
optional delete = 3
Delete objects
string request_payer = 4
Confirms that the requester knows that they will be charged for the request.
message
oss.proto:512DeleteObjectsOutput
repeated deleted = 1
DeletedObject
map<string, string> metadata = 2
The metadata returned from OSS.
rpc ListObjects (, )
oss.proto:38Returns some or all (up to 1,000) of the objects in a bucket. Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_ListObjects.html
message
oss.proto:520ListObjectsInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string delimiter = 3
A delimiter is a character you use to group keys.
string encoding_type = 4
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
string expected_bucket_owner = 5
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
string marker = 6
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
int32 maxKeys = 7
Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
string prefix = 8
Limits the response to keys that begin with the specified prefix.
string request_payer = 9
Confirms that the requester knows that they will be charged for the request.
bool fetch_owner = 10
Decide whether fetch owner info from server,which is required for aliyun oss.
message
oss.proto:555ListObjectsOutput
repeated string common_prefixes = 1
CommonPrefixes
repeated contents = 2
Objects contents
string delimiter = 3
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
string encoding_type = 4
Encoding type used by Amazon S3 to encode object keys in the response.
bool is_truncated = 5
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
string marker = 6
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
int32 max_keys = 7
The maximum number of keys returned in the response body.
string name = 8
The bucket name.
string next_marker = 9
When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects.
string prefix = 10
Keys that begin with the indicated prefix.
map<string, string> metadata = 11
The metadata returned from OSS.
rpc HeadObject (, )
oss.proto:41The HEAD action retrieves metadata from an object without returning the object itself. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html
message
oss.proto:1397HeadObjectInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string checksum_mode = 4
To retrieve the checksum, this parameter must be enabled
string expected_bucket_owner = 5
The account ID of the expected bucket owner
string if_match = 6
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
int64 if_modified_since = 7
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
string if_none_match = 8
Return the object only if its entity tag (ETag) is different from the one specified
int64 if_unmodified_since = 9
Return the object only if it has not been modified since the specified time;
int32 part_number = 10
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
string request_payer = 11
Confirms that the requester knows that they will be charged for the request.
string sse_customer_algorithm = 12
Specifies the algorithm to use to when encrypting the object (for example, AES256).
string sse_customer_key = 13
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data
string sse_customer_key_md5 = 14
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
string version_id = 15
VersionId used to reference a specific version of the object.
bool with_details = 16
Return object details meta
message
oss.proto:1443HeadObjectOutput
map<string, string> result_metadata = 1
Metadata pertaining to the operation's result.
rpc IsObjectExist (, )
oss.proto:43This action used to check if the file exists.
message
oss.proto:1449IsObjectExistInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string version_id = 4
Object version id
message
oss.proto:1463IsObjectExistOutput
bool file_exist = 1
Object exist or not
map<string, string> metadata = 2
The metadata returned from OSS.
rpc PutObjectTagging (, )
oss.proto:48Object Tagging API Sets the supplied tag-set to an object that already exists in a bucket. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html
message
oss.proto:330PutObjectTaggingInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required.
string key = 3
Name of the object key. This member is required.
map<string, string> tags = 4
Container for the TagSet and Tag elements
string version_id = 5
The versionId of the object that the tag-set will be added to.
message
oss.proto:346PutObjectTaggingOutput
string version_id = 1
The versionId of the object the tag-set was added to.
map<string, string> result_metadata = 2
Metadata pertaining to the operation's result.
rpc DeleteObjectTagging (, )
oss.proto:51Removes the entire tag set from the specified object. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html
message
oss.proto:354DeleteObjectTaggingInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the objects from which to remove the tags.
string key = 3
The key that identifies the object in the bucket from which to remove all tags. This member is required.
string version_id = 4
The versionId of the object that the tag-set will be removed from.
string expected_bucket_owner = 5
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
message
oss.proto:371DeleteObjectTaggingOutput
string version_id = 1
The versionId of the object the tag-set was removed from.
map<string, string> result_metadata = 2
Metadata pertaining to the operation's result.
rpc GetObjectTagging (, )
oss.proto:54Returns the tag-set of an object. Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_GetObjectTagging.html
message
oss.proto:379GetObjectTaggingInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object for which to get the tagging information. This member is required.
string key = 3
Object key for which to get the tagging information. This member is required.
string version_id = 4
The versionId of the object for which to get the tagging information.
string expected_bucket_owner = 5
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
string request_payer = 6
Confirms that the requester knows that they will be charged for the request.
message
oss.proto:399GetObjectTaggingOutput
map<string, string> tags = 1
Contains the tag set. This member is required.
string version_id = 2
The versionId of the object for which you got the tagging information.
map<string, string> result_metadata = 3
Metadata pertaining to the operation's result.
rpc GetObjectCannedAcl (, )
oss.proto:68Returns object canned acl. Refer https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#CannedACL
message
oss.proto:616GetObjectCannedAclInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string version_id = 4
VersionId used to reference a specific version of the object
message
oss.proto:630GetObjectCannedAclOutput
string canned_acl = 1
Object CannedACL
optional owner = 2
Owner
string request_charged = 3
If present, indicates that the requester was successfully charged for the request.
map<string, string> metadata = 4
The metadata returned from OSS.
rpc PutObjectCannedAcl (, )
oss.proto:71Set object canned acl. Refer https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#CannedACL
message
oss.proto:643PutObjectCannedAclInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string acl = 4
The canned ACL to apply to the object
string version_id = 5
VersionId used to reference a specific version of the object.
message
oss.proto:659PutObjectCannedAclOutput
string request_charged = 1
Request charged
map<string, string> metadata = 2
The metadata returned from OSS.
rpc CreateMultipartUpload (, )
oss.proto:76Object Multipart Operation API Initiates a multipart upload and returns an upload ID. Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_CreateMultipartUpload.html
message
oss.proto:829CreateMultipartUploadInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string acl = 4
The canned ACL to apply to the object. This action is not supported by Amazon S3 on Outposts.
bool bucket_key_enabled = 5
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
string cache_control = 6
Specifies caching behavior along the request/reply chain
string content_disposition = 7
Specifies presentational information for the object
string content_encoding = 8
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
string content_language = 9
The language the content is in.
string content_type = 10
A standard MIME type describing the format of the object data.
string expected_bucket_owner = 11
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
int64 expires = 12
The date and time at which the object is no longer cacheable.
string grant_full_control = 13
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This action is not supported by Amazon S3 on Outposts.
string grant_read = 14
Allows grantee to read the object data and its metadata. This action is not supported by Amazon S3 on Outposts.
string grant_read_acp = 15
Allows grantee to read the object ACL. This action is not supported by Amazon S3 on Outposts.
string grant_write_acp = 16
Allows grantee to write the ACL for the applicable object. This action is not supported by Amazon S3 on Outposts.
map<string, string> meta_data = 17
A map of metadata to store with the object
string object_lock_legal_hold_status = 18
Specifies whether you want to apply a legal hold to the uploaded object
string object_lock_mode = 19
Specifies the Object Lock mode that you want to apply to the uploaded object
int64 object_lock_retain_until_date = 20
Specifies the date and time when you want the Object Lock to expire
string request_payer = 21
Confirms that the requester knows that they will be charged for the request
string sse_customer_algorithm = 22
Specifies the algorithm to use to when encrypting the object (for example, AES256).
string sse_customer_key = 23
Specifies the customer-provided encryption key to use in encrypting data
string sse_customer_key_md5 = 24
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321
string sse_kms_encryption_context = 25
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption
string sse_kms_key_id = 26
Specifies the ID of the symmetric customer managed key to use for object encryption
string server_side_encryption = 27
The server-side encryption algorithm used when storing this object
string storage_class = 28
By default, oss store uses the STANDARD Storage Class to store newly created objects
map<string, string> tagging = 29
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
string website_redirect_location = 30
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.
message
oss.proto:910CreateMultipartUploadOutput
string bucket = 1
The bucket name containing the object This member is required
string key = 2
Name of the object key. This member is required.
int64 abort_date = 3
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header
string abort_rule_id = 4
It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
bool bucket_key_enabled = 5
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
string request_charged = 6
If present, indicates that the requester was successfully charged for the request.
string sse_customer_algorithm = 7
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
string sse_customer_key_md5 = 8
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
string sse_kms_encryption_context = 9
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
string sse_kms_key_id = 10
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
string server_side_encryption = 11
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
string upload_id = 12
ID for the initiated multipart upload.
map<string, string> metadata = 13
The metadata returned from OSS.
rpc UploadPart (stream , )
oss.proto:79Uploads a part in a multipart upload. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
message
oss.proto:955UploadPartInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
bytes body = 4
Object data.
int64 content_length = 5
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
string content_md5 = 6
The base64-encoded 128-bit MD5 digest of the part data.
string expected_bucket_owner = 7
The account ID of the expected bucket owner
int32 part_number = 8
Part number of part being uploaded. This is a positive integer between 1 and 10,000. This member is required.
string request_payer = 9
Confirms that the requester knows that they will be charged for the request.
string sse_customer_algorithm = 10
Specifies the algorithm to use to when encrypting the object (for example, AES256).
string sse_customer_key = 11
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data
string sse_customer_key_md5 = 12
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
string upload_id = 13
Upload ID identifying the multipart upload whose part is being uploaded. This member is required.
message
oss.proto:992UploadPartOutput
bool bucket_key_enabled = 1
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
string etag = 2
Entity tag for the uploaded object.
string request_charged = 3
If present, indicates that the requester was successfully charged for the request.
string sse_customer_algorithm = 4
Specifies the algorithm to use to when encrypting the object (for example, AES256).
string sse_customer_key_md5 = 5
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
string sse_kms_key_id = 6
Specifies the ID of the symmetric customer managed key to use for object encryption
string server_side_encryption = 7
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
map<string, string> metadata = 8
The metadata returned from OSS.
rpc UploadPartCopy (, )
oss.proto:82Uploads a part by copying data from an existing object as data source. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
message
oss.proto:1016UploadPartCopyInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
optional copy_source = 4
CopySource
int32 part_number = 5
Part number of part being copied. This is a positive integer between 1 and 10,000. This member is required.
string upload_id = 6
Upload ID identifying the multipart upload whose part is being copied. This member is required.
int64 start_position = 7
The range of bytes to copy from the source object.bytes=start_position-part_size
int64 part_size = 8
Part size
message
oss.proto:1048UploadPartCopyOutput
bool bucket_key_enabled = 1
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
optional copy_part_result = 2
Container for all response elements.
string copy_source_version_id = 3
The version of the source object that was copied, if you have enabled versioning on the source bucket.
string request_charged = 4
If present, indicates that the requester was successfully charged for the request.
string sse_customer_algorithm = 5
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
string sse_customer_key_md5 = 6
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
string sse_kms_key_id = 7
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
string server_side_encryption = 8
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
map<string, string> metadata = 9
The metadata returned from OSS.
rpc CompleteMultipartUpload (, )
oss.proto:85Completes a multipart upload by assembling previously uploaded parts. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
message
oss.proto:1094CompleteMultipartUploadInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string upload_id = 4
ID for the initiated multipart upload. This member is required.
string request_payer = 5
Confirms that the requester knows that they will be charged for the request.
string expected_bucket_owner = 6
Expected bucket owner
optional multipart_upload = 7
The container for the multipart upload request information.
message
oss.proto:1115CompleteMultipartUploadOutput
string bucket = 1
The bucket name containing the object This member is required
string key = 2
Name of the object key. This member is required.
bool bucket_key_enabled = 3
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
string etag = 4
Entity tag that identifies the newly created object's data
string expiration = 5
If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.
string location = 6
The URI that identifies the newly created object.
string request_charged = 7
If present, indicates that the requester was successfully charged for the request.
string sse_kms_keyId = 8
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
string server_side_encryption = 9
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
string version_id = 10
Version ID of the newly created object, in case the bucket has versioning turned on.
map<string, string> metadata = 11
The metadata returned from OSS.
rpc AbortMultipartUpload (, )
oss.proto:88This action aborts a multipart upload. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
message
oss.proto:1150AbortMultipartUploadInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string expected_bucket_owner = 4
The account ID of the expected bucket owner
string request_payer = 5
Confirms that the requester knows that they will be charged for the request.
string upload_id = 6
Upload ID that identifies the multipart upload. This member is required.
message
oss.proto:1169AbortMultipartUploadOutput
string request_charged = 1
If present, indicates that the requester was successfully charged for the request.
map<string, string> metadata = 2
The metadata returned from OSS.
rpc ListMultipartUploads (, )
oss.proto:91This action lists in-progress multipart uploads. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
message
oss.proto:1177ListMultipartUploadsInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string delimiter = 3
Character you use to group keys. All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.
string encoding_type = 4
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character;
string expected_bucket_owner = 5
The account ID of the expected bucket owner
string key_marker = 6
Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list. If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.
int64 max_uploads = 7
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
string prefix = 8
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)
string upload_id_marker = 9
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.
message
oss.proto:1245ListMultipartUploadsOutput
string bucket = 1
The bucket name containing the object This member is required
repeated string common_prefixes = 2
If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element.
string delimiter = 3
Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.
string encoding_type = 4
Encoding type used by Amazon S3 to encode object keys in the response.
bool is_truncated = 5
Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
string key_marker = 6
The key at or after which the listing began.
int32 max_uploads = 7
Maximum number of multipart uploads that could have been included in the response.
string next_key_marker = 8
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
string next_upload_id_marker = 9
When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
string prefix = 10
When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
string upload_id_marker = 11
Upload ID after which listing began.
repeated uploads = 12
Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.
map<string, string> metadata = 13
The metadata returned from OSS.
rpc ListParts (, )
oss.proto:94Lists the parts that have been uploaded for a specific multipart upload. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
message
oss.proto:1550ListPartsInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string expected_bucket_owner = 4
The account ID of the expected bucket owner
int64 max_parts = 5
Sets the maximum number of parts to return
int64 part_number_marker = 6
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
string request_payer = 7
Confirms that the requester knows that they will be charged for the request.
string upload_id = 8
Upload ID identifying the multipart upload whose parts are being listed.
message
oss.proto:1585ListPartsOutput
string bucket = 1
The bucket name containing the object This member is required
string key = 2
Name of the object key. This member is required.
string upload_id = 3
Upload ID identifying the multipart upload whose parts are being listed.
string next_part_number_marker = 4
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
int64 max_parts = 5
Maximum number of parts that were allowed in the response.
bool is_truncated = 6
Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
repeated parts = 7
Container for elements related to a particular part. A response can contain zero or more Part elements.
map<string, string> metadata = 8
The metadata returned from OSS.
rpc ListObjectVersions (, )
oss.proto:98Returns metadata about all versions of the objects in a bucket. Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectVersions.html
message
oss.proto:1286ListObjectVersionsInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string delimiter = 3
A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
string encoding_type = 4
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character;
string expected_bucket_owner = 5
The account ID of the expected bucket owner
string key_marker = 6
Specifies the key to start with when listing objects in a bucket.
int64 max_keys = 7
Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains true. To return the additional keys, see key-marker and version-id-marker.
string prefix = 8
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
string version_id_marker = 9
Specifies the object version you want to start listing from.
message
oss.proto:1360ListObjectVersionsOutput
repeated string common_prefixes = 1
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
repeated delete_markers = 2
Container for an object that is a delete marker.
string delimiter = 3
The delimiter grouping the included keys.
string encoding_type = 4
Encoding type used by Amazon S3 to encode object key names in the XML response.
bool is_truncated = 5
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria
string key_marker = 6
Marks the last key returned in a truncated response.
int64 max_keys = 7
Specifies the maximum number of objects to return
string name = 8
The bucket name.
string next_key_marker = 9
When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria
string next_version_id_marker = 10
When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria.
string prefix = 11
Selects objects that start with the value supplied by this parameter.
string version_id_marker = 12
Marks the last version of the key returned in a truncated response.
repeated versions = 13
Container for version information.
map<string, string> metadata = 14
The metadata returned from OSS.
rpc SignURL (, )
oss.proto:102A presigned URL gives you access to the object identified in the URL, provided that the creator of the presigned URL has permissions to access that object. Refer https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html
message
oss.proto:1471SignURLInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
string method = 4
the method for sign url, eg. GET、POST
int64 expired_in_sec = 5
expire time of the sign url
message
oss.proto:1487SignURLOutput
string signed_url = 1
Object signed url
This action used to set download bandwidth limit speed. Refer https://github.com/aliyun/aliyun-oss-go-sdk/blob/master/oss/client.go#L2106
This action used to set upload bandwidth limit speed. Refer https://github.com/aliyun/aliyun-oss-go-sdk/blob/master/oss/client.go#L2096
rpc AppendObject (stream , )
oss.proto:113This action is used to append object. Refer https://help.aliyun.com/document_detail/31981.html or https://github.com/minio/minio-java/issues/980
message
oss.proto:1503AppendObjectInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
bytes body = 4
Object content
int64 position = 5
Append start position
string acl = 6
Object ACL
string cache_control = 7
Sets the Cache-Control header of the response.
string content_disposition = 8
Sets the Content-Disposition header of the response
string content_encoding = 9
Sets the Content-Encoding header of the response
string content_md5 = 10
The base64-encoded 128-bit MD5 digest of the part data.
int64 expires = 11
Sets the Expires header of the response
string storage_class = 12
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
string server_side_encryption = 13
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
string meta = 14
Object metadata
map<string, string> tags = 15
Object tags
message
oss.proto:1542AppendObjectOutput
int64 append_position = 1
Next append position
map<string, string> metadata = 2
The metadata returned from OSS.
rpc RestoreObject (, )
oss.proto:117Restores an archived copy of an object back. Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_RestoreObject.html
message
oss.proto:801RestoreObjectInput
string store_name = 1
Required. The name of oss store.
string bucket = 2
The bucket name containing the object This member is required
string key = 3
Name of the object key. This member is required.
optional restore_request = 4
The information of restoring request.
string version_id = 5
VersionId used to reference a specific version of the object.
message
oss.proto:817RestoreObjectOutput
string request_charged = 1
If present, indicates that the requester was successfully charged for the request.
string restore_output_path = 2
Indicates the path in the provided S3 output location where Select results will be restored to.
map<string, string> metadata = 3
The metadata returned from OSS.
message
oss.proto:684CSVInput
Used in:
bool allow_quoted_record_delimiter = 1
Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
string comments = 2
A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.
string field_delimiter = 3
A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
string file_header_info = 4
Describes the first line of input. Valid values are: * NONE: First line is not a header. * IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s). * Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).
string quote_character = 5
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ". Type: String Default: " Ancestors: CSV
string quote_escape_character = 6
A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".
string record_delimiter = 7
A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
message
oss.proto:734CSVOutput
Used in:
string field_delimiter = 1
The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
string quote_character = 2
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".
string quote_escape_character = 3
The single character used for escaping the quote character inside an already escaped value.
string quote_fields = 4
Indicates whether to use quotation marks around output fields. * ALWAYS: Always use quotation marks for output fields. * ASNEEDED: Use quotation marks for output fields when needed.
string record_delimiter = 5
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
message
oss.proto:1088CompletedMultipartUpload
Used in:
repeated parts = 1
Array of CompletedPart data types.
message
oss.proto:1079CompletedPart
Used in:
string etag = 1
Entity tag returned when the part was uploaded.
int32 part_number = 2
Part number that identifies the part. This is a positive integer between 1 and 10,000.
message
oss.proto:444CopyObjectResult
Used in:
string etag = 1
Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.
int64 last_modified = 2
Creation date of the object.
message
oss.proto:1040CopyPartResult
Used in:
string etag = 1
Entity tag of the object.
int64 last_modified = 2
Last modified time
message
oss.proto:410CopySource
Used in: ,
string copy_source_bucket = 1
source object bucket name
string copy_source_key = 2
source object name
string copy_source_version_id = 3
source object version
message
oss.proto:465Delete
Used in:
repeated objects = 1
ObjectIdentifier
bool quiet = 2
Element to enable quiet mode for the request. When you add this element, you must set its value to true.
message
oss.proto:1322DeleteMarkerEntry
Used in:
bool is_latest = 1
Specifies whether the object is (true) or is not (false) the latest version of an object.
string key = 2
Name of the object key. This member is required.
int64 last_modified = 3
Date and time the object was last modified.
optional owner = 4
Owner
string version_id = 5
Version ID of an object.
message
oss.proto:496DeletedObject
Used in:
bool delete_marker = 1
Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.
string delete_marker_version_id = 2
The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.
string key = 3
The name of the deleted object.
string version_id = 4
The version ID of the deleted object.
message
oss.proto:667GlacierJobParameters
Used in:
string tier = 1
Retrieval tier at which the restore will be processed. This member is required.
message
oss.proto:1220Initiator
Used in:
string display_name = 1
Initiator name
string id = 2
Initiator id
message
oss.proto:723InputSerialization
Used in:
optional csv = 1
Describes the serialization of a CSV-encoded object.
string compression_type = 2
Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.
string json = 3
Specifies JSON as object's input serialization format.
message
oss.proto:1228MultipartUpload
Used in:
int64 initiated = 1
Date and time at which the multipart upload was initiated.
optional initiator = 2
Identifies who initiated the multipart upload.
string key = 3
Name of the object key. This member is required.
optional owner = 4
Specifies the owner of the object that is part of the multipart upload.
string storage_class = 5
The class of storage used to store the object.
string upload_id = 6
Upload ID that identifies the multipart upload.
message
oss.proto:597Object
Used in:
string etag = 1
The entity tag is a hash of the object
string key = 2
The name that you assign to an object. You use the object key to retrieve the object.
int64 last_modified = 3
Creation date of the object.
optional owner = 4
The owner of the object
int64 size = 5
Size in bytes of the object
string storage_class = 6
The class of storage used to store the object.
string type = 7
The type of object which is required for aliyun oss.
message
oss.proto:474ObjectIdentifier
Used in:
string key = 1
Key name of the object. This member is required.
string version_id = 2
VersionId for the specific version of the object to delete.
message
oss.proto:1338ObjectVersion
Used in:
string etag = 1
The entity tag is an MD5 hash of that version of the object.
bool is_latest = 2
Specifies whether the object is (true) or is not (false) the latest version of an object.
string key = 3
Name of the object key. This member is required.
int64 last_modified = 4
Date and time the object was last modified.
optional owner = 5
Specifies the owner of the object.
int64 size = 6
Size in bytes of the object.
string storage_class = 7
The class of storage used to store the object.
string version_id = 8
Version ID of an object.
message
oss.proto:674OutPutLocation
Used in:
string bucket_name = 1
The name of the bucket where the restore results will be placed. This member is required.
string prefix = 2
The prefix that is prepended to the restore results for this request. This member is required.
message
oss.proto:759OutputSerialization
Used in:
optional csv = 1
Describes the serialization of CSV-encoded Select results.
string json = 2
Specifies JSON as request's output serialization format.
message
oss.proto:589Owner
Used in: , , , ,
string display_name = 1
Owner display name
string id = 2
Owner id
message
oss.proto:1573Part
Used in:
string etag = 1
Part Etag
int64 last_modified = 2
Last modified time
int64 part_number = 3
Part number
int64 size = 4
Part size
message
oss.proto:783RestoreRequest
Used in:
int32 days = 1
Lifetime of the active copy in days.
string description = 2
The optional description for the job.
optional glacier_job_parameters = 3
S3 Glacier related parameters pertaining to this job.
optional output_location = 4
Describes the location where the restore job's output is stored.
optional select_parameters = 5
Describes the parameters for Select job types.
string tier = 6
Retrieval tier at which the restore will be processed.
string type = 7
Type of restore request.
message
oss.proto:767SelectParameters
Used in:
string expression = 1
The expression that is used to query the object. This member is required.
string expression_type = 2
The type of the provided expression (for example, SQL). This member is required.
optional input_serialization = 3
Describes the serialization format of the object. This member is required.
optional output_serialization = 4
Describes how the results of the Select job are serialized. This member is required.
message
oss.proto:1493UpdateBandwidthRateLimitInput
Used as request type in: ObjectStorageService.UpdateDownloadBandwidthRateLimit, ObjectStorageService.UpdateUploadBandwidthRateLimit
string store_name = 1
Required. The name of oss store.
int64 average_rate_limit_in_bits_per_sec = 2
The average upload/download bandwidth rate limit in bits per second.
string gateway_resource_name = 3
Resource name of gateway