Before using obsutil, you need to configure the interconnection between obsutil and OBS, including the endpoint and access keys (AK and SK) of OBS. You can use obsutil to perform operations on OBS buckets and objects only after obtaining the OBS authentication.
Prerequisites
- You have obtained the enabled regions and endpoints of OBS. For details, see Regions and Endpoints.
- You have obtained the access keys (AK and SK). For details about how to obtain access keys, see Creating Access Keys (AK and SK).
Configuration Method
Run the config command to initialize obsutil. For details about the config command, see Updating a Configuration File. The following is an example:
- In Windowsobsutil config -interactivePlease input your ak:xxxxxxxxxxxxxxxxxxxxxxxxxPlease input your sk:xxxxxxxxxxxxxxxxxxxxxxxxxPlease input your endpoint:xxxxxxxxxxxxxxxxxxxxxxxxxPlease input your token:Config file url:C:\Users\tools\.obsutilconfigUpdate config file successfully!
- In Linux OS or macOS./obsutil config -interactivePlease input your ak:xxxxxxxxxxxxxxxxxxxxxxxxxPlease input your sk:xxxxxxxxxxxxxxxxxxxxxxxxxPlease input your endpoint:xxxxxxxxxxxxxxxxxxxxxxxxxPlease input your token:Config file url:C:\Users\tools\.obsutilconfigUpdate config file successfully!
- After running the preceding commands, a configuration file .obsutilconfig is automatically generated in the same home directory of the user who executes obsutil commands (the ~ directory in Linux or macOS, and the C:\Users\<Username> directory in Windows). .obsutilconfig contains all the configuration information of obsutil.
- For details about the parameters in the .obsutilconfig file, see Parameter Description.
- The .obsutilconfig file contains the AK and SK information of a user. Therefore, it is hidden by default to prevent key disclosure. To query the file, run the following command in the home directory of the user who executes obsutil commands.
- In Windowsdir
- In Linux or macOSls -a
or
ls -al
- In Windows
- obsutil encrypts the AK and SK in the .obsutilconfig file to ensure key security.
Checking the Connectivity
After the configuration is complete, you can check whether it is correct by running the following commands:
- In Windowsobsutil ls -s
- In Linux or macOS./obsutil ls -s
Check the configuration result based on the command output:
- If the command output contains Bucket number is:, the configuration is correct.
- If the command output contains Http status [403], the access keys are incorrectly configured.
- If the command output contains A connection attempt failed, then OBS cannot be accessed. In this case, check the network condition.
If the command output contains Http status [403], you may not have the required permissions for obtaining the bucket list. In this case, further locate the root cause based on the specific situation.
- Prerequisites
- Configuration Method
- Checking the Connectivity