diff --git a/docs/obs_3rd_party/python_sdk/ALL_META.TXT.json b/docs/obs_3rd_party/python_sdk/ALL_META.TXT.json index db284dd91..3c3ef045b 100644 --- a/docs/obs_3rd_party/python_sdk/ALL_META.TXT.json +++ b/docs/obs_3rd_party/python_sdk/ALL_META.TXT.json @@ -9,7 +9,7 @@ "code":"1", "des":"This section describes the important notes about Object Storage Service (OBS) SDK for Python.Some features are available only in some regions. If 405 HTTP status code is ", "doc_type":"sdk-python-devg", - "kw":"Before You Start (SDK for Python),Python SDK Developer Guide", + "kw":"Before You Start,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -17,7 +17,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Before You Start (SDK for Python)", + "title":"Before You Start", "githuburl":"" }, { @@ -45,7 +45,7 @@ "code":"3", "des":"Before using OBS SDK for Python to access OBS, you need to prepare the service and development environments. To prepare the service environment, you must get an account a", "doc_type":"sdk-python-devg", - "kw":"Preparations (SDK for Python),Python SDK Developer Guide", + "kw":"Preparations,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -53,7 +53,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Preparations (SDK for Python)", + "title":"Preparations", "githuburl":"" }, { @@ -63,7 +63,7 @@ "code":"4", "des":"This topic provides the download links and installation methods of OBS SDK for Python.Latest version of OBS Python SDK source code: DownloadYou can use the methods listed", "doc_type":"sdk-python-devg", - "kw":"Downloading and Installing OBS SDK for Python,Python SDK Developer Guide", + "kw":"Downloading and Installing an SDK,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -71,7 +71,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading and Installing OBS SDK for Python", + "title":"Downloading and Installing an SDK", "githuburl":"" }, { @@ -81,7 +81,7 @@ "code":"5", "des":"OBS employs access keys (AK and SK) for signature verification to ensure that only authorized accounts can access specified OBS resources. Detailed explanations of access", "doc_type":"sdk-python-devg", - "kw":"Getting Started with OBS SDK for Python,Python SDK Developer Guide", + "kw":"Getting Started,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -89,7 +89,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Getting Started with OBS SDK for Python", + "title":"Getting Started", "githuburl":"" }, { @@ -99,7 +99,7 @@ "code":"6", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"Initialization (SDK for Python)", + "kw":"Initialization", "search_title":"", "metedata":[ { @@ -107,7 +107,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Initialization (SDK for Python)", + "title":"Initialization", "githuburl":"" }, { @@ -117,7 +117,7 @@ "code":"7", "des":"ObsClient functions as the Python client for accessing OBS. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resources, such as", "doc_type":"sdk-python-devg", - "kw":"Initializing an Instance of ObsClient (SDK for Python),Initialization (SDK for Python),Python SDK De", + "kw":"Initializing an Instance of ObsClient,Initialization,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -125,7 +125,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Initializing an Instance of ObsClient (SDK for Python)", + "title":"Initializing an Instance of ObsClient", "githuburl":"" }, { @@ -135,7 +135,7 @@ "code":"8", "des":"BucketClient functions as the Python client for accessing an OBS bucket. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resou", "doc_type":"sdk-python-devg", - "kw":"Initializing a BucketClient Instance (SDK for Python),Initialization (SDK for Python),Python SDK Dev", + "kw":"Initializing a bucketClient Instance,Initialization,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -143,7 +143,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Initializing a BucketClient Instance (SDK for Python)", + "title":"Initializing a bucketClient Instance", "githuburl":"" }, { @@ -153,7 +153,7 @@ "code":"9", "des":"You can enable the SDK log function to record log information generated during API calling into log files for subsequent data analysis or fault location. The procedure is", "doc_type":"sdk-python-devg", - "kw":"Log Initialization (SDK for Python),Initialization (SDK for Python),Python SDK Developer Guide", + "kw":"Log Initialization,Initialization,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -161,7 +161,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Log Initialization (SDK for Python)", + "title":"Log Initialization", "githuburl":"" }, { @@ -171,7 +171,7 @@ "code":"10", "des":"Each time an ObsClient related API is called (excluding ObsClient.createSignedUrl and ObsClient.createPostSignature), an SDK common result object will be returned. You ca", "doc_type":"sdk-python-devg", - "kw":"SDK Common Results (SDK for Python),Initialization (SDK for Python),Python SDK Developer Guide", + "kw":"SDK Common Result Objects,Initialization,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -179,7 +179,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"SDK Common Results (SDK for Python)", + "title":"SDK Common Result Objects", "githuburl":"" }, { @@ -189,7 +189,7 @@ "code":"11", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"Bucket-Related APIs (SDK for Python)", + "kw":"Bucket-Related APIs", "search_title":"", "metedata":[ { @@ -197,7 +197,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Bucket-Related APIs (SDK for Python)", + "title":"Bucket-Related APIs", "githuburl":"" }, { @@ -207,7 +207,7 @@ "code":"12", "des":"This API creates an OBS bucket. Buckets are containers for storing objects (files uploaded to OBS) in OBS.When creating a bucket, you can also configure parameters such a", "doc_type":"sdk-python-devg", - "kw":"Creating a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Creating a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -215,7 +215,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Creating a Bucket (SDK for Python)", + "title":"Creating a Bucket", "githuburl":"" }, { @@ -225,7 +225,7 @@ "code":"13", "des":"OBS buckets are containers for storing objects you upload to OBS. This API returns a list of all buckets that meet the specified conditions in all regions of the current ", "doc_type":"sdk-python-devg", - "kw":"Obtaining a Bucket List (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer G", + "kw":"Obtaining a Bucket List,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -233,7 +233,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining a Bucket List (SDK for Python)", + "title":"Obtaining a Bucket List", "githuburl":"" }, { @@ -243,7 +243,7 @@ "code":"14", "des":"This API checks whether a bucket exists. If an HTTP status code 200 is returned, the bucket exists. If 404 is returned, the bucket does not exist.To determine whether a b", "doc_type":"sdk-python-devg", - "kw":"Checking Whether a Bucket Exists (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK De", + "kw":"Checking Whether a Bucket Exists,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -251,7 +251,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Checking Whether a Bucket Exists (SDK for Python)", + "title":"Checking Whether a Bucket Exists", "githuburl":"" }, { @@ -261,7 +261,7 @@ "code":"15", "des":"This API deletes an empty bucket. You can delete buckets you no longer use to free up space. The name of a deleted bucket can be reused for another bucket at least 30 min", "doc_type":"sdk-python-devg", - "kw":"Deleting a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Deleting a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -269,7 +269,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting a Bucket (SDK for Python)", + "title":"Deleting a Bucket", "githuburl":"" }, { @@ -279,7 +279,7 @@ "code":"16", "des":"This API lists some or all of the objects in a bucket. You can use parameters such as the prefix, number of returned objects, and start position to list objects that meet", "doc_type":"sdk-python-devg", - "kw":"Listing Objects in a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Develop", + "kw":"Listing Objects in a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -287,7 +287,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Listing Objects in a Bucket (SDK for Python)", + "title":"Listing Objects in a Bucket", "githuburl":"" }, { @@ -297,7 +297,7 @@ "code":"17", "des":"This API lists some or all of the object versions in a bucket. You can use parameters such as the prefix, number of returned object versions, and start position to list t", "doc_type":"sdk-python-devg", - "kw":"Listing Object Versions in a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK", + "kw":"Listing Object Versions in a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -305,7 +305,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Listing Object Versions in a Bucket (SDK for Python)", + "title":"Listing Object Versions in a Bucket", "githuburl":"" }, { @@ -315,7 +315,7 @@ "code":"18", "des":"This API returns information about a bucket, including the storage class, region, CORS rules, and redundancy policy.To obtain bucket metadata, you must be the bucket owne", "doc_type":"sdk-python-devg", - "kw":"Obtaining Bucket Metadata (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer", + "kw":"Obtaining Bucket Metadata,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -323,7 +323,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining Bucket Metadata (SDK for Python)", + "title":"Obtaining Bucket Metadata", "githuburl":"" }, { @@ -333,7 +333,7 @@ "code":"19", "des":"This API returns the region of a bucket.To obtain the region of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketLocation in IA", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Region of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK De", + "kw":"Obtaining the Region of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -341,7 +341,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Region of a Bucket (SDK for Python)", + "title":"Obtaining the Region of a Bucket", "githuburl":"" }, { @@ -351,7 +351,7 @@ "code":"20", "des":"This API returns the storage information of a bucket, including the number of objects and the space occupied by the objects in the bucket.OBS measures bucket storage stat", "doc_type":"sdk-python-devg", - "kw":"Obtaining Storage Information of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Pyth", + "kw":"Obtaining Storage Information of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -359,7 +359,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining Storage Information of a Bucket (SDK for Python)", + "title":"Obtaining Storage Information of a Bucket", "githuburl":"" }, { @@ -369,7 +369,7 @@ "code":"21", "des":"A quota limits the maximum capacity allowed in a bucket. By default, there is no limit on the storage capacity of the entire OBS system or a single bucket, and any number", "doc_type":"sdk-python-devg", - "kw":"Configuring a Storage Quota (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Develop", + "kw":"Configuring a Storage Quota,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -377,7 +377,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring a Storage Quota (SDK for Python)", + "title":"Configuring a Storage Quota", "githuburl":"" }, { @@ -387,7 +387,7 @@ "code":"22", "des":"This API returns the storage quota (upper limit of the storage capacity) of a bucket. If the quota is 0, there is no upper limit on the bucket capacity.A bucket storage q", "doc_type":"sdk-python-devg", - "kw":"Obtaining a Bucket Storage Quota (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK De", + "kw":"Obtaining a Bucket Storage Quota,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -395,7 +395,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining a Bucket Storage Quota (SDK for Python)", + "title":"Obtaining a Bucket Storage Quota", "githuburl":"" }, { @@ -405,7 +405,7 @@ "code":"23", "des":"This API configures a storage class for a bucket. If you do not specify a storage class when uploading or copying an object, or initiating a multipart upload, the object ", "doc_type":"sdk-python-devg", - "kw":"Configuring a Storage Class for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Pytho", + "kw":"Configuring a Storage Class for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -413,7 +413,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring a Storage Class for a Bucket (SDK for Python)", + "title":"Configuring a Storage Class for a Bucket", "githuburl":"" }, { @@ -423,7 +423,7 @@ "code":"24", "des":"This API returns the storage class of a bucket.To obtain a bucket's storage class, you must be the bucket owner or have the required permission (obs:bucket:GetBucketStora", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Storage Class of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python", + "kw":"Obtaining the Storage Class of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -431,7 +431,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Storage Class of a Bucket (SDK for Python)", + "title":"Obtaining the Storage Class of a Bucket", "githuburl":"" }, { @@ -439,9 +439,9 @@ "node_id":"obs_22_0814.xml", "product_code":"obs", "code":"25", - "des":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", + "des":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "doc_type":"sdk-python-devg", - "kw":"Configuring a Bucket ACL (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer ", + "kw":"Configuring a Bucket ACL,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -449,7 +449,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring a Bucket ACL (SDK for Python)", + "title":"Configuring a Bucket ACL", "githuburl":"" }, { @@ -457,9 +457,9 @@ "node_id":"obs_22_0815.xml", "product_code":"obs", "code":"26", - "des":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", + "des":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "doc_type":"sdk-python-devg", - "kw":"Obtaining a Bucket ACL (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer Gu", + "kw":"Obtaining a Bucket ACL,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -467,7 +467,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining a Bucket ACL (SDK for Python)", + "title":"Obtaining a Bucket ACL", "githuburl":"" }, { @@ -477,7 +477,7 @@ "code":"27", "des":"This API enables logging for a bucket (source) and configures another bucket (target) to store the log files. When a bucket is created, logging is not enabled by default.", "doc_type":"sdk-python-devg", - "kw":"Configuring Logging for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK De", + "kw":"Configuring Logging for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -485,7 +485,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring Logging for a Bucket (SDK for Python)", + "title":"Configuring Logging for a Bucket", "githuburl":"" }, { @@ -495,7 +495,7 @@ "code":"28", "des":"This API returns the logging configuration of a bucket.To obtain the logging configuration of a bucket, you must be the bucket owner or have the required permission (obs:", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Logging Configuration of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python", + "kw":"Obtaining the Logging Configuration of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -503,7 +503,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Logging Configuration of a Bucket (SDK for Python)", + "title":"Obtaining the Logging Configuration of a Bucket", "githuburl":"" }, { @@ -513,7 +513,7 @@ "code":"29", "des":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", "doc_type":"sdk-python-devg", - "kw":"Configuring a Bucket Policy (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Develop", + "kw":"Configuring a Bucket Policy,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -521,7 +521,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring a Bucket Policy (SDK for Python)", + "title":"Configuring a Bucket Policy", "githuburl":"" }, { @@ -531,7 +531,7 @@ "code":"30", "des":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Policy of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK De", + "kw":"Obtaining the Policy of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -539,7 +539,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Policy of a Bucket (SDK for Python)", + "title":"Obtaining the Policy of a Bucket", "githuburl":"" }, { @@ -549,7 +549,7 @@ "code":"31", "des":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", "doc_type":"sdk-python-devg", - "kw":"Deleting a Bucket Policy (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer ", + "kw":"Deleting a Bucket Policy,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -557,7 +557,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting a Bucket Policy (SDK for Python)", + "title":"Deleting a Bucket Policy", "githuburl":"" }, { @@ -567,7 +567,7 @@ "code":"32", "des":"You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.This API configures lifecycle rules for a bucket.Expired ob", "doc_type":"sdk-python-devg", - "kw":"Configuring Lifecycle Rules for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Pytho", + "kw":"Configuring Lifecycle Rules for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -575,7 +575,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring Lifecycle Rules for a Bucket (SDK for Python)", + "title":"Configuring Lifecycle Rules for a Bucket", "githuburl":"" }, { @@ -585,7 +585,7 @@ "code":"33", "des":"You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.This API returns the lifecycle rules of a bucket.To obtain ", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Lifecycle Configuration of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Pyth", + "kw":"Obtaining the Lifecycle Configuration of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -593,7 +593,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Lifecycle Configuration of a Bucket (SDK for Python)", + "title":"Obtaining the Lifecycle Configuration of a Bucket", "githuburl":"" }, { @@ -603,7 +603,7 @@ "code":"34", "des":"You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.This API deletes the lifecycle configuration of a bucket.To", "doc_type":"sdk-python-devg", - "kw":"Deleting the Lifecycle Configuration of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Pytho", + "kw":"Deleting the Lifecycle Configuration of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -611,7 +611,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting the Lifecycle Configuration of a Bucket (SDK for Python)", + "title":"Deleting the Lifecycle Configuration of a Bucket", "githuburl":"" }, { @@ -621,7 +621,7 @@ "code":"35", "des":"You can host static website resources such as HTML web pages, flash files, or audio and video files in an OBS bucket, so that you can provide these hosted resources using", "doc_type":"sdk-python-devg", - "kw":"Configuring Static Website Hosting for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python", + "kw":"Configuring Static Website Hosting for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -629,7 +629,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring Static Website Hosting for a Bucket (SDK for Python)", + "title":"Configuring Static Website Hosting for a Bucket", "githuburl":"" }, { @@ -639,7 +639,7 @@ "code":"36", "des":"You can host static website resources such as HTML web pages, flash files, as well as audio and video files in an OBS bucket, so that you can provide these hosted resourc", "doc_type":"sdk-python-devg", - "kw":"Obtaining Static Website Hosting for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),", + "kw":"Obtaining Static Website Hosting for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -647,7 +647,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining Static Website Hosting for a Bucket (SDK for Python)", + "title":"Obtaining Static Website Hosting for a Bucket", "githuburl":"" }, { @@ -657,7 +657,7 @@ "code":"37", "des":"You can host static website resources such as HTML web pages, flash files, as well as audio and video files in an OBS bucket, so that you can provide these hosted resourc", "doc_type":"sdk-python-devg", - "kw":"Deleting Static Website Hosting for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),P", + "kw":"Deleting Static Website Hosting for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -665,7 +665,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting Static Website Hosting for a Bucket (SDK for Python)", + "title":"Deleting Static Website Hosting for a Bucket", "githuburl":"" }, { @@ -675,7 +675,7 @@ "code":"38", "des":"You can enable versioning to automatically maintain previous versions of an object. When versioning is enabled, you can access earlier versions of an object to recover yo", "doc_type":"sdk-python-devg", - "kw":"Configuring Versioning for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK", + "kw":"Configuring Versioning for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -683,7 +683,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring Versioning for a Bucket (SDK for Python)", + "title":"Configuring Versioning for a Bucket", "githuburl":"" }, { @@ -693,7 +693,7 @@ "code":"39", "des":"You can enable versioning to automatically maintain previous versions of an object. When versioning is enabled, you can access earlier versions of an object to recover yo", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Versioning Status of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Py", + "kw":"Obtaining the Versioning Status of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -701,7 +701,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Versioning Status of a Bucket (SDK for Python)", + "title":"Obtaining the Versioning Status of a Bucket", "githuburl":"" }, { @@ -711,7 +711,7 @@ "code":"40", "des":"Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources", "doc_type":"sdk-python-devg", - "kw":"Configuring CORS for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Devel", + "kw":"Configuring CORS for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -719,7 +719,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring CORS for a Bucket (SDK for Python)", + "title":"Configuring CORS for a Bucket", "githuburl":"" }, { @@ -729,7 +729,7 @@ "code":"41", "des":"Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources", "doc_type":"sdk-python-devg", - "kw":"Obtaining the CORS Configuration of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),P", + "kw":"Obtaining the CORS Configuration of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -737,7 +737,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the CORS Configuration of a Bucket (SDK for Python)", + "title":"Obtaining the CORS Configuration of a Bucket", "githuburl":"" }, { @@ -747,7 +747,7 @@ "code":"42", "des":"Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources", "doc_type":"sdk-python-devg", - "kw":"Deleting the CORS Configuration of a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Py", + "kw":"Deleting the CORS Configuration of a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -755,7 +755,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting the CORS Configuration of a Bucket (SDK for Python)", + "title":"Deleting the CORS Configuration of a Bucket", "githuburl":"" }, { @@ -765,7 +765,7 @@ "code":"43", "des":"If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analy", "doc_type":"sdk-python-devg", - "kw":"Configuring Tags for a Bucket (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Devel", + "kw":"Configuring Tags for a Bucket,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -773,7 +773,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring Tags for a Bucket (SDK for Python)", + "title":"Configuring Tags for a Bucket", "githuburl":"" }, { @@ -783,7 +783,7 @@ "code":"44", "des":"If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analy", "doc_type":"sdk-python-devg", - "kw":"Obtaining Bucket Tags (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer Gui", + "kw":"Obtaining Bucket Tags,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -791,7 +791,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining Bucket Tags (SDK for Python)", + "title":"Obtaining Bucket Tags", "githuburl":"" }, { @@ -801,7 +801,7 @@ "code":"45", "des":"If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analy", "doc_type":"sdk-python-devg", - "kw":"Deleting Bucket Tags (SDK for Python),Bucket-Related APIs (SDK for Python),Python SDK Developer Guid", + "kw":"Deleting Bucket Tags,Bucket-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -809,7 +809,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting Bucket Tags (SDK for Python)", + "title":"Deleting Bucket Tags", "githuburl":"" }, { @@ -819,7 +819,7 @@ "code":"46", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"Object-Related APIs (SDK for Python)", + "kw":"Object-Related APIs", "search_title":"", "metedata":[ { @@ -827,7 +827,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Object-Related APIs (SDK for Python)", + "title":"Object-Related APIs", "githuburl":"" }, { @@ -837,7 +837,7 @@ "code":"47", "des":"You can use this API to upload an object to a specified bucket. In OBS, objects are basic data units that you can operate. OBS Python SDK provides many APIs for uploading", "doc_type":"sdk-python-devg", - "kw":"Object Upload Overview (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer Gu", + "kw":"Object Upload Overview,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -845,7 +845,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Object Upload Overview (SDK for Python)", + "title":"Object Upload Overview", "githuburl":"" }, { @@ -855,7 +855,7 @@ "code":"48", "des":"This API uploads the text using strings as the data source to a specified bucket.To upload an object, you must be the bucket owner or have the required permission (obs:ob", "doc_type":"sdk-python-devg", - "kw":"Uploading Objects - Text-Based (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Deve", + "kw":"Uploading Objects - Text-Based,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -863,7 +863,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading Objects - Text-Based (SDK for Python)", + "title":"Uploading Objects - Text-Based", "githuburl":"" }, { @@ -873,7 +873,7 @@ "code":"49", "des":"You can upload texts, images, videos, or any other types of files smaller than 5 GB.Streaming upload uses readable objects that contain the read attribute as the data sou", "doc_type":"sdk-python-devg", - "kw":"Uploading an Object - Streaming (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Dev", + "kw":"Uploading an Object - Streaming,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -881,7 +881,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading an Object - Streaming (SDK for Python)", + "title":"Uploading an Object - Streaming", "githuburl":"" }, { @@ -891,7 +891,7 @@ "code":"50", "des":"This API uploads local filesto OBS over the Internet. These files can be texts, images, videos, or any other type of files.OBS does not involve folders like in a file sys", "doc_type":"sdk-python-devg", - "kw":"Uploading an Object - File-Based (SDK for Python),Object-Related APIs (SDK for Python),Python SDK De", + "kw":"Uploading an Object - File-Based,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -899,7 +899,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading an Object - File-Based (SDK for Python)", + "title":"Uploading an Object - File-Based", "githuburl":"" }, { @@ -909,7 +909,7 @@ "code":"51", "des":"This API uploads a file or folder to an existing OBS bucket. These files can be texts, images, videos, or any other type of files.The AppendObject operation adds data to ", "doc_type":"sdk-python-devg", - "kw":"Uploading an Object - Append (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Develo", + "kw":"Uploading an Object - Append,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -917,7 +917,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading an Object - Append (SDK for Python)", + "title":"Uploading an Object - Append", "githuburl":"" }, { @@ -927,7 +927,7 @@ "code":"52", "des":"The resumable upload is an encapsulated and enhanced version of the multipart upload used for dealing with possible upload failures of large files when the network connec", "doc_type":"sdk-python-devg", - "kw":"Uploading an Object - Resumable (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Dev", + "kw":"Uploading an Object - Resumable,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -935,7 +935,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading an Object - Resumable (SDK for Python)", + "title":"Uploading an Object - Resumable", "githuburl":"" }, { @@ -945,7 +945,7 @@ "code":"53", "des":"You can query the upload progress when uploading an object in streaming, file-based, multipart, appendable, or resumable mode.This example configures a callback function ", "doc_type":"sdk-python-devg", - "kw":"Obtaining the Upload Progress (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Devel", + "kw":"Obtaining the Upload Progress,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -953,7 +953,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining the Upload Progress (SDK for Python)", + "title":"Obtaining the Upload Progress", "githuburl":"" }, { @@ -963,7 +963,7 @@ "code":"54", "des":"This API uploads an object up to 5 GB to a specified bucket in HTML form. You can call ObsClient.createPostSignature to generate parameters for requesting a browser-based", "doc_type":"sdk-python-devg", - "kw":"Uploading an Object - Browser-Based (SDK for Python),Object-Related APIs (SDK for Python),Python SDK", + "kw":"Uploading an Object - Browser-Based,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -971,7 +971,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading an Object - Browser-Based (SDK for Python)", + "title":"Uploading an Object - Browser-Based", "githuburl":"" }, { @@ -981,7 +981,7 @@ "code":"55", "des":"OBS Python SDK provides abundant APIs for downloading objects using various methods:Binary DownloadStreaming DownloadFile-Based DownloadPartial DownloadResumable Download", "doc_type":"sdk-python-devg", - "kw":"Object Download Overview (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer ", + "kw":"Object Download Overview,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -989,7 +989,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Object Download Overview (SDK for Python)", + "title":"Object Download Overview", "githuburl":"" }, { @@ -997,9 +997,9 @@ "node_id":"obs_22_0908.xml", "product_code":"obs", "code":"56", - "des":"This API downloads an object in binary from OBS to your local computer.To download an object, you must be the bucket owner or have the required permission (obs:object:Get", + "des":"This API downloads a file using a stream from OBS to your local computer. If loadStreamInMemory is set to True, downloadpath will be invalid. The binary stream of the fil", "doc_type":"sdk-python-devg", - "kw":"Downloading an Object - Binary (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Deve", + "kw":"Downloading an Object - Binary,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1007,7 +1007,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading an Object - Binary (SDK for Python)", + "title":"Downloading an Object - Binary", "githuburl":"" }, { @@ -1015,9 +1015,9 @@ "node_id":"obs_22_0909.xml", "product_code":"obs", "code":"57", - "des":"This API downloads an object using streaming from OBS to your local computer.To download an object, you must be the bucket owner or have the required permission (obs:obje", + "des":"This API downloads a file using a stream from OBS to your local computer. If the object to be downloaded is too large or the download is expected to take a long time, you", "doc_type":"sdk-python-devg", - "kw":"Downloading an Object - Streaming (SDK for Python),Object-Related APIs (SDK for Python),Python SDK D", + "kw":"Downloading an Object - Streaming,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1025,7 +1025,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading an Object - Streaming (SDK for Python)", + "title":"Downloading an Object - Streaming", "githuburl":"" }, { @@ -1035,7 +1035,7 @@ "code":"58", "des":"This API downloads an object as a file from OBS to your local computer.To download an object, you must be the bucket owner or have the required permission (obs:object:Get", "doc_type":"sdk-python-devg", - "kw":"Downloading an Object - File-Based (SDK for Python),Object-Related APIs (SDK for Python),Python SDK ", + "kw":"Downloading an Object - File-Based,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1043,7 +1043,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading an Object - File-Based (SDK for Python)", + "title":"Downloading an Object - File-Based", "githuburl":"" }, { @@ -1051,9 +1051,9 @@ "node_id":"obs_22_0911.xml", "product_code":"obs", "code":"59", - "des":"This API downloads partial data of an object by specifying a range. If the specified range is from 0 to 1,000, data from byte 0 to byte 1,000, 1,001 bytes in total, are r", + "des":"This API downloads partial data of an object by specifying a range. If the specified range is from 0 to 1000, data from byte 0 to byte 1,000, 1,001 bytes in total, are re", "doc_type":"sdk-python-devg", - "kw":"Downloading an Object - Range-Based (SDK for Python),Object-Related APIs (SDK for Python),Python SDK", + "kw":"Downloading an Object - Range-Based,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1061,7 +1061,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading an Object - Range-Based (SDK for Python)", + "title":"Downloading an Object - Range-Based", "githuburl":"" }, { @@ -1071,7 +1071,7 @@ "code":"60", "des":"Downloading large files often fails due to unstable network or program breakdown. It is a waste of resources to download files again. Moreover, the restarted download may", "doc_type":"sdk-python-devg", - "kw":"Downloading an Object - Resumable (SDK for Python),Object-Related APIs (SDK for Python),Python SDK D", + "kw":"Downloading an Object - Resumable,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1079,7 +1079,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading an Object - Resumable (SDK for Python)", + "title":"Downloading an Object - Resumable", "githuburl":"" }, { @@ -1089,7 +1089,7 @@ "code":"61", "des":"You can obtain the download progress when downloading an object in binary, streaming, file-based, or resumable mode.This example returns the object download progress.Samp", "doc_type":"sdk-python-devg", - "kw":"Downloading an Object - Obtaining the Download Progress (SDK for Python),Object-Related APIs (SDK fo", + "kw":"Downloading an Object - Obtaining the Download Progress,Object-Related APIs,Python SDK Developer Gui", "search_title":"", "metedata":[ { @@ -1097,7 +1097,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Downloading an Object - Obtaining the Download Progress (SDK for Python)", + "title":"Downloading an Object - Obtaining the Download Progress", "githuburl":"" }, { @@ -1107,7 +1107,7 @@ "code":"62", "des":"This API creates a folder in an existing bucket to manage data in OBS.OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. ", "doc_type":"sdk-python-devg", - "kw":"Uploading an Object - Creating a Folder (SDK for Python),Object-Related APIs (SDK for Python),Python", + "kw":"Uploading an Object - Creating a Folder,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1115,7 +1115,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading an Object - Creating a Folder (SDK for Python)", + "title":"Uploading an Object - Creating a Folder", "githuburl":"" }, { @@ -1125,7 +1125,7 @@ "code":"63", "des":"This API copies an object stored in OBS to another path, with a copy created during the process. You can create a copy of an object up to 5 GB in a single operation.To co", "doc_type":"sdk-python-devg", - "kw":"Copying an Object (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Copying an Object,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1133,7 +1133,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Copying an Object (SDK for Python)", + "title":"Copying an Object", "githuburl":"" }, { @@ -1143,7 +1143,7 @@ "code":"64", "des":"This API deletes an object in the specified bucket to save space and costs.To delete an object, you must be the bucket owner or have the required permission (obs:object:D", "doc_type":"sdk-python-devg", - "kw":"Deleting an Object (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Deleting an Object,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1151,7 +1151,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Deleting an Object (SDK for Python)", + "title":"Deleting an Object", "githuburl":"" }, { @@ -1161,7 +1161,7 @@ "code":"65", "des":"This API deletes objects in a batch from a specific bucket. Deleted objects cannot be restored.OBS does not involve folders like in a file system. All elements stored in ", "doc_type":"sdk-python-devg", - "kw":"Batch Deleting Objects (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer Gu", + "kw":"Batch Deleting Objects,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1169,7 +1169,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Batch Deleting Objects (SDK for Python)", + "title":"Batch Deleting Objects", "githuburl":"" }, { @@ -1179,7 +1179,7 @@ "code":"66", "des":"Object metadata is a set of name-value pairs that describe the object and is used for object management.Currently, only the system-defined metadata can be obtained. Syste", "doc_type":"sdk-python-devg", - "kw":"Obtaining Object Metadata (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer", + "kw":"Obtaining Object Metadata,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1187,7 +1187,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining Object Metadata (SDK for Python)", + "title":"Obtaining Object Metadata", "githuburl":"" }, { @@ -1197,7 +1197,7 @@ "code":"67", "des":"Object metadata is a set of name-value pairs that describe the object and is used for object management.Currently, only the system-defined metadata can be modified.System", "doc_type":"sdk-python-devg", - "kw":"Modifying Object Metadata (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer", + "kw":"Modifying Object Metadata,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1205,7 +1205,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Modifying Object Metadata (SDK for Python)", + "title":"Modifying Object Metadata", "githuburl":"" }, { @@ -1213,9 +1213,9 @@ "node_id":"obs_22_0922.xml", "product_code":"obs", "code":"68", - "des":"OBS allows the control of access permissions for objects. By default, only object creators have the read and write permissions on the object. However, the creator can set", + "des":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "doc_type":"sdk-python-devg", - "kw":"Configuring an Object ACL (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer", + "kw":"Configuring an Object ACL,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1223,7 +1223,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Configuring an Object ACL (SDK for Python)", + "title":"Configuring an Object ACL", "githuburl":"" }, { @@ -1231,9 +1231,9 @@ "node_id":"obs_22_0923.xml", "product_code":"obs", "code":"69", - "des":"This API returns the ACL of an object in a specified bucket.To obtain an object ACL, you must be the bucket owner or have the required permission (obs:object:GetObjectAcl", + "des":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "doc_type":"sdk-python-devg", - "kw":"Obtaining an Object ACL (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer G", + "kw":"Obtaining an Object ACL,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1241,7 +1241,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Obtaining an Object ACL (SDK for Python)", + "title":"Obtaining an Object ACL", "githuburl":"" }, { @@ -1251,7 +1251,7 @@ "code":"70", "des":"To obtain the contents of an object in the Cold storage class, you need to restore the object first and then you can download it. After an object is restored, a copy of t", "doc_type":"sdk-python-devg", - "kw":"Restoring a Cold Object (SDK for Python),Object-Related APIs (SDK for Python),Python SDK Developer G", + "kw":"Restoring a Cold Object,Object-Related APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1259,7 +1259,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Restoring a Cold Object (SDK for Python)", + "title":"Restoring a Cold Object", "githuburl":"" }, { @@ -1269,7 +1269,7 @@ "code":"71", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"APIs Related to Multipart Upload (SDK for Python)", + "kw":"APIs Related to Multipart Upload", "search_title":"", "metedata":[ { @@ -1277,7 +1277,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"APIs Related to Multipart Upload (SDK for Python)", + "title":"APIs Related to Multipart Upload", "githuburl":"" }, { @@ -1287,7 +1287,7 @@ "code":"72", "des":"You can upload large files using multipart upload. Multipart upload is applicable to many scenarios, including:Files to be uploaded are larger than 100 MB.The network con", "doc_type":"sdk-python-devg", - "kw":"Multipart Upload Overview (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Python ", + "kw":"Multipart Upload Overview,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1295,7 +1295,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Multipart Upload Overview (SDK for Python)", + "title":"Multipart Upload Overview", "githuburl":"" }, { @@ -1305,7 +1305,7 @@ "code":"73", "des":"This API initiates a multipart upload and returns a globally unique upload ID. You can use the returned upload ID when you later upload, assemble, or list parts. A single", "doc_type":"sdk-python-devg", - "kw":"Initiating a Multipart Upload (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Pyt", + "kw":"Initiating a Multipart Upload,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1313,7 +1313,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Initiating a Multipart Upload (SDK for Python)", + "title":"Initiating a Multipart Upload", "githuburl":"" }, { @@ -1323,7 +1323,7 @@ "code":"74", "des":"After a multipart upload is initiated, this API uploads a part to a specified bucket. In the upload request, the multipart upload ID must be included. Except for the part", "doc_type":"sdk-python-devg", - "kw":"Uploading a Part (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Python SDK Devel", + "kw":"Uploading a Part,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1331,7 +1331,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Uploading a Part (SDK for Python)", + "title":"Uploading a Part", "githuburl":"" }, { @@ -1341,7 +1341,7 @@ "code":"75", "des":"This API lists the uploaded parts in a specified bucket. This request must contain the multipart upload ID.You can list the uploaded parts of a specified multipart upload", "doc_type":"sdk-python-devg", - "kw":"Listing Uploaded Parts (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Python SDK", + "kw":"Listing Uploaded Parts,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1349,7 +1349,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Listing Uploaded Parts (SDK for Python)", + "title":"Listing Uploaded Parts", "githuburl":"" }, { @@ -1359,7 +1359,7 @@ "code":"76", "des":"This API lists ongoing multipart uploads.Ongoing multipart uploads are the multipart uploads that have been initiated but have not been completed or aborted. A maximum of", "doc_type":"sdk-python-devg", - "kw":"Listing Multipart Uploads (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Python ", + "kw":"Listing Multipart Uploads,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1367,7 +1367,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Listing Multipart Uploads (SDK for Python)", + "title":"Listing Multipart Uploads", "githuburl":"" }, { @@ -1377,7 +1377,7 @@ "code":"77", "des":"This API assembles the uploaded parts to complete the multipart upload. Before performing this operation, you cannot download the uploaded data. When assembling parts, yo", "doc_type":"sdk-python-devg", - "kw":"Assembling Parts (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Python SDK Devel", + "kw":"Assembling Parts,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1385,7 +1385,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Assembling Parts (SDK for Python)", + "title":"Assembling Parts", "githuburl":"" }, { @@ -1395,7 +1395,7 @@ "code":"78", "des":"This API copies a part to a specified bucket. This request must contain the multipart upload ID.After creating a multipart upload, you can specify the upload ID and uploa", "doc_type":"sdk-python-devg", - "kw":"Copying a Part (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Python SDK Develop", + "kw":"Copying a Part,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1403,7 +1403,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Copying a Part (SDK for Python)", + "title":"Copying a Part", "githuburl":"" }, { @@ -1413,7 +1413,7 @@ "code":"79", "des":"This API aborts a multipart upload using the multipart upload ID.After a multipart upload is aborted, the upload ID cannot be used to upload any part. The storage occupie", "doc_type":"sdk-python-devg", - "kw":"Aborting a Multipart Upload (SDK for Python),APIs Related to Multipart Upload (SDK for Python),Pytho", + "kw":"Aborting a Multipart Upload,APIs Related to Multipart Upload,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1421,7 +1421,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Aborting a Multipart Upload (SDK for Python)", + "title":"Aborting a Multipart Upload", "githuburl":"" }, { @@ -1431,7 +1431,7 @@ "code":"80", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"Client-Side Encryption APIs (SDK for Python)", + "kw":"Client-Side Encryption APIs", "search_title":"", "metedata":[ { @@ -1439,7 +1439,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Client-Side Encryption APIs (SDK for Python)", + "title":"Client-Side Encryption APIs", "githuburl":"" }, { @@ -1449,7 +1449,7 @@ "code":"81", "des":"Client-side encryption is a process where data is encrypted using the selected encryption method and information on your local PC before it is transmitted to an OBS serve", "doc_type":"sdk-python-devg", - "kw":"Introduction (SDK for Python),Client-Side Encryption APIs (SDK for Python),Python SDK Developer Guid", + "kw":"Overview,Client-Side Encryption APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1457,7 +1457,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Introduction (SDK for Python)", + "title":"Overview", "githuburl":"" }, { @@ -1467,7 +1467,7 @@ "code":"82", "des":"The OBS SDK for Python offers two types of CryptoCipher. Choose the one right for you.CtrRSACipherGenerator needs an RSA public or private key to encrypt the randomly gen", "doc_type":"sdk-python-devg", - "kw":"Client-Side Encryption (SDK for Python),Client-Side Encryption APIs (SDK for Python),Python SDK Deve", + "kw":"Client-Side Encryption APIs,Client-Side Encryption APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1475,7 +1475,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Client-Side Encryption (SDK for Python)", + "title":"Client-Side Encryption APIs", "githuburl":"" }, { @@ -1485,7 +1485,7 @@ "code":"83", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"Other APIs (SDK for Python)", + "kw":"Other APIs", "search_title":"", "metedata":[ { @@ -1493,7 +1493,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Other APIs (SDK for Python)", + "title":"Other APIs", "githuburl":"" }, { @@ -1503,7 +1503,7 @@ "code":"84", "des":"This API creates a URL whose Query parameters are carried with authentication information by specifying the AK and SK, HTTP method, and request parameters. You can provid", "doc_type":"sdk-python-devg", - "kw":"Creating a Signed URL (SDK for Python),Other APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Creating a Signed URL,Other APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1511,7 +1511,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Creating a Signed URL (SDK for Python)", + "title":"Creating a Signed URL", "githuburl":"" }, { @@ -1521,7 +1521,7 @@ "code":"85", "des":"This API generates parameters for authentication. The parameters can be used to perform a browser-based upload through POST operations.There are two request parameters ge", "doc_type":"sdk-python-devg", - "kw":"Generating Authentication Parameters for Browser-Based Uploads (SDK for Python),Other APIs (SDK for ", + "kw":"Generating Authentication Parameters for Browser-Based Uploads,Other APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1529,7 +1529,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Generating Authentication Parameters for Browser-Based Uploads (SDK for Python)", + "title":"Generating Authentication Parameters for Browser-Based Uploads", "githuburl":"" }, { @@ -1539,7 +1539,7 @@ "code":"86", "des":"This API configures server-side encryption for objects, so that they will be encrypted or decrypted when you upload them to or download them from a bucket.The encryption ", "doc_type":"sdk-python-devg", - "kw":"Server-Side Encryption (SDK for Python),Other APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Server-Side Encryption,Other APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1547,7 +1547,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Server-Side Encryption (SDK for Python)", + "title":"Server-Side Encryption", "githuburl":"" }, { @@ -1557,7 +1557,7 @@ "code":"87", "des":"This API uploads the files of the static website to your bucket in OBS as objects and configures the public-read permission on the files, and then configures the static w", "doc_type":"sdk-python-devg", - "kw":"Static Website Hosting (SDK for Python),Other APIs (SDK for Python),Python SDK Developer Guide", + "kw":"Static Website Hosting,Other APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1565,7 +1565,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Static Website Hosting (SDK for Python)", + "title":"Static Website Hosting", "githuburl":"" }, { @@ -1575,7 +1575,7 @@ "code":"88", "des":"When calling an API, you can configure user-defined headers to meet specific needs. The SDK will automatically calculate the signature for the specified headers if needed", "doc_type":"sdk-python-devg", - "kw":"User-defined Header (SDK for Python),Other APIs (SDK for Python),Python SDK Developer Guide", + "kw":"User-defined Headers,Other APIs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1583,7 +1583,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"User-defined Header (SDK for Python)", + "title":"User-defined Headers", "githuburl":"" }, { @@ -1593,7 +1593,7 @@ "code":"89", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"Troubleshooting (SDK for Python)", + "kw":"Troubleshooting", "search_title":"", "metedata":[ { @@ -1601,7 +1601,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Troubleshooting (SDK for Python)", + "title":"Troubleshooting", "githuburl":"" }, { @@ -1611,7 +1611,7 @@ "code":"90", "des":"The OBS server complies with the HTTP standard. After an API is called, the OBS server returns a standard HTTP status code. The following tables list the categories of HT", "doc_type":"sdk-python-devg", - "kw":"HTTP Status Codes (SDK for Python),Troubleshooting (SDK for Python),Python SDK Developer Guide", + "kw":"HTTP Status Codes,Troubleshooting,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1619,7 +1619,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"HTTP Status Codes (SDK for Python)", + "title":"HTTP Status Codes", "githuburl":"" }, { @@ -1629,7 +1629,7 @@ "code":"91", "des":"If the OBS server encounters an error when processing a request, a response containing the error code and error description is returned.The following table lists details ", "doc_type":"sdk-python-devg", - "kw":"OBS Server-Side Error Codes (SDK for Python),Troubleshooting (SDK for Python),Python SDK Developer G", + "kw":"OBS Server-Side Error Codes,Troubleshooting,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1637,7 +1637,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"OBS Server-Side Error Codes (SDK for Python)", + "title":"OBS Server-Side Error Codes", "githuburl":"" }, { @@ -1647,7 +1647,7 @@ "code":"92", "des":"OBS Python SDK provides the logging function based on the Python log library. You can call ObsClient.initLog to enable and configure logging. Sample code is as follows:Th", "doc_type":"sdk-python-devg", - "kw":"Log Analysis (SDK for Python),Troubleshooting (SDK for Python),Python SDK Developer Guide", + "kw":"Log Analysis,Troubleshooting,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1655,7 +1655,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Log Analysis (SDK for Python)", + "title":"Log Analysis", "githuburl":"" }, { @@ -1665,7 +1665,7 @@ "code":"93", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"sdk-python-devg", - "kw":"FAQs (SDK for Python)", + "kw":"FAQs", "search_title":"", "metedata":[ { @@ -1673,7 +1673,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"FAQs (SDK for Python)", + "title":"FAQs", "githuburl":"" }, { @@ -1681,9 +1681,9 @@ "node_id":"obs_22_1607.xml", "product_code":"obs", "code":"94", - "des":"To do this, perform the following steps:Set the object access permission to public-read by referring to Configuring an Object ACL (SDK for Python).Obtain the URL of the o", + "des":"To do this, perform the following steps:Set the object ACL to public read by referring to Configuring an Object ACL.Obtain the URL of the object by referring to How Do I ", "doc_type":"sdk-python-devg", - "kw":"How Do I Make an Object Accessible to Anonymous Users? (SDK for Python),FAQs (SDK for Python),Python", + "kw":"How Do I Make an Object Accessible to Anonymous Users?,FAQs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1691,7 +1691,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"How Do I Make an Object Accessible to Anonymous Users? (SDK for Python)", + "title":"How Do I Make an Object Accessible to Anonymous Users?", "githuburl":"" }, { @@ -1701,7 +1701,7 @@ "code":"95", "des":"OBS employs access keys (AK and SK) for signature verification to ensure that only authorized accounts can access specified OBS resources. Detailed explanations of access", "doc_type":"sdk-python-devg", - "kw":"How Can I Obtain the AK and SK? (SDK for Python),FAQs (SDK for Python),Python SDK Developer Guide", + "kw":"How Can I Obtain the AK and SK?,FAQs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1709,7 +1709,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"How Can I Obtain the AK and SK? (SDK for Python)", + "title":"How Can I Obtain the AK and SK?", "githuburl":"" }, { @@ -1719,7 +1719,7 @@ "code":"96", "des":"After setting an ACL to grant anonymous users the read permission for an object in a bucket, you can download this object using its URL. Methods to obtain the object URL ", "doc_type":"sdk-python-devg", - "kw":"How Do I Obtain an Object URL? (Python SDK),FAQs (SDK for Python),Python SDK Developer Guide", + "kw":"How Do I Obtain an Object URL?,FAQs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1727,7 +1727,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"How Do I Obtain an Object URL? (Python SDK)", + "title":"How Do I Obtain an Object URL?", "githuburl":"" }, { @@ -1737,7 +1737,7 @@ "code":"97", "des":"If a file exceeds 100 MB, you are advised to upload the file using multipart upload.Multipart upload refers to splitting an object into multiple parts and uploading them ", "doc_type":"sdk-python-devg", - "kw":"How Do I Improve the Uploading Speed of Large Files over the Public Network? (SDK for Python),FAQs (", + "kw":"How Do I Improve the Uploading Speed of Large Files over the Public Network?,FAQs,Python SDK Develop", "search_title":"", "metedata":[ { @@ -1745,7 +1745,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"How Do I Improve the Uploading Speed of Large Files over the Public Network? (SDK for Python)", + "title":"How Do I Improve the Uploading Speed of Large Files over the Public Network?", "githuburl":"" }, { @@ -1755,7 +1755,7 @@ "code":"98", "des":"This example sets the object expiration time using a header when uploading a file stream.This example sets the object expiration time using a user-defined header when upl", "doc_type":"sdk-python-devg", - "kw":"Setting an Object Expiration Time (SDK for Python),FAQs (SDK for Python),Python SDK Developer Guide", + "kw":"Setting an Object Expiration Time,FAQs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1763,7 +1763,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"Setting an Object Expiration Time (SDK for Python)", + "title":"Setting an Object Expiration Time", "githuburl":"" }, { @@ -1773,7 +1773,7 @@ "code":"99", "des":"Multipurpose Internet Mail Extensions (MIME) type is a standard way of describing a data type. The MIME type is passed in the Content-Type header.If you do not specify Co", "doc_type":"sdk-python-devg", - "kw":"What Is Content-Type (MIME)? (Python SDK),FAQs (SDK for Python),Python SDK Developer Guide", + "kw":"What Is Content-Type (MIME)?,FAQs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1781,7 +1781,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"What Is Content-Type (MIME)? (Python SDK)", + "title":"What Is Content-Type (MIME)?", "githuburl":"" }, { @@ -1791,7 +1791,7 @@ "code":"100", "des":"When calling APIs, you may need to specify the account ID (DomainID) and user ID (UserID) in some requests. You need to obtain them from the console in advance. To obtain", "doc_type":"sdk-python-devg", - "kw":"How Do I Get My Account ID and IAM User ID? (SDK for Python),FAQs (SDK for Python),Python SDK Develo", + "kw":"How Do I Get My Account ID and IAM User ID?,FAQs,Python SDK Developer Guide", "search_title":"", "metedata":[ { @@ -1799,7 +1799,7 @@ "documenttype":"sdk-python-devg" } ], - "title":"How Do I Get My Account ID and IAM User ID? (SDK for Python)", + "title":"How Do I Get My Account ID and IAM User ID?", "githuburl":"" }, { diff --git a/docs/obs_3rd_party/python_sdk/CLASS.TXT.json b/docs/obs_3rd_party/python_sdk/CLASS.TXT.json index a778209ed..a3b2476b7 100644 --- a/docs/obs_3rd_party/python_sdk/CLASS.TXT.json +++ b/docs/obs_3rd_party/python_sdk/CLASS.TXT.json @@ -2,7 +2,7 @@ { "desc":"This section describes the important notes about Object Storage Service (OBS) SDK for Python.Some features are available only in some regions. If 405 HTTP status code is ", "product_code":"obs", - "title":"Before You Start (SDK for Python)", + "title":"Before You Start", "uri":"obs_22_0001.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -20,7 +20,7 @@ { "desc":"Before using OBS SDK for Python to access OBS, you need to prepare the service and development environments. To prepare the service environment, you must get an account a", "product_code":"obs", - "title":"Preparations (SDK for Python)", + "title":"Preparations", "uri":"obs_22_0300.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -29,7 +29,7 @@ { "desc":"This topic provides the download links and installation methods of OBS SDK for Python.Latest version of OBS Python SDK source code: DownloadYou can use the methods listed", "product_code":"obs", - "title":"Downloading and Installing OBS SDK for Python", + "title":"Downloading and Installing an SDK", "uri":"obs_22_0400.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -38,7 +38,7 @@ { "desc":"OBS employs access keys (AK and SK) for signature verification to ensure that only authorized accounts can access specified OBS resources. Detailed explanations of access", "product_code":"obs", - "title":"Getting Started with OBS SDK for Python", + "title":"Getting Started", "uri":"obs_22_0500.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -47,7 +47,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"Initialization (SDK for Python)", + "title":"Initialization", "uri":"obs_22_0600.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -56,7 +56,7 @@ { "desc":"ObsClient functions as the Python client for accessing OBS. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resources, such as", "product_code":"obs", - "title":"Initializing an Instance of ObsClient (SDK for Python)", + "title":"Initializing an Instance of ObsClient", "uri":"obs_22_0601.html", "doc_type":"sdk-python-devg", "p_code":"6", @@ -65,7 +65,7 @@ { "desc":"BucketClient functions as the Python client for accessing an OBS bucket. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resou", "product_code":"obs", - "title":"Initializing a BucketClient Instance (SDK for Python)", + "title":"Initializing a bucketClient Instance", "uri":"obs_22_0602.html", "doc_type":"sdk-python-devg", "p_code":"6", @@ -74,7 +74,7 @@ { "desc":"You can enable the SDK log function to record log information generated during API calling into log files for subsequent data analysis or fault location. The procedure is", "product_code":"obs", - "title":"Log Initialization (SDK for Python)", + "title":"Log Initialization", "uri":"obs_22_0603.html", "doc_type":"sdk-python-devg", "p_code":"6", @@ -83,7 +83,7 @@ { "desc":"Each time an ObsClient related API is called (excluding ObsClient.createSignedUrl and ObsClient.createPostSignature), an SDK common result object will be returned. You ca", "product_code":"obs", - "title":"SDK Common Results (SDK for Python)", + "title":"SDK Common Result Objects", "uri":"obs_22_0604.html", "doc_type":"sdk-python-devg", "p_code":"6", @@ -92,7 +92,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"Bucket-Related APIs (SDK for Python)", + "title":"Bucket-Related APIs", "uri":"obs_22_0800.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -101,7 +101,7 @@ { "desc":"This API creates an OBS bucket. Buckets are containers for storing objects (files uploaded to OBS) in OBS.When creating a bucket, you can also configure parameters such a", "product_code":"obs", - "title":"Creating a Bucket (SDK for Python)", + "title":"Creating a Bucket", "uri":"obs_22_0801.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -110,7 +110,7 @@ { "desc":"OBS buckets are containers for storing objects you upload to OBS. This API returns a list of all buckets that meet the specified conditions in all regions of the current ", "product_code":"obs", - "title":"Obtaining a Bucket List (SDK for Python)", + "title":"Obtaining a Bucket List", "uri":"obs_22_0802.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -119,7 +119,7 @@ { "desc":"This API checks whether a bucket exists. If an HTTP status code 200 is returned, the bucket exists. If 404 is returned, the bucket does not exist.To determine whether a b", "product_code":"obs", - "title":"Checking Whether a Bucket Exists (SDK for Python)", + "title":"Checking Whether a Bucket Exists", "uri":"obs_22_0803.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -128,7 +128,7 @@ { "desc":"This API deletes an empty bucket. You can delete buckets you no longer use to free up space. The name of a deleted bucket can be reused for another bucket at least 30 min", "product_code":"obs", - "title":"Deleting a Bucket (SDK for Python)", + "title":"Deleting a Bucket", "uri":"obs_22_0804.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -137,7 +137,7 @@ { "desc":"This API lists some or all of the objects in a bucket. You can use parameters such as the prefix, number of returned objects, and start position to list objects that meet", "product_code":"obs", - "title":"Listing Objects in a Bucket (SDK for Python)", + "title":"Listing Objects in a Bucket", "uri":"obs_22_0805.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -146,7 +146,7 @@ { "desc":"This API lists some or all of the object versions in a bucket. You can use parameters such as the prefix, number of returned object versions, and start position to list t", "product_code":"obs", - "title":"Listing Object Versions in a Bucket (SDK for Python)", + "title":"Listing Object Versions in a Bucket", "uri":"obs_22_0806.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -155,7 +155,7 @@ { "desc":"This API returns information about a bucket, including the storage class, region, CORS rules, and redundancy policy.To obtain bucket metadata, you must be the bucket owne", "product_code":"obs", - "title":"Obtaining Bucket Metadata (SDK for Python)", + "title":"Obtaining Bucket Metadata", "uri":"obs_22_0807.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -164,7 +164,7 @@ { "desc":"This API returns the region of a bucket.To obtain the region of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketLocation in IA", "product_code":"obs", - "title":"Obtaining the Region of a Bucket (SDK for Python)", + "title":"Obtaining the Region of a Bucket", "uri":"obs_22_0808.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -173,7 +173,7 @@ { "desc":"This API returns the storage information of a bucket, including the number of objects and the space occupied by the objects in the bucket.OBS measures bucket storage stat", "product_code":"obs", - "title":"Obtaining Storage Information of a Bucket (SDK for Python)", + "title":"Obtaining Storage Information of a Bucket", "uri":"obs_22_0809.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -182,7 +182,7 @@ { "desc":"A quota limits the maximum capacity allowed in a bucket. By default, there is no limit on the storage capacity of the entire OBS system or a single bucket, and any number", "product_code":"obs", - "title":"Configuring a Storage Quota (SDK for Python)", + "title":"Configuring a Storage Quota", "uri":"obs_22_0810.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -191,7 +191,7 @@ { "desc":"This API returns the storage quota (upper limit of the storage capacity) of a bucket. If the quota is 0, there is no upper limit on the bucket capacity.A bucket storage q", "product_code":"obs", - "title":"Obtaining a Bucket Storage Quota (SDK for Python)", + "title":"Obtaining a Bucket Storage Quota", "uri":"obs_22_0811.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -200,7 +200,7 @@ { "desc":"This API configures a storage class for a bucket. If you do not specify a storage class when uploading or copying an object, or initiating a multipart upload, the object ", "product_code":"obs", - "title":"Configuring a Storage Class for a Bucket (SDK for Python)", + "title":"Configuring a Storage Class for a Bucket", "uri":"obs_22_0812.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -209,25 +209,25 @@ { "desc":"This API returns the storage class of a bucket.To obtain a bucket's storage class, you must be the bucket owner or have the required permission (obs:bucket:GetBucketStora", "product_code":"obs", - "title":"Obtaining the Storage Class of a Bucket (SDK for Python)", + "title":"Obtaining the Storage Class of a Bucket", "uri":"obs_22_0813.html", "doc_type":"sdk-python-devg", "p_code":"11", "code":"24" }, { - "desc":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", + "desc":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "product_code":"obs", - "title":"Configuring a Bucket ACL (SDK for Python)", + "title":"Configuring a Bucket ACL", "uri":"obs_22_0814.html", "doc_type":"sdk-python-devg", "p_code":"11", "code":"25" }, { - "desc":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", + "desc":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "product_code":"obs", - "title":"Obtaining a Bucket ACL (SDK for Python)", + "title":"Obtaining a Bucket ACL", "uri":"obs_22_0815.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -236,7 +236,7 @@ { "desc":"This API enables logging for a bucket (source) and configures another bucket (target) to store the log files. When a bucket is created, logging is not enabled by default.", "product_code":"obs", - "title":"Configuring Logging for a Bucket (SDK for Python)", + "title":"Configuring Logging for a Bucket", "uri":"obs_22_0816.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -245,7 +245,7 @@ { "desc":"This API returns the logging configuration of a bucket.To obtain the logging configuration of a bucket, you must be the bucket owner or have the required permission (obs:", "product_code":"obs", - "title":"Obtaining the Logging Configuration of a Bucket (SDK for Python)", + "title":"Obtaining the Logging Configuration of a Bucket", "uri":"obs_22_0817.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -254,7 +254,7 @@ { "desc":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", "product_code":"obs", - "title":"Configuring a Bucket Policy (SDK for Python)", + "title":"Configuring a Bucket Policy", "uri":"obs_22_0818.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -263,7 +263,7 @@ { "desc":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", "product_code":"obs", - "title":"Obtaining the Policy of a Bucket (SDK for Python)", + "title":"Obtaining the Policy of a Bucket", "uri":"obs_22_0819.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -272,7 +272,7 @@ { "desc":"OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control ca", "product_code":"obs", - "title":"Deleting a Bucket Policy (SDK for Python)", + "title":"Deleting a Bucket Policy", "uri":"obs_22_0820.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -281,7 +281,7 @@ { "desc":"You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.This API configures lifecycle rules for a bucket.Expired ob", "product_code":"obs", - "title":"Configuring Lifecycle Rules for a Bucket (SDK for Python)", + "title":"Configuring Lifecycle Rules for a Bucket", "uri":"obs_22_0821.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -290,7 +290,7 @@ { "desc":"You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.This API returns the lifecycle rules of a bucket.To obtain ", "product_code":"obs", - "title":"Obtaining the Lifecycle Configuration of a Bucket (SDK for Python)", + "title":"Obtaining the Lifecycle Configuration of a Bucket", "uri":"obs_22_0822.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -299,7 +299,7 @@ { "desc":"You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.This API deletes the lifecycle configuration of a bucket.To", "product_code":"obs", - "title":"Deleting the Lifecycle Configuration of a Bucket (SDK for Python)", + "title":"Deleting the Lifecycle Configuration of a Bucket", "uri":"obs_22_0823.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -308,7 +308,7 @@ { "desc":"You can host static website resources such as HTML web pages, flash files, or audio and video files in an OBS bucket, so that you can provide these hosted resources using", "product_code":"obs", - "title":"Configuring Static Website Hosting for a Bucket (SDK for Python)", + "title":"Configuring Static Website Hosting for a Bucket", "uri":"obs_22_0824.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -317,7 +317,7 @@ { "desc":"You can host static website resources such as HTML web pages, flash files, as well as audio and video files in an OBS bucket, so that you can provide these hosted resourc", "product_code":"obs", - "title":"Obtaining Static Website Hosting for a Bucket (SDK for Python)", + "title":"Obtaining Static Website Hosting for a Bucket", "uri":"obs_22_0825.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -326,7 +326,7 @@ { "desc":"You can host static website resources such as HTML web pages, flash files, as well as audio and video files in an OBS bucket, so that you can provide these hosted resourc", "product_code":"obs", - "title":"Deleting Static Website Hosting for a Bucket (SDK for Python)", + "title":"Deleting Static Website Hosting for a Bucket", "uri":"obs_22_0826.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -335,7 +335,7 @@ { "desc":"You can enable versioning to automatically maintain previous versions of an object. When versioning is enabled, you can access earlier versions of an object to recover yo", "product_code":"obs", - "title":"Configuring Versioning for a Bucket (SDK for Python)", + "title":"Configuring Versioning for a Bucket", "uri":"obs_22_0827.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -344,7 +344,7 @@ { "desc":"You can enable versioning to automatically maintain previous versions of an object. When versioning is enabled, you can access earlier versions of an object to recover yo", "product_code":"obs", - "title":"Obtaining the Versioning Status of a Bucket (SDK for Python)", + "title":"Obtaining the Versioning Status of a Bucket", "uri":"obs_22_0828.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -353,7 +353,7 @@ { "desc":"Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources", "product_code":"obs", - "title":"Configuring CORS for a Bucket (SDK for Python)", + "title":"Configuring CORS for a Bucket", "uri":"obs_22_0829.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -362,7 +362,7 @@ { "desc":"Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources", "product_code":"obs", - "title":"Obtaining the CORS Configuration of a Bucket (SDK for Python)", + "title":"Obtaining the CORS Configuration of a Bucket", "uri":"obs_22_0830.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -371,7 +371,7 @@ { "desc":"Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources", "product_code":"obs", - "title":"Deleting the CORS Configuration of a Bucket (SDK for Python)", + "title":"Deleting the CORS Configuration of a Bucket", "uri":"obs_22_0831.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -380,7 +380,7 @@ { "desc":"If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analy", "product_code":"obs", - "title":"Configuring Tags for a Bucket (SDK for Python)", + "title":"Configuring Tags for a Bucket", "uri":"obs_22_0834.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -389,7 +389,7 @@ { "desc":"If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analy", "product_code":"obs", - "title":"Obtaining Bucket Tags (SDK for Python)", + "title":"Obtaining Bucket Tags", "uri":"obs_22_0835.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -398,7 +398,7 @@ { "desc":"If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analy", "product_code":"obs", - "title":"Deleting Bucket Tags (SDK for Python)", + "title":"Deleting Bucket Tags", "uri":"obs_22_0836.html", "doc_type":"sdk-python-devg", "p_code":"11", @@ -407,7 +407,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"Object-Related APIs (SDK for Python)", + "title":"Object-Related APIs", "uri":"obs_22_0900.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -416,7 +416,7 @@ { "desc":"You can use this API to upload an object to a specified bucket. In OBS, objects are basic data units that you can operate. OBS Python SDK provides many APIs for uploading", "product_code":"obs", - "title":"Object Upload Overview (SDK for Python)", + "title":"Object Upload Overview", "uri":"obs_22_0501.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -425,7 +425,7 @@ { "desc":"This API uploads the text using strings as the data source to a specified bucket.To upload an object, you must be the bucket owner or have the required permission (obs:ob", "product_code":"obs", - "title":"Uploading Objects - Text-Based (SDK for Python)", + "title":"Uploading Objects - Text-Based", "uri":"obs_22_0901.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -434,7 +434,7 @@ { "desc":"You can upload texts, images, videos, or any other types of files smaller than 5 GB.Streaming upload uses readable objects that contain the read attribute as the data sou", "product_code":"obs", - "title":"Uploading an Object - Streaming (SDK for Python)", + "title":"Uploading an Object - Streaming", "uri":"obs_22_0902.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -443,7 +443,7 @@ { "desc":"This API uploads local filesto OBS over the Internet. These files can be texts, images, videos, or any other type of files.OBS does not involve folders like in a file sys", "product_code":"obs", - "title":"Uploading an Object - File-Based (SDK for Python)", + "title":"Uploading an Object - File-Based", "uri":"obs_22_0903.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -452,7 +452,7 @@ { "desc":"This API uploads a file or folder to an existing OBS bucket. These files can be texts, images, videos, or any other type of files.The AppendObject operation adds data to ", "product_code":"obs", - "title":"Uploading an Object - Append (SDK for Python)", + "title":"Uploading an Object - Append", "uri":"obs_22_0904.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -461,7 +461,7 @@ { "desc":"The resumable upload is an encapsulated and enhanced version of the multipart upload used for dealing with possible upload failures of large files when the network connec", "product_code":"obs", - "title":"Uploading an Object - Resumable (SDK for Python)", + "title":"Uploading an Object - Resumable", "uri":"obs_22_0905.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -470,7 +470,7 @@ { "desc":"You can query the upload progress when uploading an object in streaming, file-based, multipart, appendable, or resumable mode.This example configures a callback function ", "product_code":"obs", - "title":"Obtaining the Upload Progress (SDK for Python)", + "title":"Obtaining the Upload Progress", "uri":"obs_22_0906.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -479,7 +479,7 @@ { "desc":"This API uploads an object up to 5 GB to a specified bucket in HTML form. You can call ObsClient.createPostSignature to generate parameters for requesting a browser-based", "product_code":"obs", - "title":"Uploading an Object - Browser-Based (SDK for Python)", + "title":"Uploading an Object - Browser-Based", "uri":"obs_22_0907.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -488,25 +488,25 @@ { "desc":"OBS Python SDK provides abundant APIs for downloading objects using various methods:Binary DownloadStreaming DownloadFile-Based DownloadPartial DownloadResumable Download", "product_code":"obs", - "title":"Object Download Overview (SDK for Python)", + "title":"Object Download Overview", "uri":"obs_22_0502.html", "doc_type":"sdk-python-devg", "p_code":"46", "code":"55" }, { - "desc":"This API downloads an object in binary from OBS to your local computer.To download an object, you must be the bucket owner or have the required permission (obs:object:Get", + "desc":"This API downloads a file using a stream from OBS to your local computer. If loadStreamInMemory is set to True, downloadpath will be invalid. The binary stream of the fil", "product_code":"obs", - "title":"Downloading an Object - Binary (SDK for Python)", + "title":"Downloading an Object - Binary", "uri":"obs_22_0908.html", "doc_type":"sdk-python-devg", "p_code":"46", "code":"56" }, { - "desc":"This API downloads an object using streaming from OBS to your local computer.To download an object, you must be the bucket owner or have the required permission (obs:obje", + "desc":"This API downloads a file using a stream from OBS to your local computer. If the object to be downloaded is too large or the download is expected to take a long time, you", "product_code":"obs", - "title":"Downloading an Object - Streaming (SDK for Python)", + "title":"Downloading an Object - Streaming", "uri":"obs_22_0909.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -515,16 +515,16 @@ { "desc":"This API downloads an object as a file from OBS to your local computer.To download an object, you must be the bucket owner or have the required permission (obs:object:Get", "product_code":"obs", - "title":"Downloading an Object - File-Based (SDK for Python)", + "title":"Downloading an Object - File-Based", "uri":"obs_22_0910.html", "doc_type":"sdk-python-devg", "p_code":"46", "code":"58" }, { - "desc":"This API downloads partial data of an object by specifying a range. If the specified range is from 0 to 1,000, data from byte 0 to byte 1,000, 1,001 bytes in total, are r", + "desc":"This API downloads partial data of an object by specifying a range. If the specified range is from 0 to 1000, data from byte 0 to byte 1,000, 1,001 bytes in total, are re", "product_code":"obs", - "title":"Downloading an Object - Range-Based (SDK for Python)", + "title":"Downloading an Object - Range-Based", "uri":"obs_22_0911.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -533,7 +533,7 @@ { "desc":"Downloading large files often fails due to unstable network or program breakdown. It is a waste of resources to download files again. Moreover, the restarted download may", "product_code":"obs", - "title":"Downloading an Object - Resumable (SDK for Python)", + "title":"Downloading an Object - Resumable", "uri":"obs_22_0912.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -542,7 +542,7 @@ { "desc":"You can obtain the download progress when downloading an object in binary, streaming, file-based, or resumable mode.This example returns the object download progress.Samp", "product_code":"obs", - "title":"Downloading an Object - Obtaining the Download Progress (SDK for Python)", + "title":"Downloading an Object - Obtaining the Download Progress", "uri":"obs_22_0913.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -551,7 +551,7 @@ { "desc":"This API creates a folder in an existing bucket to manage data in OBS.OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. ", "product_code":"obs", - "title":"Uploading an Object - Creating a Folder (SDK for Python)", + "title":"Uploading an Object - Creating a Folder", "uri":"obs_22_0915.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -560,7 +560,7 @@ { "desc":"This API copies an object stored in OBS to another path, with a copy created during the process. You can create a copy of an object up to 5 GB in a single operation.To co", "product_code":"obs", - "title":"Copying an Object (SDK for Python)", + "title":"Copying an Object", "uri":"obs_22_0917.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -569,7 +569,7 @@ { "desc":"This API deletes an object in the specified bucket to save space and costs.To delete an object, you must be the bucket owner or have the required permission (obs:object:D", "product_code":"obs", - "title":"Deleting an Object (SDK for Python)", + "title":"Deleting an Object", "uri":"obs_22_0918.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -578,7 +578,7 @@ { "desc":"This API deletes objects in a batch from a specific bucket. Deleted objects cannot be restored.OBS does not involve folders like in a file system. All elements stored in ", "product_code":"obs", - "title":"Batch Deleting Objects (SDK for Python)", + "title":"Batch Deleting Objects", "uri":"obs_22_0919.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -587,7 +587,7 @@ { "desc":"Object metadata is a set of name-value pairs that describe the object and is used for object management.Currently, only the system-defined metadata can be obtained. Syste", "product_code":"obs", - "title":"Obtaining Object Metadata (SDK for Python)", + "title":"Obtaining Object Metadata", "uri":"obs_22_0920.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -596,25 +596,25 @@ { "desc":"Object metadata is a set of name-value pairs that describe the object and is used for object management.Currently, only the system-defined metadata can be modified.System", "product_code":"obs", - "title":"Modifying Object Metadata (SDK for Python)", + "title":"Modifying Object Metadata", "uri":"obs_22_0921.html", "doc_type":"sdk-python-devg", "p_code":"46", "code":"67" }, { - "desc":"OBS allows the control of access permissions for objects. By default, only object creators have the read and write permissions on the object. However, the creator can set", + "desc":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "product_code":"obs", - "title":"Configuring an Object ACL (SDK for Python)", + "title":"Configuring an Object ACL", "uri":"obs_22_0922.html", "doc_type":"sdk-python-devg", "p_code":"46", "code":"68" }, { - "desc":"This API returns the ACL of an object in a specified bucket.To obtain an object ACL, you must be the bucket owner or have the required permission (obs:object:GetObjectAcl", + "desc":"Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over r", "product_code":"obs", - "title":"Obtaining an Object ACL (SDK for Python)", + "title":"Obtaining an Object ACL", "uri":"obs_22_0923.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -623,7 +623,7 @@ { "desc":"To obtain the contents of an object in the Cold storage class, you need to restore the object first and then you can download it. After an object is restored, a copy of t", "product_code":"obs", - "title":"Restoring a Cold Object (SDK for Python)", + "title":"Restoring a Cold Object", "uri":"obs_22_0924.html", "doc_type":"sdk-python-devg", "p_code":"46", @@ -632,7 +632,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"APIs Related to Multipart Upload (SDK for Python)", + "title":"APIs Related to Multipart Upload", "uri":"obs_22_1000.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -641,7 +641,7 @@ { "desc":"You can upload large files using multipart upload. Multipart upload is applicable to many scenarios, including:Files to be uploaded are larger than 100 MB.The network con", "product_code":"obs", - "title":"Multipart Upload Overview (SDK for Python)", + "title":"Multipart Upload Overview", "uri":"obs_22_1001.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -650,7 +650,7 @@ { "desc":"This API initiates a multipart upload and returns a globally unique upload ID. You can use the returned upload ID when you later upload, assemble, or list parts. A single", "product_code":"obs", - "title":"Initiating a Multipart Upload (SDK for Python)", + "title":"Initiating a Multipart Upload", "uri":"obs_22_1002.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -659,7 +659,7 @@ { "desc":"After a multipart upload is initiated, this API uploads a part to a specified bucket. In the upload request, the multipart upload ID must be included. Except for the part", "product_code":"obs", - "title":"Uploading a Part (SDK for Python)", + "title":"Uploading a Part", "uri":"obs_22_1003.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -668,7 +668,7 @@ { "desc":"This API lists the uploaded parts in a specified bucket. This request must contain the multipart upload ID.You can list the uploaded parts of a specified multipart upload", "product_code":"obs", - "title":"Listing Uploaded Parts (SDK for Python)", + "title":"Listing Uploaded Parts", "uri":"obs_22_1004.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -677,7 +677,7 @@ { "desc":"This API lists ongoing multipart uploads.Ongoing multipart uploads are the multipart uploads that have been initiated but have not been completed or aborted. A maximum of", "product_code":"obs", - "title":"Listing Multipart Uploads (SDK for Python)", + "title":"Listing Multipart Uploads", "uri":"obs_22_1005.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -686,7 +686,7 @@ { "desc":"This API assembles the uploaded parts to complete the multipart upload. Before performing this operation, you cannot download the uploaded data. When assembling parts, yo", "product_code":"obs", - "title":"Assembling Parts (SDK for Python)", + "title":"Assembling Parts", "uri":"obs_22_1006.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -695,7 +695,7 @@ { "desc":"This API copies a part to a specified bucket. This request must contain the multipart upload ID.After creating a multipart upload, you can specify the upload ID and uploa", "product_code":"obs", - "title":"Copying a Part (SDK for Python)", + "title":"Copying a Part", "uri":"obs_22_1007.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -704,7 +704,7 @@ { "desc":"This API aborts a multipart upload using the multipart upload ID.After a multipart upload is aborted, the upload ID cannot be used to upload any part. The storage occupie", "product_code":"obs", - "title":"Aborting a Multipart Upload (SDK for Python)", + "title":"Aborting a Multipart Upload", "uri":"obs_22_1008.html", "doc_type":"sdk-python-devg", "p_code":"71", @@ -713,7 +713,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"Client-Side Encryption APIs (SDK for Python)", + "title":"Client-Side Encryption APIs", "uri":"obs_22_1009.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -722,7 +722,7 @@ { "desc":"Client-side encryption is a process where data is encrypted using the selected encryption method and information on your local PC before it is transmitted to an OBS serve", "product_code":"obs", - "title":"Introduction (SDK for Python)", + "title":"Overview", "uri":"obs_22_1010.html", "doc_type":"sdk-python-devg", "p_code":"80", @@ -731,7 +731,7 @@ { "desc":"The OBS SDK for Python offers two types of CryptoCipher. Choose the one right for you.CtrRSACipherGenerator needs an RSA public or private key to encrypt the randomly gen", "product_code":"obs", - "title":"Client-Side Encryption (SDK for Python)", + "title":"Client-Side Encryption APIs", "uri":"obs_22_1011.html", "doc_type":"sdk-python-devg", "p_code":"80", @@ -740,7 +740,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"Other APIs (SDK for Python)", + "title":"Other APIs", "uri":"obs_22_1300.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -749,7 +749,7 @@ { "desc":"This API creates a URL whose Query parameters are carried with authentication information by specifying the AK and SK, HTTP method, and request parameters. You can provid", "product_code":"obs", - "title":"Creating a Signed URL (SDK for Python)", + "title":"Creating a Signed URL", "uri":"obs_22_1301.html", "doc_type":"sdk-python-devg", "p_code":"83", @@ -758,7 +758,7 @@ { "desc":"This API generates parameters for authentication. The parameters can be used to perform a browser-based upload through POST operations.There are two request parameters ge", "product_code":"obs", - "title":"Generating Authentication Parameters for Browser-Based Uploads (SDK for Python)", + "title":"Generating Authentication Parameters for Browser-Based Uploads", "uri":"obs_22_1302.html", "doc_type":"sdk-python-devg", "p_code":"83", @@ -767,7 +767,7 @@ { "desc":"This API configures server-side encryption for objects, so that they will be encrypted or decrypted when you upload them to or download them from a bucket.The encryption ", "product_code":"obs", - "title":"Server-Side Encryption (SDK for Python)", + "title":"Server-Side Encryption", "uri":"obs_22_1303.html", "doc_type":"sdk-python-devg", "p_code":"83", @@ -776,7 +776,7 @@ { "desc":"This API uploads the files of the static website to your bucket in OBS as objects and configures the public-read permission on the files, and then configures the static w", "product_code":"obs", - "title":"Static Website Hosting (SDK for Python)", + "title":"Static Website Hosting", "uri":"obs_22_1304.html", "doc_type":"sdk-python-devg", "p_code":"83", @@ -785,7 +785,7 @@ { "desc":"When calling an API, you can configure user-defined headers to meet specific needs. The SDK will automatically calculate the signature for the specified headers if needed", "product_code":"obs", - "title":"User-defined Header (SDK for Python)", + "title":"User-defined Headers", "uri":"obs_22_1305.html", "doc_type":"sdk-python-devg", "p_code":"83", @@ -794,7 +794,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"Troubleshooting (SDK for Python)", + "title":"Troubleshooting", "uri":"obs_22_1500.html", "doc_type":"sdk-python-devg", "p_code":"", @@ -803,7 +803,7 @@ { "desc":"The OBS server complies with the HTTP standard. After an API is called, the OBS server returns a standard HTTP status code. The following tables list the categories of HT", "product_code":"obs", - "title":"HTTP Status Codes (SDK for Python)", + "title":"HTTP Status Codes", "uri":"obs_22_1501.html", "doc_type":"sdk-python-devg", "p_code":"89", @@ -812,7 +812,7 @@ { "desc":"If the OBS server encounters an error when processing a request, a response containing the error code and error description is returned.The following table lists details ", "product_code":"obs", - "title":"OBS Server-Side Error Codes (SDK for Python)", + "title":"OBS Server-Side Error Codes", "uri":"obs_22_1502.html", "doc_type":"sdk-python-devg", "p_code":"89", @@ -821,7 +821,7 @@ { "desc":"OBS Python SDK provides the logging function based on the Python log library. You can call ObsClient.initLog to enable and configure logging. Sample code is as follows:Th", "product_code":"obs", - "title":"Log Analysis (SDK for Python)", + "title":"Log Analysis", "uri":"obs_22_1503.html", "doc_type":"sdk-python-devg", "p_code":"89", @@ -830,16 +830,16 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", - "title":"FAQs (SDK for Python)", + "title":"FAQs", "uri":"obs_22_1600.html", "doc_type":"sdk-python-devg", "p_code":"", "code":"93" }, { - "desc":"To do this, perform the following steps:Set the object access permission to public-read by referring to Configuring an Object ACL (SDK for Python).Obtain the URL of the o", + "desc":"To do this, perform the following steps:Set the object ACL to public read by referring to Configuring an Object ACL.Obtain the URL of the object by referring to How Do I ", "product_code":"obs", - "title":"How Do I Make an Object Accessible to Anonymous Users? (SDK for Python)", + "title":"How Do I Make an Object Accessible to Anonymous Users?", "uri":"obs_22_1607.html", "doc_type":"sdk-python-devg", "p_code":"93", @@ -848,7 +848,7 @@ { "desc":"OBS employs access keys (AK and SK) for signature verification to ensure that only authorized accounts can access specified OBS resources. Detailed explanations of access", "product_code":"obs", - "title":"How Can I Obtain the AK and SK? (SDK for Python)", + "title":"How Can I Obtain the AK and SK?", "uri":"obs_22_1609.html", "doc_type":"sdk-python-devg", "p_code":"93", @@ -857,7 +857,7 @@ { "desc":"After setting an ACL to grant anonymous users the read permission for an object in a bucket, you can download this object using its URL. Methods to obtain the object URL ", "product_code":"obs", - "title":"How Do I Obtain an Object URL? (Python SDK)", + "title":"How Do I Obtain an Object URL?", "uri":"obs_22_1613.html", "doc_type":"sdk-python-devg", "p_code":"93", @@ -866,7 +866,7 @@ { "desc":"If a file exceeds 100 MB, you are advised to upload the file using multipart upload.Multipart upload refers to splitting an object into multiple parts and uploading them ", "product_code":"obs", - "title":"How Do I Improve the Uploading Speed of Large Files over the Public Network? (SDK for Python)", + "title":"How Do I Improve the Uploading Speed of Large Files over the Public Network?", "uri":"obs_22_1614.html", "doc_type":"sdk-python-devg", "p_code":"93", @@ -875,7 +875,7 @@ { "desc":"This example sets the object expiration time using a header when uploading a file stream.This example sets the object expiration time using a user-defined header when upl", "product_code":"obs", - "title":"Setting an Object Expiration Time (SDK for Python)", + "title":"Setting an Object Expiration Time", "uri":"obs_22_1704.html", "doc_type":"sdk-python-devg", "p_code":"93", @@ -884,7 +884,7 @@ { "desc":"Multipurpose Internet Mail Extensions (MIME) type is a standard way of describing a data type. The MIME type is passed in the Content-Type header.If you do not specify Co", "product_code":"obs", - "title":"What Is Content-Type (MIME)? (Python SDK)", + "title":"What Is Content-Type (MIME)?", "uri":"obs_22_1702.html", "doc_type":"sdk-python-devg", "p_code":"93", @@ -893,7 +893,7 @@ { "desc":"When calling APIs, you may need to specify the account ID (DomainID) and user ID (UserID) in some requests. You need to obtain them from the console in advance. To obtain", "product_code":"obs", - "title":"How Do I Get My Account ID and IAM User ID? (SDK for Python)", + "title":"How Do I Get My Account ID and IAM User ID?", "uri":"obs_22_1703.html", "doc_type":"sdk-python-devg", "p_code":"93", diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0001.html b/docs/obs_3rd_party/python_sdk/obs_22_0001.html index 90fd6ce0f..b78ddf8c5 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0001.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0001.html @@ -1,6 +1,6 @@ -

Before You Start (SDK for Python)

+

Before You Start

This section describes the important notes about Object Storage Service (OBS) SDK for Python.

Important Notes

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0100.html b/docs/obs_3rd_party/python_sdk/obs_22_0100.html index d0afb6a47..da0c8b818 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0100.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0100.html @@ -11,364 +11,364 @@ -

Creating a Bucket (SDK for Python)

+

Creating a Bucket

ObsClient.createBucket

Creates a bucket.

-

Obtaining a Bucket List (SDK for Python)

+

Obtaining a Bucket List

ObsClient.listBuckets

Returns a list of buckets in alphabetical order.

-

Checking Whether a Bucket Exists (SDK for Python)

+

Checking Whether a Bucket Exists

ObsClient.headBucket

Determines whether a bucket exists.

-

Deleting a Bucket (SDK for Python)

+

Deleting a Bucket

ObsClient.deleteBucket

Deletes an empty bucket.

-

Listing Objects in a Bucket (SDK for Python)

+

Listing Objects in a Bucket

ObsClient.listObjects

Returns some or all (up to 1,000) of the objects in a bucket.

-

Listing Object Versions in a Bucket (SDK for Python)

+

Listing Object Versions in a Bucket

ObsClient.listVersions

Lists some or all (up to 1,000) of the object versions in a bucket.

-

Listing Multipart Uploads (SDK for Python)

+

Listing Multipart Uploads

ObsClient.listMultipartUploads

Lists ongoing multipart uploads.

-

Obtaining Bucket Metadata (SDK for Python)

+

Obtaining Bucket Metadata

ObsClient.getBucketMetadata

Sends a HEAD request to a bucket to obtain the bucket metadata such as CORS rules (if set), the storage class, and other information.

-

Obtaining the Region of a Bucket (SDK for Python)

+

Obtaining the Region of a Bucket

ObsClient.getBucketLocation

Returns the region where the bucket is created.

-

Obtaining Storage Information of a Bucket (SDK for Python)

+

Obtaining Storage Information of a Bucket

ObsClient.getBucketStorageInfo

Returns the storage information of a bucket, including the number of objects and the space occupied by the objects in the bucket.

-

Configuring a Storage Quota (SDK for Python)

+

Configuring a Storage Quota

ObsClient.setBucketQuota

Sets a storage quota for a bucket.

-

Obtaining a Bucket Storage Quota (SDK for Python)

+

Obtaining a Bucket Storage Quota

ObsClient.getBucketQuota

Returns the storage quota of a bucket.

-

Configuring a Storage Class for a Bucket (SDK for Python)

+

Configuring a Storage Class for a Bucket

ObsClient.setBucketStoragePolicy

Configures a storage class for a bucket.

-

Obtaining the Storage Class of a Bucket (SDK for Python)

+

Obtaining the Storage Class of a Bucket

ObsClient.getBucketStoragePolicy

Returns the storage class of a bucket.

-

Configuring a Bucket ACL (SDK for Python)

+

Configuring a Bucket ACL

ObsClient.setBucketAcl

-

Configures the ACL for a bucket.

+

Configures a bucket ACL.

-

Obtaining a Bucket ACL (SDK for Python)

+

Obtaining a Bucket ACL

ObsClient.getBucketAcl

-

Returns the bucket ACL.

+

Obtains a bucket ACL.

-

Configuring Logging for a Bucket (SDK for Python)

+

Configuring Logging for a Bucket

ObsClient.setBucketLogging

Configures logging for a bucket.

-

Obtaining the Logging Configuration of a Bucket (SDK for Python)

+

Obtaining the Logging Configuration of a Bucket

ObsClient.getBucketLogging

Returns the logging configuration of a bucket.

-

Configuring a Bucket Policy (SDK for Python)

+

Configuring a Bucket Policy

ObsClient.setBucketPolicy

Configures a bucket policy. If the bucket already has a policy, the policy will be overwritten by the one specified in this request.

-

Obtaining the Policy of a Bucket (SDK for Python)

+

Obtaining the Policy of a Bucket

ObsClient.getBucketPolicy

Returns the policy of a bucket.

-

Deleting a Bucket Policy (SDK for Python)

+

Deleting a Bucket Policy

ObsClient.deleteBucketPolicy

Deletes the policy of a bucket.

-

Configuring Lifecycle Rules for a Bucket (SDK for Python)

+

Configuring Lifecycle Rules for a Bucket

ObsClient.setBucketLifecycle

Configures lifecycle rules for a bucket to periodically transition objects between storage classes or delete objects.

-

Obtaining the Lifecycle Configuration of a Bucket (SDK for Python)

+

Obtaining the Lifecycle Configuration of a Bucket

ObsClient.getBucketLifecycle

Returns the lifecycle configuration of a bucket.

-

Deleting the Lifecycle Configuration of a Bucket (SDK for Python)

+

Deleting the Lifecycle Configuration of a Bucket

ObsClient.deleteBucketLifecycle

Deletes all lifecycle rules of a bucket.

-

Configuring Static Website Hosting for a Bucket (SDK for Python)

+

Configuring Static Website Hosting for a Bucket

ObsClient.setBucketWebsite

Configures static website hosting for a bucket.

-

Obtaining Static Website Hosting for a Bucket (SDK for Python)

+

Obtaining Static Website Hosting for a Bucket

ObsClient.getBucketWebsite

Returns the static website hosting configuration of a bucket.

-

Deleting Static Website Hosting for a Bucket (SDK for Python)

+

Deleting Static Website Hosting for a Bucket

ObsClient.deleteBucketWebsite

Deletes the static website hosting configurations of a bucket.

-

Configuring Versioning for a Bucket (SDK for Python)

+

Configuring Versioning for a Bucket

ObsClient.setBucketVersioning

Configures versioning for a bucket.

-

Obtaining the Versioning Status of a Bucket (SDK for Python)

+

Obtaining the Versioning Status of a Bucket

ObsClient.getBucketVersioning

Returns the versioning status of a bucket.

-

Configuring CORS for a Bucket (SDK for Python)

+

Configuring CORS for a Bucket

ObsClient.setBucketCors

Configures CORS for a bucket to allow cross-origin requests.

-

Obtaining the CORS Configuration of a Bucket (SDK for Python)

+

Obtaining the CORS Configuration of a Bucket

ObsClient.getBucketCors

Returns the CORS rules of a bucket.

-

Deleting the CORS Configuration of a Bucket (SDK for Python)

+

Deleting the CORS Configuration of a Bucket

ObsClient.deleteBucketCors

Deletes the CORS configuration of a bucket.

-

Configuring Tags for a Bucket (SDK for Python)

+

Configuring Tags for a Bucket

ObsClient.setBucketTagging

Configures tags for a bucket.

-

Obtaining Bucket Tags (SDK for Python)

+

Obtaining Bucket Tags

ObsClient.getBucketTagging

Returns the tags of a bucket.

-

Deleting Bucket Tags (SDK for Python)

+

Deleting Bucket Tags

ObsClient.deleteBucketTagging

Deletes the tags of a bucket.

-

Object Upload Overview (SDK for Python)

+

Object Upload Overview

ObsClient.putContent

Uploads an object to a bucket.

-

Uploading an Object - File-Based (SDK for Python)

+

Uploading an Object - File-Based

ObsClient.putFile

Uploads a file or folder to a bucket.

-

Uploading an Object - Append (SDK for Python)

+

Uploading an Object - Append

ObsClient.appendObject

Appends content to an uploaded object.

-

Object Download Overview (SDK for Python)

+

Object Download Overview

ObsClient.getObject

Downloads an object from a bucket.

-

Copying an Object (SDK for Python)

+

Copying an Object

ObsClient.copyObject

Creates a copy for a specified object.

-

Deleting an Object (SDK for Python)

+

Deleting an Object

ObsClient.deleteObject

Deletes a single object from a bucket.

-

Batch Deleting Objects (SDK for Python)

+

Batch Deleting Objects

ObsClient.deleteObjects

Deletes multiple objects from a bucket in a batch.

-

Obtaining Object Metadata (SDK for Python)

+

Obtaining Object Metadata

ObsClient.getObjectMetadata

Returns the object metadata.

-

Modifying Object Metadata (SDK for Python)

+

Modifying Object Metadata

ObsClient.setObjectMetadata

Modifies the metadata for an object.

-

Configuring an Object ACL (SDK for Python)

+

Configuring an Object ACL

ObsClient.setObjectAcl

-

Configures the ACL for an object.

+

Configures an ACL for an object in a specified bucket.

-

Obtaining an Object ACL (SDK for Python)

+

Obtaining an Object ACL

ObsClient.getObjectAcl

-

Returns the ACL of an object.

+

Obtains the ACL of an object in a specified bucket.

-

Initiating a Multipart Upload (SDK for Python)

+

Initiating a Multipart Upload

ObsClient.initiateMultipartUpload

Initiates a multipart upload in a bucket.

-

Uploading a Part (SDK for Python)

+

Uploading a Part

ObsClient.uploadPart

Uploads parts to a bucket by specifying the multipart upload ID.

-

Copying a Part (SDK for Python)

+

Copying a Part

ObsClient.copyPart

Copies a part to a specified bucket by specifying the multipart upload ID.

-

Listing Uploaded Parts (SDK for Python)

+

Listing Uploaded Parts

ObsClient.listParts

Returns the uploaded parts in a bucket by specifying the multipart upload ID.

-

Assembling Parts (SDK for Python)

+

Assembling Parts

ObsClient.completeMultipartUpload

Completes a multipart upload based on the multipart upload ID.

-

Aborting a Multipart Upload (SDK for Python)

+

Aborting a Multipart Upload

ObsClient.abortMultipartUpload

@@ -382,28 +382,28 @@

Restores a Cold object.

-

Creating a Signed URL (SDK for Python)

+

Creating a Signed URL

ObsClient.createSignedUrl

Creates a signed URL based on the specified AK and SK, HTTP method, and request parameters.

-

Generating Authentication Parameters for Browser-Based Uploads (SDK for Python)

+

Generating Authentication Parameters for Browser-Based Uploads

ObsClient.createPostSignature

Creates request parameters for authentication to enable browser-based upload with POST.

-

Uploading an Object - Resumable (SDK for Python)

+

Uploading an Object - Resumable

ObsClient.uploadFile

Enables resumable uploads of objects in the event of unstable network connections or program crashes.

-

Downloading an Object - Resumable (SDK for Python)

+

Downloading an Object - Resumable

ObsClient.downloadFile

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0300.html b/docs/obs_3rd_party/python_sdk/obs_22_0300.html index fd5db814c..992c8faec 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0300.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0300.html @@ -1,6 +1,6 @@ -

Preparations (SDK for Python)

+

Preparations

Before using OBS SDK for Python to access OBS, you need to prepare the service and development environments. To prepare the service environment, you must get an account and an access key. Both of them are necessary for interaction between OBS SDK for Python and OBS. To ensure successful SDK installation and SDK-based code development and running, you should also set up a local development environment, for example, installing dependencies and development tools.

Preparing Access Keys

Access keys consist of two parts: an access key ID (AK) and a secret access key (SK). OBS uses access keys to sign requests to make sure that only authorized accounts can access specified OBS resources. Programmatic access must be enabled for an IAM user before the IAM user can get access keys. Access keys are explained as follows:

  • One AK maps to only one user but one user can have multiple AKs. OBS authenticates users by their AKs.
  • An SK is required for accessing OBS. Authentication information is generated based on the SK and request headers. AKs and SKs are in one-to-one match.
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0400.html b/docs/obs_3rd_party/python_sdk/obs_22_0400.html index dffbc5a95..db09d0920 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0400.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0400.html @@ -1,8 +1,8 @@ -

Downloading and Installing OBS SDK for Python

+

Downloading and Installing an SDK

This topic provides the download links and installation methods of OBS SDK for Python.

-

Downloading OBS SDK for Python

Latest version of OBS Python SDK source code: Download

+

Downloading OBS SDK for Python

Latest version of OBS Python SDK source code: Download

Installing OBS SDK for Python

You can use the methods listed in Table 1 to install OBS SDK for Python.

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0500.html b/docs/obs_3rd_party/python_sdk/obs_22_0500.html index 7e3cd40e8..a271d5dee 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0500.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0500.html @@ -1,6 +1,6 @@ -

Getting Started with OBS SDK for Python

+

Getting Started

Creating an AK and SK

OBS employs access keys (AK and SK) for signature verification to ensure that only authorized accounts can access specified OBS resources. Detailed explanations of access keys are as follows:

  • AK is short for Access Key ID. One AK maps to only one user but one user can have multiple AKs. OBS authenticates users by their AKs.
  • SK is short for Secret Access Key, which is used to access OBS. You can generate authentication information based on SKs and request headers. An SK maps to an AK, and they group into a pair.

Access keys are permanent. There are also temporary security credentials (consisting of an AK/SK pair and a security token). Each user can create a maximum of two valid AK/SK pairs. Temporary security credentials can only be used to access OBS within the specified validity period. Once they expire, they must be requested again. For security purposes, you are advised to use temporary security credentials to access OBS. If you want to use permanent access keys, periodically update them.

@@ -59,7 +59,7 @@

For more information, see chapter Initialization.

-

For details about log configuration, see Log Initialization (SDK for Python).

+

For details about log configuration, see Log Initialization.

Creating a Bucket

A bucket is a global namespace of OBS and is a data container. It functions as a root directory of a file system and can store objects.

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0501.html b/docs/obs_3rd_party/python_sdk/obs_22_0501.html index 98ffbb850..28fc0d8c3 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0501.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0501.html @@ -1,6 +1,6 @@ -

Object Upload Overview (SDK for Python)

+

Object Upload Overview

You can use this API to upload an object to a specified bucket. In OBS, objects are basic data units that you can operate. OBS Python SDK provides many APIs for uploading objects using various methods:

  • Text-based upload: Character strings are used as the data source of an object.
  • Streaming upload: Readable objects that contain the read attribute are used as the data source of an object.
  • File-based upload: Local files are used as the data source of objects.
  • Multipart upload: Large files can be uploaded in multiple parts.
  • Append upload: You can append data to an object.
  • Resumable upload: It is an encapsulated and enhanced version of the multipart upload used for dealing with possible upload failures of large files when the network connection is unstable or a program crashes.
  • Browser-based upload: You can upload objects to a specified bucket in HTML form.

SDK supports the upload of objects whose size ranges from 0 KB to 5 GB. For streaming upload, append upload, and file-based upload, data to be uploaded in a batch cannot be larger than 5 GB. If the file is larger than 5 GB, multipart upload (whose part size is smaller than 5 GB) is suitable. Browser-based upload allows files to be uploaded through a browser.

@@ -8,7 +8,7 @@
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0502.html b/docs/obs_3rd_party/python_sdk/obs_22_0502.html index bf7dd70e2..22b174760 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0502.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0502.html @@ -1,12 +1,12 @@ -

Object Download Overview (SDK for Python)

+

Object Download Overview

OBS Python SDK provides abundant APIs for downloading objects using various methods:

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0600.html b/docs/obs_3rd_party/python_sdk/obs_22_0600.html index 267787597..e81b6a160 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0600.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0600.html @@ -1,16 +1,16 @@ -

Initialization (SDK for Python)

+

Initialization

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0601.html b/docs/obs_3rd_party/python_sdk/obs_22_0601.html index 7d4e5d13d..f855b4357 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0601.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0601.html @@ -1,6 +1,6 @@ -

Initializing an Instance of ObsClient (SDK for Python)

+

Initializing an Instance of ObsClient

Function

ObsClient functions as the Python client for accessing OBS. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resources, such as buckets and objects, stored in OBS.

Method

ObsClient(access_key_id, secret_access_key, server)
@@ -270,7 +270,7 @@ obsClient.close()
-
Parent topic: Initialization (SDK for Python)
+
Parent topic: Initialization
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0602.html b/docs/obs_3rd_party/python_sdk/obs_22_0602.html index cb8279f71..7d1e88bd0 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0602.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0602.html @@ -1,6 +1,6 @@ -

Initializing a BucketClient Instance (SDK for Python)

+

Initializing a bucketClient Instance

Function

BucketClient functions as the Python client for accessing an OBS bucket. It offers users a series of APIs for interaction with OBS. These APIs are used for managing resources, such as buckets and objects, stored in OBS.

Except for ObsClient.listBuckets, ObsClient.downloadFile, Obsclient.uploadFile, ObsClient.createPostSignature, and ObsClient.createSignedUrl, BucketClient implements the same APIs as ObsClient, including the same functions and parameters, with the bucketName parameter omitted.

@@ -63,7 +63,7 @@ else:
-
Parent topic: Initialization (SDK for Python)
+
Parent topic: Initialization
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0603.html b/docs/obs_3rd_party/python_sdk/obs_22_0603.html index ad0d324c3..5a6c7d80a 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0603.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0603.html @@ -1,6 +1,6 @@ -

Log Initialization (SDK for Python)

+

Log Initialization

Function

You can enable the SDK log function to record log information generated during API calling into log files for subsequent data analysis or fault location. The procedure is as follows:

  1. Find file log.conf in the OBS Python SDK. The content format is as follows:
    [LOGCONF]
 
@@ -131,7 +131,7 @@ obsClient.close()
-
Parent topic: Initialization (SDK for Python)
+
Parent topic: Initialization
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0604.html b/docs/obs_3rd_party/python_sdk/obs_22_0604.html index e50f867ea..6ba243d32 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0604.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0604.html @@ -1,6 +1,6 @@ -

SDK Common Results (SDK for Python)

+

SDK Common Result Objects

Function

Each time an ObsClient related API is called (excluding ObsClient.createSignedUrl and ObsClient.createPostSignature), an SDK common result object will be returned. You can obtain the HTTP status code from this object to check whether the operation is successful.

Parameter Description

@@ -109,7 +109,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

@@ -148,7 +148,7 @@ except:
-
Parent topic: Initialization (SDK for Python)
+
Parent topic: Initialization
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0800.html b/docs/obs_3rd_party/python_sdk/obs_22_0800.html index f5cfd526a..401de524c 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0800.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0800.html @@ -1,76 +1,76 @@ -

Bucket-Related APIs (SDK for Python)

+

Bucket-Related APIs

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0801.html b/docs/obs_3rd_party/python_sdk/obs_22_0801.html index 79b8c117b..40236c4f9 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0801.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0801.html @@ -1,8 +1,8 @@ -

Creating a Bucket (SDK for Python)

+

Creating a Bucket

Function

This API creates an OBS bucket. Buckets are containers for storing objects (files uploaded to OBS) in OBS.

-

When creating a bucket, you can also configure parameters such as the storage class, region, and access control as needed.

+

When creating a bucket, you can also configure parameters such as the storage class, region, and access control list (ACL) as needed.

Restrictions

  • To create a bucket, you must have the obs:bucket:CreateBucket permission.
  • A maximum of 100 buckets (regardless of regions) can be created for an account. There is no limit on the number and size of objects in a bucket.
  • The created bucket name must be unique in OBS. If you repeatedly create buckets with the same name in the same region, an HTTP status code 200 will be returned. In other cases, creating a bucket with an existing bucket name will have an HTTP status code 409 returned, indicating that such a bucket already exists.
  • The name of a deleted bucket can be reused for another bucket or a parallel file system at least 30 minutes after the deletion.
@@ -66,11 +66,11 @@

No

-

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

@@ -80,9 +80,9 @@
- - @@ -95,9 +95,9 @@ @@ -221,7 +221,7 @@ - @@ -264,13 +264,13 @@
Table 2 CreateBucketHeader

Parameter

Type

+

Type

Mandatory (Yes/No)

+

Mandatory (Yes/No)

Description

No

Explanation:

-

Access control list (ACL) that can be pre-defined during bucket creation

+

ACL that can be pre-defined during bucket creation

Value range:

-

See Table 3.

+

For details, see HeadPermission.

Default value:

PRIVATE

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.
-
Table 5 ExtensionGrant

Parameter

+
- - - @@ -280,11 +280,11 @@ - @@ -294,11 +294,11 @@ - @@ -338,7 +338,7 @@ @@ -563,7 +563,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0802.html b/docs/obs_3rd_party/python_sdk/obs_22_0802.html index 2afcb3b3f..a4dcf53c3 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0802.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0802.html @@ -1,6 +1,6 @@ -

Obtaining a Bucket List (SDK for Python)

+

Obtaining a Bucket List

Function

OBS buckets are containers for storing objects you upload to OBS. This API returns a list of all buckets that meet the specified conditions in all regions of the current account. Returned buckets are listed in alphabetical order by bucket name.

Restrictions

  • To obtain a bucket list, you must have the obs:bucket:ListAllMyBuckets permission.
@@ -38,11 +38,11 @@
- @@ -172,7 +172,7 @@ @@ -306,7 +306,7 @@ @@ -320,7 +320,7 @@ @@ -414,7 +414,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0803.html b/docs/obs_3rd_party/python_sdk/obs_22_0803.html index 299f8808c..bc5b00dc4 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0803.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0803.html @@ -1,6 +1,6 @@ -

Checking Whether a Bucket Exists (SDK for Python)

+

Checking Whether a Bucket Exists

Function

This API checks whether a bucket exists. If an HTTP status code 200 is returned, the bucket exists. If 404 is returned, the bucket does not exist.

Restrictions

  • To determine whether a bucket exists, you must be the bucket owner or have the required permission (obs:bucket:HeadBucket in IAM or HeadBucket in a bucket policy).
@@ -42,8 +42,8 @@
@@ -173,7 +173,7 @@ @@ -260,7 +260,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0804.html b/docs/obs_3rd_party/python_sdk/obs_22_0804.html index da94e370d..267301f17 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0804.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0804.html @@ -1,6 +1,6 @@ -

Deleting a Bucket (SDK for Python)

+

Deleting a Bucket

Function

This API deletes an empty bucket. You can delete buckets you no longer use to free up space. The name of a deleted bucket can be reused for another bucket at least 30 minutes after the deletion.

Restrictions

  • Only empty buckets can be deleted. An empty bucket means that:
    • The bucket does not contain any object (including noncurrent versions and delete markers).
    • The bucket does not contain any fragments, which means that there are no multipart uploads that have not been completed in the bucket.
    @@ -43,8 +43,8 @@
@@ -174,7 +174,7 @@ @@ -253,7 +253,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0805.html b/docs/obs_3rd_party/python_sdk/obs_22_0805.html index 046bd32b0..ab404b27b 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0805.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0805.html @@ -1,6 +1,6 @@ -

Listing Objects in a Bucket (SDK for Python)

+

Listing Objects in a Bucket

Function

This API lists some or all of the objects in a bucket. You can use parameters such as the prefix, number of returned objects, and start position to list objects that meet specified criteria. Returned objects are listed in alphabetical order by object name.

Restrictions

  • A maximum of 1,000 objects can be listed for each API call.
  • To list objects in a bucket, you must be the bucket owner or have the required permission (obs:bucket:ListBucket in IAM or ListBucket in a bucket policy).
@@ -101,11 +101,11 @@
- @@ -235,7 +235,7 @@ @@ -272,12 +272,12 @@ - @@ -300,7 +300,7 @@

Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you specify logs/ as the prefix, logs/day1, logs/day2, and logs/day3 will be returned. If you leave this parameter blank, all objects in the bucket will be returned.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -315,7 +315,7 @@

This parameter is only used for listing objects with a single version.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -328,7 +328,7 @@

Assume that a bucket has objects abcd, abcde, and bbcde in it. If delimiter is set to d and prefix is set to a, objects abcd and abcde are grouped into a commonPrefix with abcd as the prefix. If only delimiter is set to d, objects abcd and abcde are grouped into a commonPrefix with abcd as the prefix, and bbcde is grouped separately into another commonPrefix with bbcd as the prefix.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -352,7 +352,7 @@

Whether all results are returned in the response

Value range:

  • True indicates that not all results are returned.
  • False indicates that all results are returned.
-

Default value:

+

Default value:

None

@@ -364,7 +364,7 @@

Object name to start with upon next request for listing objects

Value range:

An object name string

-

Default value:

+

Default value:

None

@@ -408,7 +408,7 @@

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -421,7 +421,7 @@

Restrictions:

The time must be in the ISO8601 format.

Example: 2018-01-01T00:00:00.000Z

-

Default value:

+

Default value:

None

@@ -435,7 +435,7 @@

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

@@ -447,7 +447,7 @@

Object size

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

@@ -469,7 +469,7 @@

Storage class of the object

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 9.
-

Default value:

+

Default value:

None

@@ -479,10 +479,10 @@ @@ -509,7 +509,7 @@ @@ -523,7 +523,7 @@ @@ -770,7 +770,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0806.html b/docs/obs_3rd_party/python_sdk/obs_22_0806.html index 407cc3798..60a18c967 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0806.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0806.html @@ -1,6 +1,6 @@ -

Listing Object Versions in a Bucket (SDK for Python)

+

Listing Object Versions in a Bucket

Function

This API lists some or all of the object versions in a bucket. You can use parameters such as the prefix, number of returned object versions, and start position to list the object versions that meet specified criteria. Returned object versions are listed in alphabetical order by object name.

Restrictions

  • To list object versions in a bucket, you must be the bucket owner or have the required permission (obs:bucket:ListBucketVersions in IAM or ListBucketVersions in a bucket policy).
@@ -55,11 +55,11 @@
- @@ -281,7 +281,7 @@ @@ -618,7 +618,7 @@ @@ -707,7 +707,7 @@ @@ -906,7 +906,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0807.html b/docs/obs_3rd_party/python_sdk/obs_22_0807.html index 96da23272..ba3369e5f 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0807.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0807.html @@ -1,6 +1,6 @@ -

Obtaining Bucket Metadata (SDK for Python)

+

Obtaining Bucket Metadata

Function

This API returns information about a bucket, including the storage class, region, CORS rules, and redundancy policy.

Restrictions

  • To obtain bucket metadata, you must be the bucket owner or have the required permission (obs:bucket:HeadBucket in IAM or HeadBucket in a bucket policy).
@@ -70,8 +70,8 @@
@@ -88,7 +88,7 @@ - @@ -201,7 +201,7 @@ @@ -218,7 +218,7 @@ - @@ -258,9 +258,9 @@ - - - - - - - @@ -349,7 +349,7 @@ @@ -60,7 +60,7 @@ - @@ -173,7 +173,7 @@ @@ -190,7 +190,7 @@ - @@ -293,7 +293,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0809.html b/docs/obs_3rd_party/python_sdk/obs_22_0809.html index ecbf80c7c..ec0ed0ac5 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0809.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0809.html @@ -1,6 +1,6 @@ -

Obtaining Storage Information of a Bucket (SDK for Python)

+

Obtaining Storage Information of a Bucket

Function

This API returns the storage information of a bucket, including the number of objects and the space occupied by the objects in the bucket.

OBS measures bucket storage statistics in the background and does not update the storage information in real time. So, you are advised not to perform real-time verification on the storage information.

@@ -44,8 +44,8 @@
@@ -62,7 +62,7 @@ - @@ -175,7 +175,7 @@ @@ -192,7 +192,7 @@ - @@ -306,7 +306,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0810.html b/docs/obs_3rd_party/python_sdk/obs_22_0810.html index 364ebe761..0b8b251b8 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0810.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0810.html @@ -1,6 +1,6 @@ -

Configuring a Storage Quota (SDK for Python)

+

Configuring a Storage Quota

Function

A quota limits the maximum capacity allowed in a bucket. By default, there is no limit on the storage capacity of the entire OBS system or a single bucket, and any number of objects can be stored. You can set a storage quota to control the total size of objects that can be uploaded to the bucket. After the storage quota has been reached, object upload will fail.

A quota limit does not apply to the objects uploaded before the quota is configured. If the specified quota is already smaller than the total size of existing objects in the bucket, the existing objects in the bucket will not be deleted, but no more object can be uploaded to the bucket later. In this case, to upload new objects, you must delete some existing objects to make the used space below the quota limit.

@@ -56,9 +56,9 @@
@@ -75,7 +75,7 @@ - @@ -188,7 +188,7 @@ @@ -273,7 +273,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0811.html b/docs/obs_3rd_party/python_sdk/obs_22_0811.html index 1d976fa4e..e7455902e 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0811.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0811.html @@ -1,6 +1,6 @@ -

Obtaining a Bucket Storage Quota (SDK for Python)

+

Obtaining a Bucket Storage Quota

Function

This API returns the storage quota (upper limit of the storage capacity) of a bucket. If the quota is 0, there is no upper limit on the bucket capacity.

Restrictions

  • A bucket storage quota must be a non-negative integer expressed in bytes. The maximum value is 263 – 1.
  • A bucket owner with a frozen account in arrears is not allowed to query the bucket storage quota.
  • To obtain the storage quota of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketQuota in IAM or GetBucketQuota in a bucket policy).
@@ -42,8 +42,8 @@
@@ -60,7 +60,7 @@ - @@ -173,7 +173,7 @@ @@ -190,7 +190,7 @@ - @@ -294,7 +294,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0812.html b/docs/obs_3rd_party/python_sdk/obs_22_0812.html index 5df2e8b8c..c58328f67 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0812.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0812.html @@ -1,6 +1,6 @@ -

Configuring a Storage Class for a Bucket (SDK for Python)

+

Configuring a Storage Class for a Bucket

Function

This API configures a storage class for a bucket. If you do not specify a storage class when uploading or copying an object, or initiating a multipart upload, the object inherits the bucket's storage class.

Restrictions

  • To configure a storage class for a bucket, you must be the bucket owner or have the required permission (obs:PutBucketStoragePolicy in IAM or PutBucketStoragePolicy in a bucket policy).
@@ -55,9 +55,9 @@
@@ -110,7 +110,7 @@ - @@ -223,7 +223,7 @@ @@ -308,7 +308,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0813.html b/docs/obs_3rd_party/python_sdk/obs_22_0813.html index d6e4fd9ce..dbed18702 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0813.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0813.html @@ -1,6 +1,6 @@ -

Obtaining the Storage Class of a Bucket (SDK for Python)

+

Obtaining the Storage Class of a Bucket

Function

This API returns the storage class of a bucket.

Restrictions

  • To obtain a bucket's storage class, you must be the bucket owner or have the required permission (obs:bucket:GetBucketStoragePolicy in IAM or GetBucketStoragePolicy in a bucket policy).
@@ -42,8 +42,8 @@
@@ -173,7 +173,7 @@ @@ -326,7 +326,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0814.html b/docs/obs_3rd_party/python_sdk/obs_22_0814.html index 5c9f0ee6d..30040446a 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0814.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0814.html @@ -1,11 +1,10 @@ -

Configuring a Bucket ACL (SDK for Python)

-

Function

OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control can be implemented using IAM permissions, bucket policies, and ACLs (including bucket and object ACLs).

-

A bucket ACL grants permissions to another account and its IAM users, rather than the current account and its IAM users. It can grant access to both a bucket (including the objects in it) and the bucket ACL. The granted access includes view and edit permissions. You must specify a bucket name when configuring a bucket ACL.

-

This API modifies a bucket ACL.

+

Configuring a Bucket ACL

+

Function

Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over resources when a bucket or object is created. That is, the bucket creator has full control over the bucket, and the object uploader has full control over the object. Other accounts do not have the permissions to access resources. If resource owners want to grant other accounts the read and write permissions on resources, they can use ACLs. ACLs grant permissions to accounts. After an account is granted permissions, both the account and its IAM users can access the resources.

+

-

Restrictions

  • A bucket ACL can have up to 100 grants.
  • To configure an ACL for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketAcl in IAM or PutBucketAcl in a bucket policy).
+

Restrictions

  • A bucket can have up to 100 ACL rules.
  • To configure an ACL for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketAcl in IAM or PutBucketAcl in a bucket policy).

Method

ObsClient.setBucketAcl(bucketName, acl, aclControl, extensionHeaders)

@@ -42,7 +41,7 @@
@@ -102,11 +101,11 @@ - @@ -116,9 +115,9 @@ - @@ -128,12 +127,12 @@ - @@ -174,7 +173,7 @@ - @@ -272,7 +271,7 @@ @@ -286,7 +285,7 @@ @@ -311,7 +310,7 @@ - @@ -321,11 +320,11 @@ - @@ -335,12 +334,12 @@ - @@ -364,9 +363,9 @@ - @@ -376,11 +375,11 @@ - @@ -390,11 +389,11 @@ - @@ -437,7 +436,7 @@ - @@ -550,7 +549,7 @@ @@ -649,7 +648,7 @@ # Set the ACL permission control for bucket examplebucket to public read for all users and to read and write for the IAM user.acl=ACL(owner=owner,grants=[grant1,grant2,grant3])bucketName="examplebucket" - # Configure the bucket ACL. + # Set the bucket ACL.resp=obsClient.setBucketAcl(bucketName,acl)# If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails. @@ -671,7 +670,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0815.html b/docs/obs_3rd_party/python_sdk/obs_22_0815.html index ed2fb8835..bef12b9cd 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0815.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0815.html @@ -1,8 +1,8 @@ -

Obtaining a Bucket ACL (SDK for Python)

-

Function

OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control can be implemented using IAM permissions, bucket policies, and ACLs (including bucket and object ACLs).

-

A bucket ACL grants permissions to another account and its IAM users, rather than the current account and its IAM users. It can grant access to both a bucket (including the objects in it) and the bucket ACL. The granted access includes view and edit permissions. You must specify a bucket name when configuring a bucket ACL.

+

Obtaining a Bucket ACL

+

Function

Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over resources when a bucket or object is created. That is, the bucket creator has full control over the bucket, and the object uploader has full control over the object. Other accounts do not have the permissions to access resources. If resource owners want to grant other accounts the read and write permissions on resources, they can use ACLs. ACLs grant permissions to accounts. After an account is granted permissions, both the account and its IAM users can access the resources.

+

This API returns the ACL of a bucket.

Restrictions

  • To obtain the ACL of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketAcl in IAM or GetBucketAcl in a bucket policy).
@@ -44,8 +44,8 @@
@@ -62,7 +62,7 @@ - @@ -175,7 +175,7 @@ @@ -192,8 +192,8 @@ - @@ -216,7 +216,7 @@ - @@ -226,7 +226,7 @@ - @@ -236,12 +236,12 @@ - @@ -268,7 +268,7 @@ @@ -282,7 +282,7 @@ @@ -307,9 +307,9 @@ - @@ -319,9 +319,9 @@ - @@ -331,12 +331,12 @@ - @@ -360,11 +360,11 @@ - @@ -374,11 +374,11 @@ - @@ -388,11 +388,11 @@ - @@ -432,7 +432,7 @@ @@ -79,12 +79,12 @@ - @@ -94,11 +94,11 @@ - @@ -108,9 +108,9 @@ - @@ -120,12 +120,12 @@ - @@ -149,7 +149,7 @@ - @@ -159,11 +159,11 @@ - @@ -173,12 +173,12 @@ - @@ -202,10 +202,10 @@ - @@ -215,11 +215,11 @@ - @@ -229,11 +229,11 @@ - @@ -275,7 +275,7 @@ - @@ -437,7 +437,7 @@ @@ -550,7 +550,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0817.html b/docs/obs_3rd_party/python_sdk/obs_22_0817.html index b525e92fd..47db29eb6 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0817.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0817.html @@ -1,6 +1,6 @@ -

Obtaining the Logging Configuration of a Bucket (SDK for Python)

+

Obtaining the Logging Configuration of a Bucket

Function

This API returns the logging configuration of a bucket.

Restrictions

  • To obtain the logging configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketLogging in IAM or GetBucketLogging in a bucket policy).
@@ -42,8 +42,8 @@
@@ -60,7 +60,7 @@ - @@ -173,7 +173,7 @@ @@ -190,7 +190,7 @@ - @@ -214,12 +214,12 @@ - @@ -229,11 +229,11 @@ - @@ -243,9 +243,9 @@ - @@ -255,12 +255,12 @@ - @@ -280,9 +280,9 @@ - @@ -290,11 +290,11 @@ - @@ -302,12 +302,12 @@ - @@ -327,11 +327,11 @@ - @@ -339,11 +339,11 @@ - @@ -351,9 +351,9 @@ - @@ -421,7 +421,7 @@ @@ -76,7 +76,7 @@ - @@ -189,7 +189,7 @@ @@ -272,7 +272,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0819.html b/docs/obs_3rd_party/python_sdk/obs_22_0819.html index a7ae816ad..70bca828c 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0819.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0819.html @@ -1,6 +1,6 @@ -

Obtaining the Policy of a Bucket (SDK for Python)

+

Obtaining the Policy of a Bucket

Function

OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control can be implemented using IAM permissions, bucket policies, and ACLs.

A bucket policy is applied to a configured bucket and the objects in it. You can use a bucket policy to grant permissions for the bucket and the objects in it to IAM users or other accounts. If you want IAM users to have different permissions for different buckets, you can configure required bucket policies.

This API returns the policy of a bucket.

@@ -45,8 +45,8 @@
@@ -63,7 +63,7 @@ - @@ -176,7 +176,7 @@ @@ -193,7 +193,7 @@ - @@ -297,7 +297,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0820.html b/docs/obs_3rd_party/python_sdk/obs_22_0820.html index 68d58ddf1..d7f66a16d 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0820.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0820.html @@ -1,6 +1,6 @@ -

Deleting a Bucket Policy (SDK for Python)

+

Deleting a Bucket Policy

Function

OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control can be implemented using IAM permissions, bucket policies, and ACLs.

A bucket policy is applied to a configured bucket and the objects in it. You can use a bucket policy to grant permissions for the bucket and the objects in it to IAM users or other accounts. If you want IAM users to have different permissions for different buckets, you can configure required bucket policies.

This API deletes the policy of a bucket. OBS returns 204 No Content if the deletion is successful or the requested bucket policy does not exist.

@@ -44,8 +44,8 @@
@@ -62,7 +62,7 @@ - @@ -175,7 +175,7 @@ @@ -254,7 +254,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0821.html b/docs/obs_3rd_party/python_sdk/obs_22_0821.html index b5ada0039..e8623e65c 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0821.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0821.html @@ -1,6 +1,6 @@ -

Configuring Lifecycle Rules for a Bucket (SDK for Python)

+

Configuring Lifecycle Rules for a Bucket

Function

You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.

This API configures lifecycle rules for a bucket.

  • Expired objects will be permanently deleted and cannot be recovered.
  • Multi-AZ redundancy is not available for Cold storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Cold storage class based on a lifecycle rule.
  • The minimum storage duration is 30 days for Warm storage, and 90 days for Cold storage. After an object is transitioned to the Cold storage class, if it stays in this storage class for less than 90 days, you still need to pay for a full 90 days.
@@ -44,7 +44,7 @@
@@ -57,8 +57,8 @@ @@ -84,7 +84,7 @@ @@ -112,7 +112,7 @@

Lifecycle rule ID

Value range:

The value must contain 1 to 255 characters.

-

Default value:

+

Default value:

None

@@ -125,9 +125,9 @@ @@ -139,9 +139,9 @@ @@ -155,9 +155,9 @@ @@ -169,9 +169,9 @@ @@ -185,9 +185,9 @@ @@ -199,11 +199,11 @@ @@ -229,10 +229,10 @@ @@ -263,11 +263,11 @@ @@ -295,10 +295,10 @@ @@ -310,11 +310,11 @@ @@ -450,12 +450,12 @@ @@ -467,11 +467,11 @@ @@ -631,7 +631,7 @@ @@ -728,7 +728,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0822.html b/docs/obs_3rd_party/python_sdk/obs_22_0822.html index bcfedc22a..58024b5e6 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0822.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0822.html @@ -1,6 +1,6 @@ -

Obtaining the Lifecycle Configuration of a Bucket (SDK for Python)

+

Obtaining the Lifecycle Configuration of a Bucket

Function

You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.

This API returns the lifecycle rules of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -191,9 +191,9 @@ - @@ -213,9 +213,9 @@ - @@ -239,9 +239,9 @@ - @@ -265,11 +265,11 @@ - @@ -279,12 +279,12 @@ - @@ -294,11 +294,11 @@ - @@ -310,11 +310,11 @@ - @@ -324,11 +324,11 @@ - @@ -340,11 +340,11 @@ - @@ -354,11 +354,11 @@ - @@ -382,14 +382,14 @@ - @@ -401,12 +401,12 @@ - @@ -416,13 +416,13 @@ - @@ -484,12 +484,12 @@ - @@ -499,13 +499,13 @@ - @@ -603,12 +603,12 @@ - - @@ -758,7 +758,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0823.html b/docs/obs_3rd_party/python_sdk/obs_22_0823.html index b27a7faa6..3a6c31873 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0823.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0823.html @@ -1,6 +1,6 @@ -

Deleting the Lifecycle Configuration of a Bucket (SDK for Python)

+

Deleting the Lifecycle Configuration of a Bucket

Function

You can configure lifecycle rules to periodically delete objects or transition objects between storage classes.

This API deletes the lifecycle configuration of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -253,7 +253,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0824.html b/docs/obs_3rd_party/python_sdk/obs_22_0824.html index df80b5b0a..cbff1f42b 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0824.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0824.html @@ -1,6 +1,6 @@ -

Configuring Static Website Hosting for a Bucket (SDK for Python)

+

Configuring Static Website Hosting for a Bucket

Function

You can host static website resources such as HTML web pages, flash files, or audio and video files in an OBS bucket, so that you can provide these hosted resources using the bucket's website endpoint to end users. Typical use cases include:

  • Redirecting all requests to another website
  • Redirecting specific requests

This API configures static website hosting for a bucket.

@@ -43,7 +43,7 @@
@@ -56,8 +56,8 @@ @@ -83,7 +83,7 @@ @@ -95,7 +95,7 @@ @@ -107,7 +107,7 @@ @@ -119,7 +119,7 @@ @@ -247,7 +247,7 @@

Conditions that must be met for the specified redirect to apply

Value range:

See Table 6.

-

Default value:

+

Default value:

None

@@ -259,7 +259,7 @@ @@ -517,7 +517,7 @@ @@ -632,7 +632,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0825.html b/docs/obs_3rd_party/python_sdk/obs_22_0825.html index 6c5d4f866..1f215c7c2 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0825.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0825.html @@ -1,6 +1,6 @@ -

Obtaining Static Website Hosting for a Bucket (SDK for Python)

+

Obtaining Static Website Hosting for a Bucket

Function

You can host static website resources such as HTML web pages, flash files, as well as audio and video files in an OBS bucket, so that you can provide these hosted resources using the bucket's website endpoint to end users. Typical use cases include:

  • Redirecting all requests to another website
  • Redirecting specific requests

This API returns the static website hosting configuration of the bucket.

@@ -44,8 +44,8 @@
@@ -62,7 +62,7 @@ - @@ -175,7 +175,7 @@ @@ -192,7 +192,7 @@ - @@ -216,7 +216,7 @@ - @@ -226,7 +226,7 @@ - @@ -236,7 +236,7 @@ - @@ -246,7 +246,7 @@ - @@ -370,11 +370,11 @@ - @@ -384,9 +384,9 @@ - @@ -628,7 +628,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0826.html b/docs/obs_3rd_party/python_sdk/obs_22_0826.html index 1d77a9bcc..e64d85a01 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0826.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0826.html @@ -1,6 +1,6 @@ -

Deleting Static Website Hosting for a Bucket (SDK for Python)

+

Deleting Static Website Hosting for a Bucket

Function

You can host static website resources such as HTML web pages, flash files, as well as audio and video files in an OBS bucket, so that you can provide these hosted resources using the bucket's website endpoint to end users. Typical use cases include:

  • Redirecting all requests to another website
  • Redirecting specific requests

This API deletes the static website hosting configuration of the bucket.

@@ -44,8 +44,8 @@
@@ -62,7 +62,7 @@ - @@ -175,7 +175,7 @@ @@ -256,7 +256,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0827.html b/docs/obs_3rd_party/python_sdk/obs_22_0827.html index 12541ea21..3c2c925dc 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0827.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0827.html @@ -1,6 +1,6 @@ -

Configuring Versioning for a Bucket (SDK for Python)

+

Configuring Versioning for a Bucket

Function

You can enable versioning to automatically maintain previous versions of an object. When versioning is enabled, you can access earlier versions of an object to recover your data in the event of accidental actions or application failures.

This API configures the versioning status for a bucket.

@@ -57,9 +57,9 @@
@@ -76,7 +76,7 @@ - @@ -189,7 +189,7 @@ @@ -270,7 +270,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0828.html b/docs/obs_3rd_party/python_sdk/obs_22_0828.html index 16459e900..f742bf913 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0828.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0828.html @@ -1,6 +1,6 @@ -

Obtaining the Versioning Status of a Bucket (SDK for Python)

+

Obtaining the Versioning Status of a Bucket

Function

You can enable versioning to automatically maintain previous versions of an object. When versioning is enabled, you can access earlier versions of an object to recover your data in the event of accidental actions or application failures.

This API obtains the versioning status of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -191,11 +191,11 @@ - @@ -275,7 +275,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0829.html b/docs/obs_3rd_party/python_sdk/obs_22_0829.html index a78f96f32..91eaf2d1c 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0829.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0829.html @@ -1,6 +1,6 @@ -

Configuring CORS for a Bucket (SDK for Python)

+

Configuring CORS for a Bucket

Function

Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources located in another one. For general web page requests, website scripts and contents in one domain cannot interact with those in another because of Same Origin Policies (SOPs). OBS supports CORS rules that allow the resources in OBS to be requested by other domains.

This API configures CORS for a bucket.

@@ -44,7 +44,7 @@

CORS rule list of the bucket. For details, see Table 1.

Restrictions:

A list can have a maximum of 100 CORS rules.

-

Default value:

+

Default value:

None

@@ -57,8 +57,8 @@
@@ -178,7 +178,7 @@ - @@ -291,7 +291,7 @@ @@ -390,7 +390,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0830.html b/docs/obs_3rd_party/python_sdk/obs_22_0830.html index aded270a3..291b6e3dc 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0830.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0830.html @@ -1,6 +1,6 @@ -

Obtaining the CORS Configuration of a Bucket (SDK for Python)

+

Obtaining the CORS Configuration of a Bucket

Function

Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources located in another one. For general web page requests, website scripts and contents in one domain cannot interact with those in another because of Same Origin Policies (SOPs). OBS supports CORS rules that allow the resources in OBS to be requested by other domains.

This API returns the CORS configuration of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -191,7 +191,7 @@ - @@ -394,7 +394,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0831.html b/docs/obs_3rd_party/python_sdk/obs_22_0831.html index 692333c21..13eb9e302 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0831.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0831.html @@ -1,6 +1,6 @@ -

Deleting the CORS Configuration of a Bucket (SDK for Python)

+

Deleting the CORS Configuration of a Bucket

Function

Cross-origin resource sharing (CORS) is a mechanism defined by the World Wide Web Consortium (W3C) that allows a web application program in one domain to access resources located in another one. For general web page requests, website scripts and contents in one domain cannot interact with those in another because of Same Origin Policies (SOPs). OBS supports CORS rules that allow the resources in OBS to be requested by other domains.

This API deletes the CORS configuration of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -255,7 +255,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0834.html b/docs/obs_3rd_party/python_sdk/obs_22_0834.html index b8e7d12e7..9d8c14543 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0834.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0834.html @@ -1,6 +1,6 @@ -

Configuring Tags for a Bucket (SDK for Python)

+

Configuring Tags for a Bucket

Function

If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analysis. For example, if you have an application that uploads its running data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags in SDRs.

This API adds tags to a bucket.

@@ -44,7 +44,7 @@

Bucket tag list. For details, see Table 1.

Restrictions:

  • A bucket can have a maximum of 10 tags. Each tag can have only one pair of key values.
  • For the same bucket, tag keys must be unique, but tag values can be duplicated or left blank.
-

Default value:

+

Default value:

None

@@ -57,8 +57,8 @@ @@ -82,11 +82,11 @@ - @@ -146,7 +146,7 @@ - @@ -259,7 +259,7 @@ @@ -346,7 +346,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0835.html b/docs/obs_3rd_party/python_sdk/obs_22_0835.html index da8fc4bcf..c8a13ade5 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0835.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0835.html @@ -1,6 +1,6 @@ -

Obtaining Bucket Tags (SDK for Python)

+

Obtaining Bucket Tags

Function

If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analysis. For example, if you have an application that uploads its running data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags in SDRs.

This API returns the tags of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -191,7 +191,7 @@ - @@ -215,11 +215,11 @@ - @@ -352,7 +352,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0836.html b/docs/obs_3rd_party/python_sdk/obs_22_0836.html index 7e01b34cd..8c51c6ae4 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0836.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0836.html @@ -1,6 +1,6 @@ -

Deleting Bucket Tags (SDK for Python)

+

Deleting Bucket Tags

Function

If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analysis. For example, if you have an application that uploads its running data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags in SDRs.

This API deletes the tags of a bucket.

@@ -43,8 +43,8 @@
@@ -61,7 +61,7 @@ - @@ -174,7 +174,7 @@ @@ -253,7 +253,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0900.html b/docs/obs_3rd_party/python_sdk/obs_22_0900.html index 1c8b1474e..c55f52af2 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0900.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0900.html @@ -1,56 +1,56 @@ -

Object-Related APIs (SDK for Python)

+

Object-Related APIs

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0901.html b/docs/obs_3rd_party/python_sdk/obs_22_0901.html index 45e9b58ac..0f89d8e9d 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0901.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0901.html @@ -1,6 +1,6 @@ -

Uploading Objects - Text-Based (SDK for Python)

+

Uploading Objects - Text-Based

Function

This API uploads the text using strings as the data source to a specified bucket.

Restrictions

  • To upload an object, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy).
  • The object size in a single upload ranges from 0 to 5 GB.
  • To upload files larger than 5 GB, multipart uploads should be used.
@@ -101,7 +101,7 @@

Callback function for obtaining the upload progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress.

Upload progress callback only supports streaming, file-based, multipart, appendable, and resumable uploads.

@@ -127,11 +127,11 @@
- @@ -172,9 +172,9 @@ @@ -185,16 +185,16 @@ - @@ -207,7 +207,7 @@ @@ -357,7 +357,7 @@ - @@ -478,7 +478,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -503,11 +503,11 @@ - @@ -517,9 +517,9 @@ - @@ -559,7 +559,7 @@ @@ -731,11 +731,11 @@ - @@ -743,11 +743,11 @@ - @@ -755,13 +755,13 @@ - @@ -769,11 +769,11 @@ - @@ -781,14 +781,14 @@ - @@ -796,11 +796,11 @@ - @@ -808,11 +808,11 @@ - @@ -820,9 +820,9 @@ - @@ -910,7 +910,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0902.html b/docs/obs_3rd_party/python_sdk/obs_22_0902.html index b0f40a80d..c05d5b828 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0902.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0902.html @@ -1,6 +1,6 @@ -

Uploading an Object - Streaming (SDK for Python)

+

Uploading an Object - Streaming

Function

You can upload texts, images, videos, or any other types of files smaller than 5 GB.

Streaming upload uses readable objects that contain the read attribute as the data source and uploads data to a specified bucket in network streams or file streams.

@@ -58,10 +58,10 @@
@@ -103,7 +103,7 @@

Callback function for obtaining the upload progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress.

Upload progress callback only supports streaming, file-based, multipart, appendable, and resumable uploads.

@@ -129,11 +129,11 @@
- @@ -174,9 +174,9 @@ @@ -187,16 +187,16 @@ - @@ -209,7 +209,7 @@ @@ -236,9 +236,9 @@ - @@ -262,10 +262,10 @@ - @@ -293,9 +293,9 @@

Expiration time of the object (calculated from the latest modification time of the object). Expired objects are automatically deleted.

Restrictions:

This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

@@ -361,7 +361,7 @@ - @@ -482,7 +482,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -507,11 +507,11 @@ - @@ -521,9 +521,9 @@ - @@ -563,7 +563,7 @@ @@ -735,11 +735,11 @@ - @@ -747,11 +747,11 @@ - @@ -759,13 +759,13 @@ - @@ -773,11 +773,11 @@ - @@ -785,14 +785,14 @@ - @@ -800,11 +800,11 @@ - @@ -812,11 +812,11 @@ - @@ -824,9 +824,9 @@ - @@ -1002,7 +1002,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0903.html b/docs/obs_3rd_party/python_sdk/obs_22_0903.html index 54bd81608..dc5c095b5 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0903.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0903.html @@ -1,8 +1,8 @@ -

Uploading an Object - File-Based (SDK for Python)

+

Uploading an Object - File-Based

Function

This API uploads local files to OBS over the Internet. These files can be texts, images, videos, or any other type of files.

-
  • OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. To create a folder in OBS is essentially to create an object whose size is 0 and whose name ends with a slash (/). You can perform download, delete, or other operations on such objects as you do on ordinary objects.
  • If versioning is enabled, when uploading an object, OBS automatically allocates a unique version ID for the object. Objects with the same name are stored in OBS as objects with different version IDs. If versioning is not enabled, when uploading an object to a folder where there is already an object with the same name, the new object will overwrite the existing one.
  • You can pass user-defined headers in extensionHeaders in a dictionary. For details, see User-defined Header (SDK for Python).
+
  • OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. To create a folder in OBS is essentially to create an object whose size is 0 and whose name ends with a slash (/). You can perform download, delete, or other operations on such objects as you do on ordinary objects.
  • If versioning is enabled, when uploading an object, OBS automatically allocates a unique version ID for the object. Objects with the same name are stored in OBS as objects with different version IDs. If versioning is not enabled, when uploading an object to a folder where there is already an object with the same name, the new object will overwrite the existing one.
  • You can pass user-defined headers in extensionHeaders in a dictionary. For details, see User-defined Headers.

Restrictions

  • To upload an object, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy).
  • The object size in a single upload ranges from 0 to 5 GB.
  • To upload files larger than 5 GB, multipart uploads should be used.
@@ -99,11 +99,11 @@
@@ -114,11 +114,11 @@ - @@ -143,12 +143,12 @@ - @@ -158,11 +158,11 @@ - @@ -172,16 +172,16 @@ - @@ -191,11 +191,11 @@ - @@ -205,11 +205,11 @@ - @@ -221,9 +221,9 @@ - @@ -233,11 +233,11 @@ - @@ -247,10 +247,10 @@ - @@ -260,11 +260,11 @@ - @@ -274,13 +274,13 @@ - @@ -346,7 +346,7 @@ - @@ -467,7 +467,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -492,11 +492,11 @@ - @@ -506,9 +506,9 @@ - @@ -548,7 +548,7 @@ - @@ -683,7 +683,7 @@ @@ -694,15 +694,15 @@
Table 5 ExtensionGrant

Parameter

Type

+

Type

Mandatory (Yes/No)

+

Mandatory (Yes/No)

Description

+

Description

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Custom permissions for the bucket

-

Value range:

+

Value range:

You can select one or more permissions from Table 6.

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -474,7 +474,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Bucket name

-

Restrictions:

-
  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
    +

    Restrictions:

    +
    • A bucket name must be unique across all accounts and regions.
    • A bucket name:
      • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
      • Cannot be formatted as an IP address.
      • Cannot start or end with a hyphen (-) or period (.).
      • Cannot contain two consecutive periods (..), for example, my..bucket.
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
    • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.
    -

    Default value:

    +

    Default value:

    None

Explanation:

Whether the object is appendable

-

Value range:

+

Value range:

True: The object is appendable.

False: The object is not appendable.

-

Default value:

+

Default value:

None

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

-

Value range:

+

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

@@ -693,7 +693,7 @@

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Extension headers

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

GetBucketMetadataResponse

Explanation:

+

Explanation:

Response to the request for obtaining bucket metadata

str

Explanation:

+

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin specified in the CORS rules is returned. AllowedOrigin indicates the origin from which the requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

Default value:

None

@@ -270,9 +270,9 @@

str

Explanation:

+

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader specified in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

Default value:

None

@@ -282,7 +282,7 @@

str

Explanation:

+

Explanation:

AllowedMethod in the CORS rules of the bucket. It specifies the HTTP method of cross-origin requests, that is, the operation type of buckets and objects.

Value range:

The following HTTP methods are supported:

@@ -295,9 +295,9 @@

str

Explanation:

+

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

Default value:

None

@@ -307,11 +307,11 @@

int

Explanation:

+

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in seconds

Default value:

100

@@ -321,9 +321,9 @@

str

Explanation:

+

Explanation:

OBS version of the bucket

-

Value range:

+

Value range:

  • 3.0 indicates the latest OBS version.
  • -- indicates any version earlier than 3.0.

Default value:

None

@@ -333,13 +333,13 @@

str

Explanation:

+

Explanation:

Data redundancy type that can be specified during bucket creation

-

Restrictions:

+

Restrictions:

Multi-AZ redundancy is not available for Cold storage. If the region where the bucket is located does not support multi-AZ storage, single-AZ storage is used by default.

-

Value range:

+

Value range:

If multi-AZ storage is configured for the bucket, 3az is returned. If single-AZ storage is configured for the bucket, None is returned.

-

Default value:

+

Default value:

None

Explanation:

Enterprise project ID that can be specified during bucket creation. If you have enabled Enterprise Project Management Service (EPS), you can obtain the project ID from the EPS console.

-

Restrictions:

+

Restrictions:

The value of Epid is a UUID. Epid is not required if you have not enabled EPS yet.

Example: 9892d768-2d13-450f-aac7-ed0e44c2585f

Default value:

@@ -484,7 +484,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0808.html b/docs/obs_3rd_party/python_sdk/obs_22_0808.html index 17af46ed6..e75147128 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0808.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0808.html @@ -1,6 +1,6 @@ -

Obtaining the Region of a Bucket (SDK for Python)

+

Obtaining the Region of a Bucket

Function

This API returns the region of a bucket.

Restrictions

  • To obtain the region of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketLocation in IAM or GetBucketLocation in a bucket policy).
@@ -42,8 +42,8 @@

Explanation:

Extension headers

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

LocationResponse

Explanation:

+

Explanation:

Response to the request for obtaining a bucket location

Explanation:

Extension headers

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

GetBucketStorageInfoResponse

Explanation:

+

Explanation:

Response result of the request for obtaining storage information about a bucket

Explanation:

Extension headers

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

GetBucketQuotaResponse

Explanation:

+

Explanation:

Response result of the request for obtaining the storage capacity quota of a bucket

Explanation:

Extension headers

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

-

Bucket ACL

+

Bucket ACL.

Value range:

See Table 1.

Default value:

@@ -58,9 +57,9 @@

No

Explanation:

-

Pre-defined ACL

+

Pre-defined ACL.

Value range:

-

See Table 3.

+

For details, see HeadPermission.

Default value:

None

NOTE:

acl and aclControl are mutually exclusive.

@@ -75,9 +74,9 @@

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Bucket owner information. For details, see Table 4.

-

Restrictions:

+

Restrictions:

Owner and Grants must be used together and they cannot be used with aclControl.

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

List of grantees' permission information. For details, see Table 5.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Whether the bucket ACL is applied to all objects in the bucket

-

Value range:

+

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -246,7 +245,7 @@

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Grantee information. For details, see Table 6.

Yes if used as a request parameter

Explanation:

+

Explanation:

Granted permission

-

Value range:

+

Value range:

You can select one or more permissions from Table 2.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Whether the bucket ACL is applied to all objects in the bucket

-

Value range:

+

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

Yes if the parameter is used as a request parameter and group is left blank

Explanation:

+

Explanation:

Account (domain) ID of the grantee.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

-

Username of the grantee. For details, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Restrictions:

+

Explanation:

+

Username of the grantee. For details, see How Do I Get My Account ID and IAM User ID?

+

Restrictions:

  • Cannot contain full-width characters.
  • Starts with a letter.
  • Contains 6 to 32 characters.
  • Contains only letters, digits, hyphens (-), and underscores (_).
-

Default value:

+

Default value:

None

Yes if the parameter is used as a request parameter and grantee_id is left blank

Explanation:

+

Explanation:

Authorized user group

-

Value range:

+

Value range:

See Table 7.

-

Default value:

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

ACL

Explanation:

-

Bucket ACL

+

Explanation:

+

ACL configuration of the bucket.

Yes if used as a request parameter

Explanation:

+

Explanation:

Bucket owner. For details, see Table 3.

Yes if used as a request parameter

Explanation:

+

Explanation:

Grantees' permission information. For details, see Table 4.

No if used as a request parameter

Explanation:

+

Explanation:

Whether the bucket ACL is applied to all objects in the bucket

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Grantee information. For details, see Table 5.

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Granted permission. For details, see Table 6.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Whether the bucket ACL is applied to all objects in the bucket

-

Value range:

+

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

Yes if the parameter is used as a request parameter and group is left blank

Explanation:

+

Explanation:

Account (domain) ID of the grantee.

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Username of the grantee.

-

Restrictions:

+

Restrictions:

  • Cannot contain full-width characters.
  • Starts with a letter.
  • Contains 6 to 32 characters.
  • Contains only letters, digits, hyphens (-), and underscores (_).
-

Default value:

+

Default value:

None

Yes if the parameter is used as a request parameter and grantee_id is left blank

Explanation:

+

Explanation:

Authorized user group

-

Value range:

+

Value range:

See Table 7.

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -563,7 +563,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0816.html b/docs/obs_3rd_party/python_sdk/obs_22_0816.html index 23c82f9cc..52f37e2e4 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0816.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0816.html @@ -1,6 +1,6 @@ -

Configuring Logging for a Bucket (SDK for Python)

+

Configuring Logging for a Bucket

Function

This API enables logging for a bucket (source) and configures another bucket (target) to store the log files. When a bucket is created, logging is not enabled by default. You can call this API to enable logging for the bucket. With logging enabled, a log message is generated for each operation on the bucket. Multiple log messages are packed into a file. The bucket for storing log files must be specified when logging is enabled. It can be the bucket logging is enabled for, or any other bucket you have access to. If you specify another bucket for storing logs, the bucket must be in the same region as the logged bucket. You can also configure access to log files and the name prefix of log files.

Restrictions

  • OBS creates log files and uploads them to the bucket. Before enabling logging for a bucket, you need to create an IAM agency to delegate OBS to upload log files to the specified bucket.
  • To configure logging for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketLogging in IAM or PutBucketLogging in a bucket policy).
@@ -54,8 +54,8 @@

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

+

Explanation:

Name of the bucket for storing log files

-

Restrictions:

-
  • This bucket must be in the same region as the bucket with logging enabled.
  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
    +

    Restrictions:

    +
    • This bucket must be in the same region as the bucket with logging enabled.
    • A bucket name must be unique across all accounts and regions.
    • A bucket name:
      • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
      • Cannot be formatted as an IP address.
      • Cannot start or end with a hyphen (-) or period (.).
      • Cannot contain two consecutive periods (..), for example, my..bucket.
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
    • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.
    -

    Default value:

    +

    Default value:

    None

No

Explanation:

+

Explanation:

Name prefix for log files stored in the log storage bucket

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Permission information list of grantees, which defines grantees and their permissions for log files. For details, see Table 2.

-

Default value:

+

Default value:

None

Yes when configuring bucket logging

Explanation:

+

Explanation:

Name of the IAM agency created by the owner of the target bucket for OBS.

You can select an existing IAM agency or create one.

-

Restrictions:

+

Restrictions:

By default, the IAM agency only requires the PutObject permission to upload logs to the target bucket. If default encryption is enabled for the target bucket, the agency also requires the KMS Administrator permission in the region where the target bucket is located.

-

Default value:

+

Default value:

None

Yes

Explanation:

+

Explanation:

Grantee information. For details, see Table 3.

Yes

Explanation:

+

Explanation:

Granted permission

-

Value range:

+

Value range:

See Table 4.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Whether the bucket ACL is applied to all objects in the bucket

-

Value range:

+

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

Yes if group is left blank.

Explanation:

+

Explanation:

Account (domain) ID of the grantee.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Username of the grantee.

-

Restrictions:

+

Restrictions:

  • Starts with a letter. Contains 6 to 32 characters.
  • Contains only letters, digits, hyphens (-), and underscores (_).
-

Default value:

+

Default value:

None

Yes if grantee_id is left blank.

Explanation:

+

Explanation:

Authorized user group

-

Value range:

+

Value range:

See Table 5.

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -324,7 +324,7 @@

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Logging

Explanation:

+

Explanation:

Logging configuration information

No if used as a request parameter

Explanation:

+

Explanation:

Name of the bucket for storing log files

-

Restrictions:

-
  • This bucket must be in the same region as the bucket with logging enabled.
  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
    +

    Restrictions:

    +
    • This bucket must be in the same region as the bucket with logging enabled.
    • A bucket name must be unique across all accounts and regions.
    • A bucket name:
      • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
      • Cannot be formatted as an IP address.
      • Cannot start or end with a hyphen (-) or period (.).
      • Cannot contain two consecutive periods (..), for example, my..bucket.
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
    • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.
    -

    Default value:

    +

    Default value:

    None

No if used as a request parameter

Explanation:

+

Explanation:

Name prefix for log files stored in the log storage bucket

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Permission information list of grantees, which defines grantees and their permissions for log files. For details, see Table 3.

-

Default value:

+

Default value:

None

Yes if the parameter is in a request to enable bucket logging

Explanation:

+

Explanation:

Name of the IAM agency created by the owner of the target bucket for OBS.

You can select an existing IAM agency or create one.

-

Restrictions:

+

Restrictions:

By default, the IAM agency only requires the PutObject permission to upload logs to the target bucket. If default encryption is enabled for the target bucket, the agency also requires the KMS Administrator permission in the region where the target bucket is located.

-

Default value:

+

Default value:

None

Grantee

Explanation:

+

Explanation:

Grantee information. For details, see Table 4.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Granted permission

-

Value range:

+

Value range:

See Table 6.

-

Default value:

+

Default value:

None

bool

Explanation:

+

Explanation:

Whether the bucket ACL is applied to all objects in the bucket

-

Value range:

+

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

str

Explanation:

+

Explanation:

Account (domain) ID of the grantee.

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

str

Explanation:

+

Explanation:

Account name of the grantee.

-

Restrictions:

+

Restrictions:

  • Starts with a letter. Contains 6 to 32 characters.
  • Contains only letters, digits, hyphens (-), and underscores (_).
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Authorized user group. For details, see Table 5.

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -526,7 +526,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0818.html b/docs/obs_3rd_party/python_sdk/obs_22_0818.html index 53ecfd51c..8ba4ef003 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0818.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0818.html @@ -1,6 +1,6 @@ -

Configuring a Bucket Policy (SDK for Python)

+

Configuring a Bucket Policy

Function

OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control can be implemented using IAM permissions, bucket policies, and ACLs.

A bucket policy is applied to a configured bucket and the objects in it. You can use a bucket policy to grant permissions for the bucket and the objects in it to IAM users or other accounts. If you want IAM users to have different permissions for different buckets, you can configure required bucket policies.

This API configures a policy for a bucket.

@@ -58,8 +58,8 @@

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Policy

Explanation:

+

Explanation:

Bucket policy

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

List of lifecycle rules. For details, see Table 1.

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

Explanation:

List of lifecycle rules. For details, see Table 2.

-

Default value:

+

Default value:

None

Explanation:

Object name prefix. It identifies the objects the rule applies to. You can leave this parameter blank to apply the rule to all objects in the bucket.

Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you set Prefix to ExampleObject.jpg, the rule applies to object ExampleObject.jpg only. If you set Prefix to logs/, the rule applies to the three objects with name starting with logs/. If you leave Prefix blank, the rule applies to all objects in the bucket.

-

Value range:

+

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

Explanation:

Whether the rule is enabled

-

Value range:

+

Value range:

  • Enabled
  • Disabled
-

Default value:

+

Default value:

None

Explanation:

Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 3.

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Default value:

+

Default value:

None

Explanation:

Object expiration time. For details, see Table 4.

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Default value:

+

Default value:

None

Explanation:

Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 7.

-

Restrictions:

+

Restrictions:

  • This parameter applies only to noncurrent object versions.
  • Versioning is enabled (or suspended after being enabled) for the bucket.
  • This parameter is not available for parallel file systems.
-

Default value:

+

Default value:

None

Explanation:

Expiration time of noncurrent object versions. For details, see Table 8.

-

Restrictions:

+

Restrictions:

  • This parameter applies only to noncurrent object versions.
  • Versioning is enabled (or suspended after being enabled) for the bucket.
CAUTION:

This parameter is not available for parallel file systems.

-

Default value:

+

Default value:

None

Explanation:

Storage class of the object after transition

-

Restrictions:

+

Restrictions:

  • The Standard storage class is not supported.
  • Restrictions on storage class transitions:
    • Only transitions from the Standard storage class to the Warm storage class are supported. To transition objects from Warm to Standard, you must manually do it.
    • Only transitions from the Standard or Warm storage class to the Cold storage class are supported. To transition objects from Cold to Standard or Warm, you must restore the objects first and then manually transition their storage class.
    • Multi-AZ redundancy is not available for Cold storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Cold storage class based on a lifecycle rule.
-

Value range:

+

Value range:

See Table 5.

Default value:

None

@@ -248,10 +248,10 @@

Explanation:

OBS executes the lifecycle rule for objects that were modified before the specified date.

-

Restrictions:

+

Restrictions:

The value must conform with the ISO8601 standards and indicate UTC 00:00. For example, 2018-01-01T00:00:00.000Z indicates only objects that were last modified before the specified time are transitioned to the specified storage class.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

Explanation:

Number of days (since the last update was made to the object) after which the lifecycle rule takes effect

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

Explanation:

OBS executes the lifecycle rule for objects that were modified before the specified date.

-

Restrictions:

+

Restrictions:

The value must conform with the ISO8601 standards and indicate UTC 00:00. For example, 2018-01-01T00:00:00.000Z indicates only objects that were last modified before the specified time are deleted.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

Explanation:

Number of days (since the last update was made to the object) after which the lifecycle rule takes effect

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

Explanation:

Storage class of noncurrent object versions after transition

-

Restrictions:

+

Restrictions:

  • The Standard storage class is not supported.
  • Restrictions on storage class transitions:
    • Only transitions from the Standard storage class to the Warm storage class are supported. To transition objects from Warm to Standard, you must manually do it.
    • Only transitions from the Standard or Warm storage class to the Cold storage class are supported. To transition objects from Cold to Standard or Warm, you must restore the objects first and then manually transition their storage class.
    • Multi-AZ redundancy is not available for Cold storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Cold storage class based on a lifecycle rule.
-

Value range:

+

Value range:

See Table 5.

-

Default value:

+

Default value:

None

Explanation:

Number of days an object is noncurrent before the specified rule takes effect

-

Restrictions:

+

Restrictions:

This parameter applies only to noncurrent object versions.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

LifecycleResponse

Explanation:

+

Explanation:

Response to the request for obtaining the lifecycle configuration information of a bucket

-

Default value:

+

Default value:

None

Lifecycle

Explanation:

+

Explanation:

Bucket lifecycle configuration. For details, see Table 3.

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

List of lifecycle rules. For details, see Table 4.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Lifecycle rule ID

Value range:

The value must contain 1 to 255 characters.

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Object name prefix. It identifies the objects the rule applies to. You can leave this parameter blank to apply the rule to all objects in the bucket.

Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you set Prefix to ExampleObject.jpg, the rule applies to object ExampleObject.jpg only. If you set Prefix to logs/, the rule applies to the three objects with name starting with logs/. If you leave Prefix blank, the rule applies to all objects in the bucket.

-

Value range:

+

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Whether the rule is enabled

-

Value range:

+

Value range:

  • Enabled
  • Disabled
-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 5.

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Object expiration time. For details, see Table 7.

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 9.

-

Restrictions:

+

Restrictions:

  • This parameter applies only to noncurrent object versions.
  • Versioning is enabled (or suspended after being enabled) for the bucket.
  • This parameter is not available for parallel file systems.
-

Default value:

+

Default value:

None

No if used as a request parameter

Explanation:

+

Explanation:

Expiration time of noncurrent object versions. For details, see Table 10.

-

Restrictions:

+

Restrictions:

  • This parameter applies only to noncurrent object versions.
  • Versioning is enabled (or suspended after being enabled) for the bucket.
  • This parameter is not available for parallel file systems.
-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Storage class of the object after transition

-

Restrictions:

+

Restrictions:

  • The Standard storage class is not supported.
  • Restrictions on storage class transitions:
    • Only transitions from the Standard storage class to the Warm storage class are supported. To transition objects from Warm to Standard, you must manually do it.
    • Only transitions from the Standard or Warm storage class to the Cold storage class are supported. To transition objects from Cold to Standard or Warm, you must restore the objects first and then manually transition their storage class.
    • Multi-AZ redundancy is not available for Cold storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Cold storage class based on a lifecycle rule.
-

Value range:

+

Value range:

See Table 6.

-

Default value:

+

Default value:

None

Yes if the parameter is used as a request parameter and days is absent

Explanation:

+

Explanation:

Date when an object will be transitioned.

-

Restrictions:

+

Restrictions:

The value must conform with the ISO8601 standards and indicate UTC 00:00. For example, 2018-01-01T00:00:00.000Z indicates only objects that were last modified before the specified time are transitioned to the specified storage class.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

Yes if the parameter is used as a request parameter and date is absent

Explanation:

+

Explanation:

Number of days (since the last update was made to the object) after which the lifecycle rule takes effect

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

Yes if the parameter is used as a request parameter and days is absent

Explanation:

+

Explanation:

OBS executes the lifecycle rule for objects that were modified before the specified date.

-

Restrictions:

+

Restrictions:

The value must conform with the ISO8601 standards and indicate UTC 00:00. For example, 2018-01-01T00:00:00.000Z indicates only objects that were last modified before the specified time are deleted.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

Yes if the parameter is used as a request parameter and date is absent

Explanation:

+

Explanation:

Number of days (since the last update was made to the object) after which the lifecycle rule takes effect

-

Restrictions:

+

Restrictions:

This parameter applies only to the current object version.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Storage class of the object after transition

-

Restrictions:

+

Restrictions:

  • The Standard storage class is not supported.
  • Restrictions on storage class transitions:
    • Only transitions from the Standard storage class to the Warm storage class are supported. To transition objects from Warm to Standard, you must manually do it.
    • Only transitions from the Standard or Warm storage class to the Cold storage class are supported. To transition objects from Cold to Standard or Warm, you must restore the objects first and then manually transition their storage class.
    • Multi-AZ redundancy is not available for Cold storage. For this reason, buckets or objects with multi-AZ redundancy cannot be transitioned to the Cold storage class based on a lifecycle rule.
-

Value range:

+

Value range:

See Table 6.

Default value:

None

@@ -620,13 +620,13 @@

Yes if used as a request parameter

Explanation:

+

Explanation:

Number of days an object is noncurrent before the specified rule takes effect

-

Restrictions:

+

Restrictions:

This parameter applies only to noncurrent object versions.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Input parameters for configuring static website hosting. For details, see Table 1.

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

Explanation:

Redirection rules for all requests. For details, see Table 2.

-

Default value:

+

Default value:

None

Explanation:

Default page configuration. For details, see Table 3.

-

Default value:

+

Default value:

None

Explanation:

Error page configuration. For details, see Table 4.

-

Default value:

+

Default value:

None

Explanation:

List of routing rules. For details, see Table 5.

-

Default value:

+

Default value:

None

Explanation:

Details about the redirection. For details, see Table 7.

-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

WebsiteConfiguration

Explanation:

+

Explanation:

Website hosting settings of a bucket

No if used as a request parameter

Explanation:

+

Explanation:

Redirection rules for all requests. For details, see Table 3.

No if used as a request parameter

Explanation:

+

Explanation:

Default page configuration. For details, see Table 4.

No if used as a request parameter

Explanation:

+

Explanation:

Error page configuration. For details, see Table 5.

No if used as a request parameter

Explanation:

+

Explanation:

List of routing rules. For details, see Table 6.

No if used as a request parameter

Explanation:

+

Explanation:

Conditions that must be met for the specified redirect to apply

Value range:

See Table 7.

-

Default value:

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Details about the redirection. For details, see Table 8.

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Versioning status of the bucket

Value range:
  • Enabled
  • Suspended
-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

list of CorsRule

Explanation:

+

Explanation:

CORS rule list of the bucket. For details, see Table 2.

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

Yes if used as a request parameter

Explanation:

+

Explanation:

Bucket tag list. For details, see Table 2.

-

Restrictions:

+

Restrictions:

  • A bucket can have a maximum of 10 tags. Each tag can have only one pair of key values.
  • For the same bucket, tag keys must be unique, but tag values can be duplicated or left blank.
-

Default value:

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

TagInfo

Explanation:

+

Explanation:

Bucket tag configuration. For details, see Table 2.

Yes if used as a request parameter

Explanation:

+

Explanation:

Bucket tag list. For details, see Table 3.

-

Restrictions:

+

Restrictions:

  • A bucket can have a maximum of 10 tags. Each tag can have only one pair of key values.
  • For the same bucket, tag keys must be unique, but tag values can be duplicated or left blank.
-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Pre-defined access policy specified during object creation.

+

ACL that can be pre-defined during object creation

Value range:

-

See Table 3.

+

For details about the available options, see HeadPermission.

Default value:

None

No

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.

The request is redirected to object anotherPage.html in the same bucket:

location:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata location.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

Explanation:

Multipurpose Internet Mail Extensions (MIME) type of the object to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

+

See What Is Content-Type (MIME)?

Default value:

If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

See How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

See How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Granted permissions

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -694,7 +694,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Storage class of the object to be uploaded

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 4.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID. If versioning is enabled for the bucket, the object version ID will be returned.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ETag of an object, which is a base64-encoded 128-bit MD5 digest. ETag is the unique identifier of the object content. It can be used to determine whether the object content is changed. For example, if the ETag is A when an object is uploaded and is B when the object is downloaded, the object content is changed. The ETag reflects changes only to the contents of the object, not its metadata. An uploaded object or copied object has a unique ETag.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

SSE-KMS algorithm

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

Advanced Encryption Standard 256 (AES256)

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Full path to the object

-

Default value:

+

Default value:

None

Explanation:

Content of the object to be uploaded

-

Value range:

+

Value range:

NOTICE:
  • Streaming upload requires CONTENT to be a readable object that contains the READ attribute.
  • When uploading file streams, you must open files in RB or RB+ mode.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Pre-defined access policy specified during object creation.

+

ACL that can be pre-defined during object creation

Value range:

-

See Table 3.

+

For details about the available options, see HeadPermission.

Default value:

None

No

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.

The request is redirected to object anotherPage.html in the same bucket:

location:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata location.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

+

See What Is Content-Type (MIME)?

Default value:

If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.

No

Explanation:

+

Explanation:

Header for server-side encryption. For details, see Table 5 or Table 6.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Address (URL) to which a successfully answered request is redirected

  • If the value is valid and the request is successful, OBS returns status code 303. Location in the returned results contains SuccessActionRedirect as well as the bucket name, object name, and object ETag.
  • If the value is invalid, OBS ignores this parameter. In such case, Location in the returned results indicates the object address, and OBS returns a status code based on whether the operation succeeds or fails.
-

Default value:

+

Default value:

None

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Granted permissions

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -698,7 +698,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Storage class of the object

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 4.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID. If versioning is enabled for the bucket, the object version ID will be returned.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ETag of an object, which is a base64-encoded 128-bit MD5 digest. ETag is the unique identifier of the object content. It can be used to determine whether the object content is changed. For example, if the ETag is A when an object is uploaded and is B when the object is downloaded, the object content is changed. The ETag reflects changes only to the contents of the object, not its metadata. An uploaded object or copied object has a unique ETag.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

SSE-KMS algorithm

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Full path to the object

-

Default value:

+

Default value:

None

Explanation:

Callback function for obtaining the upload progress

-

Restrictions:

+

Restrictions:

The progress of a folder upload cannot be obtained.

-

Default value:

+

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress.

Upload progress callback only supports streaming, file-based, multipart, appendable, and resumable uploads.

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

+

Explanation:

Base64-encoded MD5 value of the data to be uploaded. It is used for the OBS server to verify data integrity.

-

Value range:

+

Value range:

Base64-encoded 128-bit MD5 value of the request body calculated according to RFC 1864

Example: n58IG6hfM7vqI4K0vnWpog==

-

Default value:

+

Default value:

None

No

Explanation:

-

Pre-defined access policy specified during object creation.

-

Value range:

-

See Table 3.

-

Default value:

+

Explanation:

+

ACL that can be pre-defined during object creation

+

Value range:

+

For details about the available options, see HeadPermission.

+

Default value:

None

No

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.

The request is redirected to object anotherPage.html in the same bucket:

location:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata location.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.

No

Explanation:

+

Explanation:

Size of the object to be uploaded

-

Restrictions:

+

Restrictions:

  • The object size in a single upload ranges from 0 to 5 GB.
  • To upload files larger than 5 GB, multipart uploads should be used.
-

Default value:

+

Default value:

If this parameter is not specified, OBS SDK for Python automatically calculates the size of the object.

No

Explanation:

+

Explanation:

Server-side encryption header

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Storage class of the object

-

Value range:

+

Value range:

See Table 4.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Address (URL) to which a successfully answered request is redirected

  • If the value is valid and the request is successful, OBS returns status code 303. Location in the returned results contains SuccessActionRedirect as well as the bucket name, object name, and object ETag.
  • If the value is invalid, OBS ignores this parameter. In such case, Location in the returned results indicates the object address, and OBS returns a status code based on whether the operation succeeds or fails.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

List of the extended permissions for the object to be uploaded

-

Value range:

+

Value range:

See Table 7.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Expiration time of the object (calculated from the latest modification time of the object). Expired objects are automatically deleted.

-

Restrictions:

+

Restrictions:

This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Granted permissions

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -570,7 +570,7 @@

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

- - @@ -724,11 +724,11 @@ - @@ -736,11 +736,11 @@ - @@ -748,13 +748,13 @@ - @@ -762,11 +762,11 @@ - @@ -774,14 +774,14 @@ - @@ -789,11 +789,11 @@ - @@ -801,11 +801,11 @@ - @@ -813,9 +813,9 @@ - @@ -1156,7 +1156,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0904.html b/docs/obs_3rd_party/python_sdk/obs_22_0904.html index 98655d3d7..128366001 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0904.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0904.html @@ -1,6 +1,6 @@ -

Uploading an Object - Append (SDK for Python)

+

Uploading an Object - Append

Function

This API uploads a file or folder to an existing OBS bucket. These files can be texts, images, videos, or any other type of files.

The AppendObject operation adds data to the end of an object in a specified bucket. If there is no object with the same key values in the bucket, a new object is created.

@@ -102,7 +102,7 @@

Callback function for obtaining the upload progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress.

@@ -127,11 +127,11 @@
- @@ -252,11 +252,11 @@ @@ -267,16 +267,16 @@ - @@ -289,8 +289,8 @@ - @@ -363,7 +363,7 @@ - @@ -570,7 +570,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -595,11 +595,11 @@ - @@ -609,9 +609,9 @@ - @@ -652,7 +652,7 @@ - @@ -787,7 +787,7 @@ @@ -824,11 +824,11 @@ - @@ -836,13 +836,13 @@ - @@ -850,11 +850,11 @@ - @@ -862,11 +862,11 @@ - @@ -874,14 +874,14 @@ - @@ -889,11 +889,11 @@ - @@ -901,11 +901,11 @@ - @@ -913,9 +913,9 @@ - @@ -1019,7 +1019,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0905.html b/docs/obs_3rd_party/python_sdk/obs_22_0905.html index 7943c1c32..ca3b6159a 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0905.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0905.html @@ -1,6 +1,6 @@ -

Uploading an Object - Resumable (SDK for Python)

+

Uploading an Object - Resumable

Function

The resumable upload is an encapsulated and enhanced version of the multipart upload used for dealing with possible upload failures of large files when the network connection is unstable or a program crashes. This API splits the file into multiple parts and uploads them individually. The upload result of each part is recorded in a checkpoint file in real time. A success message is returned only when all parts are uploaded. If any parts fail, an error message is returned telling you to call the API again to upload the failed parts. Since the checkpoint file contains the progress of each part, it saves you uploading all parts again in the event of an error.

Restrictions

  • To upload an object, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy).
  • The file uploaded by the resumable upload API must exceed 100 KB.
  • To obtain the progress of the last upload, you must enable resumable upload when you use this API.
@@ -110,7 +110,7 @@
@@ -179,11 +179,11 @@ - @@ -208,9 +208,9 @@ @@ -221,16 +221,16 @@ - @@ -243,7 +243,7 @@ @@ -282,10 +282,10 @@ - @@ -381,7 +381,7 @@ - @@ -502,7 +502,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -517,7 +517,7 @@ - @@ -527,11 +527,11 @@ - @@ -541,9 +541,9 @@ - @@ -584,7 +584,7 @@
Table 11 GetResult.body

GetResult.body Type

Description

+

Description

PutContentResponse

Explanation:

+

Explanation:

Response to the request for uploading an object. For details, see Table 12.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Storage class of the object

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 4.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID. If versioning is enabled for the bucket, the object version ID will be returned.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ETag of an object, which is a base64-encoded 128-bit MD5 digest. ETag is the unique identifier of the object content. It can be used to determine whether the object content is changed. For example, if the ETag is A when an object is uploaded and is B when the object is downloaded, the object content is changed. The ETag reflects changes only to the contents of the object, not its metadata. An uploaded object or copied object has a unique ETag.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

SSE-KMS algorithm

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Full path to the object

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Pre-defined access control policies, which can be specified in the append upload request.

-

Restrictions:

+

Pre-defined ACL, which can be specified in the append upload request.

+

Restrictions:

This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.

Value range:

-

See Table 4.

+

For details about the available options, see HeadPermission.

Default value:

None

No

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.

The request is redirected to object anotherPage.html in the same bucket:

location:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata location.

-

Restrictions:

+

Restrictions:

  • This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.
  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

Explanation:

MIME type of the object specified in the first append upload MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Restrictions:

+

See What Is Content-Type (MIME)?

+

Restrictions:

This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.

Default value:

If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.

@@ -320,7 +320,7 @@

Explanation:

Server-side encryption header

-

Restrictions:

+

Restrictions:

This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.

Default value:

None

@@ -334,7 +334,7 @@

Explanation:

Storage class of the object that can be specified in the append upload request

-

Restrictions:

+

Restrictions:

This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 5.
@@ -348,10 +348,10 @@

No

Explanation:

+

Explanation:

Address (URL) to which a successfully answered request is redirected

  • If the value is valid and the request is successful, OBS returns status code 303. Location in the returned results contains SuccessActionRedirect as well as the bucket name, object name, and object ETag.
  • If the value is invalid, OBS ignores this parameter. In such case, Location in the returned results indicates the object address, and OBS returns a status code based on whether the operation succeeds or fails.
-

Default value:

+

Default value:

None

Explanation:

List of extension permissions that can be specified in the append upload request

-

Restrictions:

+

Restrictions:

This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.

Value range:

See Table 8.

@@ -379,7 +379,7 @@

Explanation:

Lifecycle (starting from the last modification time of the object) that can be specified in the append upload request. Once the object expires, it is automatically deleted.

-

Restrictions:

+

Restrictions:

  • This parameter can only be configured in the first request for append upload. The configurations specified in the first request will be used in subsequent requests by default.
  • This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API.

Value range:

An integer greater than or equal to 0, in days

@@ -449,7 +449,7 @@

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Granted permissions

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -674,7 +674,7 @@

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Object storage class.

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 5.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ETag of an object, which is a base64-encoded 128-bit MD5 digest. ETag is the unique identifier of the object content. It can be used to determine whether the object content is changed. For example, if the ETag is A when an object is uploaded and is B when the object is downloaded, the object content is changed. The ETag reflects changes only to the contents of the object, not its metadata. An uploaded object or copied object has a unique ETag.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

Start position for next appending

-

Value range:

+

Value range:

An integer greater than or equal to 0, in bytes

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

SSE-KMS algorithm

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Full path to the object

-

Default value:

+

Default value:

None

Explanation:

Address of a file generated for recording the progress of a resumable upload. The file contains the information about parts and the upload progress.

-

Restrictions:

+

Restrictions:

This parameter is valid only for resumable uploads.

Default value:

If this parameter is left blank, the progress file will be in the same directory as the local file to be uploaded.

@@ -155,7 +155,7 @@

Callback function for obtaining the upload progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress.

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Pre-defined access policy specified during object creation.

+

ACL that can be pre-defined during object creation

Value range:

-

See Table 3.

+

For details about the available options, see HeadPermission.

Default value:

None

No

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.

The request is redirected to object anotherPage.html in the same bucket:

location:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata location.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

+

See What Is Content-Type (MIME)?

Default value:

If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.

No

Explanation:

+

Explanation:

Address (URL) to which a successfully answered request is redirected

  • If the value is valid and the request is successful, OBS returns status code 303. Location in the returned results contains SuccessActionRedirect as well as the bucket name, object name, and object ETag.
  • If the value is invalid, OBS ignores this parameter. In such case, Location in the returned results indicates the object address, and OBS returns a status code based on whether the operation succeeds or fails.
-

Default value:

+

Default value:

None

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

Description

Description

+

Description

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Granted permissions

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -600,13 +600,13 @@

Responses

- - @@ -719,7 +719,7 @@ @@ -836,7 +836,7 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -973,7 +973,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0906.html b/docs/obs_3rd_party/python_sdk/obs_22_0906.html index 9bfbce2ac..d8de05fee 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0906.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0906.html @@ -1,6 +1,6 @@ -

Obtaining the Upload Progress (SDK for Python)

+

Obtaining the Upload Progress

You can query the upload progress when uploading an object in streaming, file-based, multipart, appendable, or resumable mode.

This example configures a callback function to obtain the object upload progress.

Sample code is as follows:

@@ -102,7 +102,7 @@
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0907.html b/docs/obs_3rd_party/python_sdk/obs_22_0907.html index 6e9a1f6b8..649059f4d 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0907.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0907.html @@ -1,6 +1,6 @@ -

Uploading an Object - Browser-Based (SDK for Python)

+

Uploading an Object - Browser-Based

Function

This API uploads an object up to 5 GB to a specified bucket in HTML form. You can call ObsClient.createPostSignature to generate parameters for requesting a browser-based upload. For details, see the following:

  1. Call ObsClient.createPostSignature to generate request parameters for authentication.
  2. Prepare an HTML form.
  3. Enter the request parameters in the page.
  4. Select a local file and upload it in browser-based mode.

There are two request parameters generated for authentication:

@@ -101,7 +101,7 @@
@@ -109,10 +109,10 @@ - @@ -123,7 +123,7 @@ @@ -272,7 +272,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0908.html b/docs/obs_3rd_party/python_sdk/obs_22_0908.html index dfffddc73..b26bc1067 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0908.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0908.html @@ -1,7 +1,7 @@ -

Downloading an Object - Binary (SDK for Python)

-

Function

This API downloads an object in binary from OBS to your local computer.

+

Downloading an Object - Binary

+

Function

This API downloads a file using a stream from OBS to your local computer. If loadStreamInMemory is set to True, downloadpath will be invalid. The binary stream of the file will be downloaded to the local computer.

Restrictions

  • To download an object, you must be the bucket owner or have the required permission (obs:object:GetObject in IAM or GetObject in a bucket policy).
  • Objects in the Cold storage class can be downloaded only when they are restored.
@@ -69,7 +69,7 @@

Additional parameters of an object download request

Value range:

See Table 2.

-

Default value:

+

Default value:

None

@@ -83,7 +83,7 @@

Headers in the request used for obtaining the storage class, redundancy policy, and other basic information about the object

Value range:

See Table 3.

-

Default value:

+

Default value:

None

@@ -112,7 +112,7 @@

Callback function for obtaining the download progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress.

@@ -122,11 +122,11 @@
- @@ -360,7 +360,7 @@

Server-side decryption headers. For details, see Table 5.

Restrictions:

If the object uploaded to the server is encrypted on the server using the encryption key provided by the client, downloading the object requires including the encryption key in the message.

-

Default value:

+

Default value:

None

@@ -493,7 +493,7 @@ - @@ -606,7 +606,7 @@ @@ -643,9 +643,9 @@ - @@ -653,9 +653,9 @@ - @@ -663,11 +663,11 @@ - @@ -675,9 +675,9 @@ - @@ -685,11 +685,11 @@ - @@ -697,11 +697,11 @@ - @@ -709,11 +709,11 @@ - @@ -721,11 +721,11 @@ - @@ -733,12 +733,12 @@ - @@ -746,11 +746,11 @@ - @@ -758,13 +758,13 @@ - @@ -772,11 +772,11 @@ - @@ -784,9 +784,9 @@ - @@ -794,9 +794,9 @@ - @@ -804,9 +804,9 @@ - @@ -814,9 +814,9 @@ - @@ -824,11 +824,11 @@ - @@ -836,9 +836,9 @@ - @@ -846,11 +846,11 @@ - @@ -858,13 +858,13 @@ - @@ -872,11 +872,11 @@ - @@ -884,12 +884,12 @@ - @@ -897,9 +897,9 @@ - @@ -907,11 +907,11 @@ - @@ -919,14 +919,14 @@ - @@ -934,11 +934,11 @@ - @@ -946,11 +946,11 @@ - @@ -958,16 +958,16 @@ - @@ -1067,8 +1067,8 @@ try:bucketName="examplebucket"objectKey="objectname" - # If loadStreamInMemory is set to True, downloadpath will be invalid, and data streams will be downloaded to the memory. - # Download the object using streaming. + # If loadStreamInMemory is set to True, downloadpath will be invalid. The binary stream of the file will be downloaded to the memory. + #Download an object in a binary stream.resp=obsClient.getObject(bucketName=bucketName,objectKey=objectKey,loadStreamInMemory=True)# If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails.ifresp.status<300: @@ -1093,7 +1093,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0909.html b/docs/obs_3rd_party/python_sdk/obs_22_0909.html index d1cffc99a..4f1bf881f 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0909.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0909.html @@ -1,7 +1,7 @@ -

Downloading an Object - Streaming (SDK for Python)

-

Function

This API downloads an object using streaming from OBS to your local computer.

+

Downloading an Object - Streaming

+

Function

This API downloads a file using a stream from OBS to your local computer. If the object to be downloaded is too large or the download is expected to take a long time, you can use streams to download the object.

Restrictions

  • To download an object, you must be the bucket owner or have the required permission (obs:object:GetObject in IAM or GetObject in a bucket policy).
  • Objects in the Cold storage class can be downloaded only when they are restored.
@@ -69,7 +69,7 @@

Additional parameters of an object download request

Value range:

See Table 2.

-

Default value:

+

Default value:

None

@@ -83,7 +83,7 @@

Headers in the request used for obtaining the storage class, redundancy policy, and other basic information about the object

Value range:

See Table 3.

-

Default value:

+

Default value:

None

@@ -112,7 +112,7 @@

Callback function for obtaining the download progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress.

@@ -122,11 +122,11 @@
- @@ -252,9 +252,9 @@ @@ -360,7 +360,7 @@

Server-side decryption headers. For details, see Table 5.

Restrictions:

If the object uploaded to the server is encrypted on the server using the encryption key provided by the client, downloading the object requires including the encryption key in the message.

-

Default value:

+

Default value:

None

@@ -606,7 +606,7 @@ @@ -643,9 +643,9 @@ - @@ -653,9 +653,9 @@ - @@ -663,11 +663,11 @@ - @@ -675,9 +675,9 @@ - @@ -685,11 +685,11 @@ - @@ -697,11 +697,11 @@ - @@ -709,11 +709,11 @@ - @@ -721,11 +721,11 @@ - @@ -733,12 +733,12 @@ - @@ -746,11 +746,11 @@ - @@ -758,13 +758,13 @@ - @@ -772,11 +772,11 @@ - @@ -784,9 +784,9 @@ - @@ -794,9 +794,9 @@ - @@ -804,9 +804,9 @@ - @@ -814,9 +814,9 @@ - @@ -824,11 +824,11 @@ - @@ -836,9 +836,9 @@ - @@ -846,11 +846,11 @@ - @@ -858,13 +858,13 @@ - @@ -872,11 +872,11 @@ - @@ -884,12 +884,12 @@ - @@ -897,9 +897,9 @@ - @@ -907,11 +907,11 @@ - @@ -919,14 +919,14 @@ - @@ -934,11 +934,11 @@ - @@ -946,11 +946,11 @@ - @@ -958,16 +958,16 @@ - @@ -1107,7 +1107,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0910.html b/docs/obs_3rd_party/python_sdk/obs_22_0910.html index c148f6d17..b3ccb03ea 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0910.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0910.html @@ -1,6 +1,6 @@ -

Downloading an Object - File-Based (SDK for Python)

+

Downloading an Object - File-Based

Function

This API downloads an object as a file from OBS to your local computer.

Restrictions

  • To download an object, you must be the bucket owner or have the required permission (obs:object:GetObject in IAM or GetObject in a bucket policy).
  • Objects in the Cold storage class can be downloaded only when they are restored.
@@ -108,7 +108,7 @@

Callback function for obtaining the download progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress.

@@ -118,11 +118,11 @@
- @@ -230,7 +230,7 @@
Table 9 List of returned results

Type

Description

+

Description

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Value of Policy that is not encoded by Base64. This parameter can only be used for verification. For example:

{"expiration":"2023-09-12T12:52:59Z","conditions":[{"content-type":"text/plain"},{"bucket":"examplebucket"},{"key":"example/objectname"},]}"

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Value of Policy that is encoded by Base64. For example:

eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0xMlQxMjo1Mjo1OVoiLCJjb25kaXRpb25zIjpbeyJjb250ZW50LXR5cGUiOiJ0ZXh0L3BsYWluIn0seyJidWNrZXQiOiJleGFtcGxlYnVja2V0In0seyJrZXkiOiJleGFtcGxlL29iamVjdG5hbWUifSxdfQ==

-

Default value:

+

Default value:

None

Explanation:

signature in the form For example:

g0jQr4v9VWd1Q2FOFDG6LGfV9Cw=

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is left blank in the request, this parameter is returned and indicates a readable stream. You can read object content from it.

-

Default value:

+

Default value:

None

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the data stream in the memory.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the size of the data stream.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in bytes

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is not left blank, this parameter is returned and indicates the download path.

-

Default value:

+

Default value:

None

bool

Explanation:

+

Explanation:

Whether the deleted object is a delete marker

-

Value range:

+

Value range:

  • True: The deleted object is a delete marker.
  • False: The deleted object is not a delete marker.
-

Default value:

+

Default value:

False

str

Explanation:

+

Explanation:

Object storage class.

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 10.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin in the CORS rules is returned. AllowedOrigin indicates the origin from which the requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

AllowedMethod in the CORS rules of the bucket. It specifies the HTTP method of cross-origin requests, that is, the operation type of buckets and objects.

-

Value range:

+

Value range:

The following HTTP methods are supported:

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in seconds

-

Default value:

+

Default value:

100

int

Explanation:

+

Explanation:

Object size

-

Value range:

+

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Cache-Control header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Disposition header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Encoding header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Language header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

None

str

Explanation:

+

Explanation:

Expires header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Time when the last modification was made to the object

-

Restrictions:

+

Restrictions:

The time must be in the GMT format, for example, Wed, 25 Mar 2020 02:39:52 GMT.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Restore status of an object. This header is returned when a Cold object is being restored or has been restored.

For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored. expiry-date indicates when the restored object expires.

-

Restrictions:

+

Restrictions:

This parameter is only available for Cold objects.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Expiration details Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Objects are encrypted using SSE-KMS on the server side.

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL. This parameter specifies the address the request for the object is redirected to.

The request is redirected to object anotherPage.html in the same bucket:

WebsiteRedirectLocation:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

Explanation:

Download range. For example, 0-999 indicates the download range is from byte 1 to byte 1,000.

-

Value range:

+

Value range:

Value range: 0 to the object length minus 1. Format: x-y, indicating the range is from byte x+1 to byte y+1

-

Restrictions:

+

Restrictions:

The upper limit of range is the length of the object minus 1. If the specified value exceeds this limit, the length of the object minus 1 is used.

Default value:

None

@@ -298,7 +298,7 @@

Explanation:

The object is returned if it has been modified since the specified time; otherwise, an error is returned.

-

Restrictions:

+

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 4 to specify time.

For example, DateTime(year=2023, month=9, day=12)

Default value:

@@ -315,10 +315,10 @@

Explanation:

The object is returned if it has not been modified since the specified time; otherwise, an error is returned.

-

Restrictions:

+

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 4 to specify time.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is left blank in the request, this parameter is returned and indicates a readable stream. You can read object content from it.

-

Default value:

+

Default value:

None

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the data stream in the memory.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the size of the data stream.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in bytes

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is not left blank, this parameter is returned and indicates the download path.

-

Default value:

+

Default value:

None

bool

Explanation:

+

Explanation:

Whether the deleted object is a delete marker

-

Value range:

+

Value range:

  • True: The deleted object is a delete marker.
  • False: The deleted object is not a delete marker.
-

Default value:

+

Default value:

False

str

Explanation:

+

Explanation:

Object storage class.

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 10.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin specified in the CORS rules is returned. AllowedOrigin indicates the origin from which the requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader specified in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

AllowedMethod in the CORS rules of the bucket. It specifies the HTTP method of cross-origin requests, that is, the operation type of buckets and objects.

-

Value range:

+

Value range:

The following HTTP methods are supported:

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in seconds

-

Default value:

+

Default value:

100

int

Explanation:

+

Explanation:

Object size

-

Value range:

+

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Cache-Control header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Disposition header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Encoding header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Language header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

None

str

Explanation:

+

Explanation:

Expires header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Time when the last modification was made to the object

-

Restrictions:

+

Restrictions:

The time must be in the GMT format, for example, Wed, 25 Mar 2020 02:39:52 GMT.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Restore status of an object. This header is returned when a Cold object is being restored or has been restored.

For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored. expiry-date indicates when the restored object expires.

-

Restrictions:

+

Restrictions:

If the object is not in the Cold storage class, this parameter is left blank.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Expiration details. Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Objects are encrypted using SSE-KMS on the server side.

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL. This parameter specifies the address the request for the object is redirected to.

The request is redirected to object anotherPage.html in the same bucket:

WebsiteRedirectLocation:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None
-
Table 3 GetObjectHeader

Parameter

+
@@ -248,9 +248,9 @@ @@ -356,7 +356,7 @@

Server-side decryption headers. For details, see Table 5.

Restrictions:

If the object uploaded to the server is encrypted on the server using the encryption key provided by the client, downloading the object requires including the encryption key in the message.

-

Default value:

+

Default value:

None

@@ -602,7 +602,7 @@ @@ -627,7 +627,7 @@
Table 3 GetObjectHeader

Parameter

Type

Explanation:

Download range. For example, 0-999 indicates the download range is from byte 1 to byte 1,000.

-

Value range:

+

Value range:

Value range: 0 to the object length minus 1. Format: x-y, indicating the range is from byte x+1 to byte y+1

-

Restrictions:

+

Restrictions:

The upper limit of range is the length of the object minus 1. If the specified value exceeds this limit, the length of the object minus 1 is used.

Default value:

None

@@ -294,7 +294,7 @@

Explanation:

The object is returned if it has been modified since the specified time; otherwise, an error is returned.

-

Restrictions:

+

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 4 to specify time.

For example, DateTime(year=2023, month=9, day=12)

Default value:

@@ -311,10 +311,10 @@

Explanation:

The object is returned if it has not been modified since the specified time; otherwise, an error is returned.

-

Restrictions:

+

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 4 to specify time.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

-
Table 9 ObjectStream

Parameter

+
@@ -639,9 +639,9 @@ - @@ -649,9 +649,9 @@ - @@ -659,11 +659,11 @@ - @@ -671,9 +671,9 @@ - @@ -681,11 +681,11 @@ - @@ -693,11 +693,11 @@ - @@ -705,11 +705,11 @@ - @@ -717,11 +717,11 @@ - @@ -729,12 +729,12 @@ - @@ -742,11 +742,11 @@ - @@ -754,13 +754,13 @@ - @@ -768,11 +768,11 @@ - @@ -780,9 +780,9 @@ - @@ -790,9 +790,9 @@ - @@ -800,9 +800,9 @@ - @@ -810,9 +810,9 @@ - @@ -820,11 +820,11 @@ - @@ -832,9 +832,9 @@ - @@ -842,11 +842,11 @@ - @@ -854,13 +854,13 @@ - @@ -868,11 +868,11 @@ - @@ -880,12 +880,12 @@ - @@ -893,9 +893,9 @@ - @@ -903,11 +903,11 @@ - @@ -915,14 +915,14 @@ - @@ -930,11 +930,11 @@ - @@ -942,11 +942,11 @@ - @@ -954,16 +954,16 @@ - @@ -1099,7 +1099,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0911.html b/docs/obs_3rd_party/python_sdk/obs_22_0911.html index 48c4f310d..d11aa5254 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0911.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0911.html @@ -1,7 +1,7 @@ -

Downloading an Object - Range-Based (SDK for Python)

-

Function

This API downloads partial data of an object by specifying a range. If the specified range is from 0 to 1,000, data from byte 0 to byte 1,000, 1,001 bytes in total, are returned. If the specified range is invalid, data of the whole object is returned.

+

Downloading an Object - Range-Based

+

Function

This API downloads partial data of an object by specifying a range. If the specified range is from 0 to 1000, data from byte 0 to byte 1,000, 1,001 bytes in total, are returned. If the specified range is invalid, data of the whole object is returned.

Restrictions

  • To download an object, you must be the bucket owner or have the required permission (obs:object:GetObject in IAM or GetObject in a bucket policy).
  • Objects in the Cold storage class can be downloaded only when they are restored.
  • If the specified range is invalid (for example, the start or end position is set to a negative integer or the range is larger than the object length), the whole object is returned.
@@ -108,7 +108,7 @@

Callback function for obtaining the download progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress.

@@ -118,11 +118,11 @@
- @@ -247,11 +247,15 @@ @@ -356,7 +360,7 @@

Server-side decryption headers. For details, see Table 5.

Restrictions:

If the object uploaded to the server is encrypted on the server using the encryption key provided by the client, downloading the object requires including the encryption key in the message.

-

Default value:

+

Default value:

None

@@ -602,7 +606,7 @@ @@ -627,11 +631,11 @@
Table 9 ObjectStream

Parameter

Type

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is left blank in the request, this parameter is returned and indicates a readable stream. You can read object content from it.

-

Default value:

+

Default value:

None

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the data stream in the memory.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the size of the data stream.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in bytes

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is not left blank, this parameter is returned and indicates the download path.

-

Default value:

+

Default value:

None

bool

Explanation:

+

Explanation:

Whether the deleted object is a delete marker

-

Value range:

+

Value range:

  • True: The deleted object is a delete marker.
  • False: The deleted object is not a delete marker.
-

Default value:

+

Default value:

False

str

Explanation:

+

Explanation:

Object storage class.

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 10.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin specified in the CORS rules is returned. AllowedOrigin indicates the origin from which the requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader specified in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

AllowedMethod in the CORS rules of the bucket. It specifies the HTTP method of cross-origin requests, that is, the operation type of buckets and objects.

-

Value range:

+

Value range:

The following HTTP methods are supported:

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in seconds

-

Default value:

+

Default value:

100

int

Explanation:

+

Explanation:

Object size

-

Value range:

+

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Cache-Control header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Disposition header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Encoding header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Language header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

None

str

Explanation:

+

Explanation:

Expires header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Time when the last modification was made to the object

-

Restrictions:

+

Restrictions:

The time must be in the GMT format, for example, Wed, 25 Mar 2020 02:39:52 GMT.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Restore status of an object. This header is returned when a Cold object is being restored or has been restored.

For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored. expiry-date indicates when the restored object expires.

-

Restrictions:

+

Restrictions:

If the object is not in the Cold storage class, this parameter is left blank.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Expiration details. Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Objects are encrypted using SSE-KMS on the server side.

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL. This parameter specifies the address the request for the object is redirected to.

The request is redirected to object anotherPage.html in the same bucket:

WebsiteRedirectLocation:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Download range

+

The object content within the specified range is downloaded. If the range value is invalid, the entire object is downloaded.

Value range:

-

0 to the object length minus 1. Format: x-y

-

Restrictions:

The upper limit of range is the length of the object minus 1. If the specified value exceeds this limit, the length of the object minus 1 is used.

+

Restrictions:

+
  • The value of range ranges from 0 to the object size minus 1. The start value of range is mandatory. If only the start value is specified, the object content from the start value to the object size minus 1 is downloaded.

    bytes=byte_range

    +

    Example 1: bytes=0-4

    +

    Example 2: bytes=1024

    +

    Example 3: bytes=10-20,30-40 (multiple ranges)

    +
  • Even when the range header is included, the ETag value in the response still corresponds to the entire object, not just the specified range.

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

-
@@ -488,7 +488,7 @@
-
Parent topic: Other APIs (SDK for Python)
+
Parent topic: Other APIs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1304.html b/docs/obs_3rd_party/python_sdk/obs_22_1304.html index 1249f5ebf..8a79f5b18 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1304.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1304.html @@ -1,13 +1,13 @@ -

Static Website Hosting (SDK for Python)

+

Static Website Hosting

Function

This API uploads the files of the static website to your bucket in OBS as objects and configures the public-read permission on the files, and then configures the static website hosting mode for your bucket to host your static websites in OBS. After this, when third-party users access your websites, they actually access the objects in your bucket in OBS. When using static website hosting, you can configure request redirection to redirect specific or all requests.

Restrictions

  • To upload an object, you must have the obs:object:PutObject permission.

Uploading a Website File to a Bucket

1. Upload the website files to your bucket in OBS as objects and set the MIME type for the objects.

-

2. Set the ACL for the objects to public-read.

+

2. Set the object ACL to public read.

3. Access the objects using a browser.

This example uploads an HTML website file to a bucket and grants the public read permission for the object to implement static website hosting.

@@ -98,7 +98,7 @@ if resp.status < 300: print('Put File Succeeded') print('requestId:', resp.requestId) - # Set the object ACL to public-read. + # Set the object ACL to public read. resp2 = obsClient.setObjectAcl(bucketName, objectKey, aclControl=HeadPermission.PUBLIC_READ) if resp2.status < 300: print('Set Object Acl Succeeded') @@ -474,7 +474,7 @@
-
Parent topic: Other APIs (SDK for Python)
+
Parent topic: Other APIs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1305.html b/docs/obs_3rd_party/python_sdk/obs_22_1305.html index fe743c60b..ad0661a3b 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1305.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1305.html @@ -1,6 +1,6 @@ -

User-defined Header (SDK for Python)

+

User-defined Headers

Function

When calling an API, you can configure user-defined headers to meet specific needs. The SDK will automatically calculate the signature for the specified headers if needed.

Method:

You can add the specified headers in extensionHeaders in the dictionary format.

@@ -279,7 +279,7 @@
-
Parent topic: Other APIs (SDK for Python)
+
Parent topic: Other APIs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1500.html b/docs/obs_3rd_party/python_sdk/obs_22_1500.html index bec1afc19..dff1f39de 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1500.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1500.html @@ -1,14 +1,14 @@ -

Troubleshooting (SDK for Python)

+

Troubleshooting

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1501.html b/docs/obs_3rd_party/python_sdk/obs_22_1501.html index dfd7c264f..366b5284a 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1501.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1501.html @@ -1,6 +1,6 @@ -

HTTP Status Codes (SDK for Python)

+

HTTP Status Codes

The OBS server complies with the HTTP standard. After an API is called, the OBS server returns a standard HTTP status code. The following tables list the categories of HTTP status codes and the common HTTP status codes in OBS.

  • Categories of HTTP status codes
Table 9 ObjectStream

Parameter

+
- - @@ -639,7 +643,7 @@ - @@ -647,7 +651,7 @@ - @@ -655,9 +659,9 @@ - @@ -665,7 +669,7 @@ - @@ -673,11 +677,11 @@ - @@ -685,11 +689,11 @@ - @@ -697,11 +701,11 @@ - @@ -709,11 +713,11 @@ - @@ -721,12 +725,12 @@ - @@ -734,11 +738,11 @@ - @@ -746,13 +750,13 @@ - @@ -760,11 +764,11 @@ - @@ -772,9 +776,9 @@ - @@ -782,9 +786,9 @@ - @@ -792,9 +796,9 @@ - @@ -802,9 +806,9 @@ - @@ -812,11 +816,11 @@ - @@ -824,9 +828,9 @@ - @@ -834,11 +838,11 @@ - @@ -846,13 +850,13 @@ - @@ -860,11 +864,11 @@ - @@ -872,12 +876,12 @@ - @@ -885,9 +889,9 @@ - @@ -895,11 +899,11 @@ - @@ -907,14 +911,14 @@ - @@ -922,11 +926,11 @@ - @@ -934,11 +938,11 @@ - @@ -946,16 +950,16 @@ - @@ -999,7 +1003,7 @@
Table 9 ObjectStream

Parameter

Type

+

Type

Description

+

Description

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is left blank in the request, this parameter is returned and indicates a readable stream. You can read object content from it.

object

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the data stream in the memory.

int

Explanation:

+

Explanation:

If loadStreamInMemory is set to True in the request, this parameter is returned and indicates the size of the data stream.

-

Value range:

+

Value range:

0 to (263 – 1), in bytes

str

Explanation:

+

Explanation:

If loadStreamInMemory is set to False and downloadPath is not left blank, this parameter is returned and indicates the download path.

bool

Explanation:

+

Explanation:

Whether the deleted object is a delete marker

-

Value range:

+

Value range:

  • True: The deleted object is a delete marker.
  • False: The deleted object is not a delete marker.
-

Default value:

+

Default value:

False

str

Explanation:

+

Explanation:

Object storage class.

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 10.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin specified in the CORS rules is returned. AllowedOrigin indicates the origin from which the requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader specified in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

AllowedMethod in the CORS rules of the bucket. It specifies the HTTP method of cross-origin requests, that is, the operation type of buckets and objects.

-

Value range:

+

Value range:

The following HTTP methods are supported:

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

-

Value range:

+

Value range:

0 to (231 – 1), in seconds

-

Default value:

+

Default value:

100

int

Explanation:

+

Explanation:

Object size

-

Value range:

+

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Cache-Control header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Disposition header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Encoding header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Content-Language header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

None

str

Explanation:

+

Explanation:

Expires header in the response

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Time when the last modification was made to the object

-

Restrictions:

+

Restrictions:

The time must be in the GMT format, for example, Wed, 25 Mar 2020 02:39:52 GMT.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Restore status of an object. This header is returned when a Cold object is being restored or has been restored.

For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored. expiry-date indicates when the restored object expires.

-

Restrictions:

+

Restrictions:

If the object is not in the Cold storage class, this parameter is left blank.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Expiration details. Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Objects are encrypted using SSE-KMS on the server side.

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL. This parameter specifies the address the request for the object is redirected to.

The request is redirected to object anotherPage.html in the same bucket:

WebsiteRedirectLocation:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None
-

Code Examples

This example downloads part of object objectname by specifying a range from 0 to 1,000.

+

Code Examples

This example downloads part of object objectname by specifying a range from 0 to 1,000. You can also specify multiple ranges when obtaining the objectname object.

@@ -80,11 +80,11 @@ - @@ -109,11 +109,11 @@ - @@ -137,11 +137,11 @@ - @@ -155,7 +155,7 @@

Callback function for obtaining the download progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of downloaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Downloading an Object - Obtaining the Download Progress.

@@ -165,11 +165,11 @@
- @@ -193,13 +193,13 @@ - @@ -209,11 +209,11 @@ - @@ -223,11 +223,11 @@ - @@ -239,12 +239,12 @@ - @@ -256,12 +256,12 @@ - @@ -271,11 +271,11 @@ - @@ -285,11 +285,11 @@ - @@ -299,11 +299,11 @@ - @@ -436,7 +436,7 @@ - @@ -549,7 +549,7 @@ @@ -586,11 +586,11 @@ - @@ -598,11 +598,11 @@ - @@ -610,11 +610,11 @@ - @@ -622,12 +622,12 @@ - @@ -635,11 +635,11 @@ - @@ -647,13 +647,13 @@ - @@ -661,11 +661,11 @@ - @@ -673,11 +673,11 @@ - @@ -685,11 +685,11 @@ - @@ -697,13 +697,13 @@ - @@ -711,11 +711,11 @@ - @@ -723,12 +723,12 @@ - @@ -736,9 +736,9 @@ - @@ -746,11 +746,11 @@ - @@ -758,14 +758,14 @@ - @@ -773,11 +773,11 @@ - @@ -785,11 +785,11 @@ - @@ -797,16 +797,16 @@ - @@ -814,9 +814,9 @@ - - @@ -128,11 +128,11 @@ - @@ -161,7 +161,7 @@

Value range:

Base64-encoded 128-bit MD5 value of the request body calculated according to RFC 1864

Example: n58IG6hfM7vqI4K0vnWpog==

-

Default value:

+

Default value:

None

@@ -172,10 +172,10 @@ @@ -185,16 +185,16 @@ - @@ -206,9 +206,9 @@ @@ -222,7 +222,7 @@

Size of the object to be uploaded

Restrictions:

  • The object size in a single upload ranges from 0 to 5 GB.
  • To upload files larger than 5 GB, multipart uploads should be used.
-

Default value:

+

Default value:

If this parameter is not specified, OBS SDK for Python automatically calculates the size of the object.

@@ -234,9 +234,9 @@ - @@ -248,9 +248,9 @@ @@ -260,10 +260,10 @@ - @@ -291,9 +291,9 @@

Expiration time of the object (calculated from the latest modification time of the object). Expired objects are automatically deleted.

Restrictions:

This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in days

-

Default value:

+

Default value:

None

@@ -359,7 +359,7 @@ - @@ -480,7 +480,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -505,11 +505,11 @@ - @@ -519,9 +519,9 @@ - @@ -562,7 +562,7 @@ @@ -734,11 +734,11 @@ - @@ -746,11 +746,11 @@ - @@ -758,13 +758,13 @@ - @@ -772,11 +772,11 @@ - @@ -784,14 +784,14 @@ - @@ -799,11 +799,11 @@ - @@ -811,11 +811,11 @@ - @@ -823,9 +823,9 @@ - @@ -907,7 +907,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0917.html b/docs/obs_3rd_party/python_sdk/obs_22_0917.html index 7170b5595..93f33ce63 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0917.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0917.html @@ -1,9 +1,9 @@ -

Copying an Object (SDK for Python)

+

Copying an Object

Function

This API copies an object stored in OBS to another path, with a copy created during the process. You can create a copy of an object up to 5 GB in a single operation.

-

Restrictions

  • To copy an object, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy).
  • The object copy request carries the information about the source bucket and object to be copied in the header field. The message body cannot be carried.
  • The target object size ranges from 0 to 5 GB. If the source object size exceeds 5 GB, you can only copy parts of the object by referring to APIs Related to Multipart Upload (SDK for Python).
+

Restrictions

  • To copy an object, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy).
  • The object copy request carries the information about the source bucket and object to be copied in the header field. The message body cannot be carried.
  • The target object size ranges from 0 to 5 GB. If the source object size exceeds 5 GB, you can only copy parts of the object by referring to APIs Related to Multipart Upload.

Method

ObsClient.copyObject(sourceBucketName, sourceObjectKey, destBucketName, destObjectKey, metadata, headers, versionId, extensionHeaders)
@@ -124,9 +124,9 @@
@@ -151,7 +151,7 @@ @@ -338,7 +338,7 @@ @@ -400,7 +400,7 @@ 
 1
  2
  3
@@ -1039,7 +1043,8 @@
 37
 38
 39
-40
from obs import GetObjectHeader
+40
+41
from obs import GetObjectHeader
 from obs import ObsClient
 import os
 import traceback
@@ -1059,7 +1064,8 @@
 try:
     # Specify the additional headers of the request for downloading an object.
     headers = GetObjectHeader()
-    # Specify the range (0-1000 as an example) of the object bytes to be returned.
+    # Specify the range (0-1000 in this example) of the object bytes to be returned.
+    # You can specify multiple ranges when obtaining an object. For example, headers.range='0-1000,2000-3000'.
     headers.range = '0-1000'
     bucketName = "examplebucket"
     objectKey = "objectname"
@@ -1087,7 +1093,7 @@
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0912.html b/docs/obs_3rd_party/python_sdk/obs_22_0912.html index fc70b3fa4..f2a554106 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0912.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0912.html @@ -1,6 +1,6 @@ -

Downloading an Object - Resumable (SDK for Python)

+

Downloading an Object - Resumable

Function

Downloading large files often fails due to unstable network or program breakdown. It is a waste of resources to download files again. Moreover, the restarted download may still fail due to an unstable network. To resolve such issues, the resumable download API splits the file to be downloaded into multiple parts and downloads them separately. The download result of each part is recorded in a checkpoint file in real time. Only when all parts are downloaded is a message indicating the download is successful returned. If any parts fail to be downloaded, a message is returned telling you to call the API again to download the failed parts. Since the checkpoint file contains the progress of all parts, it helps you avoid downloading all parts in re-downloads, so that you can enjoy a cost-effective, efficient download.

Restrictions

  • To download an object, you must be the bucket owner or have the required permission (obs:object:GetObject in IAM or GetObject in a bucket policy).
  • The resumable download is an encapsulated and enhanced version of partial download.
  • This API saves resources and improves efficiency upon the re-download, and speeds up the download process by concurrently downloading parts. You do not need to worry about internal service details, such as the creation and deletion of checkpoint files, division of objects, or concurrent downloads of parts.
@@ -68,9 +68,9 @@

Explanation:

Part size

-

Value range:

+

Value range:

The value must be greater than 0 but less than the object size, in bytes.

-

Default value:

+

Default value:

5MB

No

Explanation:

+

Explanation:

Maximum number of parts that can be downloaded concurrently in a multipart download

-

Value range:

+

Value range:

The value must be greater than 0 but not exceed the result of the file size divided by the part size (rounded up).

-

Default value:

+

Default value:

1, indicating concurrent downloads are not used.

No

Explanation:

+

Explanation:

Path of a file generated for recording the progress of a resumable download. The file contains the information about parts and progress.

-

Restrictions:

+

Restrictions:

This parameter is valid only for resumable uploads.

-

Default value:

+

Default value:

If this parameter is left blank, the checkpoint file will be saved in the current directory.

No

Explanation:

+

Explanation:

Object version ID, for example, G001117FCE89978B0000401205D5DC9

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None. If this parameter is left blank, the latest version of the object is obtained.

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

+

Explanation:

Download range. For example, 0-999 indicates the download range is from byte 1 to byte 1,000.

-

Value range:

+

Value range:

Value range: 0 to the object length minus 1. Format: x-y, indicating the range is from byte x+1 to byte y+1

-

Restrictions:

+

Restrictions:

The upper limit of range is the length of the object minus 1. If the specified value exceeds this limit, the length of the object minus 1 is used.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Preset ETag. If the ETag of the object to be downloaded is the same as the preset ETag, the object is returned. Otherwise, an error is returned.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Preset ETag. If the ETag of the object to be downloaded is different from the preset ETag, the object is returned. Otherwise, an error is returned.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

The object is returned if it has been modified since the specified time; otherwise, an error is returned.

-

Restrictions:

+

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 3 to specify time.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

The object is returned if it has not been modified since the specified time; otherwise, an error is returned.

-

Restrictions:

+

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 3 to specify time.

For example, DateTime(year=2023, month=9, day=12)

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Origin of the cross-domain request specified by the preflight request. Generally, it is a domain name.

-

Restrictions:

+

Restrictions:

Each origin can contain only one wildcard character (*).

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

HTTP headers in a cross-origin request Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Server-side decryption headers. For details, see Table 4.

-

Restrictions:

+

Restrictions:

If the object uploaded to the server is encrypted on the server using the encryption key provided by the client, downloading the object requires including the encryption key in the message.

-

Default value:

+

Default value:

None

GetResult

Explanation:

+

Explanation:

SDK common results

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Object storage class.

-

Value range:

+

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 9.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin specified in the CORS rules is returned. AllowedOrigin indicates the origin from which the requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader specified in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain only one wildcard character (*). Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

AllowedMethod in the CORS rules of the bucket. It specifies the HTTP method of cross-origin requests, that is, the operation type of buckets and objects.

-

Value range:

+

Value range:

The following HTTP methods are supported:

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

int

Explanation:

+

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

-

Value range:

+

Value range:

An integer greater than or equal to 0, in seconds

-

Default value:

+

Default value:

100

int

Explanation:

+

Explanation:

Object size

-

Value range:

+

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MIME type of the object to be downloaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

None

str

Explanation:

+

Explanation:

Time when the last modification was made to the object

-

Restrictions:

+

Restrictions:

The time must be in the GMT format, for example, Wed, 25 Mar 2020 02:39:52 GMT.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Restore status of an object. This header is returned when a Cold object is being restored or has been restored.

For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored. expiry-date indicates when the restored object expires.

-

Restrictions:

+

Restrictions:

This parameter is only available for Cold objects.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Expiration details. Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

SSE-KMS is used for encrypting objects on the server side.

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL. This parameter specifies the address the request for the object is redirected to.

The request is redirected to object anotherPage.html in the same bucket:

WebsiteRedirectLocation:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

bool

Explanation:

+

Explanation:

Whether the object is appendable

-

Value range:

+

Value range:

True: The object is appendable.

False: The object is not appendable.

Default value:

@@ -827,9 +827,9 @@

int

Explanation:

+

Explanation:

Start position for next appending

-

Value range:

+

Value range:

0 to the object length, in bytes.

Default value:

None

@@ -965,7 +965,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0913.html b/docs/obs_3rd_party/python_sdk/obs_22_0913.html index 6adddf6ac..e1ea79836 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0913.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0913.html @@ -1,6 +1,6 @@ -

Downloading an Object - Obtaining the Download Progress (SDK for Python)

+

Downloading an Object - Obtaining the Download Progress

You can obtain the download progress when downloading an object in binary, streaming, file-based, or resumable mode.

This example returns the object download progress.

Sample code is as follows:

@@ -104,7 +104,7 @@
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0915.html b/docs/obs_3rd_party/python_sdk/obs_22_0915.html index 7aacd3d46..e41d08767 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0915.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0915.html @@ -1,6 +1,6 @@ -

Uploading an Object - Creating a Folder (SDK for Python)

+

Uploading an Object - Creating a Folder

Function

This API creates a folder in an existing bucket to manage data in OBS.

OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. To create a folder in OBS is essentially to create an object whose size is 0 and whose name ends with a slash (/). Such objects are no different from other objects (you can perform normal operations on them such as download and delete), except that they are displayed as folders in OBS console.

@@ -102,7 +102,7 @@

Callback function for obtaining the upload progress

Default value:

None

-
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).

+
NOTE:

This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress.

Streaming uploads, file-based uploads, multipart uploads, appendable uploads, and resumable uploads are supported.

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Pre-defined access policy specified during object creation.

-

Value range:

-

See Table 3.

-

Default value:

+

ACL that can be pre-defined during object creation

+

Value range:

+

For details about the available options, see HeadPermission.

+

Default value:

None

No

Explanation:

+

Explanation:

If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.

The request is redirected to object anotherPage.html in the same bucket:

location:/anotherPage.html

The request is redirected to an external URL http://www.example.com/:

location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata location.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

-

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

Value range:

+

See What Is Content-Type (MIME)?

+

Default value:

If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.

No

Explanation:

+

Explanation:

Header for server-side encryption. For details, see Table 5 or Table 6.

-

Default value:

+

Default value:

None

Explanation:

Storage class of the object

-

Value range:

+

Value range:

See Table 4.

-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Address (URL) to which a successfully answered request is redirected

  • If the value is valid and the request is successful, OBS returns status code 303. Location in the returned results contains SuccessActionRedirect as well as the bucket name, object name, and object ETag.
  • If the value is invalid, OBS ignores this parameter. In such case, Location in the returned results indicates the object address, and OBS returns a status code based on whether the operation succeeds or fails.
-

Default value:

+

Default value:

None

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

No

Explanation:

+

Explanation:

Account (domain) ID of the grantee

-

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

-

Default value:

+

Value range:

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

+

Default value:

None

No

Explanation:

+

Explanation:

Granted permissions

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -697,7 +697,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

str

Explanation:

+

Explanation:

Storage class of the object

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 4.
-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Object version ID. If versioning is enabled for the bucket, the object version ID will be returned.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

-

Value range:

+

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

SSE-KMS algorithm

-

Value range:

+

Value range:

kms

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

ID of the KMS master key when SSE-KMS is used

-

Value range:

+

Value range:

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.

str

Explanation:

+

Explanation:

SSE-C algorithm

-

Value range:

+

Value range:

AES256

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

str

Explanation:

+

Explanation:

Full path to the object

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

No

Explanation:

-

Pre-defined access control policies, which can be specified when copying the object

+

ACL that can be pre-defined during object copying

Default value:

None

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

+

See What Is Content-Type (MIME)?

Default value:

None

-
Table 3 HeadPermission

Constant

+
@@ -458,7 +458,7 @@ - @@ -653,7 +653,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -681,7 +681,7 @@ @@ -734,7 +734,7 @@ @@ -975,7 +975,7 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -1122,7 +1122,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0918.html b/docs/obs_3rd_party/python_sdk/obs_22_0918.html index 36c721340..94912e962 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0918.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0918.html @@ -1,6 +1,6 @@ -

Deleting an Object (SDK for Python)

+

Deleting an Object

Function

This API deletes an object in the specified bucket to save space and costs.

Restrictions

  • To delete an object, you must be the bucket owner or have the required permission (obs:object:DeleteObject in IAM or DeleteObject in a bucket policy).
  • If versioning is not enabled for a bucket, deleted objects cannot be recovered.
@@ -43,7 +43,7 @@

Target object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -57,7 +57,7 @@

Object version ID, for example, G001117FCE89978B0000401205D5DC9

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None. If this parameter is left blank, the latest version of the object is deleted.

@@ -69,9 +69,9 @@ @@ -201,7 +201,7 @@ @@ -342,7 +342,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0919.html b/docs/obs_3rd_party/python_sdk/obs_22_0919.html index 45a3bf307..ad4981662 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0919.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0919.html @@ -1,6 +1,6 @@ -

Batch Deleting Objects (SDK for Python)

+

Batch Deleting Objects

Function

This API deletes objects in a batch from a specific bucket. Deleted objects cannot be restored.

OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. A folder you see on the console or other tools in OBS is essentially an object whose size is 0 and whose name ends with a slash (/). To delete a folder, you need to list all objects whose names are prefixed with the folder name and then call the batch deletion API.

In a batch delete operation, OBS concurrently deletes the specified objects and returns the deletion result of each object.

@@ -41,9 +41,9 @@
- @@ -56,8 +56,8 @@ @@ -85,7 +85,7 @@

Response mode to the request for deleting objects in a batch

Value range:

  • False: The detailed mode. Results of both successful and failed deletions are returned.
  • True: The quiet mode. Only results of failed deletions are returned.
-

Default value:

+

Default value:

False

@@ -97,7 +97,7 @@ @@ -269,7 +269,7 @@ @@ -508,7 +508,7 @@ except: diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0920.html b/docs/obs_3rd_party/python_sdk/obs_22_0920.html index 99766d24b..916b4b517 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0920.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0920.html @@ -1,6 +1,6 @@ -

Obtaining Object Metadata (SDK for Python)

+

Obtaining Object Metadata

Function

Object metadata is a set of name-value pairs that describe the object and is used for object management.

Currently, only the system-defined metadata can be obtained. System-defined metadata consists of system-controlled metadata and user-controlled metadata.

This API sends a HEAD request to obtain the metadata of an object in a specified bucket.

@@ -45,7 +45,7 @@

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -59,7 +59,7 @@

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

@@ -71,9 +71,9 @@ @@ -85,9 +85,9 @@ @@ -101,7 +101,7 @@

Header for server-side decryption

Value range:

For details, see Table 2.

-

Default value:

+

Default value:

None

@@ -113,9 +113,9 @@ @@ -287,7 +287,7 @@ @@ -312,7 +312,7 @@
Table 3 HeadPermission

Constant

Default Value

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

Explanation:

Account (domain) ID of the grantee

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -870,7 +870,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Yes

Explanation:

+

Explanation:

Request parameters of deleting objects in a batch For details, see Table 2.

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

Explanation:

List of objects to be deleted. For details, see Table 3.

-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Origin of the cross-domain request specified by the preflight request. Generally, it is a domain name.

-

Restrictions:

+

Restrictions:

You can configure one or more rules and use at most one wildcard character (*) in each rule. If you want to configure multiple rules, separate them using a line breaker.

-

Default value:

+

Default value:

None

Explanation:

HTTP headers in a cross-origin request Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

You can enter multiple allowed headers, with one separated from another using a line break. Each header can contain one wildcard character (*) at most. Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

-
Table 6 GetObjectMetadataResponse

Parameter

+
@@ -328,7 +328,7 @@

Object storage class.

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 7.
-

Default value:

+

Default value:

None

@@ -338,9 +338,9 @@ @@ -350,9 +350,9 @@ @@ -365,7 +365,7 @@

Value range:

The following HTTP methods are supported:

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE
-

Default value:

+

Default value:

None

@@ -375,9 +375,9 @@ @@ -387,11 +387,11 @@ @@ -403,7 +403,7 @@

Object size

Value range:

The value ranges from 0 TB to 48.8 TB, in bytes.

-

Default value:

+

Default value:

None

@@ -414,8 +414,8 @@ @@ -425,9 +425,9 @@ @@ -437,11 +437,11 @@ @@ -453,7 +453,7 @@

Object version ID.

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

@@ -464,9 +464,9 @@ @@ -476,7 +476,7 @@ @@ -488,7 +488,7 @@

SSE-KMS is used for encrypting objects on the server side.

Value range:

kms

-

Default value:

+

Default value:

None

@@ -502,8 +502,8 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- -

Default value:

+
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).
+

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system will create one and use it by default.
@@ -515,7 +515,7 @@

SSE-C algorithm

Value range:

AES256

-

Default value:

+

Default value:

None

@@ -525,9 +525,9 @@ @@ -542,9 +542,9 @@

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

@@ -695,7 +695,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0921.html b/docs/obs_3rd_party/python_sdk/obs_22_0921.html index 132570c89..c63c42150 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0921.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0921.html @@ -1,6 +1,6 @@ -

Modifying Object Metadata (SDK for Python)

+

Modifying Object Metadata

Function

Object metadata is a set of name-value pairs that describe the object and is used for object management.

Currently, only the system-defined metadata can be modified.

System-defined metadata consists of system-controlled metadata and user-controlled metadata. The kind of metadata like Last-Modified is controlled by the system and cannot be modified. However, the kind of metadata configured for objects such as ContentLanguage can be modified by calling APIs.

@@ -46,7 +46,7 @@

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -58,9 +58,9 @@
@@ -84,7 +84,7 @@

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

@@ -94,11 +94,11 @@ - @@ -127,7 +127,7 @@

Value range:

True: The metadata operation indicator is REPLACE. REPLACE uses the complete header carried in the current request to replace the original one and deletes the metadata that is not specified.

False: The metadata operation indicator is REPLACE_NEW. REPLACE_NEW replaces the metadata that already has a value, assigns a value to the metadata that does not have a value, and retains the metadata that is not specified.

-

Default value:

+

Default value:

False

@@ -144,9 +144,9 @@

The request is redirected to an external URL http://www.example.com/:

WebsiteRedirectLocation:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

-

Restrictions:

+

Restrictions:

  • The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
  • OBS only supports redirection for objects in the root directory of a bucket.
-

Default value:

+

Default value:

None

@@ -158,7 +158,7 @@ @@ -170,7 +170,7 @@ @@ -182,7 +182,7 @@ @@ -194,7 +194,7 @@ @@ -206,7 +206,7 @@ @@ -218,9 +218,9 @@ @@ -234,7 +234,7 @@

Storage classes

Value range:

See Table 3.

-

Default value:

+

Default value:

None

@@ -400,7 +400,7 @@ @@ -497,7 +497,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0922.html b/docs/obs_3rd_party/python_sdk/obs_22_0922.html index 461b1b83b..fed268f91 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0922.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0922.html @@ -1,11 +1,10 @@ -

Configuring an Object ACL (SDK for Python)

-

Function

OBS allows the control of access permissions for objects. By default, only object creators have the read and write permissions on the object. However, the creator can set a public access policy to assign the read permission to all other users. If an object is encrypted with SSE-KMS, the ACL configured for it is not in effect in the cross-tenant case.

-

You can set an access control policy when uploading an object or call an ACL API to modify or obtain the ACL of an existing object.

-

This API sets an ACL for an object in a specified bucket.

+

Configuring an Object ACL

+

Function

Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over resources when a bucket or object is created. That is, the bucket creator has full control over the bucket, and the object uploader has full control over the object. Other accounts do not have the permissions to access resources. If resource owners want to grant other accounts the read and write permissions on resources, they can use ACLs. ACLs grant permissions to accounts. After an account is granted permissions, both the account and its IAM users can access the resources. If an object is encrypted with SSE-KMS, the ACL configured for it is not in effect in the cross-tenant case.

+

-

Restrictions

  • To configure an object ACL, you must be the bucket owner or have the required permission (obs:object:PutObjectAcl in IAM or PutObjectAcl in a bucket policy).
  • An object can have a maximum of 100 policies in its ACL.
+

Restrictions

  • To configure an object ACL, you must be the bucket owner or have the required permission (obs:object:PutObjectAcl in IAM or PutObjectAcl in a bucket policy).
  • An object can have a maximum of 100 rules in its ACL.

Method

ObsClient.setObjectAcl(bucketName, objectKey, acl, versionId, aclControl, extensionHeaders)
@@ -45,7 +44,7 @@

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -56,10 +55,10 @@ @@ -73,7 +72,7 @@

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

@@ -84,8 +83,8 @@ @@ -97,9 +96,9 @@ @@ -127,9 +126,9 @@ @@ -141,9 +140,9 @@ @@ -158,7 +157,7 @@

Value range:

True: The bucket ACL is applied to objects in the bucket.

False: The bucket ACL is not applied to objects in the bucket.

-

Default value:

+

Default value:

False

@@ -224,7 +223,7 @@ - @@ -250,7 +249,7 @@ @@ -264,7 +263,7 @@ @@ -293,7 +292,7 @@

Grantee

Value range:

See Table 7.

-

Default value:

+

Default value:

None

@@ -307,7 +306,7 @@

Granted permission

Value range:

See Table 6.

-

Default value:

+

Default value:

None

@@ -322,7 +321,7 @@

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

@@ -362,7 +361,7 @@ @@ -408,9 +407,9 @@ @@ -424,7 +423,7 @@

Authorized user group

Value range:

See Table 8.

-

Default value:

+

Default value:

None

@@ -579,7 +578,7 @@ @@ -763,7 +762,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0923.html b/docs/obs_3rd_party/python_sdk/obs_22_0923.html index 5b77434a6..77bb1345e 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0923.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0923.html @@ -1,7 +1,8 @@ -

Obtaining an Object ACL (SDK for Python)

-

Function

This API returns the ACL of an object in a specified bucket.

+

Obtaining an Object ACL

+

Function

Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over resources when a bucket or object is created. That is, the bucket creator has full control over the bucket, and the object uploader has full control over the object. Other accounts do not have the permissions to access resources. If resource owners want to grant other accounts the read and write permissions on resources, they can use ACLs. ACLs grant permissions to accounts. After an account is granted permissions, both the account and its IAM users can access the resources.

+

This API obtains the ACL of an object in a specified bucket.

Restrictions

  • To obtain an object ACL, you must be the bucket owner or have the required permission (obs:object:GetObjectAcl in IAM or GetObjectAcl in a bucket policy).
  • To call this API, you must have the read permission on the ACL of the object.
@@ -43,7 +44,7 @@

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -57,7 +58,7 @@

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

@@ -69,9 +70,9 @@ @@ -201,7 +202,7 @@ @@ -219,8 +220,8 @@ @@ -246,9 +247,9 @@ @@ -260,7 +261,7 @@ @@ -275,7 +276,7 @@

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

@@ -302,7 +303,7 @@ @@ -316,7 +317,7 @@ @@ -343,7 +344,7 @@ @@ -357,7 +358,7 @@

Granted permission

Value range:

See Table 8.

-

Default value:

+

Default value:

None

@@ -372,7 +373,7 @@

Value range:

True: The bucket ACL is applied to all objects in the bucket.

False: The bucket ACL is not applied to all objects in the bucket.

-

Default value:

+

Default value:

False

@@ -412,7 +413,7 @@ @@ -458,9 +459,9 @@ @@ -474,7 +475,7 @@

Authorized user group

Value range:

See Table 10.

-

Default value:

+

Default value:

None

@@ -571,7 +572,7 @@ try:bucketName="examplebucket"objectKey="objectname" - # Obtain the object ACL. + # Obtain the ACL of an object in a specified bucket.resp=obsClient.getObjectAcl(bucketName,objectKey)# If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails. @@ -603,7 +604,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_0924.html b/docs/obs_3rd_party/python_sdk/obs_22_0924.html index b0636f158..6d9092289 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_0924.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_0924.html @@ -1,6 +1,6 @@ -

Restoring a Cold Object (SDK for Python)

+

Restoring a Cold Object

Function

To obtain the contents of an object in the Cold storage class, you need to restore the object first and then you can download it. After an object is restored, a copy of the object is saved in the Standard storage class. By doing so, the object in the Cold storage class and its copy in the Standard storage class co-exist in the bucket. The copy will be automatically deleted once its retention period expires.

This API is used to restore Cold objects in a specified bucket.

@@ -44,7 +44,7 @@

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.

Value range:

The value must contain 1 to 1,024 characters.

-

Default value:

+

Default value:

None

@@ -58,7 +58,7 @@

After an object is restored, a Standard copy of it is generated. This parameter specifies how long the Standard copy can be retained, that is, the validity period of the restored object.

Value range:

The value ranges from 1 to 30, in days.

-

Default value:

+

Default value:

None

@@ -72,7 +72,7 @@

Retrieval speed tiers. You can select a suitable tier based on your requirements for retrieval speed.

Value range:

See Table 2.

-

Default value:

+

Default value:

Standard

@@ -84,7 +84,7 @@
@@ -97,8 +97,8 @@ @@ -250,7 +250,7 @@ @@ -341,7 +341,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1000.html b/docs/obs_3rd_party/python_sdk/obs_22_1000.html index 834089fa2..96bde2c15 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1000.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1000.html @@ -1,24 +1,24 @@ -

APIs Related to Multipart Upload (SDK for Python)

+

APIs Related to Multipart Upload

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1001.html b/docs/obs_3rd_party/python_sdk/obs_22_1001.html index b911a98cb..5a781f5b8 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1001.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1001.html @@ -1,6 +1,6 @@ -

Multipart Upload Overview (SDK for Python)

+

Multipart Upload Overview

You can upload large files using multipart upload. Multipart upload is applicable to many scenarios, including:

  • Files to be uploaded are larger than 100 MB.
  • The network condition is poor. Connection to the OBS server is constantly down.
  • Sizes of files to be uploaded are uncertain.

@@ -147,11 +147,11 @@

Below lists other multipart upload operations:

- + diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1002.html b/docs/obs_3rd_party/python_sdk/obs_22_1002.html index b5dd54f30..ac137c70d 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1002.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1002.html @@ -1,6 +1,6 @@ -

Initiating a Multipart Upload (SDK for Python)

+

Initiating a Multipart Upload

Function

This API initiates a multipart upload and returns a globally unique upload ID. You can use the returned upload ID when you later upload, assemble, or list parts. A single object can be involved in multiple multipart uploads. Each multipart upload initiation request can contain additional headers such as acl, metadata, contentType, and encoding_type. These headers are recorded in the multipart upload metadata.

Restrictions

  • To initiate a multipart upload, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy).
  • After initiating a multipart upload and uploading one or more parts, you must assemble the parts or abort the multipart upload. Only after that can OBS stops billing you for storing the uploaded parts.
@@ -54,9 +54,9 @@
@@ -117,7 +117,7 @@ @@ -170,9 +170,9 @@ @@ -238,7 +238,7 @@ - @@ -359,7 +359,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -387,7 +387,7 @@ @@ -440,7 +440,7 @@ @@ -669,7 +669,7 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -803,7 +803,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1003.html b/docs/obs_3rd_party/python_sdk/obs_22_1003.html index c1137a264..f766505b7 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1003.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1003.html @@ -1,6 +1,6 @@ -

Uploading a Part (SDK for Python)

+

Uploading a Part

Function

After a multipart upload is initiated, this API uploads a part to a specified bucket. In the upload request, the multipart upload ID must be included. Except for the part lastly being uploaded whose size ranges from 0 to 5 GB, sizes of the other parts range from 100 KB to 5 GB. Part numbers can be any number from 1 to 10,000.

When uploading a part, you must specify its upload ID and part number. A part number uniquely identifies a part and its position in the object you are uploading. If you upload a new part with the same part number as that of a previous part, the previously uploaded part will be overwritten. Whenever you upload a part, OBS returns the ETag header in the response. For each part upload task, you must record the part number and ETag value. These values are required in subsequent requests for you to complete a multipart upload.

@@ -219,11 +219,11 @@
- @@ -395,7 +395,7 @@ @@ -462,7 +462,7 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -603,7 +603,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1004.html b/docs/obs_3rd_party/python_sdk/obs_22_1004.html index 02411fccc..cdad8fc81 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1004.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1004.html @@ -1,6 +1,6 @@ -

Listing Uploaded Parts (SDK for Python)

+

Listing Uploaded Parts

Function

This API lists the uploaded parts in a specified bucket. This request must contain the multipart upload ID.

You can list the uploaded parts of a specified multipart upload or of all ongoing multipart uploads. A maximum of 1,000 uploaded parts can be returned in a response. If your multipart upload has more than 1,000 parts, you need to send multiple requests to list all uploaded parts. Assembled parts will not be listed.

@@ -100,11 +100,11 @@
- @@ -234,7 +234,7 @@ @@ -497,7 +497,7 @@ @@ -511,7 +511,7 @@ @@ -690,7 +690,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1005.html b/docs/obs_3rd_party/python_sdk/obs_22_1005.html index 593dc39a4..d0381b6ca 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1005.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1005.html @@ -1,6 +1,6 @@ -

Listing Multipart Uploads (SDK for Python)

+

Listing Multipart Uploads

Function

This API lists ongoing multipart uploads.

Ongoing multipart uploads are the multipart uploads that have been initiated but have not been completed or aborted. A maximum of 1,000 multipart uploads can be returned in a response. If there are over 1,000 ongoing tasks satisfying the list criteria, you need to send more requests to query additional multipart uploads.

@@ -53,8 +53,8 @@
@@ -276,7 +276,7 @@ @@ -614,7 +614,7 @@ @@ -628,7 +628,7 @@ @@ -787,7 +787,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1006.html b/docs/obs_3rd_party/python_sdk/obs_22_1006.html index e5b8f3465..6a88ed3ab 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1006.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1006.html @@ -1,6 +1,6 @@ -

Assembling Parts (SDK for Python)

+

Assembling Parts

Function

This API assembles the uploaded parts to complete the multipart upload. Before performing this operation, you cannot download the uploaded data. When assembling parts, you need to copy the additional message header information recorded during the multipart upload initiation to the object metadata. Such information is processed the same way the information in a common object upload is processed. In the case of assembling parts concurrently, last write wins is applied, but the time of last write is defined as the time when a multipart upload was initiated.

As long as the multipart upload is not aborted, all uploaded parts occupy the space. However, after you assembled the specified parts, those uploaded but not assembled will be deleted to free up space.

When assembling parts, OBS creates an object by putting part numbers in ascending order. If any object metadata is provided in the initiation of the multipart upload, OBS will associate the metadata with the object. After the multipart upload is complete, the parts will no longer exist. A part assembling request must contain the upload ID, part numbers, and a list of corresponding ETag values. In response to the request, the ETag that uniquely identifies the assembled parts is contained. This ETag is not the MD5 hash value of the entire object.

@@ -83,9 +83,9 @@
@@ -281,7 +281,7 @@ @@ -398,7 +398,7 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -541,7 +541,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1007.html b/docs/obs_3rd_party/python_sdk/obs_22_1007.html index 4f5add866..bb5fefc70 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1007.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1007.html @@ -1,6 +1,6 @@ -

Copying a Part (SDK for Python)

+

Copying a Part

Function

This API copies a part to a specified bucket. This request must contain the multipart upload ID.

After creating a multipart upload, you can specify the upload ID and upload parts for the multipart upload. Alternatively, you can call this API to copy part or all of an uploaded object as a part.

Assume that you copy a source object and save it as part1. If there is already a part1 before the copy, the new part1 will overwrite the existing part1. Then, only the new part1 can be listed and the old part1 is deleted. Therefore, when using this API, ensure that the target part does not exist or is no longer used, to avoid accidental deletion. The source object keeps unchanged in the entire copy process.

@@ -138,9 +138,9 @@
@@ -226,7 +226,7 @@

The following two formats are supported:

  • regionID:domainID:key/key_id
  • key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -357,7 +357,7 @@ @@ -436,7 +436,7 @@

Valid value formats are as follows:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

- +
  • regionID indicates the ID of the region where the key is used.
  • domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID?
  • key_id indicates the ID of the key created on Data Encryption Workshop (DEW).

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, OBS will create one and use it by default.
@@ -563,7 +563,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1008.html b/docs/obs_3rd_party/python_sdk/obs_22_1008.html index 5c8e892ef..4267eace0 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1008.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1008.html @@ -1,6 +1,6 @@ -

Aborting a Multipart Upload (SDK for Python)

+

Aborting a Multipart Upload

Function

This API aborts a multipart upload using the multipart upload ID.

After a multipart upload is aborted, the upload ID cannot be used to upload any part. The storage occupied by any uploaded parts will be released. If any part uploads are in progress, aborting the multipart upload might or might not make the uploads successful. To release the storage occupied by all uploaded parts, you can only abort the multipart upload after all parts have been uploaded.

@@ -72,9 +72,9 @@
@@ -204,7 +204,7 @@ @@ -291,7 +291,7 @@ diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1009.html b/docs/obs_3rd_party/python_sdk/obs_22_1009.html index a70fbd279..a4edf5a59 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1009.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1009.html @@ -1,16 +1,13 @@ - -

Client-Side Encryption APIs (SDK for Python)

- -

+

Client-Side Encryption APIs

+

- diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1010.html b/docs/obs_3rd_party/python_sdk/obs_22_1010.html index d161e59fe..4f03d7c69 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1010.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1010.html @@ -1,6 +1,6 @@ -

Introduction (SDK for Python)

+

Overview

Client-side encryption is a process where data is encrypted using the selected encryption method and information on your local PC before it is transmitted to an OBS server. During this process, the encryption method used and necessary information required for decryption will be stored in object metadata. During a download, the OBS SDK decrypts the data based on the key provided and the information stored in object metadata, and then returns the decrypted data.

  • OBS does not store your master key in any way. Keep your master key correct and intact. If your master key is lost or mistakenly used, your data cannot be decrypted.
  • Do not modify the information required for decryption in object metadata when moving or replicating an encrypted object or modifying the object metadata. If you do so, your data cannot be decrypted.
@@ -167,7 +167,7 @@
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1011.html b/docs/obs_3rd_party/python_sdk/obs_22_1011.html index 51c912ecd..a4dc9e801 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1011.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1011.html @@ -1,6 +1,6 @@ -

Client-Side Encryption (SDK for Python)

+

Client-Side Encryption APIs

Initializing CryptoCipher

The OBS SDK for Python offers two types of CryptoCipher. Choose the one right for you.

CtrRSACipherGenerator needs an RSA public or private key to encrypt the randomly generated data key.

Method

@@ -140,7 +140,7 @@
Table 6 GetObjectMetadataResponse

Parameter

Type

Explanation:

If Origin in the request meets the CORS rules of the bucket, AllowedOrigin specified in the CORS rules is returned. AllowedOrigin indicates the origin from which requests can access the bucket.

-

Restrictions:

+

Restrictions:

Domain name of the origin. Each origin can contain only one wildcard character (*), for example, https://*.vbs.example.com.

-

Default value:

+

Default value:

None

Explanation:

If RequestHeader in the request meets the CORS rules of the bucket, AllowedHeader specified in the CORS rules is returned. AllowedHeader indicates the allowed headers for cross-origin requests. Only CORS requests matching the allowed headers are valid.

-

Restrictions:

+

Restrictions:

Each header can contain at most one wildcard character (*). Spaces, ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.

-

Default value:

+

Default value:

None

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies the CORS-allowed additional headers in the response. These headers provide additional information to clients. By default, your browser can only access headers Content-Length and Content-Type. If your browser needs to access other headers, add them to a list of the allowed additional headers.

-

Restrictions:

+

Restrictions:

Spaces, wildcard characters (*), ampersands (&), colons (:), and less-than signs (<) are not allowed.

-

Default value:

+

Default value:

None

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

-

Restrictions:

+

Restrictions:

Each CORS rule can contain only one MaxAgeSeconds.

Value range:

An integer greater than or equal to 0, in seconds

-

Default value:

+

Default value:

100

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

-

Default value:

+

See What Is Content-Type (MIME)?

+

Default value:

None

Explanation:

Time when the last modification was made to the object

-

Restrictions:

+

Restrictions:

The time must be in the GMT format, for example, Wed, 25 Mar 2020 02:39:52 GMT.

-

Default value:

+

Default value:

None

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

-

Restrictions:

+

Restrictions:

If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.

Value range:

The value must contain 32 characters.

-

Default value:

+

Default value:

None

Explanation:

Restore status of an object. This header is returned when a Cold object is being restored or has been restored.

For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored. expiry-date indicates when the restored object expires.

-

Restrictions:

+

Restrictions:

This parameter is only available for Cold objects.

-

Default value:

+

Default value:

None

Explanation:

Expiration details. Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

-

Default value:

+

Default value:

None

Explanation:

MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key.

-

Restrictions:

+

Restrictions:

The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

-

Default value:

+

Default value:

None

Explanation:

Custom metadata of the object. You can add a header starting with x-obs-meta- in the request to define metadata. The custom metadata will be returned in the response when you retrieve the object or query the object metadata.

-

Restrictions:

+

Restrictions:

  • The custom metadata cannot exceed 8 KB. To measure the custom metadata, sum the number of bytes in the UTF-8 encoding of each key and value.
  • The custom metadata keys are case insensitive, but are stored in lowercase in OBS. The key values are case sensitive.
  • Both custom metadata keys and their values must conform to US-ASCII standards. If non-ASCII or unrecognizable characters are required, they must be encoded and decoded in URL or Base64 on the client, because the server does not perform such operations.
-

Default value:

+

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

Explanation:

Cache-Control header in the response. It specifies the cache behavior of the web page when an object is downloaded.

-

Default value:

+

Default value:

None

Explanation:

Content-Disposition header in the response It specifies the name of an object when it is downloaded.

-

Default value:

+

Default value:

None

Explanation:

Content-Encoding header in the response It specifies the content encoding format when an object is downloaded.

-

Default value:

+

Default value:

None

Explanation:

Content-Language header in the response It specifies the content language format when an object is downloaded.

-

Default value:

+

Default value:

None

Explanation:

Content-Type header in the response. It specifies the file type of an object when it is downloaded.

-

Default value:

+

Default value:

None

Explanation:

Expires header in the response. It specifies the cache expiration time of the web page when the object is downloaded.

-
CAUTION:

This parameter cannot be used to configure the expiration time of an object. To configure the object expiration time, see Setting an Object Expiration Time (SDK for Python).

+
CAUTION:

This parameter cannot be used to configure the expiration time of an object. To configure the object expiration time, see Setting an Object Expiration Time.

-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

-

Access permissions on the object

+

ACL of an object.

Value range:

See Table 2.

-

Default value:

+

Default value:

None

No

Explanation:

-

Pre-defined ACL For details, see Table 3.

-

Default value:

+

Pre-defined ACL. For details, see Table 3.

+

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

Explanation:

Bucket owner For details, see Table 4.

-

Restrictions:

+

Restrictions:

Owner and Grants must be used together and they cannot be used with aclControl.

-

Default value:

+

Default value:

None

Explanation:

List of grantees' permission information. For details, see Table 5.

-

Restrictions:

+

Restrictions:

Owner and Grants must be used together and they cannot be used with aclControl.

-

Default value:

+

Default value:

None

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -396,7 +395,7 @@

Account (domain) ID of the grantee

Value range:

-

Default value:

+

Default value:

None

Explanation:

Account name of the grantee

-

Restrictions:

+

Restrictions:

  • Cannot contain full-width characters.
  • Starts with a letter.
  • Contains 6 to 32 characters.
  • Contains only letters, digits, hyphens (-), and underscores (_).
-

Default value:

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

ACL

Explanation:

-

Access permissions on the object. For details, see Table 5.

-

Default value:

+

Object ACL. For details, see ACL.

+

Default value:

None

Explanation:

Bucket owner. For details, see Table 6.

-

Restrictions:

+

Restrictions:

owner and grants must be used together and they cannot be used with ACL.

-

Default value:

+

Default value:

None

Explanation:

List of grantees' permission information. For details, see Table 7.

-

Default value:

+

Default value:

None

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Grantee information. For details, see Table 9.

-

Default value:

+

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -446,7 +447,7 @@

Account (domain) ID of the grantee

Value range:

-

Default value:

+

Default value:

None

Explanation:

Account name of the grantee

-

Restrictions:

+

Restrictions:

  • Cannot contain full-width characters.
  • Starts with a letter.
  • Contains 6 to 32 characters.
  • Contains only letters, digits, hyphens (-), and underscores (_).
-

Default value:

+

Default value:

None

Explanation:

Version ID of the Cold object to be restored

-

Default value:

+

Default value:

None. If this parameter is left blank, the latest version of the object is specified.

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

-

Access control list (ACL) that can be pre-defined when a bucket is created.

+

ACL that can be pre-defined when a bucket is created.

Value range:

-

See Table 2.

+

For details about the available options, see HeadPermission.

Default value:

PRIVATE

Explanation:

MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Value range:

-

See What Is Content-Type (MIME)? (Python SDK)

+

See What Is Content-Type (MIME)?

Default value:

If you do not specify this parameter when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to this parameter.

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

public-read-write-delivered

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

+

If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket owned by another user, the bucket owner does not have the permissions on your object. After you grant this permission to the bucket owner, the bucket owner can have full control over your object.

Explanation:

Account (domain) ID of the grantee

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Permission to modify ACL configurations

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for the bucket or object permanently.

-

A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.

+

A grantee with this permission can modify the ACL, thus obtaining full access permissions.

FULL_CONTROL

@@ -576,7 +576,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

No

Explanation:

+

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Extension headers.

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Account (domain) ID of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Account name of the owner

Value range:

-

To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

To obtain the account ID, see How Do I Get My Account ID and IAM User ID?

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Explanation:

Extension headers.

-

Value range:

-

See User-defined Header (SDK for Python).

-

Default value:

+

Value range:

+

See User-defined Headers.

+

Default value:

None

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None
-

Initializing CryptoClient

Initializing CryptoClient is inherited from initializing an ObsClient. For details, see Initializing an Instance of ObsClient (SDK for Python).

+

Initializing CryptoClient

Initializing CryptoClient is inherited from initializing an ObsClient. For details, see Initializing an Instance of ObsClient.

Method

CryptoClient(access_key_id,secret_access_key,server,cipher_generator=your-cipher_generator, *args, **kwargs)
@@ -200,7 +200,7 @@
-

Initiating an Encrypted Multipart Upload

Initiating an encrypted multipart upload is inherited from the ObsClient API for initiating a multipart upload. For details, see Initiating a Multipart Upload (SDK for Python).

+

Initiating an Encrypted Multipart Upload

Initiating an encrypted multipart upload is inherited from the ObsClient API for initiating a multipart upload. For details, see Initiating a Multipart Upload.

Method

CryptoClient.initiateEncryptedMultipartUpload(bucketName, objectKey, crypto_cipher, *args, **kwargs)
@@ -266,7 +266,7 @@
-

Uploading an Encrypted Part

Uploading encrypted parts is inherited from the ObsClient API for uploading parts. For details, see Uploading a Part (SDK for Python).

+

Uploading an Encrypted Part

Uploading encrypted parts is inherited from the ObsClient API for uploading parts. For details, see Uploading a Part.

Method

CryptoClient.initiateEncryptedMultipartUpload(bucketName, objectKey, partNumber, uploadId, crypto_cipher, *args, **kwargs)
@@ -364,7 +364,7 @@
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1300.html b/docs/obs_3rd_party/python_sdk/obs_22_1300.html index a391fffda..e639560bb 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1300.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1300.html @@ -1,18 +1,18 @@ -

Other APIs (SDK for Python)

+

Other APIs

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1301.html b/docs/obs_3rd_party/python_sdk/obs_22_1301.html index f7bdc0f27..49aabbb86 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1301.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1301.html @@ -1,6 +1,6 @@ -

Creating a Signed URL (SDK for Python)

+

Creating a Signed URL

Function

This API creates a URL whose Query parameters are carried with authentication information by specifying the AK and SK, HTTP method, and request parameters. You can provide other users with this URL for temporary access. When generating a URL, you need to specify the validity period of the URL to restrict the access duration of visitors.

If you want to grant other users the permission to perform other operations on buckets or objects (for example, upload or download objects), generate a URL with the corresponding request (for example, to upload an object using the URL that generates the PUT request) and provide the URL for other users.

@@ -340,7 +340,7 @@
-
Parent topic: Other APIs (SDK for Python)
+
Parent topic: Other APIs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1302.html b/docs/obs_3rd_party/python_sdk/obs_22_1302.html index 0ca664197..beab9bff0 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1302.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1302.html @@ -1,6 +1,6 @@ -

Generating Authentication Parameters for Browser-Based Uploads (SDK for Python)

+

Generating Authentication Parameters for Browser-Based Uploads

Function

This API generates parameters for authentication. The parameters can be used to perform a browser-based upload through POST operations.

There are two request parameters generated for authentication:

  • policy, which corresponds to the policy parameter in the form.
  • signature, which corresponds to the signature parameter in the form.
@@ -196,7 +196,7 @@
-
Parent topic: Other APIs (SDK for Python)
+
Parent topic: Other APIs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1303.html b/docs/obs_3rd_party/python_sdk/obs_22_1303.html index a26b9ad0c..7e5a2b8da 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1303.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1303.html @@ -1,6 +1,6 @@ -

Server-Side Encryption (SDK for Python)

+

Server-Side Encryption

Function

This API configures server-side encryption for objects, so that they will be encrypted or decrypted when you upload them to or download them from a bucket.

The encryption and decryption happen on the server side.

There are different encryption methods for you to choose from. Available encryption methods include server-side encryption with KMS-managed keys (SSE-KMS) and server-side encryption with customer-provided keys (SSE-C). Both of the two methods use the AES-256 algorithm.

@@ -208,7 +208,7 @@

object

Explanation:

-

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python).

+

Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs and Object-Related APIs.

Default value:

None

Category

@@ -109,7 +109,7 @@
-
Parent topic: Troubleshooting (SDK for Python)
+
Parent topic: Troubleshooting
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1502.html b/docs/obs_3rd_party/python_sdk/obs_22_1502.html index c57124cad..b9b35082f 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1502.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1502.html @@ -1,6 +1,6 @@ -

OBS Server-Side Error Codes (SDK for Python)

+

OBS Server-Side Error Codes

If the OBS server encounters an error when processing a request, a response containing the error code and error description is returned.

The following table lists details about each error and its HTTP status code.

@@ -723,7 +723,7 @@
-
Parent topic: Troubleshooting (SDK for Python)
+
Parent topic: Troubleshooting
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1503.html b/docs/obs_3rd_party/python_sdk/obs_22_1503.html index 28c7831cf..3f26dbc40 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1503.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1503.html @@ -1,6 +1,6 @@ -

Log Analysis (SDK for Python)

+

Log Analysis

Log Configuration

OBS Python SDK provides the logging function based on the Python log library. You can call ObsClient.initLog to enable and configure logging. Sample code is as follows:

# Import the module.
 from obs import LogConf
@@ -34,7 +34,7 @@ obsClient.initLog(LogConf('./log.conf'), 'obs_logger');
-
Parent topic: Troubleshooting (SDK for Python)
+
Parent topic: Troubleshooting
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1600.html b/docs/obs_3rd_party/python_sdk/obs_22_1600.html index e7bfea151..8f6b1570a 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1600.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1600.html @@ -1,22 +1,22 @@ -

FAQs (SDK for Python)

+

FAQs

diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1607.html b/docs/obs_3rd_party/python_sdk/obs_22_1607.html index 3e4841f3e..444ad4cd5 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1607.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1607.html @@ -1,12 +1,12 @@ -

How Do I Make an Object Accessible to Anonymous Users? (SDK for Python)

+

How Do I Make an Object Accessible to Anonymous Users?

To do this, perform the following steps:

-
  1. Set the object access permission to public-read by referring to Configuring an Object ACL (SDK for Python).
  2. Obtain the URL of the object by referring to How Do I Obtain an Object URL? (Python SDK) and provide it to anonymous users.
  3. An anonymous user can access the object by entering the URL on a browser.
+
  1. Set the object ACL to public read by referring to Configuring an Object ACL.
  2. Obtain the URL of the object by referring to How Do I Obtain an Object URL? and provide it to anonymous users.
  3. An anonymous user can access the object by entering the URL on a browser.
-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1609.html b/docs/obs_3rd_party/python_sdk/obs_22_1609.html index 8b59a53e9..e5f7ed6e5 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1609.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1609.html @@ -1,6 +1,6 @@ -

How Can I Obtain the AK and SK? (SDK for Python)

+

How Can I Obtain the AK and SK?

OBS employs access keys (AK and SK) for signature verification to ensure that only authorized accounts can access specified OBS resources. Detailed explanations of access keys are as follows:

  • AK is short for Access Key ID. One AK maps to only one user but one user can have multiple AKs. OBS authenticates users by their AKs.
  • SK is short for Secret Access Key, which is used to access OBS. You can generate authentication information based on SKs and request headers. An SK maps to an AK, and they group into a pair.

To create an AK and SK pair, perform the following steps:

@@ -9,7 +9,7 @@
-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1613.html b/docs/obs_3rd_party/python_sdk/obs_22_1613.html index f72153908..7eec68902 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1613.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1613.html @@ -1,6 +1,6 @@ -

How Do I Obtain an Object URL? (Python SDK)

+

How Do I Obtain an Object URL?

After setting an ACL to grant anonymous users the read permission for an object in a bucket, you can download this object using its URL. Methods to obtain the object URL are as follows:

Method 1: Query by calling the API. After an object is uploaded by calling ObsClient.putContent or ObsClient.putFile, PutContentResponse is returned. You can call objectUrl to obtain the URL of the uploaded object. Sample code is as follows:

# Import the module.
@@ -26,7 +26,7 @@ else:
-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1614.html b/docs/obs_3rd_party/python_sdk/obs_22_1614.html index 7e5762875..18278c7ab 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1614.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1614.html @@ -1,13 +1,13 @@ -

How Do I Improve the Uploading Speed of Large Files over the Public Network? (SDK for Python)

+

How Do I Improve the Uploading Speed of Large Files over the Public Network?

If a file exceeds 100 MB, you are advised to upload the file using multipart upload.

Multipart upload refers to splitting an object into multiple parts and uploading them separately. Each part is a contiguous portion of the object's data. You can upload parts in any sequence. A part can be reloaded after an upload failure, without affecting other parts. Uploading multiple parts of an object using multiple threads concurrently can greatly improve the transmission efficiency.

-

For details about the sample code, see APIs Related to Multipart Upload (SDK for Python).

+

For details about the sample code, see APIs Related to Multipart Upload.

-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1701.html b/docs/obs_3rd_party/python_sdk/obs_22_1701.html index a26b84b57..5fca8fbf1 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1701.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1701.html @@ -2,9 +2,9 @@

Change History

-

Release Date

+
- diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1702.html b/docs/obs_3rd_party/python_sdk/obs_22_1702.html index 4041e6624..c12fbf304 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1702.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1702.html @@ -1,6 +1,6 @@ -

What Is Content-Type (MIME)? (Python SDK)

+

What Is Content-Type (MIME)?

Multipurpose Internet Mail Extensions (MIME) type is a standard way of describing a data type. The MIME type is passed in the Content-Type header.

If you do not specify Content-Type when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to Content-Type.

@@ -1618,7 +1618,7 @@
-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1703.html b/docs/obs_3rd_party/python_sdk/obs_22_1703.html index e662c58fe..f0ab16a50 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1703.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1703.html @@ -1,6 +1,6 @@ -

How Do I Get My Account ID and IAM User ID? (SDK for Python)

+

How Do I Get My Account ID and IAM User ID?

Obtaining the Account ID and User ID

When calling APIs, you may need to specify the account ID (DomainID) and user ID (UserID) in some requests. You need to obtain them from the console in advance. To obtain them from the console, do as follows:

  1. Log in to the management console.
  2. Hover the mouse pointer over the username and choose My Credentials from the drop-down list.

    On the My Credentials page, view the account ID and user ID.

@@ -8,7 +8,7 @@
-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs
diff --git a/docs/obs_3rd_party/python_sdk/obs_22_1704.html b/docs/obs_3rd_party/python_sdk/obs_22_1704.html index 0e37ee737..07b10eb8e 100644 --- a/docs/obs_3rd_party/python_sdk/obs_22_1704.html +++ b/docs/obs_3rd_party/python_sdk/obs_22_1704.html @@ -1,6 +1,6 @@ -

Setting an Object Expiration Time (SDK for Python)

+

Setting an Object Expiration Time

This example sets the object expiration time using a header when uploading a file stream.

obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
 try:
@@ -70,7 +70,7 @@ except:
-
Parent topic: FAQs (SDK for Python)
+
Parent topic: FAQs

Release Date

What's New

+

What's New