【Cloud Automator】ジョブと後処理の情報を一括で取得できるコマンドラインツールをリリースしました

Cloud Automator のジョブと後処理の情報を一括で取得できるコマンドラインツールをリリースしました。

背景
コマンドラインツールの紹介
利用方法
おわりに

背景

これまで、Cloud Automator のジョブや後処理の情報を一覧で取得したい場合、Web の管理画面を利用する場合には複数の画面を経由して情報を手動で抽出する必要があり、REST API を利用して情報を取得する場合は技術的な知識が必要とされるなど、どちらの方法も多くの時間と手間がかかっていました。
特に、REST API を利用する方法は技術的な難易度が高く、一部のユーザーにとっては大きな障壁となっておりました。

コマンドラインツールの紹介

今回リリースしたコマンドラインツールを使うことで、ジョブや後処理の情報を簡単に一括で取得できるようになります。
これにより、従来は手動で行っていたデータを収集する作業が自動化され、時間と手間が大幅に削減されます。
また、REST API の操作に関する技術的な障壁が取り除かれるため、プログラミングに不慣れなユーザーでも必要なジョブや後処理の情報を簡単に取得できるようになります。

利用方法

Cloud Automator CLI は、macOS、Linux、および Windows 環境にインストールできます。
今回のブログでは macOS にインストールする手順を記載しますが、その他環境のインストール手順については Cloud Automator CLIリポジトリ内のインストール手順をご参照ください。

1. インストールスクリプトを実行する

$ curl -sSf https://raw.githubusercontent.com/CloudAutomator/cli/main/install.sh | sh -s
checking GitHub for latest tag
found version: 1.0.0 for v1.0.0/macOS/arm64
Download https://github.com/CloudAutomator/cli/releases/download/v1.0.0/ca_v1.0.0_macOS_arm64.tar.gz
installed /usr/local/bin/ca

2. Cloud Automator CLI が正しくインストールされたことを確認する

$ ca version
ca version 1.0.0 (darwin/arm64)

上記コマンド実行時に command not found と表示される場合、インストール先のディレクトリが PATH に含まれているかを確認してください。

3. 環境変数に CloudAutomator の API キーをセットする

APIキーの取得方法については、サービスマニュアルをご覧ください。

$ export CLOUDAUTOMATOR_API_KEY="APIキー"

4. ジョブの一覧を取得する

$ ca jobs
[
  {
    "id": "123456",
    "name": "example-job",
    "group_id": 1234,
    "for_workflow": false,
    "aws_account_id": 4567,
    "provider_type": "aws",
    "rule_type": "schedule",
    "rule_value": {
      "next_schedule": "2024-05-01 12:00:00 +0900",
      "schedule": "2024-05-01 12:00:00",
      "time_zone": "Tokyo"
    },
    "action_type": "start_instances",
    "action_value": {
      "region": "ap-northeast-1",
      "specify_instance": "tag",
      "status_checks_enable": "true",
      "tag_key": "env",
      "tag_value": "dev",
      "trace_status": "true"
    },
    "effective_date": "2024-02-29",
    "expiration_date": "2024-03-01",
    "created_at": "2024-02-29T00:00:00.000+09:00",
    "updated_at": "2024-02-29T00:00:00.000+09:00"
  },
  ...
]

4. IDを指定してジョブを取得する

$ ca jobs --id 123456
{
  "id": "123456",
  "name": "example-job",
  "group_id": 1234,
  "for_workflow": false,
  "aws_account_id": 4567,
  "provider_type": "aws",
  "rule_type": "schedule",
  "rule_value": {
    "next_schedule": "2024-05-01 12:00:00 +0900",
    "schedule": "2024-05-01 12:00:00",
    "time_zone": "Tokyo"
  },
  "action_type": "start_instances",
  "action_value": {
    "region": "ap-northeast-1",
    "specify_instance": "tag",
    "status_checks_enable": "true",
    "tag_key": "env",
    "tag_value": "dev",
    "trace_status": "true"
  },
  "effective_date": "2024-02-29",
  "expiration_date": "2024-03-01",
  "created_at": "2024-02-29T00:00:00.000+09:00",
  "updated_at": "2024-02-29T00:00:00.000+09:00"
}