取得¶
GET /api/v1/self_built_checker/get
概要¶
UUID または業務用 refKey で保存済みの検査定義を読み取ります。
呼び出し前の確認事項と使用手順¶
空でない ruleUUID または refKey の少なくとも一方を渡します。両方を指定した場合は ruleUUID が優先され、refKey はこの get の結合条件には使用されません。この共有読み取りクエリはセルフホスト検査タイプを追加で限定していないため、本モジュールのリストが返す UUID/refKey のみを使用し、content.type=self_built_trigger を確認して他のルールを誤って読み取らないようにしてください。monitorName、alertPolicyInfos、アイデンティティ概要は付与されません。
この API は検査メタ情報とアラートポリシーの関連付けを登録/変更するもので、関連関数の実行、1 回分の検査結果の生成、セルフホスト検査の定期トリガータスクの作成は行いません。実際のスケジューリングとイベント生成は業務統合/関数側が担当します。成功後はリスト/get で設定とステータスを確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| refKey | string | 作成時の宣言で必須であり、その後は変更できません。空でなく 48 文字以下にすることを推奨します。作成時には、セルフホスト検査だけでなく、このワークスペース内の削除されていないすべての Rule の refKey と重複チェックを行います。get では refKey を単独で使用できます。modify では先に get で ruleUUID を取得してから送信する必要があり、refKey は追加の確認条件としてのみ使用できます。refKey だけでは、ポリシー参照/キャッシュ/ミュート範囲と重複名検証を確実に維持できません。 null 許可: False 例: custom-healthcheck-production取得または入力方法: 関数/業務統合向けに安定した一意キーを生成します。たとえば、同じ業務システムの検査インスタンス識別子などです。 |
|
| ruleUUID | string | 操作対象の識別子です。変更時は、特にポリシー/タイトルを変更する場合、必ず get で明確な ruleUUID を取得する必要があります。get で同時に refKey を指定した場合は ruleUUID のみを使用し、modify で両方を指定した場合は両方の条件が一致する必要があります。関数の funcId や関連キーではありません。 null 許可: False 例: rul_self_example取得または入力方法: セルフホスト検査リスト の content.data[].uuid から、このワークスペースのセルフホスト検査 UUID を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/self_built_checker/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode ruleUUID=rul_self_example
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。作成送信前のスナップショットでは null になる可能性があるため、uuid で操作します。 |
| content.uuid | string | rul_ ルール UUID。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.monitorUUID | string | 関連付けられたモニターグループ UUID。公開作成では宣言されず、通常は空文字列です。 |
| content.type | string | セルフホスト検査では self_built_trigger に固定されます。get はタイプを追加で限定しないため、本モジュールのリストの UUID のみを使用します。 |
| content.refKey | string | 固定の業務関連キー。 |
| content.secret | string または null | 共有エンティティの互換フィールド。セルフホスト検査では通常空です。作成スナップショットでは null になる可能性があり、呼び出し認証情報としては使用しません。 |
| content.jsonScript | object | 保存されたセルフホスト検査定義。Rule.type とは異なります。 |
| content.jsonScript.type | string | selfBuiltCheck に固定。 |
| content.jsonScript.title | string | ルート業務タイトル。 |
| content.jsonScript.name | string | 省略可能です。作成時に title が空の場合は生成されません。title が空でない場合は name にコピーされます。変更時に title を空にすると、履歴の name が保持されます。 |
| content.jsonScript.refFuncInfo | object | 関連関数の情報。 |
| content.jsonScript.refFuncInfo.funcId | string | 作成時のみ必須で、変更時は宣言しません。サーバー側の登録は、関数が実際に存在することや呼び出し可能であることを保証しません。 |
| content.jsonScript.refFuncInfo.description | string | オプションの文字列で、空でもかまいません。変更時に明示的に空文字列を指定するとクリアされます。 |
| content.jsonScript.refFuncInfo.definition | string | オプションのシグネチャ表示用文字列であり、本 API が実行するソースコードではありません。 |
| content.jsonScript.refFuncInfo.category | string | オプションのメタ情報です。固定の列挙型ではなく、Rule.type を変更しません。 |
| content.jsonScript.refFuncInfo.args | array | オプションの配列で、関数プラットフォームの元のメタ情報規約に従って保存されます。サーバー側はパラメータバインディングや関数シグネチャの検証を行いません。変更時は配列全体を置き換えます。 |
| content.jsonScript.refFuncInfo.kwargs | json | オプションの動的 JSON メタ情報で、子の値はその関数定義に従って解釈されます。本 API で使用できるトップレベルの callKwargs パラメータではなく、関数を即時呼び出すこともありません。変更時は kwargs 全体を置き換えます。 |
| content.jsonScript.refFuncInfo.args[] | JSON | 任意の JSON パラメータメタ情報です。サーバー側は統一された子項目 schema を提供していません。元の定義を維持します。 |
| content.jsonScript.refFuncInfo.kwargs.パラメータ名 | any | 動的なキーと値です。すべての関数に共通する必須パラメータはありません。認証情報を例/ログに渡さないでください。 |
| content.jsonScript.callKwargs | object | 履歴/その他の入口で保存される可能性がある実行パラメータです。公開 create/modify では宣言されておらず、新規に返送することはできません。 |
| content.jsonScript.callKwargs.パラメータ名 | JSON | 具体的な実行パラメータは元の関数定義に従って解釈され、存在は保証されません。 |
| content.crontabInfo | object | セルフホスト検査ではこの入口から定期トリガー設定を作成しないため、通常は {} です。 |
| content.crontabInfo.履歴フィールド | JSON | 履歴レコードにはスケジューリング情報が保持されている可能性がありますが、本 API で書き込み可能な設定ではありません。 |
| content.extend | object | 拡張メタ情報です。公開 Body では宣言されておらず、作成時は通常 {} です。 |
| content.extend.履歴フィールド | JSON | 履歴として保存された拡張フィールドです。本入口では返送して変更することはできません。 |
| content.createdWay | string | 通常は manual です。履歴により import/template/空 の場合もあります。 |
| content.isLocked | integer または boolean | ロックフラグ。 |
| content.openPermissionSet | boolean | カスタム操作権限のスイッチです。作成時は false で、共有タスクの更新を modify すると false に戻ります。 |
| content.permissionSet | array<string> |
操作権限の主体です。作成時は [] で、共有更新を modify すると [] に戻ります。 |
| content.permissionSet[] | string | 履歴のアカウント/チーム/ロール識別子。 |
| content.status | integer | 0 有効、2 無効、3 削除。直近の検査結果とは異なります。 |
| content.creator | string | 作成アイデンティティ。 |
| content.updator | string | 更新アイデンティティ。初期は空の場合があります。 |
| content.createAt | integer | 作成 Unix 秒。 |
| content.updateAt | integer | 更新 Unix 秒。未更新の場合は -1。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": 100,
"uuid": "rul_self_example",
"workspaceUUID": "wksp_example",
"monitorUUID": "",
"type": "self_built_trigger",
"refKey": "custom-healthcheck-production",
"secret": "",
"jsonScript": {
"type": "selfBuiltCheck",
"title": "本番サービスヘルスチェック",
"name": "本番サービスヘルスチェック",
"refFuncInfo": {
"funcId": "healthcheck.main",
"description": "本番サービスのヘルスチェック関数。",
"definition": "main(service)",
"category": "custom",
"args": [
"service"
],
"kwargs": {
"service": "production"
}
}
},
"crontabInfo": {},
"extend": {},
"createdWay": "manual",
"isLocked": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータが規則に違反している | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 406 | ft.CheckerSignUnspecified | ruleUUID/refKey が両方とも空、または指定されていない | モニター識別子が指定されていません | 本モジュールのリストから明確な識別子を選択してください。 |
| 404 | ft.NotFoundRule | UUID または refKey で本ワークスペースの削除されていないルールが見つからない | 業務ルールが見つかりません | リストを更新して正しい識別子を取得してください。 |
| 500 | ft.InternalServerError | ルール、参照、またはアイデンティティ情報の読み取り/フォーマットに失敗した | 内部エラー | ワークスペースと有効な識別子を確認してから再試行してください。継続的に失敗する場合は traceId を提供してください。 |