全部產品
Search
文件中心

MaxCompute:安裝並登入MaxCompute本地用戶端

更新時間:Jun 19, 2024

MaxCompute本地用戶端(odpscmd)直接在您的本機電腦上運行,提供了一個簡單且高效的方式來執行命令和管理MaxCompute服務。本文為您介紹如何安裝並啟動MaxCompute用戶端,啟動成功後即表示已經登入MaxCompute用戶端並進入MaxCompute專案。

前提條件

在使用MaxCompute用戶端前,請您確認已滿足如下條件:

  • 待安裝MaxCompute用戶端的裝置已安裝Java 8或以上版本。

  • 已建立MaxCompute專案。

    更多建立MaxCompute專案操作,請參見建立MaxCompute專案

  • 使用MaxCompute用戶端的RAM使用者已被添加至MaxCompute專案所屬的DataWorks工作空間。

    更多添加工作空間成員操作,請參見授權給其他使用者

使用限制

MaxCompute用戶端從v0.28.0版開始支援JDK 1.9,v0.28.0以下版本只支援JDK 1.8。您可以啟動MaxCompute用戶端後,在命令列介面查看用戶端版本號碼。更多啟動用戶端操作,請參見運行MaxCompute用戶端

安裝並配置MaxCompute用戶端

說明

用戶端從v0.27.0版本開始支援MaxCompute 2.0新資料類型,推薦使用新資料類型。支援的資料類型列表,請參見2.0資料類型版本

安裝並配置MaxCompute用戶端的操作流程如下:

  1. 下載MaxCompute用戶端安裝包(Github)

    說明
    • 您可以通過上方連結進入用戶端發布介面,下載最新版本的MaxCompute用戶端安裝包(odpscmd_public.zip)。

    • 如果上方連結無法下載,您可以嘗試單擊此處的MaxCompute用戶端安裝包(OSS)進行下載。更多關於Github連結訪問失敗的問題,推薦您直接在搜尋引擎中尋找相關解決方案。

  2. 解壓下載的安裝包檔案,得到binconflibplugins檔案夾。

  3. 進入conf檔案夾,配置odps_config.ini檔案。

    odps_config.ini檔案中使用井號(#)作為注釋。參數說明如下。

    參數

    是否必填

    描述

    樣本

    project_name

    訪問的目標MaxCompute專案名稱。

    如果您建立了標準模式的工作空間,在配置project_name時,請注意區分生產環境與開發環境(_dev)的專案名稱,請參見必讀:簡單模式和標準模式的區別

    您可以登入MaxCompute控制台,在工作區> 專案管理頁面擷取MaxCompute專案名稱。

    doc_test_dev

    access_id

    阿里雲帳號或RAM使用者的AccessKey ID。

    您可以進入AccessKey管理頁面擷取AccessKey ID。

    access_key

    AccessKey ID對應的AccessKey Secret。

    您可以進入AccessKey管理頁面擷取AccessKey Secret。

    end_point

    MaxCompute服務的串連地址。

    您需要根據建立MaxCompute專案時選擇的地區以及網路連接方式配置Endpoint。各地區及網路對應的Endpoint值,請參見Endpoint

    重要
    • Endpoint用於MaxCompute服務,Tunnel Endpoint用於MaxCompute的Tunnel服務,此處請填寫Endpoint。

    • 如果Endpoint配置有誤,會出現無法訪問錯誤,請務必仔細確認。

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

    log_view_host

    Logview地址。您可以通過該地址查看作業的詳細運行資訊,並為報錯處理提供依據。固定取值為:http://logview.odps.aliyun.com。

    說明

    推薦您配置該參數,如果不配置該參數,在作業報錯時無法快速定位問題。

    http://logview.odps.aliyun.com

    https_check

    是否開啟HTTPS訪問機制,對訪問MaxCompute專案的請求進行加密。取值範圍如下:

    • True:採用HTTPS機制。

    • False:採用HTTP機制。

    預設值為False。

    True

    data_size_confirm

    輸入資料量的最大值,單位為GB。取值範圍無限制。推薦設定為100 GB。

    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

    Tunnel服務的外網訪問連結。如果您未配置Tunnel Endpoint,Tunnel會自動路由到MaxCompute服務所在網路對應的Tunnel Endpoint。如果您配置了Tunnel Endpoint,則以配置為準,不進行自動路由。

    各地區及網路對應的Tunnel Endpoint值,請參見Endpoint

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

    set.<key>

    設定MaxCompute專案的屬性。

    更多屬性資訊,請參見屬性列表

    set.odps.sql.decimal.odps2=true

    說明

    請確保上述資訊配置正確,若資訊配置錯誤,會導致專案串連失敗。

啟動MaxCompute用戶端

MaxCompute用戶端可通過如下方式啟動,您可以任選其中一種:

方式一:安裝包的指令檔

在MaxCompute用戶端安裝路徑下的bin檔案夾中,雙擊odpscmd.bat檔案(Windows系統)或者雙擊odpscmd檔案(macOS系統),即可啟動MaxCompute用戶端。返回如下資訊,表明已成功串連MaxCompute專案。image.png

方式二:系統的命令列執行視窗

在系統的命令列執行視窗,進入MaxCompute用戶端安裝路徑下的bin目錄,執行odpscmd命令(Windows系統)或sh odpscmd(Linux系統或Mac系統),即可啟動MaxCompute用戶端。返回如下資訊,表明已成功串連MaxCompute專案。

說明

在Ubuntu執行sh odpscmd會提示報錯,請您使用./odpscmd命令嘗試啟動。

image.png

如果您通過系統的命令列視窗啟動MaxCompute用戶端,可以指定參數來執行命令,更多參數資訊,請參見參考:啟動參數

後續步驟

登入MaxCompute用戶端後,即可在MaxCompute專案內建立表,請參見建立表

相關文檔

使用MaxCompute用戶端詳細說明及配置時的常見報錯,請參見使用本地用戶端(odpscmd)串連