doc-exports/docs/obs/tool-obsutil/obs_11_0025.html

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

• Windows

  obsutil help [command]

• macOS or Linux

  ./obsutil help [command]

Examples

• In Windows, run obsutil help mb to view the help information for the command that creates 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

Parameter	Optional or Mandatory	Description
command	Optional	Currently, the help documents of the following commands are available: For abort, see Deleting a Multipart Upload Task. For chattri, see Setting Object Properties. For cp, see Uploading an Object, Copying an Object, and Downloading an Object. For ls, see Listing Buckets, Listing Objects, and Listing Multipart Upload Tasks. For mb, see Creating a Bucket. For mkdir, see Creating a Folder. For mv, see Moving an Object. For restore, see Restoring Objects from the Cold Storage. For rm, see Deleting a Bucket and Deleting an Object. For sign, see Generating the Download Link of an Object. For stat, see Querying Bucket Properties and Querying Object Properties. For sync, see Synchronously Uploading Incremental Objects, Synchronously Copying Incremental Objects, and Synchronously Downloading Incremental Objects. For archive, see Archiving Log Files. For clear, see Deleting Part Records. For config, see Updating a Configuration File. For help, see Viewing Command Help Information. For version, see Querying the Version Number.

Parent topic: Auxiliary Commands