すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:config

最終更新日:Dec 23, 2024

このトピックでは、configコマンドを実行して、Object Storage Service (OSS) アクセス情報を保存するための設定ファイルを作成する方法について説明します。 他のコマンドを実行するときに -cオプションを追加できます。 このように、ossutilは特定の設定ファイルの設定を使用してOSSにアクセスします。

重要

ossutil 1.6.16以降の場合、コマンドラインでossutilをバイナリ名として直接使用できます。 オペレーティングシステムに基づいてバイナリ名を更新する必要はありません。 1.6.16より前のossutilの場合、オペレーティングシステムに基づいてバイナリ名を更新する必要があります。 詳細は、「ossutilコマンドリファレンス」をご参照ください。

コマンド構文

configコマンドは、インタラクティブモードまたは非インタラクティブモードで実行できます。 インタラクティブモードでは、configコマンドを実行する前に、設定ファイルを使用して関連する設定を完了する必要があります。 configコマンドを実行すると、ossutilは構成ファイルから構成を直接読み取ります。 非対話モードでは、configコマンドを実行するときにパラメーターを指定する必要があります。 非インタラクティブモードと比較して、インタラクティブモードはより高いセキュリティを提供します。

次のコマンド構文を使用して、configコマンドを非対話モードで実行します。

ossutil config 
[-e, --endpoint <value>] 
[-i, --access-key-id <value>] 
[-k, --access-key-secret <value>] 
[-t, --sts-token <value>]
[--ram-role-arn <value>]
[-L language <value>] 
[--output-dir <value>] 
[-c, --config-file <value>]

次の表に、上記のオプションを示します。

オプション

説明

-e, -- endpoint

バケットが配置されているリージョンのエンドポイント。 詳細は、「リージョンとエンドポイント」をご参照ください。 ossutilがOSSへのアクセスに使用するプロトコルを指定するには、http:// またはhttps:// を追加します。 デフォルトのプロトコルはHTTPです。

-i, -- access-key-id

設定ファイルの [Credentials] セクションのAccessKey ID。 AccessKey IDの表示方法の詳細については、「AccessKeyペアの取得」をご参照ください。

-k, -- access-key-secret

設定ファイルの [Credentials] セクションのAccessKey secret。 AccessKeyシークレットの表示方法の詳細については、「AccessKeyペアの取得」をご参照ください。

-t, -- sts-token

OSSへのアクセスに使用されるSTS (Security Token Service) トークン。 このパラメーターは、STSの一時的なアクセス資格情報を使用してOSSにアクセスする場合にのみ必要です。 STSトークンを生成する方法の詳細については、「STSが提供する一時的なアクセス資格情報を使用してOSSにアクセスする」をご参照ください。

-- ram-role-arn

認証用のRamRoleArnモードのRAMロールのAlibaba Cloudリソース名 (ARN) 。 AssumeRoleを呼び出してRAMユーザーとしてOSSにアクセスする場合にのみ、このパラメーターを設定する必要があります。

-L言語

ossutilが使用する言語。 値:

  • CH: 中国語。 このパラメーターをCHに設定する場合は、システムがUTF-8エンコードをサポートしていることを確認してください。

  • EN: 英語。

-- output-dir

出力オブジェクトが格納されているディレクトリ。 出力オブジェクトには、cpコマンドを実行して複数のオブジェクトを同時にコピーするときに発生するエラーによって生成されるレポートオブジェクトが含まれます。

既定では、出力オブジェクトの格納に使用されるディレクトリは、現在のディレクトリのossutil_outputです。

-c, -- config-file

