コンテンツにスキップ

無効化



POST /api/v1/self_built_checker/disable

概要

セルフホストインスペクションを無効化します。

呼び出し前の確認と使用手順

一致するセルフホストインスペクションの status を 2 に設定し、このレコードを一時停止します。関連付けられた関数を即時実行せず、新しいスケジュールを作成せず、外部ビジネス連携のタスクが一時停止済み/開始済みであることも保証しません。実際の実行状態は連携側で確認する必要があります。

使用できるのは、現在のワークスペースの本モジュール一覧に存在する UUID のみです。refKey を指定した場合は UUID と組み合わせて絞り込みます。単独で一括指定するための方式ではありません。true を返しますが、項目ごとの一致件数/変更件数は返しません。空の配列または一致なしでも成功する場合があるため、ステータス/関連付けは読み戻して確認する必要があります。エラー/タイムアウトが発生した場合は、まず設定の現在の状態を確認してください。削除/送信後の非同期ディスパッチが失敗しても、すでにデータベースに反映されている可能性があります。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
ruleUUIDs[*] string 空でない文字列を推奨します。関数 ID やその他のルール識別子ではありません。
例: rul_self_example
取得または入力方法: 確認済みの単一のセルフホストインスペクション UUID。
refKey string 任意の追加絞り込み条件で、各 UUID と同時に一致させます。UUID の代替パラメータではなく、refKey のみを渡してコレクションを操作することはできません。
null を許可: False
例: custom-healthcheck-production
取得または入力方法: 同じビジネス関連キーを追加で確認する場合に入力します。
ruleUUIDs array 任意と宣言されていますが、実際には配列を必ず指定する必要があります。省略すると in_(None) により 500 になる可能性があり、refKey は配列の代替にはなりません。空でない配列を推奨し、他の種類のルールや別ワークスペースの UUID を混在させないでください。
null を許可: False
例: ["rul_self_example"]
取得または入力方法: 本モジュールの一覧から、現在のワークスペースのセルフホストインスペクション uuid を項目ごとに確認します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/self_built_checker/disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUIDs":["rul_self_example"]}'

レスポンス

HTTP 200、application/json。以下の例は、そのまま読み取れる主要フィールドを示します。

フィールド 型 説明
content boolean 成功時は true。入力した各 UUID が一致したことや、実際に変更されたことを意味しません。
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している パラメータの解析に失敗 パラメータの位置、フィールド名、型、および値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
500 ft.InternalServerError 対象が未選択、フィールドの形状または長さの誤り、データベース/送信後の非同期タスクディスパッチなどの失敗 内部エラー まず現在のルールを読み戻して保存済みか確認してください。現在のワークスペースで明確な ruleUUID を使用してから再試行し、traceId を提供してください。

フィードバック

このページは役に立ちましたか?