コンテンツにスキップ

有効化



POST /api/v1/self_built_checker/enable

概要

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

呼び出し前および使用手順

削除されていないセルフホスト型インスペクションの status を 0 に設定します。関連関数は即時実行されず、新しいスケジュールも作成されず、外部業務連携のタスクがすでに一時停止/開始していることも保証されません。実際の実行状態は連携側で確認する必要があります。

このワークスペースのこのモジュールのリストにある 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/enable' \
  -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 を提供してください。

フィードバック

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