Install and configure a client

Last Updated: Apr 20, 2018

You can access MaxCompute features using the client. This section introduces how to install and configure a client. For more information, see Client.


We recommend that you use the MaxCompute Studio tool. This tool is integrated with the Java environment and allows development and execution of MaxCompute SQL scripts, data management, visual log analysis, JAVA (UDF, MR) development. And the console can also be integratd into this tool. For more information, see What is Studio.

You can also use DataWorks to access MaxCompute. After creating a project on the console, you can directly click Enter Workspace of the specified project in the project list to operate. For more information, see DataWorks.

Install a client


Since MaxCompute client is developed in Java, make sure you have installed JRE 1.7 or later version first.

  1. Click download MaxCompute client.
  2. Decompress it into a folder. After decompression, you can see four following folders:
  1. bin/ conf/ lib/ plugins/

Configure a client

Edit the odps_config.ini file from the conf folder to configure the client:

  1. access_id=*******************
  2. access_key=*********************
  3. #AccessID and AccessKey correspond to your Alibaba Cloud account information. You can apply for it on the official website.
  4. project_name=my_project
  5. # Specify the project you want to use.
  6. end_point=https://xxxxx
  7. # Access URL of the MaxCompute service.
  8. tunnel_endpoint=https://xxxxx
  9. # Access URL of the MaxCompute Tunnel service.
  10. log_view_host=
  11. # After task execution, the client returns the LogView address of this task. You can view the detailed execution information of this task at this address.
  12. https_check=true
  13. # Determine whether to enable HTTPS access.


  • We recommend that you configure the client according to the region.
  • The number sign (#) is used as a comment symbol in the dps_config.ini file. However, the MaxCompute client uses double minus signs (—) as a comment.
  • You must create a project before specifying it in the configuration file. For more information, see Create a project.
  • MaxCompute provides two service addresses separately on the Internet and the intranet. Different addresses correspond to different download prices. For more information, see Access Domains and Data Centers.

Run the Console

After the configuration file is modified, you can run MaxCompute in bin directory (./bin/odpscmd in Linux, and ./bin/odpscmd.bat in Windows), for example:

  1. create table tbl1(id bigint);
  2. insert overwrite table tbl1 select count(*) from tbl1;
  3. select 'welcome to MaxCompute!' from tbl1;

For more information about SQL statements, see Summary.

Thank you! We've received your feedback.