ロボットの実行ログの検索

この記事の内容
  1. 事前操作
  2. フロー
  3. テンプレート
  4. postManテンプレート
  5. Javaテンプレート
  6. リクエスト
  7. リクエストヘッダー
  8. リクエストボディ
  9. リクエスト例
  10. レスポンス
  11. レスポンスボディ
  12. レスポンスボディの例
  13. ステータスコードの説明

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

事前操作

​ 先にロボットのスタートアップAPIを呼び出すか、他の方法でjobUuidを取得する必要があります。

フロー

テンプレート

postManテンプレート

Javaテンプレート

​ リクエストモデル:

​ レスポンスモデル:

​

リクエスト

基本 説明
HTTP URL https://api.example.com/oapi/dispatch/v2/job/log/search 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください
HTTP Method POST

リクエストヘッダー

基本 説明
Authorization Bearer {accessToken} {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります
Content-Type application/json

リクエストボディ

名称 型 説明 必須かどうか 説明
jobUuid string ロボット実行uuid はい ロボットのスタートアップAPIで取得します
page int ページ番号 いいえ デフォルトは最初のページです
size int 1ページあたりの件数 いいえ デフォルトは20件です
queryFilter
∟ beginTime string 終了日時 いいえ 開始日時
∟ endTime string 開始日時 いいえ 終了日時
∟ searchKey string 検索キーワード いいえ 検索キーワード
∟ sort object 並べ替えフィールド いいえ
∟ sortKey string 並べ替えキー いいえ デフォルトはtimeです。現在はtimeのみ対応しています
∟ sortOrder string 並べ替え順序 いいえ asc 昇順 desc 降順

リクエスト例

{
  "jobUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0",
  "page": 1,
  "size": 20,
  "queryFilter":{
    "beginTime":"2024-03-20 11:11:11",
    "endTime":"2024-03-20 11:11:12",
    "searchKey":"商品検索",
    "sort": {
      "sortKey": "time",
      "sortOrder": "desc"
    }
  }
}

レスポンス

レスポンスボディ

名称 型 必須かどうか 説明
code int はい ステータスコードです。200は成功、500は失敗を示します
success boolean はい 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます
msg string はい ステータスコードの説明
data object はい
∟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

レスポンスボディの例

{
    "requestId":"xxxxx",
    "page": {
            "total": 18,
            "size": 10,
            "page": 1
        },
    "logs": [
            {
                "level": "信息",
                "logId": 1,
                "text": "开始执行...",
                "time": "03/20/2024 15:35:23"
            }
        ],    
      
}

ステータスコードの説明

エラーコード 説明 調査の推奨事項
200 正常 呼び出しは正常です
500 サーバー側のエラー サーバー側のエラーについては、テクニカルサポートにお問い合わせください
80204001 ログ検索の失敗 ログを検索できないことを示します(原因には、ロボットが未接続であることや、ロボットが削除済みであることがあります)
80204004 ログ検索のタイムアウト ログ検索がタイムアウトしたことを示します
OpenAPIの記事一覧ページの先頭へ ↑