diff --git a/doc/source/obs/index.rst b/doc/source/obs/index.rst deleted file mode 100644 index 8ec4f3d5..00000000 --- a/doc/source/obs/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -====================== -Object Storage Service -====================== - - -.. toctree:: - :maxdepth: 2 - - - api-reference-(s3)/index - api-reference-(swift)/index - user-guide/index \ No newline at end of file diff --git a/doc/source/obs/user-guide/access-keys-(ak-sk).md b/doc/source/obs/user-guide/access-keys-(ak-sk).md index 0024ba68..bae28bcc 100644 --- a/doc/source/obs/user-guide/access-keys-(ak-sk).md +++ b/doc/source/obs/user-guide/access-keys-(ak-sk).md @@ -13,7 +13,7 @@ You can create a pair of permanent AK and SK on the **My Credentials** page. **Temporary AK/SK Pair** -Temporary AK/SK and security token are temporary access tokens issued by the system to users. The validity period is between 15 minutes and 24 hours. Temporary AK/SK and security token comply with the least privilege principle and can be used to access OBS temporarily. Error code 403 is returned if an access request does not have the security token. +A temporary AK/SK pair and the security token are temporary access tokens granted by the system to users. The validity period of the tokens ranges from 15 minutes to 24 hours. After the tokens expire, you need to obtain the tokens again. A temporary AK/SK pair and the security token comply with the least privilege principle and can only be used to temporarily access OBS. A 403 error will be returned if the security token is not available. - Temporary AK: indicates the ID of a temporary access key. It is the unique ID associated with the SK. The AK and SK are used together to obtain an encrypted signature for a request. - Temporary SK: indicates the temporary private key used together with its associated temporary AK. The AK and SK are used together to identify a request sender to prevent the request from being modified. diff --git a/doc/source/obs/user-guide/accessing-an-object-using-its-object-url.md b/doc/source/obs/user-guide/accessing-an-object-using-its-object-url.md index 8b14d58e..3d06f741 100644 --- a/doc/source/obs/user-guide/accessing-an-object-using-its-object-url.md +++ b/doc/source/obs/user-guide/accessing-an-object-using-its-object-url.md @@ -4,7 +4,7 @@ The object uniform resource locator \(URL\) \(object sharing\) function allows a ## Prerequisites -An anonymous user has been assigned with the permission to read the specified object. For details, see [Authorizing Access Permissions to Anonymous Users](authorizing-access-permissions-to-anonymous-users.md). +An anonymous user has been assigned with the permission to read the specified object. For details, see [Configuring an Object ACL](configuring-an-object-acl.md). ## Procedure @@ -18,9 +18,9 @@ An anonymous user has been assigned with the permission to read the specified ob - If you select **Other object storage services** when logging in to OBS Browser, the object URL is in the format of https://_storage server IP address_ or _domain name_/_bucket name_/_directory level_/_object name_. If the object is in the root directory of the bucket, the URL does not contain a _directory level_. - If you select **OBS** when logging in to OBS Browser, the object URL is in the format of https://_bucket name.domain name_/_directory level_/_object name._ If the object is in the root directory of the bucket, the URL does not contain a _directory level_. - >![](/images/icon-note.gif) **NOTE:** - >To allow anonymous users to access objects stored in a bucket of Cold storage class using the URL, ensure that the objects are in the **Restored** state. - >The method of using a browser to access objects varies depending on the object type. You can directly open **.txt** and **.html** files using a browser. However, when you open **.exe** and **.dat** files using a browser, the files are automatically downloaded to your local computer. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >To allow anonymous users to access objects stored in a bucket of Cold storage class using the URL, ensure that the objects are in the **Restored** state. + >The method of using a browser to access objects varies depending on the object type. You can directly open **.txt** and **.html** files using a browser. However, when you open **.exe** and **.dat** files using a browser, the files are automatically downloaded to your local computer. 4. Click **Copy** to copy the URL of the object. 5. In the displayed dialog box, click **Close** to close the dialog box. diff --git a/doc/source/obs/user-guide/accessing-an-object-using-its-url.md b/doc/source/obs/user-guide/accessing-an-object-using-its-url.md index 0691aee9..a7c07890 100644 --- a/doc/source/obs/user-guide/accessing-an-object-using-its-url.md +++ b/doc/source/obs/user-guide/accessing-an-object-using-its-url.md @@ -4,14 +4,14 @@ If you set the permission for an object to allow anonymous users to read it, ano ## Prerequisites -A read permission has been set for anonymous users. For details about how to set the permission, see [Authorizing Access Permissions to Anonymous Users](authorizing-access-permissions-to-anonymous-users.md). +A read permission has been set for anonymous users. For details about how to enable the permission, see [Authorizing Access Permissions to Anonymous Users](authorizing-access-permissions-to-anonymous-users.md). ->![](/images/icon-note.gif) **NOTE:** ->Encrypted objects cannot be shared. +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Encrypted objects cannot be shared. ## Procedure -1. In the bucket list, click the bucket to be operated. The **Summary** page of the bucket is displayed. +1. In the bucket list, click the bucket to be operated. The **Overview** page of the bucket is displayed. 2. In the navigation pane on the left, click **Objects**. 3. Click the object to be shared. The object information is displayed on the top part of the page. The **Link** displays the shared link of the object. For details, see [Figure 1](#fig36534596192426). @@ -20,8 +20,8 @@ A read permission has been set for anonymous users. For details about how to set **Figure 1** Object link ![](figures/object-link.png "object-link") - >![](/images/icon-note.gif) **NOTE:** - >- To allow anonymous users to access objects whose storage classes are **Cold** using the URL, ensure that the objects are in the **Restored** state. - >- The method of using a browser to access objects varies depending on the object type. You can directly open **.txt** and **.html** files using a browser. However, when you open **.exe** and **.dat** files using a browser, the files are automatically downloaded to your local computer. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- To allow anonymous users to access objects whose storage classes are **Cold** using the URL, ensure that the objects are in the **Restored** state. + >- The method of using a browser to access objects varies depending on the object type. You can directly open **.txt** and **.html** files using a browser. However, when you open **.exe** and **.dat** files using a browser, the files are automatically downloaded to your local computer. diff --git a/doc/source/obs/user-guide/adding-a-bucket-(getting-started).md b/doc/source/obs/user-guide/adding-a-bucket-(getting-started).md index b6621cc9..480ed523 100644 --- a/doc/source/obs/user-guide/adding-a-bucket-(getting-started).md +++ b/doc/source/obs/user-guide/adding-a-bucket-(getting-started).md @@ -2,8 +2,8 @@ A bucket is a container that stores objects in OBS. Before you store data in OBS, you need to create a bucket first. ->![](/images/icon-note.gif) **NOTE:** ->On OBS Console, an account can have 100 buckets. +>![](public_sys-resources/icon-note.gif) **NOTE:** +>On OBS Console, an account can have 100 buckets. There is no such upper limit if you use the API or other methods to create buckets. However, these buckets also take up the bucket quota on OBS Console. ## Procedure diff --git a/doc/source/obs/user-guide/adding-a-bucket.md b/doc/source/obs/user-guide/adding-a-bucket.md index b88d5cd6..cf8cf545 100644 --- a/doc/source/obs/user-guide/adding-a-bucket.md +++ b/doc/source/obs/user-guide/adding-a-bucket.md @@ -2,8 +2,8 @@ Buckets are containers that store objects in OBS. Before you store data in OBS, you need to create buckets. ->![](/images/icon-note.gif) **NOTE:** ->On OBS Console, an account can have 100 buckets. +>![](public_sys-resources/icon-note.gif) **NOTE:** +>On OBS Console, an account can have 100 buckets. There is no such upper limit if you use the API or other methods to create buckets. However, these buckets also take up the bucket quota on OBS Console. ## Procedure @@ -49,10 +49,10 @@ Buckets are containers that store objects in OBS. Before you store data in OBS, - >![](/images/icon-note.gif) **NOTE:** - >- When a URL is used to access a bucket, the bucket name will become a part of the URL. According to the DNS rule, URLs do not support uppercase letters and cannot be used to access a bucket whose name contains uppercase letters. Therefore, a bucket name can contain only lowercase letters, digits, hyphens \(-\), and periods \(.\) For example, if you attempt to access bucket **MyBucket** using the URL, bucket **mybucket** will be accessed instead, causing an access error. - >- DNS naming can standardize the bucket naming globally, facilitating the resolution when accessing a bucket. Users can benefit from new functions and optimized features, and static website hosting is then applicable to buckets. - >- Once you create a bucket, you cannot change the name of it. Make sure that the bucket name you set is appropriate. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- When a URL is used to access a bucket, the bucket name will become a part of the URL. According to the DNS rule, URLs do not support uppercase letters and cannot be used to access a bucket whose name contains uppercase letters. Therefore, a bucket name can contain only lowercase letters, digits, hyphens \(-\), and periods \(.\) For example, if you attempt to access bucket **MyBucket** using the URL, bucket **mybucket** will be accessed instead, causing an access error. + >- DNS naming can standardize the bucket naming globally, facilitating the resolution when accessing a bucket. Users can benefit from new functions and optimized features, and static website hosting is then applicable to buckets. + >- Once you create a bucket, you cannot change the name of it. Make sure that the bucket name you set is appropriate. 4. Click **OK**. 5. In the displayed dialog box, click **Close** to close the dialog box. @@ -87,9 +87,9 @@ You can specify its storage class when creating a bucket or change its storage c 2. Select a bucket from the bucket list and click ![](figures/icon-write.png) on the right. The **Change Storage Class** dialog box is displayed. 3. Select the desired storage class and click **OK**. - >![](/images/icon-note.gif) **NOTE:** - >- Changing the storage class of a bucket does not change the storage class of existing objects in the bucket. - >- When uploading an object, you can select a storage class for the object, which is the same as the bucket storage class by default. If the bucket storage class changes, the default object storage class changes accordingly. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- Changing the storage class of a bucket does not change the storage class of existing objects in the bucket. + >- An object inherits the bucket storage class by default, if no other storage class is specified for the object upon its upload. When the bucket storage class is changed, newly uploaded objects inherit the new bucket storage class by default. 4. In the displayed dialog box, click **Close** to close the dialog box. diff --git a/doc/source/obs/user-guide/adding-external-buckets.md b/doc/source/obs/user-guide/adding-external-buckets.md index 7f438f95..a228d41d 100644 --- a/doc/source/obs/user-guide/adding-external-buckets.md +++ b/doc/source/obs/user-guide/adding-external-buckets.md @@ -8,9 +8,9 @@ You have obtained the permissions to read and write the external bucket that you For example: Account **A** wants to add bucket **testbucket** of account **B**. Account **B** must authorize account **A** the permission to read bucket **testbucket**. If account **A** needs to upload object to bucket **testbucket**, account **B** needs to authorize account **A** the permission to write the bucket. Account **A** is the owner of the uploaded objects, and needs to authorize account **B** the permission to read and write the objects. ->![](/images/icon-note.gif) **NOTE:** ->An external bucket \(version 3.0 or later\) can be added only when its standard bucket policy is set to **Public Read and Write**. ->If the standard bucket policy of an external bucket is set to **Public Read and Write** upon its creation, you need to manually change the standard bucket policy to **Private** and then change it back to **Public Read and Write** again, so that it can be added. +>![](public_sys-resources/icon-note.gif) **NOTE:** +>An external bucket \(version 3.0 or later\) can be added only when its standard bucket policy is set to **Public Read and Write**. +>If the standard bucket policy of an external bucket is set to **Public Read and Write** upon its creation, you need to manually change the standard bucket policy to **Private** and then change it back to **Public Read and Write** again, so that it can be added. ## Procedure diff --git a/doc/source/obs/user-guide/application-example-1-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md b/doc/source/obs/user-guide/application-example-1-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md index 3c42a778..fb867bbe 100644 --- a/doc/source/obs/user-guide/application-example-1-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md +++ b/doc/source/obs/user-guide/application-example-1-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md @@ -43,14 +43,14 @@ A bucket ACL can be used to grant the read and write access to a bucket. If only ## Procedure 1. Log in to OBS Console. -2. In the bucket list, click the bucket to be operated. The **Summary** page of the bucket is displayed. +2. In the bucket list, click the bucket to be operated. The **Overview** page of the bucket is displayed. 3. In the navigation pane on the left, click **Permissions** to go to the permission management page. 4. Click **Bucket ACL**. The **Bucket ACL** page is displayed. 5. Click **Add**, enter the account ID of the user that will add the bucket to OBS Browser, and select the read and write access to the bucket. - >![](/images/icon-note.gif) **NOTE:** - >If you want to authorize such access to all users, in the **Public Permissions** area, authorize the **Anonymous User** the read and write access to the bucket. - >**Account ID** corresponds to **Domain ID** on the **My Credential** page. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >If you want to authorize such access to all users, in the **Public Permissions** area, authorize the **Anonymous User** the read and write access to the bucket. + >**Account ID** corresponds to **Domain ID** on the **My Credential** page. 6. Click **Save**. diff --git a/doc/source/obs/user-guide/application-example-3-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md b/doc/source/obs/user-guide/application-example-3-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md index 2f6788b4..a11b56c1 100644 --- a/doc/source/obs/user-guide/application-example-3-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md +++ b/doc/source/obs/user-guide/application-example-3-authorizing-access-permissions-required-for-adding-an-external-bucket-through.md @@ -65,12 +65,12 @@ If a custom bucket policy is used to authorize such permissions, the ListBucket,

