AUTORO REST APIを使用する

実行中のセッションをキャンセルするためには、リクエストのエンドポイントに実行中のセッションのID（session_queue_id）を挿入する必要があります。

これらは以下2つの方法で確認できます。

1. セッションキュー一覧取得のレスポンスから確認

取得したセッションキュー（JSON）のidが、セッションキューID（session_queue_id）となります。

2. AUTOROのセッション画面から確認

セッション一覧中、最も左のセッションID列の値がセッションキューID（session_queue_id）となります。

以下にて「現在実行中」のセッションをすべてキャンセルできます。
アクセスキー、シークレットアクセスキーの箇所をご自身のものに変更いただくと、すぐに使用できます。
スケジュール機能との併用も可能です。

# 変数に保存_ACCESS_KEY_ID
+store_value_accessKey:
  action>: StoreValue
  key: accessKey
  value: 'アクセスキー'

# 変数に保存_SECRET_ACCESS_KEY
+store_value_secretAccessKey:
  action>: StoreValue
  key: secretKey
  value: 'シークレットアクセスキー'

# HTTPリクエストでトークンを取得
+h_t_t_p_request_getAutoroJWT:
  action>: HTTPRequest
  url: 'https://api.roboticcrowd.com/v1/token'
  params:
    access_key_id: ${accessKey}
    secret_access_key: ${secretKey}
    expires: 3600
  method: POST
  headers:
    Content-Type: 'application/json'
  multipart: false

# 変数に保存_jwt
+store_value_jwt:
  action>: StoreValue
  key: jwt
  value: +h_t_t_p_request_getAutoroJWT

# テキストを作成_JWTトークンをリクエスト用の形式に加工
+text_jwt:
  action>: Text
  text: 'Bearer ${jwt}'

# リクエストヘッダーを作成
+create_object_requestHeader:
  action>: CreateObject
  object:
    Authorization: +text_jwt

# HTTPリクエスト_起動中のセッション一覧を取得
+h_t_t_p_request_getSessions:
  action>: HTTPRequest
  url: 'https://api.roboticcrowd.com/v1/session_queues?per_page=50&page=1&query=is%3Arunning'
  params: ''
  method: GET
  headers: +create_object_requestHeader
  multipart: false

# オブジェクトのキーの値を取得_条件を満たすセッションの総数
+get_value_with_key_totalCount:
  action>: GetValueWithKey
  object: +h_t_t_p_request_getSessions
  key: total_count
  meta:
    display: null

# 変数に保存_条件を満たすセッションの総数
+store_value_totalCount:
  action>: StoreValue
  key: totalCount
  value: +get_value_with_key_totalCount

# 繰り返し_セッションキューは1リクエストあたり50件までしか取れない仕様のためloopを設定
+loop_sessionQueue:
  loop>: ${Math.ceil(totalCount / 50)}
  _do:

    # HTTPリクエスト_起動中のセッション一覧を取得_isRunning
    +h_t_t_p_request_getSessions_2:
      action>: HTTPRequest
      url: 'https://api.roboticcrowd.com/v1/session_queues?per_page=50&page=${i+1}&query=is%3Arunning'
      params: ''
      method: GET
      headers: +create_object_requestHeader
      multipart: false

    # オブジェクトのキーの値を取得_セッションキュー
    +get_value_with_key_sessionQueue:
      action>: GetValueWithKey
      object: +h_t_t_p_request_getSessions_2
      key: session_queues

    # 各要素について繰り返す_実行中の各セッションキュー
    +for_each_sessionQueue:
      for_each>:
        sQue: +get_value_with_key_sessionQueue
      _do:

        # 真のとき_このワークフローでなければセッションをキャンセルする（WORKFLOW_IDにはこのワークフローのIDが入ってます）
        +if_isNotThisWorkflow:
          if>: ${sQue.workflow.id != WORKFLOW_ID}
          _do:

            # HTTPリクエスト_セッションをキャンセル
            +h_t_t_p_request_kill:
              action>: HTTPRequest
              url: 'https://api.roboticcrowd.com/v1/session_queues/${sQue.id}/cancel'
              params: ''
              method: DELETE
              headers: +create_object_requestHeader
              multipart: false

以下で「現在実行中」のセッションをキャンセルできます。

curl --location --request DELETE "https://api.roboticcrowd.com/v1/session_queues/セッションキューID/cancel" \
  --header "Authorization: Bearer ここにJWT" \
  --header "content-type: application/json"

以下で「現在実行中」のセッションをキャンセルできます。

