一覧取得¶
GET /api/v1/self_built_checker/list
概要¶
現在のワークスペースのセルフホストインスペクション設定と、関連するアラートポリシーをページングして一覧表示します。
呼び出し前の準備と使用手順¶
self_built_trigger のみで、削除済みではないもの。無効化済みも含み、Rule.id の降順です。現在の OpenAPI は Front の最終イベントステータスを取得せず、lastEventInfo を返しません。また、内部の scriptType や拡張フィルターも受け付けません。空ページまたはフィルターが途中で終了した場合、content.data=[] かつ pageInfo={} となるため、固定の totalCount に依存してワークスペースにルールがあるかどうかを判断できません。
この API はインスペクションメタ情報とアラートポリシーの関連付けを登録/変更するもので、関連関数を実行せず、1 回分のインスペクション結果も生成せず、セルフホストインスペクション用の定期トリガータスクも作成しません。実際のスケジューリングとイベント生成は業務連携/関数側で行います。成功後は一覧/get で設定とステータスを確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| alertPolicyUUID | commaArray | 任意。複数指定はカンマ区切りです。他のフィルターとは AND 条件で、関連付けがない場合は空を返します。 null 許容: False 例: altpl_example取得または入力方法: アラートポリシー一覧から uuid を取得します。 |
|
| checkerUUID | commaArray | 任意。複数指定はカンマ区切りです。関数 ID ではありません。 null 許容: False 例: rul_self_example取得または入力方法: 本モジュールの一覧からセルフホストルールの uuid を取得します。 |
|
| monitorUUID | commaArray | 任意。複数指定は半角カンマ区切りです。公開 create ではグループの作成をサポートしていません。 null 許容: False 例: monitor_example取得または入力方法: 実際のモニターグループ一覧または旧レコードの monitorUUID から取得します。 |
|
| pageIndex | integer | 任意。デフォルトは 1、最小値は 1。 null 許容: False $minValue: 1 例: 1取得または入力方法: 1 から開始し、pageInfo に従って進めます。 |
|
| pageSize | integer | 任意。デフォルトは 100、最大値は 100。 null 許容: False $maxValue: 100 $minValue: 1 例: 100取得または入力方法: 1 ページあたり 1..100。 |
|
| refKey | commaArray | 任意。複数指定は半角カンマ区切りで、完全なキーで一致します。 null 許容: False 例: custom-healthcheck-production取得または入力方法: 作成時に保存した業務キー。 |
|
| search | string | 任意。実際には jsonScript.refFuncInfo.title のみに一致し、ルートの title/name には一致しません。現在の公開 refFuncInfo では title が宣言されていないため、新規項目では名前による search 検索に依存せず、checkerUUID/refKey の使用を推奨します。 null 許容: False 例: 健康检查取得または入力方法: 履歴レコードの refFuncInfo.title 内のキーワードにのみ使用します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/self_built_checker/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=100
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
このページのセルフホストインスペクション。 |
| content.data[].id | integer または null | レコード番号。作成送信前のスナップショットでは null の可能性があるため、uuid で操作します。 |
| content.data[].uuid | string | rul_ ルール UUID。 |
| content.data[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].monitorUUID | string | 関連付けられたモニターグループ UUID。公開作成では宣言されておらず、通常は空文字列です。 |
| content.data[].type | string | セルフホストインスペクションでは self_built_trigger に固定されます。get ではタイプを追加で限定せず、本モジュール一覧の UUID のみを使用します。 |
| content.data[].refKey | string | 固定の業務関連キー。 |
| content.data[].secret | string または null | 共有エンティティ互換フィールド。セルフホストインスペクションでは通常空です。作成スナップショットでは null の可能性があり、呼び出し認証情報としては使用しません。 |
| content.data[].jsonScript | object | 保存されたセルフホストインスペクション定義。Rule.type とは区別されます。 |
| content.data[].jsonScript.type | string | selfBuiltCheck に固定されます。 |
| content.data[].jsonScript.title | string | ルートの業務タイトル。 |
| content.data[].jsonScript.name | string | 省略可能。作成時に title が空の場合は生成されません。title が空でない場合は name にコピーされます。title を空に変更しても履歴の name は保持されます。 |
| content.data[].jsonScript.refFuncInfo | object | 関連関数情報。 |
| content.data[].jsonScript.refFuncInfo.funcId | string | 作成時のみ必須で、変更時には宣言されません。サーバー側の登録では、関数が実際に存在するか呼び出し可能であることを保証しません。 |
| content.data[].jsonScript.refFuncInfo.description | string | 任意の文字列で、空も可能です。変更時に明示的に空文字列を指定するとクリアされます。 |
| content.data[].jsonScript.refFuncInfo.definition | string | 任意のシグネチャ表示文字列。本 API が実行するソースコードではありません。 |
| content.data[].jsonScript.refFuncInfo.category | string | 任意のメタ情報。固定の列挙値ではなく、Rule.type を変更しません。 |
| content.data[].jsonScript.refFuncInfo.args | array | 任意の配列。関数プラットフォームの元のメタ情報規約に従って保存されます。サーバー側はパラメータバインディングや関数シグネチャの検証を行いません。変更時は配列全体を置き換えます。 |
| content.data[].jsonScript.refFuncInfo.kwargs | json | 任意の動的 JSON メタ情報。子値はその関数定義に従って解釈されます。本 API で使用可能なトップレベルの callKwargs パラメータではなく、関数を即時に呼び出すこともありません。変更時は kwargs 全体を置き換えます。 |
| content.data[].jsonScript.refFuncInfo.args[] | JSON | 任意の JSON パラメータメタ情報。サーバー側は統一された子項目スキーマを提供しないため、元の定義を保持します。 |
| content.data[].jsonScript.refFuncInfo.kwargs.パラメータ名 | any | 動的なキーと値。すべての関数に共通する必須パラメータはありません。認証情報をサンプル/ログに渡さないでください。 |
| content.data[].jsonScript.callKwargs | object | 履歴/その他の入口で保存される可能性がある実行パラメータ。公開 create/modify では宣言されていないため、新規に追加して返却することはできません。 |
| content.data[].jsonScript.callKwargs.パラメータ名 | JSON | 具体的な実行パラメータは元の関数定義に従って解釈され、存在を保証するものではありません。 |
| content.data[].crontabInfo | object | セルフホストインスペクションではこの入口から定期トリガー設定を作成しないため、通常は {} です。 |
| content.data[].crontabInfo.履歴フィールド | JSON | 履歴レコードにはスケジューリング情報が保持されている可能性がありますが、本 API で書き込み可能な設定ではありません。 |
| content.data[].extend | object | 拡張メタ情報。公開 Body では宣言されておらず、作成時は通常 {} です。 |
| content.data[].extend.履歴フィールド | JSON | 履歴で保存された拡張フィールド。この入口では返却・変更をサポートしていません。 |
| content.data[].createdWay | string | 通常は manual です。履歴により import/template/空 の可能性もあります。 |
| content.data[].isLocked | integer または boolean | ロックフラグ。 |
| content.data[].openPermissionSet | boolean | カスタム操作権限のスイッチ。作成時は false で、共有タスクの modify 更新時には false に戻ります。 |
| content.data[].permissionSet | array<string> |
操作権限の主体。作成時は [] で、共有の modify 更新時には [] に戻ります。 |
| content.data[].permissionSet[] | string | 履歴のアカウント/チーム/ロール識別子。 |
| content.data[].status | integer | 0 は有効、2 は無効、3 は削除。直近のインスペクション結果ではありません。 |
| content.data[].creator | string | 作成者の識別情報。 |
| content.data[].updator | string | 更新者の識別情報。初期は空の可能性があります。 |
| content.data[].createAt | integer | 作成日時の Unix 秒。 |
| content.data[].updateAt | integer | 更新日時の Unix 秒。未更新の場合は -1。 |
| content.data[].deleteAt | integer | 削除日時の Unix 秒。未削除の場合は -1。 |
| content.data[].creatorInfo | object | 識別情報の概要。見つからない場合は {}。 |
| content.data[].creatorInfo.uuid | string | 識別情報の UUID。省略可能。 |
| content.data[].creatorInfo.status | integer | アカウントステータス。省略可能。 |
| content.data[].creatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.username | string | ログイン名。 |
| content.data[].creatorInfo.email | string | メールアドレスまたはシステム識別子。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の可能性があります。 |
| content.data[].creatorInfo.countryCode | string | 国・地域コード。省略可能。 |
| content.data[].creatorInfo.iconUrl | string | アイコン URL。省略可能。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.data[].updatorInfo | object | 識別情報の概要。見つからない場合は {}。 |
| content.data[].updatorInfo.uuid | string | 識別情報の UUID。省略可能。 |
| content.data[].updatorInfo.status | integer | アカウントステータス。省略可能。 |
| content.data[].updatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.username | string | ログイン名。 |
| content.data[].updatorInfo.email | string | メールアドレスまたはシステム識別子。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の可能性があります。 |
| content.data[].updatorInfo.countryCode | string | 国・地域コード。省略可能。 |
| content.data[].updatorInfo.iconUrl | string | アイコン URL。省略可能。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.data[].monitorName | string | 現在関連付けられているグループの表示名。ない場合は空です。 |
| content.data[].alertPolicyInfos | array<object> |
有効な関連アラートポリシーの概要。 |
| content.data[].alertPolicyInfos[].uuid | string | ポリシー UUID。 |
| content.data[].alertPolicyInfos[].name | string | ポリシー名。 |
| content.declaration | object | 共通宣言。 |
| pageInfo | object | 空でないページにはページ情報があり、空ページでは {} の可能性があります。 |
| pageInfo.pageIndex | integer | 現在のページ。省略可能。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。省略可能。 |
| pageInfo.count | integer | このページの件数。省略可能。 |
| pageInfo.totalCount | integer | 一致する総件数。省略可能。 |
{
"code": 200,
"content": {
"data": [
{
"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,
"monitorName": "",
"alertPolicyInfos": [
{
"uuid": "altpl_example",
"name": "生产告警"
}
],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 100,
"count": 1,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している場合 | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | ルール、参照、または識別情報の読み取り/フォーマットに失敗した場合 | 内部エラー | ワークスペースと有効な識別子を確認して再試行してください。失敗が続く場合は traceId を提供してください。 |