odps-inst
Install ODPS instance components
TLDR
Show instances created by current user
Describe the details of an instance
Check the status of an instance
Wait on the termination of an instance, printing log and progress information until then
Kill an instance
SYNOPSIS
odps-inst [options]
PARAMETERS
-h, --help
Display help information.
-s, --status
Show the status of the specified instance.
-l, --logview
Show the logview URL of the specified instance.
-o, --output
Redirect the output to a file.
-c, --cancel
Cancel the specified instance.
-w, --wait
Wait for the instance to complete and return the status.
-p
Specifies the MaxCompute project.
-e
Specifies the MaxCompute endpoint.
-ak
Specifies the access key ID.
-sk
Specifies the access key secret.
DESCRIPTION
The `odps-inst` command is a command-line utility used for managing instances within Alibaba Cloud's MaxCompute (formerly known as ODPS). It allows users to perform various operations on MaxCompute instances, such as viewing instance status, cancelling running instances, and retrieving instance logs. This command is typically part of the ODPS SDK and is essential for interacting with and monitoring MaxCompute jobs. It helps users to monitor the execution of their data processing tasks, diagnose potential problems, and control the overall resource usage within their MaxCompute project. The key functionality of this command is centered around control and insight into running ODPS jobs. It provides a crucial interface for developers and operators to interact with MaxCompute's task execution engine.
CAVEATS
Ensure you have the correct ODPS SDK installed and configured with the necessary access credentials before using this command. Improper credentials or network configuration can prevent `odps-inst` from connecting to MaxCompute. Cancelling an instance may result in data loss if the job has not yet completed its operations.
AUTHENTICATION
Authentication to MaxCompute is critical.
Ensure that you have set the environment variables: ALIYUN_ACCESS_KEY_ID and ALIYUN_ACCESS_KEY_SECRET, or use command line parameters to set authentication parameters.
If you don't set authentication correctly, you will be unable to connect to MaxCompute.
LOGVIEW URLS
The logview parameter returns an URL, which can be opened in browser to see running task information and log output. This is useful when debugging jobs.
ERROR HANDLING
Check the error messages carefully. The messages contain important information. The status parameter helps you to identify if a job completed successfully or failed.
Use logview urls to further investigate root causes.
HISTORY
The `odps-inst` command evolved as part of the MaxCompute (formerly ODPS) ecosystem within Alibaba Cloud. Its development was driven by the need for users to manage and monitor the execution of their data processing jobs on the MaxCompute platform. As MaxCompute usage grew, so did the need for a dedicated command-line tool for instance management, leading to the creation and subsequent updates of `odps-inst`.
Initial versions likely focused on basic status retrieval and cancellation, while later iterations incorporated features like logview integration, project specification, and improved error handling to enhance usability and operational efficiency. The command continues to be maintained and updated as MaxCompute evolves.
SEE ALSO
odpscmd(1)