edit-icon download-icon

ダウンロードとインストール

最終更新日: Aug 01, 2018

Ossutil では、コマンドラインを使用して OSS データを簡単に管理できます。現在のバージョンでは、一部のバケット管理機能およびマルチパート管理機能を使用できません。これらの機能は、今後のバージョンで提供されます。これらの機能が必要な場合は、osscmd コマンドラインツールを代わりに使用してください。

ツールのダウンロード

  • 現在のバージョン

    現在のバージョン: 1.4.1

  • 実行環境

    • Windows / Linux / Mac
    • サポートされているアーキテクチャ
      • x86 (32ビット、64ビット)
  • バイナリプログラムのダウンロード

  • バイナリプログラムのインストールと使用

    使用しているオペレーティングシステムのバイナリプログラムまたは対応する圧縮パッケージをダウンロードし、バイナリプログラムを実行します。(バイナリプログラムが実行ファイルでない場合、chmod 755 ossutilを実行して実行可能にします。) バイナリプログラムは次のように実行します。

    • Linux システムの場合: ./ossutil
    • Window システムの場合、次の 2 つの方法のいずれかを使用します (次の例は 64 ビットオペレーティングシステムの場合です):

      • パッケージを解凍します。バッチファイルをダブルクリックし、ossutil64.exe と入力します。
      • パッケージを解凍します。cmd を実行し、バイナリプログラムがあるディレクトリに移動します。ossutil64.exe と入力します。
    • Mac システムの場合: ./ossutilmac64

