変更¶
POST /api/v1/error_track_rule/{rule_uuid}/modify
概要¶
エラー追跡ルールの設定を完全に置き換えます。
呼び出し前の準備と使用手順¶
現在の Key には errorCenter.errorTrackRuleManage が必要で、現在のワークスペースのみが対象です。まず type を決定し、次に対応するインデックス/アプリケーション/サービスリストから実際の sources を取得してください。旧サンプルの wsAdmin/acnt_/group_ を流用しないでください。* は全ソースのマーカーであり、[] はワイルドカードではありません。未知のソースは保存に成功しても有効なマッチングを生成できない可能性があります。logging で外部ストレージにバインドされたアクティブなインデックスを明示的に指定すると拒否されます。その他のソースには項目ごとの存在チェックはありません。
これは完全上書き用のインターフェースです。name/type は引き続き必須です。desc、sources、extend を省略すると、それぞれ空文字列、[]、{} になり、patch ではありません。まず GET で現在の完全な設定をコピーしてから必要なフィールドを変更してください。type を変更する場合はソースも同時に調整してください。404 の前に logging ソースが検証される場合があるため、エラーの順序だけから対象の存在を推測することはできません。
このエンドポイントはルールを保存してデータベースにコミットしますが、このコントローラでダウンストリーム同期を呼び出したり、履歴データの再計算を実行したりはしません。また、公開/スキャンタスクも返しません。HTTP 200 は今回の保存レスポンスを確認するだけであり、後続のエラー生成と実際の処理範囲は業務データで検証する必要があります。extend には公開された固定の実行用サブキーはなく、自由なオブジェクトを通知/しきい値エンジンとして扱わないでください。コミット前のエンティティスナップショットを返し、新規作成時の id は null の可能性があり、sourcesInfo や身元の付加サマリーは含まれません。詳細を再取得すると最終的な id と rum サマリーを取得できます。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| rule_uuid | string | Y | 現在のワークスペースで削除されていないルールの UUID。ステータス 0(有効)と 2(無効)を含みます。テレメトリの issue_id やローカルの isset_ 処理メタデータではありません。 空文字列の許可: False 例: issetrule_example取得または入力方法: エラー追跡ルール一覧 から content.data[].uuid を取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sources[*] | any | 文字列を推奨します。1 つのインデックス name/appId/サービス service、または * です。元の宣言には要素型の制約がありません。オブジェクト/配列などを保存すると、RUM 一覧サマリーやダウンストリーム処理が 500 になる可能性があり、インターフェースによる遮断には依存できません。アカウント/チーム/ロールの UUID ではありません。 例: payment_web取得または入力方法: type=logging の場合はログインデックス一覧 から name を取得し、isBindCustomStore=1 を除外します。type=rum の場合は RUM アプリケーション簡易一覧 から appId を取得します。type=tracing の場合はサービスリスト から service を取得します。ワイルドカードにはリテラル値 * を使用します。 |
|
| extend.カスタムキー | any | 任意の JSON 値で、オブジェクト/配列/文字列/数値/ブール/null が可能です。固定の必須サブキーはありません。認証情報を入れないでください。 例: payment取得または入力方法: 呼び出し元によるルール表示用の資料です。 |
|
| desc | string | 省略可能な文字列。最大 256 文字で、空を許可します。作成時に省略すると空、変更時に省略してもクリアされ、旧値を保持しません。 空文字列の許可: True null の許可: False 最大長: 256 例: 支払いWebアプリケーションのエラーを追跡取得または入力方法: ルールの保守担当者が用途/範囲の説明を入力します。 |
|
| extend | json | 省略可能な JSON オブジェクト。ルートが null/配列/文字列の場合は事前に 406 になります。作成時に省略すると {}、変更時に省略しても {} で旧値を全面的に置き換え、{} を送信するとクリアされます。この Studio の実装はオブジェクトを保存するだけであり、任意のサブキーからしきい値/通知/正規表現などの実行機能を推測すべきではありません。 null の許可: False 例: {"ownerTeam": "payment"}取得または入力方法: 呼び出し元はルール保守用の表示情報を保存できます。公開された固定の実行用サブ設定はありません。 |
|
| name | string | Y | 必須の文字列。最大 128 文字です。宣言では非空を強制していませんが、非空を推奨します。同名であっても本インターフェースに一意性チェックはなく、名前を冪等キーとして使用しないでください。変更時も必須で、完全に置き換えます。 null の許可: False 最大長: 128 例: 支払いWebエラー集約取得または入力方法: 呼び出し元が識別可能なルール名を入力します。 |
| sources | array | 省略可能な配列。省略すると [] になります。変更時に指定すると全量置換、省略してもクリアされ、[] はワイルドカードと等しくありません。全ソースを指定する場合は明示的に ["*"] とします。現在、項目ごとに正当な文字列か/存在するかの検証は行わないため、クライアントは実際の名前/識別子を使用する必要があります。未知の値を保存できたことはマッチングが有効であることを証明しません。logging で現在アクティブな外部バインドインデックスを指定すると 404 になります。* では外部インデックスを個別に検査しないため、保存成功から外部インデックスがサポートされていると保証することはできません。 null の許可: False 例: ["payment_web"]取得または入力方法: type=logging の場合はログインデックス一覧 から name を取得し、isBindCustomStore=1 を除外します。type=rum の場合は RUM アプリケーション簡易一覧 から appId を取得します。type=tracing の場合はサービスリスト から service を取得します。ワイルドカードにはリテラル値 * を使用します。 |
|
| type | string | Y | 必須。logging/tracing/rum のいずれかです。変更時も必須で、タイプの変更も可能です。新しいタイプに適合する sources を同時に再構築する必要があり、アプリケーション ID/インデックス名/サービス名を混在させることはできません。 null の許可: False 選択可能な値: ['logging', 'tracing', 'rum'] 例: rum取得または入力方法: エラーデータのソースに応じて選択します。logging はログ、tracing はトレーシング、rum はユーザーアクセスです。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/error_track_rule/issetrule_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"支払いWebエラー集約","desc":"支払いWebアプリケーションのエラーを追跡","type":"rum","sources":["payment_web"],"extend":{"ownerTeam":"payment"}}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 保存されたルールエンティティのスナップショット。 |
| content.id | integer または null | データベースの行 ID。パスの特定には使用しません。コミット前のスナップショットでは null の可能性があります。 |
| content.uuid | string | エラー追跡ルールの UUID。issetrule_ プレフィックスを持ちます。エラー処理メタデータの isset_ やテレメトリの issue_id ではありません。 |
| content.status | integer | データベースのステータス:0 有効、2 無効、3 ソフト削除(読み取り時は 3 を除外)。 |
| content.creator | string | 作成主体の UUID。この公開エンドポイントでは通常、作成した Key リソース wsak_ になります。履歴レコードでは他の主体の場合があり、sys メタデータは自動初期化されません。 |
| content.updator | string | 最近の更新主体。未更新の場合は空になることがあります。 |
| content.createAt | integer | Unix 秒の作成時間。 |
| content.updateAt | integer | Unix 秒の更新時間。作成後に未更新の場合は通常 -1 です。 |
| content.deleteAt | integer | Unix 秒の削除時間。未削除の場合は通常 -1 です。 |
| content.workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.name | string | ルール名。同名も可能です。 |
| content.desc | string | ルールの説明。 |
| content.type | string | logging/tracing/rum。 |
| content.sources | array | 保存されたソースの配列。クライアントは文字列のみを使用すべきです。履歴の非文字列値は許容する必要があります。 |
| content.sources[] | JSON | 通常はインデックス名/appId/サービス名、または * です。ロールやアカウント ID ではありません。 |
| content.extend | object または null | 保存された拡張。通常はオブジェクトとして書き込まれます。履歴値は許容する必要があります。 |
| content.extend.カスタムキー | JSON | カスタム保存値。固定の実行セマンティクスはありません。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 7,
"uuid": "issetrule_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427260,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支払いWebエラー集約",
"desc": "支払いWebアプリケーションのエラーを追跡",
"type": "rum",
"sources": [
"payment_web"
],
"extend": {
"ownerTeam": "payment"
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通のリクエストエラーについては共通エラー定義 を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | ルールオブジェクトを送信してください。 |
| 404 | ft.NotSupportExternalLogIndexCfg | type=logging かつ sources が現在のワークスペースでアクティブな isBindCustomStore=1 のインデックスに明確に一致している | 外部インデックス設定はサポートされていません | 組み込みインデックスを選択するか、サポートされているソースに変更してください。* で回避して外部インデックスがサポートされていると推測しないでください。 |
| 404 | ft.ObjectNotExists | 現在のワークスペースに対象ルールが存在しない/削除済み | 指定されたオブジェクトが存在しません | 一覧からルールの uuid を更新してください。 |
| 500 | ft.InternalServerError | データベース、履歴オブジェクト、または未処理の保存/レスポンス構築の例外 | 内部エラー | まずルール一覧/詳細を読み戻して実際の保存状況を確認してください。作成には冪等キーがないため、結果が不明なまま再送信しないでください。 |