コンテンツにスキップ

取得



GET /api/v1/wksp_share/{wksp_share_uuid}/get

概要

1 件の認可設定の詳細と派生サイト/認可状態を読み取ります。

呼び出し前の準備と使用手順

作成/変更/削除にはデータ認可元ワークスペースの API Key を使用します。読み取りは現在の Key ワークスペースの認可方向に従って操作します。このグループで認可するのはワークスペース間のデータクエリ機能であり、メンバーの招待、アカウントロールの付与、データのコピーではありません。レスポンスの workspaceUUID は認可元、toWorkspaceUUID は被認可側です。新規追加時の Body.workspaceUUID のみが被認可ターゲットワークスペースを表し、レスポンスの同名フィールドとは方向が異なります。クエリが有効になるかは、データドメイン、ログインデックス、フィルター条件、実際の認可状態、およびソースワークスペースの状態によっても制限されます。

この読み取りには routine.defaultAccess が必要です。現在のワークスペースの認可リストが返す設定 UUID のみを使用します。現在の履歴エントリは UUID で status=0 のモデルレコードを読み取りますが、この業務クエリでは Key が属するワークスペースによる設定の絞り込みを行いません。呼び出し元は本エントリを設定の帰属やクロスワークスペース分離の検証インターフェースとして扱ってはならず、現在のワークスペースのリストで取得していない識別子を送信または転送しないでください。

未知/削除済みの UUID は現在、レコードが存在しない場合のフォーマット処理により 500 を返すため、固定の 404 を前提にできません。読み取り時は authorizationCode を削除し、機密の extra キーをクリーンアップします。これは新規追加/変更時の生のモデルレスポンスとは異なります。詳細には、リストに付加される sourceWorkspaceAccess のロックサマリーがありません。

アイデンティティ概要および extra のクロスサイトフィールドは、アイデンティティタイプ/レコードタイプに応じて省略可能です。フィールド表を、各レコードにすべての拡張が存在するものとして解釈しないでください。読み取り時に、クリーンアップされた一時認証コードや概要が再追加されることはありません。

ルートパラメータ

パラメータ名 型 必須 説明
wksp_share_uuid string Y 実際の URL パスパラメータで、通常は grant_ プレフィックスが付き、ワークスペース UUID ではありません。
例: grant_example
取得または入力方法: 認可リスト の content.data[].uuid から設定 ID を取得します。

リクエストヘッダー

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

パラメータ補足

grant_ 設定 UUID を使用して読み取ります。被認可ワークスペース UUID で代用しないでください。

リクエスト例

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

レスポンス

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