クイックスタート

  • ossutil の言語設定

    ossutil のコマンドを実行するとき、-L オプションを使用して言語を設定できます。値には CH または EN を使用でき、それぞれ中国語と英語に対応します。値は大文字と小文字が区別されません。デフォルト値は CH (中国語) です。言語を CH (中国語) に設定する場合、システムが UTF-8 エンコードであることを確認する必要があります。そうでない場合、文字化けする場合があります。

    例:

    ./ossutil help ls は、デフォルト言語で ls のヘルプを表示するときに使用します。

    ./ossutil help ls -L ch は、中国語で ls のヘルプを表示するときに使用します。

    ./ossutil help ls -L en は、英語で ls のヘルプを表示するときに使用します。

    ./ossutil config -L ch は、インタラクティブな設定コマンドの ossutil config を実行するときに使用します。プロンプトの言語は中国語です。

    ./ossutil config -L en は、インタラクティブな設定コマンドの ossutil config を実行するときに使用します。プロンプトの言語は英語です。

    注意: デフォルトでは、ossutil のエラー出力は英語です。これは、前述のオプションの影響を受けません。

  • コマンドリストの取得

    ./ossutil または ./ossutil help

  1. $./ossutil
  2. 使用法: ossutil [command] [args...] [options...]
  3. ossutil help を実行して、コマンドヘルプを表示
  4. Commands:
  5. mb cloud_url [options]
  6. bucket の作成
  7. ls [cloud_url] [options]
  8. buckets または objects をリスト
  9. rm cloud_url [options]
  10. buckets または objects を削除
  11. stat cloud_url [options]
  12. buckets または objects の説明を表示
  13. set-acl cloud_url [acl] [options]
  14. buckets または objects ACL を設定
  15. set-meta cloud_url [meta] [options]
  16. アップロードしたオブジェクトのメタデータを設定
  17. cp src_url dest_url [options]
  18. オブジェクトのアップロード、ダウンロード、またはコピー
  19. restore cloud_url [options]
  20. オブジェクトをフリーズ状態から読み取り可能状態に復元
  21. create-symlink cloud_url target_url [options]
  22. シンボリックリンクを作成
  23. read-symlink cloud_url [options]
  24. シンボリックリンクファイルの説明を取得
  25. Additional Commands:
  26. help [command]
  27. コマンドのヘルプドキュメントを取得
  28. config [options]
  29. 設定項目を保存する設定ファイルを作成
  30. hash file_url [options]
  31. ローカルファイルの crc64 または MD5 を計算
  32. update [options]
  33. ossutil を更新
  1. $./ossutil -L en
  2. Usage: ossutil [command] [args...] [options...]
  3. Please use 'ossutil help command' to show help of command
  4. Commands:
  5. mb cloud_url [options]
  6. Make Bucket
  7. ls [cloud_url] [options]
  8. List Buckets or Objects
  9. rm cloud_url [options]
  10. Remove Bucket or Objects
  11. stat cloud_url [options]
  12. Display meta information of bucket or objects
  13. set-acl cloud_url [acl] [options]
  14. Set acl on bucket or objects
  15. set-meta cloud_url [meta] [options]
  16. set metadata on already uploaded objects
  17. cp src_url dest_url [options]
  18. Upload, Download or Copy Objects
  19. restore cloud_url [options]
  20. Restore Frozen State Object to Read Ready Status
  21. create-symlink cloud_url target_url [options]
  22. Create symlink of object
  23. read-symlink cloud_url [options]
  24. Display meta information of symlink object
  25. Additional Commands:
  26. help [command]
  27. Get help about commands
  28. config [options]
  29. Create configuration file to store credentials
  30. hash file_url [options]
  31. Get crc64 or md5 of local file
  32. update [options]
  33. Update ossutil
  • コマンドのヘルプドキュメントの表示

    ./ossutil help cmdコマンドを実行する前に、help コマンドを実行してヘルプドキュメントを確認することを強くお勧めします。

  1. ./ossutil help config -L ch
  2. SYNOPSIS
  3. 設定項目を保存する設定ファイルを作成
  4. SYNTAX
  5. ossutil config [-e endpoint] [-i id] [-k key] [-t token] [-L language] [--output-dir outdir] [-c file]
  6. DETAIL DESCRIPTION
  7.  このコマンドは、設定ファイルを作成し、設定ファイルにカスタマイズされた設定項目を格納し、設定項目を使用して OSS にアクセスするときにアクセス情報を提供するために使用されます。(コマンドが設定項目を必要とするかどうかは、--config-file オプションがサポートされているかどうかによって異なります。詳細については、コマンドのヘルプを参照してください)。
  8.  設定ファイルを保存するパスを指定することができます。デフォルトパスは /home/admin/.ossutilconfig です。設定ファイル(たとえば, a)が存在する場合、ossutil a a.bak に格納し、ファイル a を再度作成し、設定項目を書き込みます。a.bak がすでに存在する場合は、ファイル a によって上書きされます。
  9.  注意:
  10.  1)設定ファイルのパスがデフォルトパスでない場合は、--config-file オプションでパスを指定できます。--config-file オプションを指定しないと、コマンド実行時に /home/admin/.ossutilconfig がデフォルトで読み込まれます)。
  11.  2)いくつかの設定項目は、コマンド実行時に --endpoint --access-key-id などのオプションを使用して設定できます(オプションについての詳細は各コマンドのヘルプを参照してください)。コマンドを実行するときにオプションを指定し、設定ファイル内に設定もあった場合、優先順位は `指定オプション > 設定ファイル` です。
  12.  3)コマンド実行時に --endpoint、--access-key-id、--access-key-secret、および --sts-token オプションを指定した場合、ossutil に設定ファイルの存在は必須ではなりません。
  13. 使用法:
  14.  このコマンドは、1)対話モードまたは 2)非対話モードで使用できます。対話モードは、より高いセキュリティを保証するので推奨されます。
  15. 1) ossutil config [-c file]
  16. このモードは対話方式で情報を設定できます。Ossutil は対話で下記の情報をリクエストします。
  17. (1) config file
  18. 設定ファイルのパスを指定します。空欄のまま Enter キーを押すと、ossutil は次のデフォルト設定ファイルを使用します。
  19. /home/admin/.ossutilconfig.
  20. 設定ファイルを指定する場合は、コマンド実行時に設定ファイルのパスに --config-file オプションを使用します。--config-file オプションをサポートするコマンドの詳細については、各コマンドのヘルプを参照してください。
  21. (2) language
  22. 初期設定の場合(設定ファイルは存在しません)、ossutil は言語を設定する必要があります。値は、CH(中国語)またはEN(英語)です。Enterキーを押すと、ossutil --language オプションの値に基づいて言語を設定します。--language オプションを設定しないと、ossutil はデフォルトで言語を CH に設定します。
  23. 設定ファイルが存在する場合、ossutil は、設定ファイル内の指定された言語オプションおよび言語情報に基づいて言語を構成します。
  24. Ossutil は、操作中に設定ファイルから言語オプションを読み取ります。このオプションが存在しない、無効な場合、ossutil はデフォルトで言語を CH に設定します。
  25. 注:この設定項目は、config コマンドが正常に実行された後に有効になります。config コマンドを実行すると、表示された言語は設定の影響を受けません。
  26. (3) endpoint, accessKeyID, accessKeySecret
  27. Enter は、設定項目がスキップされたことを示します。注:endpoint は、oss.aliyuncs.com などの第 2 レベルドメイン(SLD)である必要があります。
  28. 上記のオプションは必須です。
  29. (4) stsToken
  30. 一時トークンを使用して OSS にアクセスするには、このオプションを指定します。それ以外の場合は、Enter キーを押してこのオプションをスキップします。
  31. (5) outputDir
  32. このオプションは、出力ファイルが存在するディレクトリのパスを設定するために使用します。対話モードでは、このオプションの設定はサポートされていません。ただし、このオプションは設定ファイルで有効です。
  33. outputDir オプションのデフォルトのディレクトリは、現在のディレクトリの ossutil_output です。 Ossutil は、操作中にこのフォルダ内のすべての出力ファイルを生成します。現在、出力ファイルには、cp コマンドを実行してバッチ処理の例外が発生した場合の各ファイルの操作エラーを記録するレポートファイルが含まれています。
  34. outputDir オプションとレポートファイルの詳細については、cp コマンドのヘルプを参照してください。
  35. 注意:outputDir オプションが存在しない場合、ossutil は出力ファイルを生成するときに自動的にディレクトリを作成します。outputDir オプションが指定するディレクトリが存在しない場合、エラーが報告されます。
  36. 次の Bucket-Endpoint および Bucket-Cname オプションは対話モードから削除されますが、設定ファイルでは有効です。
  37. (6) Bucket-Endpoint
  38. Bucket-Endpoint オプションは、指定した各バケットのエンドポイントを個別に設定するために使用します。このオプションは、設定ファイル内のデフォルトのエンドポイント構成の前にあります。
  39. このバージョンでは、ossutil は対話モードで Bucket-Endpoint 設定を削除します。ただし、この設定項目は設定ファイルでも有効です。したがって、各バケットのエンドポイントを個別に指定する場合は、設定ファイルで設定を行うことができます。注:エンドポイントは SLDoss.aliyuncs.com など)である必要があります。
  40. Bucket-Endpoint オプションが指定されている場合、ossutil は、バケット上で操作を実行するときにオプション内のバケットに対応するエンドポイントを検索します。見つかった場合、エンドポイントは基本構成でエンドポイントを上書きします。ただし、コマンド実行時に --endpoint オプションを指定した場合、--endpoint オプションの優先順位が最も高くなります。
  41. (7) Bucket-Cname
  42. Bucket-Cname オプションは、指定されたバケットごとに CNAME ドメイン名(CDN ドメイン)を個別に設定するために使用されます。このオプションは、設定ファイルの Bucket-Endpoint オプションとエンドポイントの設定よりも前です。
  43. このバージョンでは、ossutil は対話モードで Bucket-Cname 設定を削除しました。ただし、この設定項目は設定ファイルで有効です。したがって、各バケットの CNAME ドメイン名を個別に指定する場合は、設定ファイルで設定を行うことができます。
  44. Bucket-Cname オプションが指定されている場合、ossutil はバケット上で操作を実行するときにオプション内のバケットに対応する CNAME ドメイン名を検索します。CNAME ドメイン名が見つかると、バケットエンドポイントオプションと基本設定のエンドポイントを上書きします。ただし、コマンド実行時に --endpoint オプションを指定した場合、--endpoint オプションの優先順位が最も高くなります。
  45. 優先度:--endpoint > Bucket-Cname > Bucket-Endpoint > endpoint > デフォルト endpoint
  46. 2) ossutil config options
  47. コマンドの実行時に --language および --config-file オプション以外のオプションを指定すると、コマンドは非対話モードになります。すべての設定項目はオプション設定ファイルで指定します。
  48. 設定ファイルの形式:
  49. [Credentials]
  50. language = CH
  51. endpoint = oss.aliyuncs.com
  52. accessKeyID = your_key_id
  53. accessKeySecret = your_key_secret
  54. stsToken = your_sts_token
  55. outputDir = your_output_dir
  56. [Bucket-Endpoint]
  57. bucket1 = endpoint1
  58. bucket2 = endpoint2
  59. ...
  60. [Bucket-Cname]
  61. bucket1 = cname1
  62. bucket2 = cname2
  63. ...
  64. SAMPLE
  65. ossutil config
  66. ossutil config -e oss-cn-hangzhou.aliyuncs.com -c ~/.myconfig
  67. OPTIONS
  68. -c, --config-file
  69. ossutil の設定ファイルのパスを指定します。Ossutil は、起動時に設定ファイルから設定を読み取り、設定コマンドを使用してファイルに設定を書き込みます。
  70. -e, --endpoint
  71. osshutil のエンドポイントを指定します(オプション値は、設定ファイルの対応する設定を上書きします)。 設定値は SLD でなければなりません。
  72. -i, --access-key-id
  73. OSS へのアクセスに使用される AccessKeyID を指定します(オプション値は、設定ファイルの対応する設定を上書きします)。
  74. -k, --access-key-secret
  75. OSS にアクセスするために使用される AccessKeySecret を指定します(オプション値は、設定ファイル内の対応する設定を上書きします)。
  76. -t, --sts-token
  77. オプションです。OSS にアクセスするために使用する STSToken を指定します(オプション値は、設定ファイルの対応する設定を上書きします)。
  78. --output-dir=ossutil_output
  79. 出力ファイルが格納されているディレクトリを指定します。出力ファイルには、cp コマンドを使用してファイルをバッチでコピーする際にエラーが発生したときに生成されるレポートファイルが含まれます。(レポートファイルの詳細については、cp コマンドのヘルプを参照してください)。デフォルト値は、カレントディレクトリの ossutil_output サブディレクトリです。
  80. -L CH, --language=CH
  81. ossutil の言語を指定します。値は CH または EN にすることができ、デフォルト値は CH です。値が CH の場合は、システムが UTF-8 エンコードであることを確認してください。
  • ossutil の設定

    コマンドを使用して OSS にアクセスする場合、最初に Access Key ペアを設定します。Access Key ペアの詳細については、「RAM および STS の概要」を参照してください。

    Ossutil は、インタラクティブモードまたは非インタラクティブモードに設定できます。

    設定コマンドのヘルプドキュメントを表示するには、ossutil help config を実行します。

    • インタラクティブモードでの ossutil の設定

    ./ossutil config

    1. $./ossutil config -L ch
    2. このコマンドは、設定ファイルを作成し、そこに設定情報を保管するために使用されます。
    3. 設定ファイルのパスを指定することができます。デフォルトパスは /home/admin/.ossutilconfig です。Enter キーを押すと、デフォルトのパスが使用されます。別のパスを指定する場合は、コマンド実行時に --config-file オプションでバスを指定します。
    • 非インタラクティブモードでの ossutil の設定

    ./ossutil config -e oss.aliyuncs.com -i your_id -k your_key