ストリームクエリの無効化

指定したストリームクエリを無効化します。この操作には管理者権限が必要です。

必要な権限

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

HTTPリクエスト

POST /api/sonar/stream-queries/:guid/disable
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     -X POST https://HOSTNAME/api/sonar/stream-queries/b90ea540-4f47-4bcf-b708-af610a649c50/disable
リクエストパラメータ
キー必須説明備考
guid文字列ストリームクエリGUID36文字

正常応答

{}

エラー応答

ストリームクエリが存在しない場合

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

{
  "error_code": "illegal-state",
  "error_msg": "stream query not found: b7036aec-6751-4a26-b6e9-4fb2a0c0ed72"
}
ストリームクエリが既に無効化されている場合

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

{
  "error_code": "illegal-state",
  "error_msg": "stream query is already disabled: b7036aec-6751-4a26-b6e9-4fb2a0c0ed72"
}
guid値がGUID形式でない場合

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

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
管理者権限がない場合

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

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