Viewing Command Help Information

Function

You can use this command to view the commands supported by obsutil or view the help information of a specific command.

Command Line Structure

• In Windows

  obsutil help [command]

• In Linux or macOS

  ./obsutil help [command]

Examples

• Take the Windows OS as an example. Run the obsutil help mb command to view the help information about the command for creating a bucket.

  obsutil help mb
  
  Summary:
    create a bucket with the specified parameters
  
  Syntax:
    obsutil mb obs://bucket [-acl=xxx] [-location=xxx] [-fs] [-az=xxx] [-sc=xxx] [-config=xxx] [-i=xxx] [-k=xxx] [-t=xxx] [-e=xxx]
  
  Options:
    -fs
      create a bucket that supports POSIX
  
    -az=xxx
      the AZ of the bucket, possible values are [multi-az]
  
    -sc=xxx
      the default storage class of the bucket, possible values are [standard|warm|cold|deep-archive]
  
    -acl=xxx
      the ACL of the bucket, possible values are [private|public-read|public-read-write]
  
    -location=xxx
      the region where the bucket is located
  
    -epid=xxx
      the enterprise project id of the bucket
  
    -kms=xxx
      the encryption id of the bucket
  
    -config=xxx
      the path to the custom config file when running this command
  
    -e=xxx
      endpoint
  
    -i=xxx
      access key ID
  
    -k=xxx
      security key ID
  
    -t=xxx
      security token
  
  Summary:
  create a bucket with the specified parameters
  
  Syntax:
    obsutil mb obs://bucket [-fs] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx]
  
  Options:
    -fs
      create a bucket that supports POSIX
  
    -acl=xxx
      the ACL of the bucket, possible values are [private|public-read|public-read-write]
  
    -sc=xxx
      the default storage class of the bucket, possible values are: [standard|warm|cold]
  
    -location=xxx
      the region where the bucket is located
  
    -config=xxx
      the path to the custom config file when running this command

Parameter Description