Policy Mode

-

Customized

+

Customized

Effect

-

Allow

+

Allow

Principal

@@ -80,12 +80,12 @@ If a custom bucket policy is used to authorize such permissions, the ListBucket,

Resources

- +

Actions

- + diff --git a/doc/source/obs/user-guide/application-example-configuring-smn-enabled-event-notification.md b/doc/source/obs/user-guide/application-example-configuring-smn-enabled-event-notification.md index d6dcbed4..983ca395 100644 --- a/doc/source/obs/user-guide/application-example-configuring-smn-enabled-event-notification.md +++ b/doc/source/obs/user-guide/application-example-configuring-smn-enabled-event-notification.md @@ -21,7 +21,7 @@ An enterprise has a large number of files to archive but it does not want to cos **Figure 2** Creating a folder ![](figures/creating-a-folder.png "creating-a-folder") -4. On the top navigation menu, click **Service List** \> **Simple Message Notification** to go to the SMN console and create an SMN topic. In the following example, **TestTopic** is the SMN topic and the notification method is email. +4. On the top navigation menu, click **Service List** \> **Simple Message Notification** to go to the SMN console and create an SMN topic. In the following example, **TestTopic** is the SMN topic and the notifications are sent by email. Use SMN to create a notification topic for OBS as follows: @@ -38,9 +38,9 @@ An enterprise has a large number of files to archive but it does not want to cos 3. Click **Create**. The **Create Event Notification** dialog box is displayed. 4. Configure the parameters. See [Figure 3](#fig377201314360) for details. For an enterprise account, the specified user in the account will be notified about all specified operations on the **SMN** folder in the **testbucket** bucket. For details about parameters, see [Table 1](configuring-smn-enabled-event-notification.md#aobs_console_0039_mmccppss_table01). - >![](/images/icon-note.gif) **NOTE:** - >- A folder path ends with a slash \(/\). Therefore, if you want to configure the event notification for operations on folders and you need to filter folders by suffix, the suffix must also end with a slash \(/\). - >- If neither the **Prefix** nor the **Suffix** is configured, the event notification rule applies to all objects in the bucket. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- A folder path ends with a slash \(/\). Therefore, if you want to configure the event notification for operations on folders and you need to filter folders by suffix, the suffix must also end with a slash \(/\). + >- If neither the **Prefix** nor the **Suffix** is configured, the event notification rule applies to all objects in the bucket. **Figure 3** Adding an event notification rule ![](figures/adding-an-event-notification-rule.png "adding-an-event-notification-rule") @@ -54,12 +54,15 @@ An enterprise has a large number of files to archive but it does not want to cos After the file is uploaded, an employee receives an email similar to the one shown in [Figure 4](#fig1183879515218). Keyword **ObjectCreated:Post** in the email indicates that the object is successfully uploaded. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >For details about each field in the notification content, see [SMN-Enabled Event Notification](smn-enabled-event-notification.md). + **Figure 4** Email details about the object uploading ![](figures/email-details-about-the-object-uploading.png "email-details-about-the-object-uploading") 3. Delete the **test.txt** file uploaded in [Step 2](#li38214839153354). - After the file is successfully deleted, an employee receives an email similar to the one shown in [Figure 5](#fig36929030152112). Keyword **ObjectRemoved:Delete** in the email indicates that the object is successfully deleted. + After the file is successfully deleted, an employee will receive an email similar to the one shown in [Figure 5](#fig36929030152112). Keyword **ObjectRemoved:Delete** in the email indicates that the object is successfully deleted. **Figure 5** Email details about the object deleting ![](figures/email-details-about-the-object-deleting.png "email-details-about-the-object-deleting") diff --git a/doc/source/obs/user-guide/bucket-acls-and-object-acls.md b/doc/source/obs/user-guide/bucket-acls-and-object-acls.md index 0994f1f9..dc6b7519 100644 --- a/doc/source/obs/user-guide/bucket-acls-and-object-acls.md +++ b/doc/source/obs/user-guide/bucket-acls-and-object-acls.md @@ -136,7 +136,7 @@ ACLs control the read and write permissions for accounts. ACL permission granula ->![](/images/icon-note.gif) **NOTE:** +>![](public_sys-resources/icon-note.gif) **NOTE:** >Every time you change the bucket or object access permission setting in an ACL, it overwrites the existing setting instead of adding a new access permission to the bucket or object. >Fragment management refers to the deletion of fragments. For the bucket owner and users who have the permission to initiate multipart tasks, deleting fragments is not restricted by bucket ACL settings. If a user has the permission to write, the user also has the permission to initiate multipart tasks. diff --git a/doc/source/obs/user-guide/bucket-policies-and-object-policies.md b/doc/source/obs/user-guide/bucket-policies-and-object-policies.md index 62f7da12..a8d99648 100644 --- a/doc/source/obs/user-guide/bucket-policies-and-object-policies.md +++ b/doc/source/obs/user-guide/bucket-policies-and-object-policies.md @@ -87,7 +87,7 @@ After a bucket is created, the default bucket policy is **Private**. Only the b ->![](/images/icon-note.gif) **NOTE:** +>![](public_sys-resources/icon-note.gif) **NOTE:** >For buckets whose version is 3.0, the default permissions of **Public Read** and **Public Read and Write** are updated to solve the problem that buckets fail to be added to OBS Browser due to permission limitations. >- Added the ListBucket permission to the **Public Read** policy. >- Added the ListBucket permission to the **Public Read and Write** policy. @@ -101,10 +101,10 @@ The following three modes are provided to facilitate quick configuration: - **Read and write**: With the **Read and write** mode, you only need to specify the **Principal** \(authorized users\). Then the authorized users have the full control permissions for the bucket and objects in the bucket, and can perform any operation on these resources. - **Customized**: With the **Customized** mode, you can define the specific operation permissions that you want to authorize to users and accounts by configuring the parameters of **Effect**, **Principal**, **Resources**, **Actions**, and **Conditions**. ->![](/images/icon-note.gif) **NOTE:** +>![](public_sys-resources/icon-note.gif) **NOTE:** >On OBS Console, when you use the custom bucket policy to authorize other users with resource operation permissions, you also need to authorize the users with the bucket read permission **ListBucket** \(leave the resource name blank to indicate that the policy takes effect on the entire bucket\). Otherwise, the users have no permission to access the bucket. ## Object Policy -An object policy applies to a specific object in a bucket, which can be a part of a bucket policy. A bucket policy implements such permission control over objects by configuring resources to which the bucket policy applies. The resources can be all objects in the bucket \(represented by an asterisk \*\) or objects with a shared name prefix. An object policy is directly configured for the selected object. +An object policy is a policy that applies to objects in a bucket. In a bucket policy, you can specify a set of objects as the resources to which the bucket policy applies, or you can use asterisk symbol \(\*\) to indicate all objects in the bucket. To configure an object policy, select an object, and then configure the object policy directly for the object. diff --git a/doc/source/obs/user-guide/configuring-a-bucket-acl-(console).md b/doc/source/obs/user-guide/configuring-a-bucket-acl-(console).md index 98d422e3..78a37451 100644 --- a/doc/source/obs/user-guide/configuring-a-bucket-acl-(console).md +++ b/doc/source/obs/user-guide/configuring-a-bucket-acl-(console).md @@ -4,8 +4,8 @@ 1. In the bucket list, click the bucket to be operated. The **Overview** page of the bucket is displayed. 2. In the navigation pane on the left, click **Permissions** to go to the permission management page. -3. In **Bucket ACL**, click **Edit** to set ACL permissions of the **Owner**, **Anonymous User**, **Registered User**, and **Log Delivery User** for the target bucket. -4. **Optional**: Click **Add** under **Bucket ACLs** to set the ACL permissions of a specific user. For details, see [Figure 1](#fig28074666202331). +3. In **Bucket ACL**, click **Edit** to set ACL permissions of the **Owner**, **Registered User**, **Anonymous User**, and **Log Delivery User** for the target bucket. +4. **Optional**: Click **Add** to set the ACL permissions of a specific user. For details, see [Figure 1](#fig28074666202331). Enter an account ID or account name and set ACL permissions for the account. You can obtain the account ID or account name on the **My Credentials** page. The account ID and account name correspond to the **Domain ID** and **Domain Name** respectively on the **My Credentials** page. diff --git a/doc/source/obs/user-guide/configuring-a-custom-bucket-policy-(common-mode).md b/doc/source/obs/user-guide/configuring-a-custom-bucket-policy-(common-mode).md index b70692f1..36aeca56 100644 --- a/doc/source/obs/user-guide/configuring-a-custom-bucket-policy-(common-mode).md +++ b/doc/source/obs/user-guide/configuring-a-custom-bucket-policy-(common-mode).md @@ -6,7 +6,7 @@ This topic describes how to configure a custom bucket policy in common mode \(GU ## Procedure -1. In the bucket list, click the bucket to be operated. The **Summary** page of the bucket is displayed. +1. In the bucket list, click the bucket to be operated. The **Overview** page of the bucket is displayed. 2. In the navigation pane on the left, click **Permissions** to go to the permission management page. 3. On the **Bucket Policies** tab page, configure a custom bucket policy according to your needs. @@ -18,8 +18,8 @@ This topic describes how to configure a custom bucket policy in common mode \(GU - **Read and write**: The authorized user will be granted with read and write permissions on the bucket and objects. For subsequent operations, see [5](#li3552175452220). - **Customized**: The authorized user will be granted with customized permissions on the bucket and objects. For detailed configuration, see [6](#li588503161565). - >![](/images/icon-note.gif) **NOTE:** - >Only one bucket policy mode can be configured at a time. + >![](public_sys-resources/icon-note.gif) **NOTE:** + >Only one bucket policy mode can be configured at a time. 5. For the read-only and read and write modes, enter information about the authorized user in the following format and click **OK**. @@ -39,7 +39,7 @@ This topic describes how to configure a custom bucket policy in common mode \(GU

Principal

-