How to use the command 'odps inst' (with examples)

The command ‘odps inst’ is used to manage instances in ODPS (Open Data Processing Service). It provides the ability to view, describe, check the status, wait for termination, and kill instances in ODPS. This article will illustrate each of these use cases with examples.

Use case 1: Show instances created by current user

Code:

odps inst show instances;

Motivation: This use case allows users to view the instances that they have created in ODPS. This can be useful for tracking and managing the progress of data processing tasks.

Explanation: The ‘show instances’ command is used to list all the instances created by the current user. It does not require any additional arguments.

Example output:

Instance ID        Owner        Creation Time           Status
---------------------------------------------------------------
123456789         user1        2021-01-01 10:00:00     Running
987654321         user1        2021-01-02 12:00:00     Succeeded

Use case 2: Describe the details of an instance

Code:

odps inst desc instance 123456789;

Motivation: This use case allows users to retrieve detailed information about a specific instance in ODPS. This can be useful for troubleshooting and understanding the execution details of a job.

Explanation: The ‘desc instance’ command is used to describe the details of a specific instance. It requires an additional argument ‘instance_id’ which is the ID of the instance to be described.

Example output:

Instance ID: 123456789
Owner: user1
Creation Time: 2021-01-01 10:00:00
Status: Running
Instance Type: ODPS

Use case 3: Check the status of an instance

Code:

odps inst status 123456789;

Motivation: This use case allows users to check the status of a specific instance in ODPS. This can be useful for monitoring the progress and completion of a job.

Explanation: The ‘status’ command is used to check the status of an instance. It requires an additional argument ‘instance_id’ which is the ID of the instance to be checked.

Example output:

Instance ID: 123456789
Status: Running

Use case 4: Wait on the termination of an instance, printing log and progress information until then

Code:

odps inst wait 123456789;

Motivation: This use case allows users to wait for the termination of a specific instance in ODPS. It prints log and progress information until the instance is terminated. This can be useful for monitoring the execution of a long-running job.

Explanation: The ‘wait’ command is used to wait on the termination of an instance. It requires an additional argument ‘instance_id’ which is the ID of the instance to wait for.

Example output:

Waiting for instance 123456789 to terminate...

2021-01-01 10:00:00 Task 1: Running
2021-01-01 10:01:00 Task 2: Running
2021-01-01 10:02:00 Task 1: Succeeded
2021-01-01 10:02:10 Task 2: Succeeded

Instance 123456789 has terminated successfully.

Use case 5: Kill an instance

Code:

odps inst kill 123456789;

Motivation: This use case allows users to terminate a specific instance in ODPS. This can be useful for stopping the execution of a job that is no longer needed or has encountered an issue.

Explanation: The ‘kill’ command is used to kill an instance. It requires an additional argument ‘instance_id’ which is the ID of the instance to be killed.

Example output:

Instance 123456789 has been terminated.

Conclusion:

The command ‘odps inst’ provides a set of useful functionalities for managing instances in ODPS. Users can use this command to view, describe, check the status, wait for termination, and kill instances in ODPS. By understanding and utilizing these use cases, users can effectively manage their data processing tasks in ODPS.