コンテンツにスキップ

RUM 設定のクイックリスト



GET /api/v1/rum_cfg/quick_list

概要

現在のワークスペースにある RUM アプリケーションの識別子と内容の簡易リストを一覧表示します。

呼び出し前の確認と使用手順

現在の Key 権限は routine.defaultAccess、rum.rumCfgManage、anonymous.shared、anonymous.snapshotShared のいずれかに一致する必要があり、認証は引き続き実際の OpenAPI アイデンティティに従って行われます。現在のワークスペースは Key によって決定され、Query のワークスペースリストを使用して範囲を広げることはできません。

削除されていないアプリケーションの uuid/appId/jsonContent/workspaceUUID のみを返し、Token、マッピング状態、統計、ダッシュボードのバインド、ページネーションは返しません。uuid は appId の別名であり、実際の内部設定 UUID ではありません。appId はカンマ区切りのフィルターです。省略または空値の場合はすべてを返し、一致しない場合は [] を返します。順序の安定性は保証されません。この OpenAPI は内部の軽量リストメソッドを呼び出すため、フロントエンドの quick_list におけるデータアクセスの絞り込み/統計返却の契約を適用できません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
appId commaArray 省略可能なカンマ区切りのアプリケーション識別子。全体の先頭と末尾の空白を除去した後、カンマで分割します。各項目は個別に trim されないため、区切り文字の近くに空白を入れないでください。省略または空値の場合は、削除されていないすべてのアプリケーションを照会します。
null の許可: False
例: payment_web,payment_mobile
取得または入力方法: RUM アプリケーション簡易リストから content[].appId を取得するか(uuid は同じ値)、現在のワークスペースの RUM アプリケーション設定から取得します。

パラメータの補足

content[].uuid は appId と同じです。このインターフェースは Client Token または RUM マッピングの準備状態を提供しません。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/rum_cfg/quick_list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode appId=payment_web

レスポンス

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

フィールド 型 説明
content array<object> アプリケーション簡易リストの配列。一致なしの場合は []、ページネーションなし。
content[].uuid string 公開互換の別名。常に appId と等しく、内部の実際の RumCfg UUID ではありません。
content[].appId string SDK/クエリで使用するアプリケーション識別子。
content[].workspaceUUID string 所属ワークスペースの UUID。
content[].jsonContent object アプリケーション内容オブジェクト。
content[].jsonContent.name string アプリケーションの表示名。
content[].jsonContent.type string web/miniapp/android/ios/custom/reactnative/harmonyos。
content[].jsonContent.extend object 任意で保存される動的拡張。存在しない場合はこのキーを省略できます。
content[].jsonContent.extend.カスタムキー JSON 呼び出し元が保存する拡張キー値。サーバー側が追加の実行パラメータをサポートすることを意味しません。
content[].declaration object 現在のワークスペースの共通宣言。
{
  "code": 200,
  "content": [
    {
      "uuid": "payment_web",
      "appId": "payment_web",
      "workspaceUUID": "wksp_example",
      "jsonContent": {
        "name": "支付Web",
        "type": "web",
        "extend": {
          "team": "payment"
        }
      },
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 パラメータの解析に失敗 Query パラメータの表と例を確認してください。
500 ft.InternalServerError データベースの読み取り、または過去の jsonContent 構造の異常 内部エラー traceId を保持してバックオフしながら再試行してください。継続的に失敗する場合は、管理者にアプリケーション設定の確認を依頼してください。

フィードバック

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