2026-02-12
This issue is the third official release.
Updated Downloading and Installing obsutil by adding obsutil signature files.
diff --git a/docs/obs/tool-obsutil/obs_11_0001.html b/docs/obs/tool-obsutil/obs_11_0001.html index d3c0d059d..f69362ce9 100644 --- a/docs/obs/tool-obsutil/obs_11_0001.html +++ b/docs/obs/tool-obsutil/obs_11_0001.html @@ -62,9 +62,9 @@ -Command Line Structures
Below describes how to use commands in obsutil:
-- In Windows -
- In Linux or macOS
./obsutil command [parameters...] [options...]
+Command Line Structure
Below describes how to use commands in obsutil:
+- Windows +
- macOS or Linux
- command indicates the command to execute, for example, ls or cp.
- parameters indicates mandatory parameters, for example, the bucket name during bucket creation.
- options indicates optional parameters. They must start with a hyphen (-).
- Square brackets ([]) are not part of a command. Remove them before executing a specific command.
- You must escape special characters (including & < > and spaces) in a command using quotation marks. Single quotation marks are for Linux or macOS, and double quotation marks for Windows.
- You can pass additional parameters in the -key=value or -key value format, for example, -acl=private, or -acl private. Both formats are the same. Choose one as you like.
- In Windows, you can execute obsutil.exe to enter interactive mode. In this mode, you can run command [parameters...] [options...] where obsutil is not needed. Below gives an example:
Enter "exit" or "quit" to logout Enter "help" or "help command" to show help docs diff --git a/docs/obs/tool-obsutil/obs_11_0005.html b/docs/obs/tool-obsutil/obs_11_0005.html index 75f33a9af..5d14176e6 100644 --- a/docs/obs/tool-obsutil/obs_11_0005.html +++ b/docs/obs/tool-obsutil/obs_11_0005.html @@ -5,11 +5,11 @@
Prerequisites
- You have obtained the enabled regions and endpoints of OBS.
- You have obtained the AK/SK. For details, see Creating Access Keys (AK and SK).
obsutil Initialization Methods
Run the config command (for more information about config, see Updating a Configuration File):
-- In Windows
+
- Windows
obsutil config -i=xxxxx -k=xxxxx -e=xxxxx
Using a temporary AK/SK pair and a security token:
obsutil config -i=xxxxx -k=xxxxx -t=xxxxx -e=xxxxx
- - In Linux or macOS +
- macOS or Linux
./obsutil config -i=xxxxx -k=xxxx -e=xxxxx
Using a temporary AK/SK pair and a security token:
./obsutil config -i=xxxxx -k=xxxxx -t=xxxxx -e=xxxxx
@@ -54,8 +54,8 @@
- Windows
- After the command is executed, there will be the .obsutilconfig file created in the directory (~ in Linux or macOS or C:\Users\<username> in Windows) where obsutil commands run. This file contains all the configuration information of obsutil.
- For details about the parameters in the .obsutilconfig file, see Configuration Parameters.
- The .obsutilconfig file contains the AK/SK information, so it is hidden by default to prevent leakage. To query this file, run the following command in the directory where obsutil commands run.
- In Windows
dir
- - In Linux or macOS
ls -a
+ - After the command is executed, there will be the .obsutilconfig file created in the directory (~ in Linux or macOS or C:\Users\<username> in Windows) where obsutil commands run. This file contains all the configuration information of obsutil.
- For details about the parameters in the .obsutilconfig file, see Configuration Parameters.
- The .obsutilconfig file contains the AK/SK information, so it is hidden by default to prevent leakage. To query this file, run the following command in the directory where you execute obsutil commands.
- Windows
dir
+ - macOS or Linux
ls -a
or
ls -al
- Windows
- In Windows
Method 3: Initialize obsutil in interactive mode.
-- In Windows
Using a permanent AK/SK pair (you do not need to enter a token, and press Enter to skip it):
+- Windows
Using a permanent AK/SK pair (you do not need to enter a token, and just press Enter to skip it):
obsutil config -interactive Please input your ak: @@ -94,7 +94,7 @@ Config file url: C:\Users\tools\.obsutilconfig Update config file successfully!
- - In Linux or macOS
Using a permanent AK/SK pair (you do not need to enter a token, and press Enter to skip it):
+ - macOS or Linux
Using a permanent AK/SK pair (you do not need to enter a token, and press Enter to skip it):
./obsutil config -interactive Please input your ak: @@ -127,11 +127,11 @@ Config file url: Update config file successfully!
diff --git a/docs/obs/tool-obsutil/obs_11_0006.html b/docs/obs/tool-obsutil/obs_11_0006.html index 5764d92ec..12791d412 100644 --- a/docs/obs/tool-obsutil/obs_11_0006.html +++ b/docs/obs/tool-obsutil/obs_11_0006.html @@ -1,8 +1,8 @@Checking the Connectivity
After the initial configuration is complete, run the following command to check the connectivity:
-- In Windows
obsutil ls -s
- - In Linux or macOS
./obsutil ls -s
+- Windows
obsutil ls -s
+ - macOS or Linux
./obsutil ls -s
Check the command output:
-- If it contains "Bucket number", the configuration is correct.
- If it contains "Http status [403]", the access keys are wrong.
- If it contains "A connection attempt failed", OBS cannot be connected. Then, check the network condition.
- If it contains "Error: cloud_url [url] is not in well format", the domain name to be accessed is incorrect. Check the domain name in the configuration file.
- If it contains "Bucket number", the configuration is correct.
- If it contains "Http status [403]", the access keys may be incorrect.
- If it contains "A connection attempt failed", OBS cannot be connected. Then, check the network condition.
- If it contains "Error: cloud_url [url] is not in well format", the domain name to be accessed is incorrect. Check the domain name in the configuration file.
If the command output contains "Http status [403]", you may not have the required permissions for obtaining the bucket list. A further analysis is required to identify the root cause.
- Windows
Quick Start
-This section uses the Linux OS as an example to describe how to use obsutil to perform basic operations in OBS. For details, see .
-Prerequisites
- You have obtained obsutil and completed initial configuration.
- The directory saving obsutil is accessed.
This section uses Linux as an example to describe how to use obsutil to perform basic operations in OBS.
+Prerequisites
- You have obtained obsutil and completed initial configuration.
- You are in the directory where obsutil is located.
-Procedure
- Run the ./obsutil mb obs://bucket-test command to create a bucket named bucket-test in the region.
./obsutil mb obs://bucket-test diff --git a/docs/obs/tool-obsutil/obs_11_0008.html b/docs/obs/tool-obsutil/obs_11_0008.html index c382f32b2..6bb3acdc9 100644 --- a/docs/obs/tool-obsutil/obs_11_0008.html +++ b/docs/obs/tool-obsutil/obs_11_0008.html @@ -5,7 +5,7 @@
If you create a bucket and name it the same as an existing one in the same account and region, no error will be reported and status code 200 is returned. The bucket properties comply with those set in the first creation request. In other cases, creating a bucket with the same name as an existing one will receive the status code 409, indicating that the bucket already exists.
Command Line Structures
- Windows
obsutil mb obs://bucket [-fs] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx]
+diff --git a/docs/obs/tool-obsutil/obs_11_0009.html b/docs/obs/tool-obsutil/obs_11_0009.html index e7de30bc0..c3735a895 100644 --- a/docs/obs/tool-obsutil/obs_11_0009.html +++ b/docs/obs/tool-obsutil/obs_11_0009.html @@ -3,11 +3,11 @@Command Line Structure
- Windows
obsutil mb obs://bucket [-fs] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx]
- macOS or Linux
./obsutil mb obs://bucket [-fs] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx]
Listing Buckets
-Function
You can use this command to obtain the bucket list. In the list, bucket names are displayed in lexicographical order.
Command Line Structure
- In Windows
obsutil ls [-s] [-sc] [-du] [-fs] [-j=1] [-limit=1] [-config=xxx]
- - In Linux or macOS
./obsutil ls [-s] [-sc] [-du] [-fs] [-j=1] [-limit=1] [-config=xxx]
+-Command Line Structure
- Windows
obsutil ls [-s] [-sc] [-du] [-fs] [-j=1] [-limit=1] [-config=xxx]
+ - macOS or Linux
./obsutil ls [-s] [-sc] [-du] [-fs] [-j=1] [-limit=1] [-config=xxx]
Examples
- Take the Windows OS as an example. Run the obsutil ls -limit=5 command to obtain the bucket list.
obsutil ls -limit=5 +
Examples
- In Windows, run obsutil ls -limit=5 to obtain the bucket list.
obsutil ls -limit=5 Start at 2024-09-29 07:58:46.0506904 +0000 UTC Bucket CreationDate Location BucketType @@ -54,7 +54,7 @@ Bucket number : 5
Optional (additional parameter). It must be used together with sc.
The maximum number of concurrent tasks for querying the bucket storage class. The default value is the value of defaultJobs in the configuration file.
-NOTE:The value is ensured to be greater than or equal to 1.
+NOTE:The tool ensures that this value is at least 1.
- In Windows, run obsutil ls -limit=5 to obtain the bucket list.
- Windows
- Windows
- Windows
