よくある質問の説明
この記事の内容
- 1.プライベートクラウドでスケジューリングAPIを使用できない
- 説明
- 原因と解決方法
- 原因1
- 解決方法
- 原因2
- 解決方法
- 原因3
- 解決方法
- 2.job/stop、job/query、task/stop、task/queryに関連する照会・制御APIを使用できない
- 説明
- 原因と解決方法
- 原因1
- 解決方法
- 3.スケジューリングAPIのユーザーがコールバックを受信していない
- 説明
- 考えられる原因と解決方法
- 原因1
- 解決方法
- 原因2
- 解決方法
- 4.スケジューリングAPIでaccountNameを指定しても反映されない
- 説明
- 原因と解決方法
- 原因1
- 解決方法
- 5.スケジューリングAPIでstartJob APIを呼び出すと、userUuidフィールドがnullであってはならないと表示される
- 説明
- 原因と解決方法
- 原因1
- 解決方法
- 6.ロボットにメインフローパラメータを設定しても、コンソールでタスクを設定するとパラメータボタンがグレーアウトしている
- 説明
- 原因と解決方法
- 原因1
- 解決方法
- 7.スケジューリングのtask/start APIで入力パラメータを渡せない
- 説明
- 原因と解決方法
- 原因1
- 解決方法
- 原因2
- 解決方法
- 原因3
- 解決方法
- 原因4
- 8.スケジューリングのjob/start APIでロボットアカウントが存在しないと表示される
- 説明
- 考えられる原因と解決方法
- 原因1
- 解決方法
- 原因2
- 解決方法
- 原因3
- 解決方法
- 9.スケジューリングAPIはスケジューリングモードでのみ使用できるか
- 説明
- 解決方法
- 10.コールバックAPIで署名を検証する必要があるか
1.プライベートクラウドでスケジューリングAPIを使用できない
説明
job/startまたはtask/startの呼び出しが成功しません。
原因と解決方法
原因1
プライベートクラウドのアドレスを使用してリクエストしていません。
解決方法
プライベートクラウドのアドレスを使用してリクエストしてください。
原因2
keyとsecretが正しくありません。パブリッククラウドのkeyとsecretを使用している可能性があります。
解決方法
表示された案内に従ってkeyとsecretを修正してください。
原因3
APIのコメントをそのままコピーした可能性があります。
解決方法
postManはコメントを認識しないため、コメントを削除してください。
2.job/stop、job/query、task/stop、task/queryに関連する照会・制御APIを使用できない
説明
現在、APIにはtask/xxxとjob/xxxの2種類があります。job/xxxは、実行ロボットとロボットを1:1で指定する簡単な実行方法を提供しますが、オーケストレーション機能はありません。taskでは、コンソールでタスクを新規作成し、タスクのuuidを指定して起動する必要があり、より豊富な機能を利用できます。
原因と解決方法
原因1
APIに渡す情報が誤っています。たとえば、job/stopで停止する際にtaskUuidを使用しています。
解決方法
正しいパラメータを使用してください。jobUuidとtaskUuidは、それぞれjob/start、task/start APIから返されます。
3.スケジューリングAPIのユーザーがコールバックを受信していない
説明
ケース1:job/startで、ロボットの実行が完了してもコールバックを受信しません。ケース2:task/startで、タスク内のすべてのロボットの実行が完了してもコールバックを受信しません。
考えられる原因と解決方法
原因1
クライアントではロボットの実行が完了したと表示されますが、サーバー側ではロボットが実行中と表示されています(API実行記録)。
解決方法
1.タスクの状態が同期されていないことが原因です。3を参照してください。現時点では、まずコンソールで手動でタスクを終了し、コールバックをトリガーする必要があります。
原因2
クライアントとコンソールの両方で完了と表示されていますが、ユーザーがコールバックを受信していません。
解決方法
- ファイアウォールのポリシーを確認し、許可リストにDr.Roboの本番サーバーのIPが追加されているか確認してください。本番環境のIPアドレスについては、雲山にお問い合わせください。
- ユーザーが提供したAPIにパブリックインターネットからアクセスできるか確認してください。
- ユーザーがローカルでデバッグしているAPIに対しては、本番サーバーからのコールバックはサポートされていません。
- api_callback_recordテーブルを、sourceUuidに基づいて照会してください。
注:サーバー側には即時の再送処理と定期的な再送処理があります。即時の再送処理では、500ms、750ms、1500msの間隔で3回再試行します。定期的な再送処理では、毎時0分に再送を行い、24回実施します。
4.スケジューリングAPIでaccountNameを指定しても反映されない
説明
ceshi1アカウントを指定しましたが、別のアカウントでロボットが実行されます。
原因と解決方法
原因1
accountNameとrobotClientGroupUuidを両方指定した場合、グループの指定が優先されます。
解決方法
robotClientGroupUuidを削除してください。
5.スケジューリングAPIでstartJob APIを呼び出すと、userUuidフィールドがnullであってはならないと表示される
説明
以前の古いkeyとsecretを使用すると発生することがあります。
例:
原因と解決方法
原因1
keyとsecretを作成した管理者ユーザーが削除されています。
解決方法
管理者アカウントでkeyとsecretを再生成し、置き換えてください。
注:このように設計されているのは、実行記録を代理ユーザーに関連付ける必要があるためです(keyとsecretは開発プラットフォームの設定にすぎず、特定のユーザーではありません)。この代理ユーザーとは、keyとsecretを作成したユーザーを指します。
6.ロボットにメインフローパラメータを設定しても、コンソールでタスクを設定するとパラメータボタンがグレーアウトしている
説明
ロボットにメインフローパラメータを設定しても、コンソールでタスクを設定するとパラメータボタンがグレーアウトしています。
原因と解決方法
原因1
ロボットに設定したメインフローパラメータが大きすぎます。4000バイトを超えると失われます。たとえば、設定したデフォルト値が非常に長い場合です。
解決方法
- デフォルト値を調整してください。
- 長いテキストをファイル形式に変換してください。
7.スケジューリングのtask/start APIで入力パラメータを渡せない
説明
実行記録の「ロボット実行記録」に実行パラメータがありません。
- start/job APIには入力パラメータを渡しています。
- 実行記録の実行パラメータが空です。
原因と解決方法
原因1
ロボットに設定したメインフローパラメータが大きすぎます。4000バイトを超えると失われます。たとえば、設定したデフォルト値が非常に長い場合です。
解決方法
- デフォルト値を調整してください。
- 長いテキストをファイル形式に変換してください。
原因2
メインフローパラメータの設定が誤っています。
解決方法
- テンプレートをダウンロードし、メインフローパラメータのリクエストテンプレートを見つけて、パラメータを置き換えてください。
- robotUuidと、タスクの新規作成時に選択したuuidが一致しているか確認してください。
- 1つのタスクに複数のタスクを設定できるため、scheduleRelaParamsはオブジェクトのコレクションです。以下のスクリーンショットを参照してください。
原因3
フロントエンドに残っている問題により、タスクの新規作成・編集時にパラメータボタンをクリックして保存する必要があります。
解決方法
タスクを編集し、パラメータをクリックして保存してください。
原因4
ロボットが削除されているか、バージョンが公開されていません。
8.スケジューリングのjob/start APIでロボットアカウントが存在しないと表示される
説明
job/start APIでロボットアカウントが存在しないと表示されます。
考えられる原因と解決方法
原因1
accountNameまたはrobotClientGroupUuidを渡していません。
解決方法
対応するロボットアカウント、または実行ロボットグループのuuidを渡してください。ロボットグループのuuidは、「ロボット管理」→「ロボットグループ」→右ボタンでクリックしてコピーできます。
原因2
誤ったaccountNameを渡しています。
解決方法
1.コンソールの「ロボット管理」の一覧画面に、対応するロボットが存在するか確認してください。
原因3
正しいユーザーアカウントを渡していますが、そのアカウントで一度もスケジューリングモードに切り替えていません。
新規作成したアカウントは、一度スケジューリングモードに切り替えることでロボットとして登録されます。つまり、ユーザーアカウントとロボットは同じではありません。
解決方法
新規作成したアカウントでクライアントにログインし、スケジューリングモードに切り替えてください。
9.スケジューリングAPIはスケジューリングモードでのみ使用できるか
説明
APIを使用してjobを起動できるのは、スケジューリングモードの場合だけです。スケジューリングモード以外でAPIを使用してjobを起動しても、実際にはタスクが起動せず、APIからエラーメッセージも返されません。
解決方法
キューで待機する仕組みがあります(デフォルトは10分)。キューの待機時間の列挙値については、スケジューリングAPIドキュメントの列挙値を参照してください。ロボットがオフラインでも呼び出しは成功します。10分以内にロボットが接続されれば、キュー内のタスクを実行できるため、エラーは返されません。
10.コールバックAPIで署名を検証する必要があるか
悪意のある攻撃を防ぐため、署名の検証を行うことをお勧めします。