予約済みクエリ一括有効化

指定された複数の予約済みクエリを有効化します。本操作には管理者権限が必要です。また、一部の処理失敗を許容します。有効化できなかった予約済みクエリが存在する場合、failures パラメータに該当する予約済みクエリの識別子および失敗理由が返却されます。

必要な権限

ADMIN以上のロールが必要です。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -d guids="GUID1,GUID2,GUIDN" \
     -X POST https://HOSTNAME/api/sonar/scheduled-queries/enable

リクエストパラメータ

正常応答

全件成功

{
  "succeeded": 1,
  "failures": []
}

• succeeded（32ビット整数）：有効化に成功した予約済みクエリの件数。すでに有効化済みの予約済みクエリは含まれません。
• failures（配列）：有効化に失敗した予約済みクエリのエラー情報
  • id（文字列）：予約済みクエリのGUID
  • reason（文字列）：エラー内容

一部成功

実行例

curl -k -H "Authorization: Bearer API_KEY" \
     -d guids="0ff16aa8-dbc1-458a-9769-342de5cf9219,65c6c0d3-b8a4-49b3-b4ea-ddd0e321c221,b7007eb2-c1df-4d4d-84f1-5d0af91db25d" \
     -X POST https://HOSTNAME/api/sonar/scheduled-queries/enable

応答例

{
  "succeeded": 2,
  "failures": [
    {
      "id": "0ff16aa8-dbc1-458a-9769-342de5cf9219",
      "reason": "scheduled-query-not-found"
    }
  ]
}

エラー応答

必須パラメータが存在しない場合

HTTPステータスコード 400 応答

{
  "error_code": "null-argument",
  "error_msg": "guids should be not null"
}

識別子がGUID形式でない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-param-type",
  "error_msg": "guids should be guid type."
}

予約済みクエリが存在しない場合

HTTPステータスコード 200 応答

{
  "succeeded": 0,
  "failures": [
    {
      "id": "0fb16ff8-dbc1-458a-9769-342de5cf9219",
      "reason": "scheduled-query-not-found"
    }
  ]
}

管理者権限がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}