MaxCompute本地用戶端(odpscmd)在本機電腦上運行,提供了一個簡單且高效的方式來執行命令和管理MaxCompute服務。本文介紹如何安裝並啟動MaxCompute用戶端,啟動成功後即表示已經登入MaxCompute用戶端並進入MaxCompute專案。
適用範圍
待安裝MaxCompute用戶端的裝置已安裝Java 8或以上版本。
版本相容性
MaxCompute用戶端從v0.28.0版開始支援JDK 1.9,v0.28.0以下版本只支援JDK 1.8。根據本文步驟安裝用戶端後,可在命令列介面查看用戶端版本號碼。
MaxCompute用戶端的輸出格式不承諾向前相容,不同版本間的用戶端命令格式及行為有差異,請勿依賴用戶端的輸出格式執行任何解析工作。
更多用戶端版本,請參見aliyun-odps-console。
編碼格式
用戶端預設編碼為UTF-8,若本機環境編碼不是UTF-8,通過用戶端查詢MaxCompute表資料傳回值有中文時可能會出現亂碼,或通過用戶端執行Tunnel命令上傳本機資料檔案到MaxCompute,也可能會出現中文亂碼。
安裝並配置MaxCompute用戶端
用戶端從v0.27.0版本開始支援MaxCompute 2.0新資料類型,推薦使用新資料類型。支援的資料類型列表,請參見2.0資料類型版本。
操作流程如下:
- 說明
通過上方連結進入用戶端發布介面,下載最新版本的MaxCompute用戶端安裝包(odpscmd_public.zip)。
如果上方連結無法下載,可以嘗試單擊此處的MaxCompute用戶端安裝包(OSS)下載。更多關於GitHub連結訪問失敗的問題,推薦在搜尋引擎中尋找相關解決方案。
解壓下載的安裝包檔案,得到bin、conf、lib和plugins檔案夾。
進入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。
無
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專案。
方式二:系統的命令列執行視窗
在系統的命令列執行視窗,進入MaxCompute用戶端安裝路徑下的bin目錄,執行odpscmd命令(Windows系統)或sh odpscmd(Linux系統或Mac系統),即可啟動MaxCompute用戶端。返回如下資訊,表明已成功串連MaxCompute專案。
在Ubuntu執行sh odpscmd會提示報錯,請使用./odpscmd命令嘗試啟動。

如果通過系統的命令列視窗啟動MaxCompute用戶端,可以指定參數來執行命令,更多參數資訊,請參見啟動參數。
後續步驟
在MaxCompute專案內建立表。
相關文檔
使用MaxCompute用戶端詳細說明及配置時的常見報錯,請參見使用本地用戶端(odpscmd)串連。