Help Center> Object Storage Service> Tools Guide> obsutil> Getting Started> Performing Initial Configuration
View PDF

Performing Initial Configuration

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 downloaded the software package of obsutil. For details, see Download and Installation.
  • You have obtained the enabled regions and endpoints of OBS. For details, see Regions and Endpoints. If you want to access OBS in the CN North-Beijing4 region, the actual OBS service address is: https://obs.cn-north-4.myhuaweicloud.com.
  • You have obtained the access keys (AK and SK). For details about how to obtain access keys, see Preparing the Environment. Click here to open the access key management page.

Configuration Method

Method 1: Run the config command to initialize obsutil. For details about the config command, see Updating a Configuration File. The following is an example:

  • In Windows 
    obsutil config -i=ak -k=sk -e=endpoint
  • In Linux or macOS 
    ./obsutil config -i=ak -k=sk -e=endpoint
  • 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 Windows 
      dir
    • In Linux or macOS 
      ls -a

      or

      ls -al
  • obsutil encrypts the AK and SK in the .obsutilconfig file to ensure key security.
  • Note: You can use the -i, -k, and -e options to configure user information for authentication. You can run the history command in the Linux OS to query the parameter values. Exercise caution when performing this operation.

Method 2: You can use Configuring Auto Obtaining of Access Keys for obsutil to implement initial configuration.

Checking the Connectivity

After the configuration is complete, you can check whether it is correct by running the following commands:

  • In Windows 
    obsutil 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.

Parent topic: Getting Started