curl --location --request DELETE "https://api.roboticcrowd.com/v1/session_queues/セッションキューID/cancel" --header "Authorization: Bearer ここにJWT" --header "content-type: application/json"

セッション画面にqueuedやrunningのセッションが大量に存在してしまっている場合、HTTPリクエストアクションを使用したAUTOROワークフローでキャンセルすることは、ロボットの空きが無いために不可能となります。

このような場合は、詳細なCSSセレクタを取得する際にもお馴染みのGoogleChrome DevToolsからAPIリクエストを叩くことによって、比較的お手軽にAUTOROのセッションをキャンセルすることができます。

方法は以下となります。

• 手元のChromeから以下URLにアクセスします。（corsの回避のためです。Unahthorizedと出ますが気にしないでください）
  https://api.roboticcrowd.com/v1/workflows?page=1&per_page=5
• ↑のURLのタブからChrome DevToolsを起動します。（Ctrl + Shift + Iまたは適当な箇所を右クリック→検証）
• Consoleタブを開きます
• 下記コードを貼り付けます

// **************************
// 以下3行を手動指定*************
const accesskey = 'あくせすきー';
const secret = 'しーくれっとあくせすきー';
const sessionQuery = 'query=is:running'; //is:queuedにすると処理待ちを全て消せます
// **************************
// **************************


const tokenEndpoint = 'https://api.roboticcrowd.com/v1/token';
const jwtEndpoint = '';
const jwtReqBody = {
        access_key_id: accesskey,
        secret_access_key: secret,
        expires: 3600
    };
// セッションキャンセル関数
const canceler = async (jwt, sessionQueueIds) =>{
    const reqedIds = ["処理済session_queue_ID"];
    for (const sQue of sessionQueueIds) {
        const delEndpoint = `https://api.roboticcrowd.com/v1/session_queues/${sQue.id}/cancel`
        const hoge = await fetch(delEndpoint, {
            method: 'DELETE',
            mode: 'cors',
            headers: {
                'Authorization': jwt
            }
        })
        reqedIds.push(sQue.id);
    }
    
    return reqedIds;
}

//Quota回避のための待機関数
const sleep = function(ms) { //msに指定したミリ秒だけ待つ関数、sleepを定義します
    return new Promise(resolve => setTimeout(resolve, ms));
};


//ここから本処理開始
//JWT取得
const jwtResponse = await fetch('https://api.roboticcrowd.com/v1/token', {
    method: 'POST',
    // mode: 'cors',
    headers : {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(jwtReqBody)
});
const jwtRespText = await jwtResponse.text();
const jwt = 'Bearer ' + jwtRespText;
console.log("-----↓JWT↓-----");
console.log(jwt);

//セッション取得
const endpoint = 'https://api.roboticcrowd.com/v1/session_queues?page=1&per_page=50&' + sessionQuery;
const sessionsResponse = await fetch(endpoint, {
    method: 'GET',
    mode: 'cors',
    headers: {
        'Authorization': jwt
    }
});

const sessionsRespJSON = await sessionsResponse.json();
const totalCount = sessionsRespJSON.total_count;
const loopCount = Math.ceil(sessionsRespJSON.total_count / 50);
console.log("-----↓セッション↓-----");
console.log(sessionsRespJSON);
console.log("該当セッション数：" + sessionsRespJSON.total_count);
console.log("ループ回数：" + loopCount);


//キャンセル開始
console.log(await canceler(jwt, sessionsRespJSON.session_queues));
//初回以降のキャンセル
if (totalCount > 50) {
    let i = 2;
    while (loopCount+1 > i) {
        const endpoint = `https://api.roboticcrowd.com/v1/session_queues?page=${i}&per_page=50&${sessionQuery}`;
        const sessionsResponse = await fetch(endpoint, {
            method: 'GET',
            mode: 'cors',
            headers: {
                'Authorization': jwt
            }
        });
        const sessionsRespJSON = await sessionsResponse.json();
        console.log(sessionsRespJSON);
        const reqedIds = await canceler(jwt, sessionsRespJSON.session_queues);
        console.log(reqedIds);
        i++;
        //Quotaは1分につき60までなのでなので待機
        await sleep(60500);
    }
}

• コード上部の「アクセスキー」「シークレットアクセスキー」を自身の環境のものに変更します。
• コード上部の変数「sessionQuery」の値を任意のものに変更します。（デフォルトではis:running)
• Enterやreturnキーを押下して、キャンセルを実行します。