すべてのプロダクト
Search

このプロダクト

    MaxCompute:MaxComputeクライアントをインストールして起動する

    ドキュメントセンター

    MaxCompute:MaxComputeクライアントをインストールして起動する

    最終更新日:Nov 22, 2024

    MaxComputeクライアント (odpscmd) は、オンプレミスのコンピューターで直接実行され、コマンドを実行してMaxComputeサービスを管理するためのシンプルで効率的な方法を提供します。 このトピックでは、MaxComputeクライアントをインストールして起動する方法について説明します。 クライアントが起動すると、MaxComputeプロジェクトが接続されます。

    前提条件

    MaxComputeクライアントをインストールする前に、次の条件が満たされていることを確認してください。

    • MaxComputeクライアントをインストールするマシンにJava 8以降がインストールされます。

    • MaxComputeプロジェクトが作成されます。

      MaxComputeプロジェクトの作成方法の詳細については、「MaxComputeプロジェクトの作成」をご参照ください。

    • MaxComputeクライアントを使用するRAMユーザーが、MaxComputeプロジェクトが属するDataWorksワークスペースに追加されます。

      DataWorksワークスペースにメンバーを追加する方法の詳細については、「RAMユーザーへの権限の付与」をご参照ください。

    制限事項

    MaxComputeクライアントV0.28.0以降は、Java Development Kit (JDK) 1.8とJDK 1.9をサポートしています。 V0.28.0より前のバージョンのMaxComputeクライアントは、JDK 1.8のみをサポートします。 MaxComputeクライアントを起動した後、CLIでクライアントのバージョンを確認できます。 MaxComputeクライアントを起動する方法の詳細については、「MaxComputeクライアントの実行」をご参照ください。

    MaxComputeクライアントのインストールと設定

    説明

    MaxComputeクライアントV0.27.0以降は、MaxCompute V2.0データ型エディションをサポートしています。 MaxCompute V2.0データ型エディションの使用を推奨します。 MaxCompute V2.0データ型エディションでサポートされているデータ型の詳細については、「MaxCompute V2.0データ型エディション」をご参照ください。

    MaxComputeクライアントをインストールして設定するには、次の手順を実行します。

    1. GitHubからMaxComputeクライアントインストールパッケージをダウンロードします。

      説明

      • 上記のリンクをクリックすると、表示されるページで最新バージョンのMaxComputeクライアントインストールパッケージ odpscmd_public.zip をダウンロードできます。

      • odpscmd_public_0.48.0.zipをクリックしてもパッケージをダウンロードできない場合は、をクリックしてパッケージをダウンロードします。 ダウンロードの失敗を解決する方法の詳細については、検索エンジンを使用して関連ソリューションを検索することをお勧めします。

    2. ダウンロードしたパッケージを解凍し、bin,conf,lib、およびpluginsフォルダーを取得します。

    3. confフォルダーを開きます。odps_config.iniファイルを設定します。

      odps_config.iniファイルで、番号記号 (#) で始まる行はコメントです。 odps_config.iniファイルのパラメーターを次の表に示します。

      パラメーター

      必須

      説明

      例

      project_name

      必須

      アクセスするMaxComputeプロジェクトの名前。

      標準モードでワークスペースを作成する場合、Default Project パラメーターを設定するときに、運用環境と開発環境のプロジェクト名の違いに注意してください。 開発環境のプロジェクトの名前は_devで終わります。 詳細については、「基本モードのワークスペースと標準モードのワークスペースの違い」をご参照ください。

      MaxComputeプロジェクトの名前を取得するには、次の手順を実行します。MaxComputeコンソールにログインします。 上部のナビゲーションバーで、リージョンを選択します。 左側のナビゲーションウィンドウで、[ワークスペース] > [プロジェクト] を選択します。 [プロジェクト] ページで、MaxComputeプロジェクトの名前を表示します。

      doc_test_dev

      access_id

      必須

      Alibaba CloudアカウントまたはRAMユーザーのAccessKey ID。

      MaxComputeコンソールの右上隅にあるプロファイル画像をクリックし、AccessKey管理を選択してAccessKey IDを取得します。

      なし

      access_key

      必須

      AccessKey IDに対応するAccessKeyシークレット。

      MaxComputeコンソールの右上隅にあるプロファイル画像をクリックし、AccessKey Managementを選択してAccessKeyシークレットを取得できます。

      なし

      end_point

      必須

      MaxComputeプロジェクトのエンドポイントを取得します。

      このパラメーターは、MaxComputeプロジェクトの作成時に選択したリージョンとネットワーク接続方法に基づいて設定する必要があります。 異なるリージョンとネットワーク接続タイプに対応するエンドポイントの詳細については、「エンドポイント」をご参照ください。

      重要

      • このパラメーターの値は、MaxComputeトンネルではなくMaxComputeへのアクセスに使用されるMaxComputeのエンドポイントです。

      • 無効なエンドポイントを指定した場合、MaxComputeプロジェクトにアクセスするとエラーが発生します。

      http://service.cn-hangzhou.maxcompute.aliyun.com/api

      log_view_host

      選択可能

      LogViewのURL (Uniform Resource Locator) 。 このURLを使用すると、ジョブの詳細な実行時情報を表示できます。 この情報は、ジョブエラーのトラブルシューティングに役立ちます。 値を http://logview.odps.aliyun.com に設定します。

      説明

      このパラメーターを設定することを推奨します。 このパラメーターを設定しないと, ジョブエラーの原因を特定できません。

      http://logview.odps.aliyun.com

      https_check

      選択可能

      HTTPSアクセスを有効にするかどうかを指定します。 HTTPSアクセスが有効になっている場合、MaxComputeプロジェクトへのアクセス要求は暗号化されます。 有効な値：

      • True: HTTPSアクセスが有効です。

      • False: HTTPアクセスが有効です。

      デフォルト値：False。

      True

      data_size_confirm

      選択可能

      入力データの最大サイズ。 (単位：GB) このパラメーターは任意の値に設定できます。 このパラメーターを100に設定することを推奨します。

      100

      update_url

      選択可能

      予約済みのパラメーター。

      なし

      use_instance_tunnel

      選択可能

      InstanceTunnelを使用してSQL文の実行結果をダウンロードするかどうかを指定します。 有効な値：

      • True: InstanceTunnelは、SQL文の実行結果をダウンロードするために使用されます。

      • False: InstanceTunnelは、SQL文の実行結果のダウンロードには使用されません。

      デフォルト値：False。

      True

      instance_tunnel_max_record

      選択可能

      クライアントが返すことができるSQL実行結果の最大数。 use_instance_tunnelパラメーターがTrueに設定されている場合、このパラメーターを設定する必要があります。 最大値: 10000。

      10000

      tunnel_endpoint

      選択可能

      MaxCompute Tunnelのパブリックエンドポイント。 このパラメーターを設定しないと、トラフィックはMaxComputeが存在するネットワークに対応するTunnelエンドポイントに自動的にルーティングされます。 このパラメーターを設定すると、トラフィックは指定されたエンドポイントにルーティングされ、自動ルーティングは実行されません。

      各リージョンとネットワークに対応するトンネルエンドポイントの詳細については、「エンドポイント」をご参照ください。

      http://dt.cn-hangzhou.maxcompute.aliyun.com

      set.<key>

      選択可能

      MaxComputeプロジェクトのプロパティ。

      MaxComputeプロジェクトのプロパティの詳細については、「プロパティ」をご参照ください。

      set.odps.sql.de cimal.odps2=true

      説明

      上記のパラメーターの設定が有効であることを確認してください。 設定が無効であると、プロジェクト接続に失敗します。

    MaxComputeクライアントを起動する

    次のいずれかの方法を使用して、MaxComputeクライアントを起動できます。

    方法1: インストールパッケージのスクリプトファイルを使用してMaxComputeクライアントを起動する

    MaxComputeクライアントのインストールディレクトリにあるbinフォルダーで、Windowsオペレーティングシステム (OS) 用のodpscmd.batファイルまたはmacOS用のodpscmdファイルをダブルクリックして、MaxComputeクライアントを起動します。 次の図に示す情報が返された場合、MaxComputeプロジェクトは接続されています。image.png

    方法2: システムのCLIを使用してMaxComputeクライアントを起動する

    システムのCLIで、MaxComputeクライアントのインストールディレクトリのbinフォルダーに移動し、Windows OSのodpscmdコマンドを実行するか、macOSまたはLinux OSのsh odpscmdコマンドを実行してMaxComputeクライアントを起動します。 次の図に示す情報が返された場合、MaxComputeプロジェクトは接続されています。

    説明

    Ubuntuでsh odpscmdコマンドを実行すると、エラーが返されます。 を実行できます。You can run the. /odpscmdコマンドを実行して、MaxComputeクライアントを起動します。

    image.png

    システムのCLIを使用してMaxComputeクライアントを起動する場合、コマンドを実行するためのパラメーターを指定できます。 詳細は、「スタートアップパラメーターの指定」をご参照ください。

    次のステップ

    MaxComputeクライアントを起動した後、接続されたMaxComputeプロジェクトにテーブルを作成できます。 テーブルの作成方法の詳細については、「テーブルの作成」をご参照ください。

    関連ドキュメント

    MaxComputeクライアントの使用方法と、MaxComputeクライアントの設定時に発生する可能性のある一般的なエラーの詳細については、「MaxComputeクライアント (odpscmd) 」をご参照ください。