ロボットの実行ログのポーリング
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
先にロボットの実行ログの検索通知APIを呼び出し、requestldを取得する必要があります。
説明:このAPIではrequestIdを使用して、今回のログをポーリングできます。100ms間隔で1回、100回を超えてポーリングすることを推奨します。
codeの定義:
1.200:ログを取得済みであることを示します
2.500:エラーを示します。ポーリングは不要です
3.80204002:ログのアップロード処理中であることを示します。ポーリングを続ける必要があります
補足:特殊なケースとして、 ロボットの実行ログの検索通知 でrequestIdを取得してから60sを超えてロボットの実行ログのポーリングAPIを呼び出した場合、ログは無効になります(クラウド上でのログの保存期間は60sです)。その場合、このステータスコードが表示されます。
テンプレート
postManテンプレート
Javaテンプレート
リクエストモデル:
レスポンスモデル:
リクエスト
| 基本 | 説明 | |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/job/log/query | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください |
| HTTP Method | GET |
リクエストヘッダー
| 基本 | 説明 | |
| Authorization | Bearer {accessToken} | {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります |
| Content-Type | application/json |
リクエストパラメータ
| 名称 | 型 | 説明 | 必須かどうか | 説明 |
|---|---|---|---|---|
| requestId | string | ロボット実行uuid | はい | ロボットのスタートアップAPIで取得します |
リクエスト例
https://api.example.com/oapi/dispatch/v2/job/log/query?requestId=xxx
レスポンス
レスポンスボディ
| 名称 | 型 | 必須かどうか | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、500は失敗を示します。80204002は処理中を示し、ポーリングを続ける必要があります。10s間ポーリングし、それでもログがない場合は中断することを推奨します |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| msg | string | はい | ステータスコードの説明 |
| data | object | はい | 今回のリクエストのrequestId |
| ∟ requestId | |||
| ∟ page | |||
| ∟ total | int | はい | 総件数 |
| ∟ page | int | はい | ページ番号 |
| ∟ size | int | はい | 1ページあたりの件数 |
| ∟ logs | object | いいえ | ログがない場合は空です |
| ∟ time | string | はい | 日時です。例:03/20/2024 15:35:23 |
| ∟ level | string | はい | ログレベル |
| ∟ text | string | はい | ログテキストです。1K以下で、長すぎる場合は切り詰められます |
| ∟ logId | long | はい | ログid |
80204002は処理中を示し、ポーリングを続ける必要があります。10s間ポーリングし、それでもログがない場合は中断することを推奨します。
レスポンスボディの例
ログ出力
{
"requestId":"xxxxx",
"page": {
"total": 18,
"size": 10,
"page": 1
},
"logs": [
{
"level": "信息",
"logId": 1,
"text": "开始执行...",
"time": "03/20/2024 15:35:23"
}
],
}