コンテンツにスキップ

取得



GET /api/v1/error_track_rule/{rule_uuid}/get

概要

単一のエラー追跡ルール設定を読み取ります。

呼び出し前の注意事項と使用手順

現在の Key には errorCenter.errorTrackRuleQuery が必要です。対象は現在のワークスペースの未削除ルールのみで、無効状態 2 も含みます。リストの uuid で特定します。未知、クロスワークスペース、または削除済みの場合は 404 を返します。本詳細には creatorInfo/updatorInfo が付与されないため、リストからフィールドの存在を仮定することはできません。

rum ソースのみ sourcesInfo が付与され、* は {name:*} の概要を返し、未知の appId は {} を返します。概要検索には削除済みの RUM アプリケーションが含まれる可能性があるため、先に有効なアプリケーションの一覧で実際の接続状況を確認してください。その他のタイプには sourcesInfo がありません。ルールは Studio に保存済みの設定を表すのみであり、エラーレコードが生成済みであること、履歴の遡及再計算が完了していること、下流で即時反映されていることを意味するものではありません。content.declaration は親の共通宣言です。リストでは pageInfo がトップレベルにあり、data は content.data を保持します。

ルートパラメータ

パラメータ名 型 必須 説明
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 を取得します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/error_track_rule/issetrule_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content object ルールエンティティおよび任意の rum 概要。
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.sourcesInfo array<object> rum ルールの list/get にのみ付与され、sources と同じ順序です。解析できない項目は {} で、アプリケーションがまだアクティブであることは保証されません。
content.sourcesInfo[].appId string 実際のアプリケーション appId。ワイルドカード項目は *。
content.sourcesInfo[].jsonContent object 元の RUM アプリケーションの jsonContent。クエリは削除済みアプリケーションを除外しないため、概要からまだアクティブであると判断できません。
content.sourcesInfo[].jsonContent.name string アプリケーションの表示名。ワイルドカード項目は *。
content.sourcesInfo[].jsonContent.type string アプリケーションプラットフォーム。ワイルドカード項目には通常ありません。
content.sourcesInfo[].jsonContent.extend object 任意のアプリケーション動的拡張。
content.sourcesInfo[].jsonContent.extend.カスタムキー JSON アプリケーションの保存拡張値。
content.declaration object または null 現在のワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "id": 7,
    "uuid": "issetrule_example",
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "workspaceUUID": "wksp_example",
    "name": "決済Webエラー集約",
    "desc": "決済Webアプリケーションのエラーを追跡",
    "type": "rum",
    "sources": [
      "payment_web"
    ],
    "extend": {
      "ownerTeam": "payment"
    },
    "sourcesInfo": [
      {
        "appId": "payment_web",
        "jsonContent": {
          "name": "決済Web",
          "type": "web"
        }
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.ObjectNotExists ルールが存在しない、削除済み、または現在の Key のワークスペースに属していない 指定されたオブジェクトが存在しません 現在のワークスペースのルールリストを更新し、実際の uuid を取得します。
500 ft.InternalServerError データベース読み取り、履歴 JSON 構造、または関連概要の構築で未処理の例外が発生 内部エラー traceId を保持してバックオフしてください。継続的に失敗する場合は、管理者に該当する履歴レコードと設定の確認を依頼してください。

フィードバック

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