ossutil構成ファイルのパス。 ossutilが起動されると、設定ファイルからパスを読み取ります。

  • 対話モードで構成ファイルを生成する

    ossutil config
    Specify the name of the configuration file. The file name can contain the file path. The default file name is /home/user/.ossutilconfig. If you press the Enter key without specifying a file path, the configuration file is generated in the default path. 
    If you want to store the configuration file in another path, set the --config-file option to the file path. 
    If you do not specify the path of the configuration file, the default configuration file named /home/user/.ossutilconfig is used.  
    If you press the Enter key without specifying the following parameters, these parameters are ignored. For more information about the parameters, run the help config command.  
    Enter the endpoint: https://oss-cn-shenzhen.aliyuncs.com 
    Enter the AccessKey ID: yourAccessKeyID 
    Enter the AccessKey secret: yourAccessKeySecret
    Enter the STS token: yourStsToken
  • 非対話モードで構成ファイルを生成する

    ossutil config -e oss-cn-beijing.aliyuncs.com -i LTAIbZcdVCmQ**** -k D26oqKBudxDRBg8Wuh2EWDBrM0****  -L CH -c /myconfig

    -L languageおよび -c, -- config-file以外のパラメーターを指定した場合、configコマンドを実行すると、非対話モードが使用されます。 次に、すべてのパラメーターを指定する必要があります。

設定ファイルの変更

重要
  • ossutil V1.7.15以降では、インタラクティブモードを使用する場合、Bucket-EndpointまたはBucket-Cnameを指定する必要はありません。 設定ファイルの各バケットにエンドポイントまたはCNAMEを指定できます。

  • ossutilを使用すると、さまざまな方法でエンドポイントを指定できます。 コマンドの -- endpointオプションで指定したエンドポイント、[Bucket-Cname] セクションで指定したエンドポイント、[Bucket-endpoint] セクションで指定したエンドポイント、[Credentials] セクションで指定したエンドポイントの設定が降順で有効になります。

生成された設定ファイルを変更することで、OSSアクセス情報を変更できます。 ossutilの設定ファイルの形式は次のとおりです。

[Credentials]
        language = CH
        endpoint = oss.aliyuncs.com
        accessKeyID = your_accesskey_id
        accessKeySecret = your_accesskey_secret
        stsToken = your_sts_token
        outputDir = your_output_dir
        ramRoleArn = your_ram_role_arn
[Bucket-Endpoint]
        bucket1 = endpoint1
        bucket2 = endpoint2
        ...
[Bucket-Cname]
        bucket1 = cname1
        bucket2 = cname2
        ...
[AkService]
        ecsAk=http://100.100.100.200/latest/meta-data/ram/security-credentials/EcsRamRoleTesting
[Default]
        userAgent = user_agent
        loglevel = log_level
        proxyHost = proxy_host
        proxyUser = proxy_user
        proxyPwd = proxy_pwd
        readTimeOut = read_time_out
        connectTimeOut = connect_time_out
        retryTimes = retry_times
  • Bucket-Endpoint: 指定したバケットごとにエンドポイントを指定します。

  • Bucket-Cname: 指定したバケットごとにCNAMEを指定します。 CNAMEの詳細については、「カスタムドメイン名のマップ」をご参照ください。

  • AkService: このオプションは、ECS (Elastic Compute Service) インスタンスにアタッチされたRAMロールを使用してOSSで操作を実行する場合に必要です。 このオプションを指定する場合は、ECSインスタンスにアタッチされているRAMロールの名前にEcsRamRoleTestingを設定するだけです。 このオプションを指定した後は、AccessKey ID、AccessKey Secret、およびSTSTokenパラメーターを指定する必要はありません。 AccessKey IDを指定した場合、AkService設定は有効になりません。 AccessKey ID、AccessKey Secret、およびSTSToken設定は、IDの検証に使用されます。 RAMロールをECSインスタンスにアタッチする方法の詳細については、「インスタンスRAMロールを使用した他のAlibaba CloudサービスへのECSアクセスの付与」をご参照ください。

  • デフォルト: 共通パラメーターのデフォルト値を変更する場合は、このオプションを指定できます。 詳細については、「オプションの表示」をご参照ください。

    説明

    ossutil V1.7.15以降のみがデフォルトオプションをサポートしています。