このトピックでは、プローブの使用方法について説明します。コマンドを実行して、ローカルクライアントとObject Storage Service (OSS) 間のネットワーク接続の例外を検出し、アップロード帯域幅とダウンロード帯域幅を確認し、ローカルシンボリックリンクのステータスを取得します。
使用上の注意
アップロード帯域幅を確認するには、
oss:GetObject、oss:PutObject、およびoss:DeleteObject権限が必要です。 ダウンロード帯域幅を確認するには、oss:GetObject権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。ossutil 1.6.16以降の場合、コマンドラインでossutilをバイナリ名として直接使用できます。 オペレーティングシステムに基づいてバイナリ名を更新する必要はありません。 1.6.16より前のossutilの場合、オペレーティングシステムに基づいてバイナリ名を更新する必要があります。 詳細は、「ossutilコマンドリファレンス」をご参照ください。
使用上の注意
probeコマンドを実行して、ローカルクライアントとOSS間のネットワーク接続の例外を検出し、アップロード帯域幅とダウンロード帯域幅を確認できます。 このコマンドを実行して、多数のシンボリックリンクのステータスをアップロードする前に確認することもできます。
ネットワーク例外の検出
ossutilは、オブジェクトをアップロードまたはダウンロードして、ローカルクライアントとOSS間のネットワーク接続のステータスを確認します。 ネットワーク例外を検出したときに指定した場所にオブジェクトをアップロードまたはダウンロードするには、実際のオブジェクトの名前を指定することを推奨します。 ネットワーク例外を検出するだけでよい場合は、オブジェクト名を指定せずにコマンドを実行します。 ossutilは、接続検出用の一時オブジェクトを生成し、接続検出の完了後にオブジェクトを削除します。
アップロードとダウンロード帯域幅の確認
このコマンドを実行してアップロードとダウンロードの帯域幅を確認すると、OSSはローカルデバイスのCPUとネットワーク帯域幅に基づいて、アップロードとダウンロードの同時タスクの推奨数を提供します。 推奨される同時タスク数を使用して、ネットワーク帯域幅の使用量を最大化できます。
ローカルシンボリックリンクのステータスを確認する
多数のシンボリックリンクをアップロードする場合、リンクの1つに異常が発生すると、アップロードが中断されます。 ローカルシンボリックリンクのステータスをアップロードする前に確認することを推奨します。 シンボリックリンクの1つに異常がある場合は、リンクをアップロードする前に問題を修正してください。
probeコマンドを実行した後、各アップロードまたはダウンロードタスクの手順と結果を表示できます。
オブジェクトのアップロードまたはダウンロードによるネットワーク例外の検出
チェックマーク (√) は、チェック結果が正であることを示す。 × 印は、チェック結果が否定的であることを示す。
検出が成功すると、アップロードまたはダウンロードされたオブジェクトのサイズ、アップロードまたはダウンロードタスクの実行に使用された時間、オブジェクトがアップロードまたはダウンロードされた場所など、アップロードまたはダウンロードタスクに関する情報が返されます。
検出に失敗した場合、ossutilはエラーの原因またはエラーコードを返します。これはエラーのトラブルシューティングに使用できます。
エラーコードの詳細については、「概要」をご参照ください。
検出が完了すると、ossutilはインストールディレクトリに
logOssProbe + DetectionCompletionTime.log形式のログファイルを作成します。 ログファイルには、probeコマンドに関する詳細情報が含まれています。
特定のアイテムを確認する
probeコマンドを実行してアップロードとダウンロードの帯域幅、またはローカルのシンボリックリンクのステータスを確認すると、チェック結果と提案が表示されます。
オブジェクトをアップロードしてネットワーク接続ステータスを確認し、レポートを生成する
ossutilは、オブジェクトをバケットにアップロードして、ローカルクライアントとバケット間のネットワーク接続ステータスをチェックします。
コマンド構文
ossutil probe {--upload [file_name]} {--bucketname bucket_name} [--object object_name] [--addr domain_name] [--upmode]次の表に、上記のコマンドのパラメーターを示します。
パラメーター
必須
説明
-- upload
課金されます
オブジェクトをアップロードして接続検出を実行することを指定します。
file_name
課金されません
バケットにアップロードするローカルファイルのフルパス。 このパラメーターを指定しないと、ossutilは一時オブジェクトを生成し、オブジェクトをアップロードして接続を検出します。
-- bucketname
課金されません
接続を確認するバケットの名前。
-- object
課金されません
アップロードされたファイルに指定するオブジェクトの名前。 コマンドでこのパラメーターを指定すると、アップロードされたファイルは指定された名前で指定されたバケットに保存されます。 コマンドでこのパラメーターを指定しない場合、接続検出が完了した後、アップロードされたファイルは削除されます。
-- addr
課金されません
ネットワークアドレスを指定します。 ossutilはping操作を使用して、ローカルコンピューターと指定されたアドレス間のネットワーク接続を確認します。
デフォルト値:
www.aliyun.com-- upmode
課金されません
オブジェクトのアップロードに使用されるメソッド。
有効な値：
normal (デフォルト): オブジェクトはシンプルアップロードを使用してアップロードされます。
append: オブジェクトは、追加アップロードを使用してアップロードされます。
multipart: オブジェクトはマルチパートアップロードを使用してアップロードされます。
例
ランダムなオブジェクトをアップロードし、ネットワークアドレスを指定してネットワーク接続を確認する
この例では、オブジェクトがアップロードされるバケットの名前はexamplebucketで、確認するネットワークアドレスは
aliyun.comです。 サンプルコマンド:ossutil probe --upload --bucketname examplebucket --addr aliyun.comサンプル出力：
begin parse parameters and prepare file...[✓] begin network detection...[✓] begin upload file(normal)...[✓] ************************* upload result ************************* upload file:success upload file size:122880(byte) upload time consuming:245(ms) (only the time consumed by probe command) ************************* report log info************************* report log file:/root/logOssProbe20201201173031.logデフォルトのシンプルアップロードモードで特定のオブジェクトをアップロードしてネットワーク接続を確認し、検出完了後にアップロードしたオブジェクトを削除します
この例では、ローカルルートディレクトリにあるexample.txtという名前のファイルが、examplebucketという名前のバケットにアップロードされます。 サンプルコマンド:
ossutil probe --upload example.txt --bucketname examplebucketサンプル出力：
begin parse parameters and prepare file...[✓] begin network detection...[✓] begin upload file(normal)...[✓] ************************* upload result ************************* upload file:success upload file size:7(byte) upload time consuming:224(ms) (only the time consumed by probe command) upload object is example.txt ************************* report log info************************* report log file:/root/logOssProbe20201201173841.log追加アップロードモードで指定されたオブジェクトをアップロードしてネットワーク接続を確認し、検出完了後にアップロードされたオブジェクトをバケットに格納します
この例では、ローカルルートディレクトリにあるexample.txtという名前のファイルが、examplebucketという名前のバケットにアップロードされます。 サンプルコマンド:
ossutil probe --upload example.txt --bucketname examplebucket --object example.txt --upmode appendサンプル出力：
begin parse parameters and prepare file...[✓] begin network detection...[✓] begin upload file(append)...[✓] ************************* upload result ************************* upload file:success upload file size:7(byte) upload time consuming:171(ms) (only the time consumed by probe command) upload object is example.txt ************************* report log info************************* report log file:/root/logOssProbe20201201174126.log
URLを使用してオブジェクトをダウンロードしてネットワーク接続を確認し、レポートを生成する
ossutilは、バケットからURLを使用してオブジェクトをダウンロードすることにより、ローカルクライアントとバケット間のネットワーク接続をチェックします。
コマンド構文
ossutil probe {--download} {--url http_url} [--addr=domain_name] [file_name]次の表に、上記のコマンドのパラメーターを示します。
パラメーター
必須
説明
-- ダウンロード
課金されます
オブジェクトをダウンロードして接続チェックを実行することを指定します。
-- url
課金されます
ダウンロードするオブジェクトのURL。 ossutilはこのURLを使用して、オブジェクトをローカルディレクトリにダウンロードします。
ダウンロードするオブジェクトのACLがpublic-readの場合、このパラメーターをオブジェクトのURLに設定します。 例:
https://examplebucket.oss-cn-beijing.aliyuncs.com/example.jpg。ダウンロードするオブジェクトのACLが非公開の場合、このパラメーターをオブジェクトの署名付きURLに設定します。 URLは二重引用符 ("") で囲む必要があります。 例:
「 https://examplebucket.oss-cn-beijing.aliyuncs.com/example.jpg?Expires=1552015472&OSSAccessKeyId=TMP. ****** 5r9f1FV12y8_Qis6LUVmvoSCUSs7aboCCHtydQ0axN32Sn-UvyY3AAAwLAIUarYNLcO87AKMEcE5O3A ****** oCFAQuRdZYyVFyqOW8QkGAN-bamUiQと署名=bIa4llbMbldrl7rwckr % 2FXXvTtxw % 3D」
-- addr
課金されません
ネットワークアドレスを指定します。 ossutilはping操作を使用して、ローカルコンピューターと指定されたアドレス間のネットワーク接続を確認します。
デフォルト値:
www.aliyun.comfile_name
課金されません
オブジェクトがダウンロードされるローカルパス。
オブジェクト名のみを指定し、ディレクトリを指定しない場合、オブジェクトはossutilのインストールディレクトリに指定された名前で格納されます。
ディレクトリのみを指定し、オブジェクト名を指定しない場合は、指定したディレクトリに元の名前でオブジェクトが格納されます。
このパラメーターを指定しないと、オブジェクトはossutilのインストールディレクトリに元の名前を使用して格納されます。
例
オブジェクトURLを使用して特定のオブジェクトをダウンロードしてネットワーク接続を確認し、オブジェクトの名前を変更する
この例では、ACLがパブリック読み取りである
example.txtオブジェクトがhttps://examplebucket.oss-cn-beijing.aliyuncs.com/example.txtからローカルディレクトリにダウンロードされ、名前が/localfile/test.txtに変更されます。 サンプルコマンド:ossutil probe --download --url https://examplebucket.oss-cn-beijing.aliyuncs.com/example.txt /localfile/test.txtサンプル出力：
begin parse parameters and prepare object...[✓] begin network detection...[✓] begin download file...[✓] ************************* download result ************************* download file:success download file size:57374182(byte) download time consuming:1246(ms) (only the time consumed by probe command) download file is /localfile/test.txt ************************* report log info************************* report log file:/root/logOssProbe20201202171639.logURLを使用してオブジェクトをダウンロードし、pingテストのネットワークアドレスを指定して、ネットワーク接続を確認します。
この例では、ACLがパブリック読み取りである
example.txtオブジェクトがhttps://examplebucket.oss-cn-beijing.aliyuncs.com/example.txtからローカルディレクトリにダウンロードされ、pingテストのネットワークアドレスがaliyun.comされます。 サンプルコマンド:ossutil probe --download --url https://examplebucket.oss-cn-beijing.aliyuncs.com/example.txt --addr aliyun.comサンプル出力：
begin parse parameters and prepare object...[✓] begin network detection...[✓] begin download file...[✓] ************************* download result ************************* download file:success download file size:57374182(byte) download time consuming:1344(ms) (only the time consumed by probe command) download file is /root/example.txt ************************* report log info************************* report log file:/root/logOssProbe20201202172232.log
指定したオブジェクトをダウンロードしてネットワーク接続を確認し、レポートを生成する
ossutilは、バケットからオブジェクトをダウンロードすることにより、ローカルクライアントとバケット間のネットワーク接続をチェックします。
コマンド構文
ossutil probe {-- download} {-- bucketname bucket_name} [-- object object_name] [-- addr domain_name] [file_name]次の表に、上記のコマンドのパラメーターを示します。
パラメーター
必須
説明
-- ダウンロード
課金されます
オブジェクトをダウンロードして接続チェックを実行することを指定します。
-- bucketname
課金されます
接続を確認するバケットの名前。
-- object
課金されません
ダウンロードするオブジェクトの名前。 コマンドでこのパラメーターを指定すると、指定したオブジェクトがローカルディレクトリにダウンロードされます。 コマンドでこのパラメーターを指定しない場合、ossutilは一時オブジェクトを生成し、指定されたバケットにオブジェクトをアップロードしてから、オブジェクトをダウンロードします。 接続チェックが完了すると、ossutilはバケットから一時オブジェクトを削除します。
-- addr
課金されません
ネットワークアドレスを指定します。 ossutilはping操作を使用して、ローカルコンピューターと指定されたアドレス間のネットワーク接続を確認します。
デフォルト値:
www.aliyun.comfile_name
課金されません
オブジェクトがダウンロードされるローカルパス。
オブジェクト名のみを指定し、ディレクトリを指定しない場合、オブジェクトはossutilのインストールディレクトリに指定された名前で格納されます。
ディレクトリのみを指定し、オブジェクト名を指定しない場合は、指定したディレクトリに元の名前でオブジェクトが格納されます。
このパラメーターを指定しないと、オブジェクトはossutilのインストールディレクトリに元の名前を使用して格納されます。
例
オブジェクトをダウンロードしてネットワーク接続を確認し、オブジェクトの名前を変更する
この例では、
/ossfolder/example.txtオブジェクトがexamplebucketバケットからダウンロードされ、名前が/localfolder/text.txtに変更されます。 サンプルコマンド:ossutil probe -- download -- bucketname examplebucket -- object /ossfolder/example.txt /localfolder/text.txtサンプル出力：
begin parse parameters and prepare object...[✓] begin network detection...[✓] begin download file...[✓] ************************* download result ************************* download file:success download file size:57374182(byte) download time consuming:1108(ms) (only the time consumed by probe command) download file is /localfolder/text.txt ************************* report log info************************* report log file:/root/logOssProbe20201202173032.log一時オブジェクトをダウンロードし、pingテスト用のネットワークのアドレスを指定して、ネットワーク接続ステータスを確認します。
この例では、一時オブジェクトはexamplebucketバケットからダウンロードされます。 確認するネットワークアドレスが
aliyun.comです。 サンプルコマンド:ossutil probe -- download -- bucketname examplebucket -- add r aliyun.comサンプル出力：
begin parse parameters and prepare object...[✓] begin network detection...[✓] begin download file...[✓] ************************* download result ************************* download file:success download file size:122880(byte) download time consuming:516(ms) (only the time consumed by probe command) download file is /root/oss-test-probe-1606902911701892000-3ifwj9t0ln ************************* report log info************************* report log file:/root/logOssProbe20201202173512.log
特定のアイテムを確認する
probeコマンドを実行して、ローカルのシンボリックリンクのステータス、アップロードおよびダウンロードの帯域幅など、特定の項目を確認できます。 ossutilは、チェック結果に基づいて、異常なシンボリックリンクの名前と、アップロードおよびダウンロードでの推奨される同時タスク数も返します。
コマンド構文
ossutil probe {-- probe-item item_value} {-- bucketname bucket-name} [-- object object_name][-- parallel <value>][-- part-size <value>][-- runtime <value>]次の表に、上記のコマンドのパラメーターを示します。
パラメーター
必須
説明
-- probe-item
課金されます
チェックするアイテム。
有効な値：
cycle-symlink: ossutilは、ローカルパスに異常なシンボリックリンクが存在するかどうかをチェックします。
upload-speed: ossutilはアップロード帯域幅をチェックします。
download-speed: ossutilはダウンロード帯域幅をチェックします。
download-time: ossutilは、オブジェクトのダウンロードに必要な時間をチェックします。
-- bucketname
-- probe-itemの値が
cycle-symlinkでない場合ははい接続を確認するバケットの名前。
-- object
-- probe-itemの値が
download-speedの場合ははいオブジェクトのタイプを示します。 オブジェクトが存在する必要があります。 サイズが5 MBを超えるオブジェクトを指定することを推奨します。 例:
ossfolder/example.txt-- 平行
課金されません
1つのオブジェクトに対する操作の同時タスクの数。 デフォルト値は 1 です。
説明このパラメーターは、-- probe-itemの値が
download-timeの場合にのみ有効です。-- 部分サイズ
課金されません
部品サイズ。 単位：バイト デフォルトでは、ossutilはオブジェクトサイズに基づいて部品サイズを決定します。
有効な値: 1 ~ 9223372036854775807
説明このパラメーターは、-- probe-itemの値が
download-timeの場合にのみ有効です。-- runtime
課金されません
最大実行時間。 最大実行時間に達すると、コマンドの実行が中断されます。
説明このパラメーターは、-- probe-itemの値が
upload-speedまたはdownload-speedの場合にのみ有効になります。例
ローカルルートディレクトリのlocalfolderディレクトリに異常なシンボリックリンクが存在するかどうかを確認する
サンプルコマンド:
ossutil probe -- probe-item cycle-symlink /root/localfolderサンプル出力：
Error: stat /root/localfolder/example.jpg: no such file or directory出力は、example.jpgシンボリックリンクが異常であることを示しています。
アップロード帯域幅の確認
この例では、ossutilは一時オブジェクトをexamplebucketという名前のバケットにアップロードし、現在のデバイスのハードウェア仕様とアップロード帯域幅に基づいて推奨される同時アップロードタスク数を返します。
サンプルコマンド:
ossutil probe -- probe-item upload-speed -- bucketname examplebucketサンプル出力：
cpu core count:2 parallel:2,average speed:679.72(KB/s),current speed:1344.00(KB/s),max speed:1440.00(KB/s)) parallel:3,average speed:643.31(KB/s),current speed:704.00(KB/s),max speed:1632.00(KB/s)) parallel:4,average speed:646.62(KB/s),current speed:512.00(KB/s),max speed:1600.00(KB/s)) suggest parallel is 2, max average speed is 679.72(KB/s)出力は、デバイスのCPUに2つのコアがあり、最大平均アップロード帯域幅は679.72 KB/sであり、同時アップロードタスクの推奨数は2であることを示しています。
ダウンロード帯域幅の確認
この例では、ossutilはexamplebucketバケットから
example.txtオブジェクトをダウンロードし、ハードウェアのパフォーマンスとダウンロード帯域幅に基づいて同時ダウンロード数を推奨します。サンプルコマンド:
ossutil probe -- probe-item download-speed -- bucketname examplebucket -- object example.txtサンプル出力：
cpu core count:2 parallel:2,average speed:12524.93(KB/s),current speed:12288.63(KB/s),max speed:14302.25(KB/s) parallel:3,average speed:12564.45(KB/s),current speed:12144.39(KB/s),max speed:14484.24(KB/s) parallel:4,average speed:12545.21(KB/s),current speed:12766.58(KB/s),max speed:13534.42(KB/s) suggest parallel is 3, max average speed is 12564.45(KB/s)出力は、デバイスのCPUに2つのコアがあり、最大平均ダウンロード帯域幅は12,564.45 KB/sであり、同時ダウンロードタスクの推奨数は3であることを示しています。
ダウンロード帯域幅を確認し、最大実行時間を指定する
この例では、ossutilはexamplebucketバケットから
example.zipオブジェクトをダウンロードし、ハードウェアパフォーマンスとダウンロード帯域幅に基づいて推奨される同時ダウンロードタスク数を返し、最大実行時間を指定します。ossutil probe -- probe-item download-speed -- bucketname examplebucket -- object example.zip -- runtime 2サンプル出力：
cpu core count:8 parallel:8,average speed:10610.66(KB/s),current speed:11245.14(KB/s),max speed:11470.41(KB/s) parallel:9,average speed:9915.97(KB/s),current speed:10763.22(KB/s),max speed:11401.97(KB/s)) parallel:10,average speed:9969.66(KB/s),current speed:11213.43(KB/s),max speed:11384.52(KB/s)) parallel:11,average speed:10298.34(KB/s),current speed:10522.27(KB/s),max speed:11282.21(KB/s) parallel:12,average speed:10454.31(KB/s),current speed:9725.25(KB/s),max speed:11426.21(KB/s)) parallel:13,average speed:9531.86(KB/s),current speed:8634.53(KB/s),max speed:11220.90(KB/s))) parallel:14,average speed:9329.45(KB/s),current speed:8542.94(KB/s),max speed:10505.16(KB/s)) parallel:15,average speed:10193.00(KB/s),current speed:10770.35(KB/s),max speed:10971.39(KB/s) parallel:16,average speed:10637.59(KB/s),current speed:10483.77(KB/s),max speed:11179.55(KB/s) suggest parallel is 16, max average speed is 10637.59(KB/s) run download-speed 2 seconds with parallel 16 parallel:16,average speed:9197.00(KB/s),current speed:9849.30(KB/s),max speed:9849.30(KB/s) 280.345640(s) elapsedダウンロードタスクの完了に必要な時間を確認する
この例では、ossutilはexamplebucketバケットから
example.txtオブジェクトをダウンロードし、ダウンロードタスクの完了に必要な時間を返します。 サンプルコマンド:ossutil probe -- probe-item download-time -- bucketname examplebucket -- object example.txtサンプル出力：
downloading average speed:6178.75(KB/s),current speed:14446.02(KB/s),max speed:14446.02(KB/s) download-speed part-size:-1, parallel:1 total bytes:31707929, cost:4.918 s, avg speed:7741.00(kB/s) 5.206202(s) elapsedダウンロードタスクの完了に必要な時間を確認し、部品サイズを指定します
この例では、ossutilは指定されたパーツサイズに基づいてexamplebucketバケットから
example.zipオブジェクトをダウンロードし、ダウンロードタスクの完了に必要な時間を返します。ossutil probe-probe-item download-time-bucketname examplebucket-object example.zip-part-size 10000000サンプル出力：
downloading average speed:9229.00(KB/s),current speed:18458.57(KB/s),max speed:18458.57(KB/s) download-speed part-size:10000000, parallel:1 total bytes:31707929, cost:3.230 s, avg speed:10321.33(kB/s) 3.569254(s) elapsedダウンロードタスクの完了に必要な時間を確認し、同時実行レベルを設定する
この例では、ossutilは指定されたパーツサイズに基づいてexamplebucketバケットから
example.zipオブジェクトをダウンロードし、ダウンロードタスクの完了に必要な時間を返します。ossutil probe -- probe-item download-time -- bucketname examplebucket -- object example.zip -- parallel 3サンプル出力：
downloading average speed:9155.00(KB/s),current speed:18310.68(KB/s),max speed:18310.68(KB/s) download-speed part-size:-1, parallel:3 total bytes:31707929, cost:3.121 s, avg speed:10321.33(kB/s) 3.424191(s) elapsed