フィールド 型 説明
content.id integer 内部行番号。API リソース識別子としては使用しません。
content.uuid string 認可設定 UUID。通常は grant_ プレフィックスが付き、詳細/変更/削除ではこの値を使用します。
content.workspaceUUID string データ認可元ワークスペース。現在のクエリ Key のワークスペースとは限りません(被認可リストの場合は他のソースワークスペースです)。
content.workspaceName string 認可元ワークスペース名。
content.toWorkspaceUUID string データクエリの認可を取得するターゲットワークスペース。
content.toWorkspaceName string 被認可ワークスペース名。
content.regionCode string 認可元サイト識別子。
content.toRegionCode string ターゲットサイト識別子。読み取り時、旧来の空値は互換ルールに従って補完されます。
content.siteRelationType string same_site/same_org_cross_site/external_org_cross_site などのサイト関係。履歴レコードでは空の場合があります。
content.sourceBaseUrl string 一部のクロスサイトレコードのソースアドレス。通常の同一サイトでは空の場合があります。今回の API Endpoint ではありません。
content.targetBaseUrl string 一部のクロスサイトレコードのターゲットアドレス。通常の同一サイトでは空の場合があります。
content.type array/string または null 保存された認可データドメイン。* はすべてを表します。履歴データは正規化されていない場合があり、status 0 のみで有効と判断できません。
content.type[] JSON 通常はデータドメイン文字列です。現在の旧エントリでは要素の列挙値を完全にはチェックしません。
content.indexes array または null 認可されたログインデックス名の集合で、インデックス UUID ではありません。* はすべてを表し、ログドメインが認可されていない場合は [] として保存されます。
content.indexes[] string 1 つのインデックス名(例: default)。
content.conditions object または null metric/tracing/rum ごとに保存されたフィルター設定。データ権限そのものやクエリ結果ではありません。
content.extra object または null ロール、認可状態、クロスサイト拡張を記録します。読み取り時と書き込みレスポンス時ではクリーンアップルールが異なるため、認証診断を含む生の書き込みレスポンスを外部共有しないでください。
content.extra.recordRole string 例: authority/mirror。一部のレコードにのみ存在します。
content.extra.grantStatus string レコードに保存された状態。読み取り時、pending を時間経過に応じて expired として表示する場合があります。
content.delayDeleteAt integer 削除予定時間。-1 は通常、予定なしを表します。レコードが必ず有効であることを意味しません。
content.status integer モデルステータス。0 は非削除、削除は通常 3 です。業務上の認可は grantStatus なども確認する必要があります。
content.creator string 作成者識別子。API Key UUID または履歴アカウント/システムアイデンティティの場合があります。
content.updator string 最近の操作者。空の場合があります。
content.createAt integer 作成 Unix 秒。
content.updateAt integer 更新 Unix 秒。初期値は -1 の場合があります。
content.deleteAt integer ソフト削除 Unix 秒。未削除の場合は通常 -1 です。
content.conditions.metric array metric カテゴリの条件配列。
content.conditions.metric[] object 1 組の条件。現在、要素には完全な事前構造チェックがありません。
content.conditions.metric[].name string 実際のフィールド名。
content.conditions.metric[].op string in または not in。
content.conditions.metric[].logic string and/or を推奨。同一カテゴリ内では一致必須です。現在、列挙値は厳密にチェックされません。
content.conditions.metric[].value array 条件値の配列。要素は実際のフィールド型に従います。
content.conditions.tracing array tracing カテゴリの条件配列。
content.conditions.tracing[] object 1 組の条件。現在、要素には完全な事前構造チェックがありません。
content.conditions.tracing[].name string 実際のフィールド名。
content.conditions.tracing[].op string in または not in。
content.conditions.tracing[].logic string and/or を推奨。同一カテゴリ内では一致必須です。現在、列挙値は厳密にチェックされません。
content.conditions.tracing[].value array 条件値の配列。要素は実際のフィールド型に従います。
content.conditions.rum array rum カテゴリの条件配列。
content.conditions.rum[] object 1 組の条件。現在、要素には完全な事前構造チェックがありません。
content.conditions.rum[].name string 実際のフィールド名。
content.conditions.rum[].op string in または not in。
content.conditions.rum[].logic string and/or を推奨。同一カテゴリ内では一致必須です。現在、列挙値は厳密にチェックされません。
content.conditions.rum[].value array 条件値の配列。要素は実際のフィールド型に従います。
content.grantMode string same_site または cross_site。読み取り時にサイト関係から派生します。
content.grantStatus string active/pending/revoked/expired などの観測可能な認可状態。pending の期限切れはここでの表示のみ正規化され、バックエンドで既に削除済みであることを意味しません。
content.syncStatus string クロスサイト同期の追加ステータス。空の場合があります。
content.lastSyncAt integer または null クロスサイト前回同期の Unix 秒。省略時は null。履歴の非正規値は実際のレスポンスで確認する必要があります。
content.regionName string リクエスト言語とサイトメタデータに基づいて生成されたソースサイト名。
content.toRegionName string リクエスト言語とサイトメタデータに基づいて生成されたターゲットサイト名。
content.creatorInfo object 作成者アイデンティティ概要。Key/履歴アカウント/システムアイデンティティの場合があります。
content.creatorInfo.uuid string アイデンティティ識別子。個人アカウント UUID であることは保証されません。
content.creatorInfo.name string 表示名。
content.creatorInfo.email string アイデンティティの多態フィールド。Key の場合は Key UUID になることがあり、一律にメールアドレスとして扱えません。
content.updatorInfo object 最近の操作者アイデンティティ概要。{} の場合があります。
content.updatorInfo.uuid string 存在する場合の操作者識別子。
content.updatorInfo.name string 存在する場合の操作者表示名。
content.updatorInfo.email string アイデンティティの多態フィールドで、実際のメールアドレスとは限りません。
content.declaration object または null 今回の Key ワークスペースの共通宣言。設定の帰属を証明するためには使用できません。
content.extra.tempAuthCodeExpireAt integer 一時認可パッケージ有効期限の Unix 秒。省略可能。直接使用できる認証コードではありません。
content.extra.pendingTargetWorkspaceUUID string pending レコードが想定するターゲットワークスペース。省略可能。
content.extra.metaUUID string 認可パッケージ識別子。省略可能で、grant 設定 UUID ではありません。
content.extra.grantScopeFingerprint string 認可範囲の概要。省略可能で、顧客認証パラメータとしては使用しません。
content.extra.createdAt integer 拡張レコード作成の Unix 秒。省略可能。
content.extra.authorityGrantUUID string mirror レコードに関連するソース認可設定 UUID。省略可能で、現在の Key ワークスペースが所有する設定として直接扱えません。
content.extra.sourceKid string ソースサイト公開鍵識別子。省略可能。
content.extra.sourceJwksUri string ソースサイト公開鍵集合アドレス。省略可能。
content.extra.syncStatus string クロスサイト同期ステータス(success/failed または空など)。省略可能。
content.extra.lastSyncAt integer 前回同期の Unix 秒。省略可能。
content.extra.lastSyncError string 適合処理された最近の同期エラー概要。省略可能で、今回の API 外層エラーコードではありません。
content.extra.lastSyncErrorAt integer 最近の同期失敗 Unix 秒。省略可能。
content.extra.resourceSummary object 一部のクロスサイトレコードで同期保存されるリソース概要。省略可能で、リアルタイムの完全なリソースリストではありません。
content.extra.resourceSummary.logging object ログリソース概要。省略可能。
content.extra.resourceSummary.logging.indexes array 上流から同期されたログインデックス概要項目。要素は文字列またはオブジェクトで、そのまま保存されます。
content.extra.resourceSummary.logging.indexes[] JSON 1 つのインデックス概要。固定の uuid/name 形式を前提にできません。インデックス操作前に、インデックスリストから実際のパラメータを取得してください。
content.extra.resourceSummary.rum object RUM リソース概要。省略可能。
content.extra.resourceSummary.rum.applications array 上流の RUM アプリケーション概要項目。文字列またはオブジェクトが実際のレスポンスに従います。
content.extra.resourceSummary.rum.applications[] JSON アプリケーション概要。現在のサイトのアプリケーション設定 UUID の代替にはなりません。
content.extra.resourceSummary.updatedAt number リソース概要の生成値。単位は上流が決定し、Studio は単位変換や統一を保証しません。
content.extra.resourceSummary.sourceGrantUUID string リソース概要に関連するソース認可設定識別子。
content.extra.sourceSite object 認可元/ターゲット側のサイトアイデンティティスナップショット。省略可能で、現在のリクエスト Endpoint の代替にはなりません。
content.extra.sourceSite.siteCode string サイトコード。省略可能。
content.extra.sourceSite.regionCode string リージョンコード。省略可能。
content.extra.sourceSite.name string サイト表示名。省略可能。
content.extra.sourceSite.issuer string 署名者アイデンティティ。省略可能。
content.extra.sourceSite.baseUrl string サイト API ベースアドレス。省略可能。
content.extra.sourceSite.jwksUri string 公開鍵集合アドレス。省略可能。
content.extra.sourceSite.kid string 公開鍵識別子。省略可能。
content.extra.sourceSite.publicKeys array 一部のサイトスナップショットには公開鍵資料が含まれます。省略可能で、秘密鍵はありません。
content.extra.sourceSite.publicKeys[] object オプションの公開鍵項目。
content.extra.sourceSite.publicKeys[].kid string 公開鍵識別子。
content.extra.sourceSite.publicKeys[].publicKey string PEM 公開鍵本文。
content.extra.targetSite object 認可元/ターゲット側のサイトアイデンティティスナップショット。省略可能で、現在のリクエスト Endpoint の代替にはなりません。
content.extra.targetSite.siteCode string サイトコード。省略可能。
content.extra.targetSite.regionCode string リージョンコード。省略可能。
content.extra.targetSite.name string サイト表示名。省略可能。
content.extra.targetSite.issuer string 署名者アイデンティティ。省略可能。
content.extra.targetSite.baseUrl string サイト API ベースアドレス。省略可能。
content.extra.targetSite.jwksUri string 公開鍵集合アドレス。省略可能。
content.extra.targetSite.kid string 公開鍵識別子。省略可能。
content.extra.targetSite.publicKeys array 一部のサイトスナップショットには公開鍵資料が含まれます。省略可能で、秘密鍵はありません。
content.extra.targetSite.publicKeys[] object オプションの公開鍵項目。
content.extra.targetSite.publicKeys[].kid string 公開鍵識別子。
content.extra.targetSite.publicKeys[].publicKey string PEM 公開鍵本文。
content.extra.resourceSummary.metric object 対応ドメインのリソース概要。省略可能。
content.extra.resourceSummary.metric.workspaceUUIDs array 同期保存されたソースワークスペース識別子の集合。要素は通常文字列です。現在の Key が任意のワークスペースを操作できる認可ではありません。
content.extra.resourceSummary.metric.workspaceUUIDs[] JSON 個々のワークスペース識別子は上流の実際のレスポンスに従います。完全に正規化されていない履歴項目は事前に確認してください。
content.extra.resourceSummary.tracing object 対応ドメインのリソース概要。省略可能。
content.extra.resourceSummary.tracing.workspaceUUIDs array 同期保存されたソースワークスペース識別子の集合。要素は通常文字列です。現在の Key が任意のワークスペースを操作できる認可ではありません。
content.extra.resourceSummary.tracing.workspaceUUIDs[] JSON 個々のワークスペース識別子は上流の実際のレスポンスに従います。完全に正規化されていない履歴項目は事前に確認してください。
content.extra.resourceSummary.lineage object 対応ドメインのリソース概要。省略可能。
content.extra.resourceSummary.lineage.workspaceUUIDs array 同期保存されたソースワークスペース識別子の集合。要素は通常文字列です。現在の Key が任意のワークスペースを操作できる認可ではありません。
content.extra.resourceSummary.lineage.workspaceUUIDs[] JSON 個々のワークスペース識別子は上流の実際のレスポンスに従います。完全に正規化されていない履歴項目は事前に確認してください。
content.creatorInfo.status integer アイデンティティ自体のステータス。アカウント/Key の実際のタイプに応じて解釈します。
content.creatorInfo.wsAccountStatus integer または null ワークスペースメンバー/アイデンティティ関連ステータス。省略可能。
content.creatorInfo.username string アイデンティティのログイン名または Key 名。システムアイデンティティでは省略可能。
content.creatorInfo.iconUrl string アイデンティティアイコン URL。空の場合があります。
content.creatorInfo.mobile string アイデンティティの携帯番号。空の場合があり、Key には通常この値はありません。
content.creatorInfo.countryCode string 携帯番号の国/地域コード。空の場合があります。
content.creatorInfo.acntWsNickname string 現在のワークスペース内のアイデンティティニックネーム。省略可能。
content.updatorInfo.status integer アイデンティティ自体のステータス。アカウント/Key の実際のタイプに応じて解釈します。
content.updatorInfo.wsAccountStatus integer または null ワークスペースメンバー/アイデンティティ関連ステータス。省略可能。
content.updatorInfo.username string アイデンティティのログイン名または Key 名。システムアイデンティティでは省略可能。
content.updatorInfo.iconUrl string アイデンティティアイコン URL。空の場合があります。
content.updatorInfo.mobile string アイデンティティの携帯番号。空の場合があり、Key には通常この値はありません。
content.updatorInfo.countryCode string 携帯番号の国/地域コード。空の場合があります。
content.updatorInfo.acntWsNickname string 現在のワークスペース内のアイデンティティニックネーム。省略可能。
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "grant_example",
    "workspaceUUID": "wksp_source",
    "toWorkspaceUUID": "wksp_target",
    "regionCode": "SITE-CODE",
    "toRegionCode": "SITE-CODE",
    "workspaceName": "授权方示例空间",
    "toWorkspaceName": "被授权方示例空间",
    "siteRelationType": "same_site",
    "sourceBaseUrl": "",
    "targetBaseUrl": "",
    "extra": {
      "recordRole": "authority",
      "grantStatus": "active"
    },
    "type": [
      "metric",
      "logging"
    ],
    "indexes": [
      "default"
    ],
    "conditions": {
      "metric": [
        {
          "name": "host",
          "op": "in",
          "logic": "and",
          "value": [
            "host-example"
          ]
        }
      ]
    },
    "delayDeleteAt": -1,
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "grantMode": "same_site",
    "grantStatus": "active",
    "syncStatus": "",
    "lastSyncAt": null,
    "regionName": "示例站点",
    "toRegionName": "示例站点",
    "creatorInfo": {
      "uuid": "wsak_example",
      "name": "示例API Key",
      "email": "wsak_example"
    },
    "updatorInfo": {},
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

この履歴インターフェースは、未知/現在のワークスペース以外の設定が一律に 404 になることを保証しません。呼び出し元は自分のワークスペースのリストにあるレコードのみを使用し、認可帰属の探索エントリとして扱わないでください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンス説明 対処方法
500 ft.InternalServerError UUID が存在しない/削除済みの場合の空オブジェクトフォーマット、または履歴データ/サイト/アイデンティティ情報の誤り 内部エラー 現在のワークスペースのリストにある設定 UUID のみを使用し、まずリストを更新してください。継続的に失敗する場合は traceId を提供し、未知の UUID を繰り返し探索しないでください。

フィードバック

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