一覧¶
GET /api/v1/wksp_share/list
概要¶
現在のワークスペースが発行または取得したデータアクセス認可設定をページングして一覧表示します。
呼び出し前の準備と使用手順¶
データ認可元ワークスペースの API Key を使用して作成/変更/削除を行います。読み取りは、現在の Key のワークスペースの認可方向に従って操作します。この API グループが認可するのはワークスペース間のデータクエリ機能であり、メンバーの招待、アカウントロールの付与、データのコピーではありません。レスポンスの workspaceUUID は認可元、toWorkspaceUUID は認可先です。新規作成時の Body.workspaceUUID のみが認可対象のターゲットワークスペースを表し、レスポンスの同名フィールドとは方向が異なります。クエリが有効になるかは、データドメイン、ログインデックス、フィルター条件、実際の認可状態、およびソースワークスペースの状態によっても制限されます。
この読み取りには routine.defaultAccess が必要です。デフォルトでは id の降順でページングされ、type が認可方向を制御します。status=0 の設定に一致しても認可が有効であるとは限らず、pending/expired/同期状態およびソースワークスペースのロックも確認する必要があります。この API は保存済み設定を表示するもので、クロスサイト同期や認可の有効化をトリガーしません。返却件数だけでクエリ可能範囲を判断しないでください。
読み取り時には authorizationCode が削除され、extra 内の tempAuthCode/tempAuthCodeHash が再帰的に除外されます。設定の認証コードが業務パラメータとして提供されることはありません。sourceWorkspaceAccess はローカルのソースワークスペースを照会できる場合にのみロック情報を返します。sourceWorkspaceAccess は常にオブジェクトです。クロスサイトまたは識別不能なソースの場合、isLocked/lockMode は null になることがあり、未ロックと解釈しないでください。
アイデンティティサマリーおよび extra のクロスサイトフィールドは、アイデンティティタイプ/レコードタイプによって省略される場合があります。フィールド表のすべての拡張が各レコードに存在すると解釈しないでください。読み取り時に、クリーンアップされた一時認証コードやサマリーが再追加されることはありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| filterWsUUIDs | commaArray | 省略可能なカンマ区切り文字列。方向に応じて対向ワークスペースでフィルターします。分割後、各項目の空白は除去されません。 null 許可: False 例: wksp_target取得または入力方法: grant 方向ではターゲットワークスペース ID、granted 方向ではソースワークスペース ID を入力します。 |
|
| namespace | commaArray | 省略可能なカンマ区切り文字列。複数のドメインは AND で組み合わせてフィルターされ、それぞれが type に一致するか * を含む必要があります。現在はレガシーな LIKE マッチングであり、完全な機能検証ではありません。 null 許可: False 例: logging,metric取得または入力方法: 確認するデータドメインの名前を選択し、複数ある場合は半角カンマで連結します。 |
|
| pageIndex | integer | 省略可能な正の整数。デフォルトは 1。 null 許可: False $minValue: 1 例: 1取得または入力方法: 1 ページ目から開始し、pageInfo と組み合わせて後続ページを読み取ります。 |
|
| pageSize | integer | 省略可能。1~100、デフォルトは 20。 null 許可: False $maxValue: 100 $minValue: 1 例: 20取得または入力方法: 一括読み取りの要件に応じて 1~100 を選択します。 |
|
| regionCode | string | 省略可能なソースサイトフィルター。レガシーな Code 形式と互換性があります。toRegionCode とは意味が異なります。 null 許可: False 例: SITE-CODE取得または入力方法: 既存レコードの regionCode からソースサイト値を取得します。ローカルレコードでは省略できます。 |
|
| search | string | 省略可能。grant ではターゲット、granted ではソースを検索します。空白は除去されず、LIKE ワイルドカードが有効な場合があります。 null 許可: False 例: 例取得または入力方法: 対向ワークスペース名または UUID で検索します。 |
|
| toRegionCode | string | 省略可能な認可先サイトフィルター。 null 許可: False 例: SITE-CODE取得または入力方法: 既存レコードの toRegionCode からターゲットサイト値を取得します。 |
|
| type | string | 省略可能。デフォルトは grant。列挙型は設定されておらず、grant 以外の値はすべて被認可分岐に入るため、grant/granted のみを使用することを推奨します。 null 許可: False 例: grant取得または入力方法: 現在のワークスペースが発行した認可を確認するには grant、現在のワークスペースが取得した認可を確認するには granted を使用します。 |
パラメータ補足説明¶
認可方向、ページングコンテナ、および認可状態については本ページを正とします。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/wksp_share/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode type=grant \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主なフィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ページングコンテナ。データは content.data にあります。 |
| content.data | array | 現在のページの認可設定一覧。 |
| content.data[].id | integer | 内部行番号。API リソース識別子としては使用されません。 |
| content.data[].uuid | string | 認可設定 UUID。通常は grant_ プレフィックスが付き、詳細/変更/削除ではこの値を使用します。 |
| content.data[].workspaceUUID | string | データ認可元ワークスペース。現在クエリに使用している Key のワークスペースとは限りません(被認可一覧の場合は他のソースワークスペースです)。 |
| content.data[].workspaceName | string | 認可元ワークスペース名。 |
| content.data[].toWorkspaceUUID | string | データクエリ認可を取得したターゲットワークスペース。 |
| content.data[].toWorkspaceName | string | 認可先ワークスペース名。 |
| content.data[].regionCode | string | 認可元サイト識別子。 |
| content.data[].toRegionCode | string | ターゲットサイト識別子。読み取り時に古い空値は互換ルールに従って補完されます。 |
| content.data[].siteRelationType | string | same_site/same_org_cross_site/external_org_cross_site などのサイト関係。履歴レコードでは空になる場合があります。 |
| content.data[].sourceBaseUrl | string | 一部のクロスサイトレコードのソースアドレス。通常の同一サイトでは空になる場合があり、今回の API Endpoint ではありません。 |
| content.data[].targetBaseUrl | string | 一部のクロスサイトレコードのターゲットアドレス。通常の同一サイトでは空になる場合があります。 |
| content.data[].type | array/string または null | 保存された認可データドメイン。* はすべてを表します。履歴データは正規化されていない場合があり、ステータス 0 だけで有効と判断できません。 |
| content.data[].type[] | JSON | 通常はデータドメイン文字列です。現在の旧エントリポイントでは要素の列挙型を完全には検証しません。 |
| content.data[].indexes | array または null | 認可されたログインデックス名の集合で、インデックス UUID ではありません。* はすべてを表し、ログドメインが認可されていない場合は [] として保存されます。 |
| content.data[].indexes[] | string | 1 つのインデックス名(例: default)。 |
| content.data[].conditions | object または null | metric/tracing/rum ごとに保存されたフィルター設定。データ権限そのものやクエリ結果ではありません。 |
| content.data[].extra | object または null | レコードロール、認可状態、およびクロスサイト拡張を記録します。読み取りと書き込みレスポンスではクリーンアップルールが異なるため、認証診断を含む生の書き込みレスポンスを外部共有しないでください。 |
| content.data[].extra.recordRole | string | authority/mirror など。一部のレコードにのみ存在します。 |
| content.data[].extra.grantStatus | string | レコードに保存された状態。読み取り時には pending を時間経過により expired として表示する場合があります。 |
| content.data[].delayDeleteAt | integer | 削除予定時刻。-1 は通常、予定なしを表します。レコードが必ず有効であることを意味しません。 |
| content.data[].status | integer | モデル状態。0 は未削除、削除は通常 3 です。業務上の認可については grantStatus なども確認する必要があります。 |
| content.data[].creator | string | 作成者識別子。API Key UUID または履歴アカウント/システムアイデンティティの場合があります。 |
| content.data[].updator | string | 最新の操作者。空の場合があります。 |
| content.data[].createAt | integer | 作成 Unix 秒。 |
| content.data[].updateAt | integer | 更新 Unix 秒。初期値は -1 の場合があります。 |
| content.data[].deleteAt | integer | ソフト削除 Unix 秒。未削除の場合は通常 -1 です。 |
| content.data[].conditions.metric | array | metric カテゴリの条件配列。 |
| content.data[].conditions.metric[] | object | 1 組の条件。現在、要素には完全な事前構造検証がありません。 |
| content.data[].conditions.metric[].name | string | 実際のフィールド名。 |
| content.data[].conditions.metric[].op | string | in または not in。 |
| content.data[].conditions.metric[].logic | string | and/or を推奨。同じカテゴリ内では一致させる必要があります。現在、列挙型は厳密に検証されません。 |
| content.data[].conditions.metric[].value | array | 条件値の配列。要素は実際のフィールド型に従います。 |
| content.data[].conditions.tracing | array | tracing カテゴリの条件配列。 |
| content.data[].conditions.tracing[] | object | 1 組の条件。現在、要素には完全な事前構造検証がありません。 |
| content.data[].conditions.tracing[].name | string | 実際のフィールド名。 |
| content.data[].conditions.tracing[].op | string | in または not in。 |
| content.data[].conditions.tracing[].logic | string | and/or を推奨。同じカテゴリ内では一致させる必要があります。現在、列挙型は厳密に検証されません。 |
| content.data[].conditions.tracing[].value | array | 条件値の配列。要素は実際のフィールド型に従います。 |
| content.data[].conditions.rum | array | rum カテゴリの条件配列。 |
| content.data[].conditions.rum[] | object | 1 組の条件。現在、要素には完全な事前構造検証がありません。 |
| content.data[].conditions.rum[].name | string | 実際のフィールド名。 |
| content.data[].conditions.rum[].op | string | in または not in。 |
| content.data[].conditions.rum[].logic | string | and/or を推奨。同じカテゴリ内では一致させる必要があります。現在、列挙型は厳密に検証されません。 |
| content.data[].conditions.rum[].value | array | 条件値の配列。要素は実際のフィールド型に従います。 |
| content.data[].grantMode | string | same_site または cross_site。読み取り時にサイト関係に基づいて導出されます。 |
| content.data[].grantStatus | string | active/pending/revoked/expired などの観測可能な認可状態。pending の期限切れはここで表示上正規化されるだけで、バックエンドで既に削除されたこととは異なります。 |
| content.data[].syncStatus | string | クロスサイト同期の付加状態。空の場合があります。 |
| content.data[].lastSyncAt | integer または null | クロスサイトの前回同期 Unix 秒。省略時は null です。履歴の非正規値は実際のレスポンスで確認する必要があります。 |
| content.data[].regionName | string | リクエスト言語とサイトメタデータに基づいて生成されたソースサイト名。 |
| content.data[].toRegionName | string | リクエスト言語とサイトメタデータに基づいて生成されたターゲットサイト名。 |
| content.data[].creatorInfo | object | 作成者アイデンティティサマリー。Key/履歴アカウント/システムアイデンティティの場合があります。 |
| content.data[].creatorInfo.uuid | string | アイデンティティ識別子。個人アカウント UUID であることは保証されません。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.email | string | アイデンティティの多態フィールド。Key の場合は Key UUID になることがあり、一律にメールアドレスとして扱えません。 |
| content.data[].updatorInfo | object | 最新の操作者アイデンティティサマリー。{} の場合があります。 |
| content.data[].updatorInfo.uuid | string | 存在する場合の操作者識別子。 |
| content.data[].updatorInfo.name | string | 存在する場合の操作者表示名。 |
| content.data[].updatorInfo.email | string | アイデンティティの多態フィールド。実際のメールアドレスとは限りません。 |
| content.data[].sourceWorkspaceAccess | object | 一覧表示時のみ付加されるソースワークスペースのロックサマリー。 |
| content.data[].sourceWorkspaceAccess.isLocked | integer または null | ローカルソースを識別できる場合は 0/1、リモートまたは識別不能な場合は null になります。 |
| content.data[].sourceWorkspaceAccess.lockMode | string または null | ソースロックモード。未識別の場合は null になります。 |
| content.declaration | object または null | 外側の共通宣言。data[] に再帰的に補完されません。 |
| pageInfo | object | トップレベルのページング情報。 |
| pageInfo.count | integer | 現在のページの件数。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.totalCount | integer | 一致するレコードの総数。有効な認可データ量ではありません。 |
| content.data[].extra.tempAuthCodeExpireAt | integer | 一時認可パッケージの有効期限 Unix 秒。省略可能で、そのまま使用できる認証コードではありません。 |
| content.data[].extra.pendingTargetWorkspaceUUID | string | pending レコードの想定ターゲットワークスペース。省略可能です。 |
| content.data[].extra.metaUUID | string | 認可パッケージ識別子。省略可能で、grant 設定 UUID ではありません。 |
| content.data[].extra.grantScopeFingerprint | string | 認可範囲のサマリー。省略可能で、顧客認証パラメータとしては使用されません。 |
| content.data[].extra.createdAt | integer | 拡張レコードの作成 Unix 秒。省略可能です。 |
| content.data[].extra.authorityGrantUUID | string | mirror レコードに関連付けられたソース認可設定 UUID。省略可能で、現在の Key ワークスペースが所有する設定として直接扱うことはできません。 |
| content.data[].extra.sourceKid | string | ソースサイトの公開鍵識別子。省略可能です。 |
| content.data[].extra.sourceJwksUri | string | ソースサイトの公開鍵セットアドレス。省略可能です。 |
| content.data[].extra.syncStatus | string | クロスサイト同期状態(success/failed または空など)。省略可能です。 |
| content.data[].extra.lastSyncAt | integer | 前回同期 Unix 秒。省略可能です。 |
| content.data[].extra.lastSyncError | string | 適合化された最新の同期エラーサマリー。省略可能で、今回の API の外側のエラーコードではありません。 |
| content.data[].extra.lastSyncErrorAt | integer | 最新の同期失敗 Unix 秒。省略可能です。 |
| content.data[].extra.resourceSummary | object | 一部のクロスサイトレコードで同期保存されるリソースサマリー。省略可能で、リアルタイムの完全なリソース一覧ではありません。 |
| content.data[].extra.resourceSummary.logging | object | ログリソースのサマリー。省略可能です。 |
| content.data[].extra.resourceSummary.logging.indexes | array | 上流から同期されたログインデックスサマリー項目。要素は文字列またはオブジェクトで、そのまま保存されます。 |
| content.data[].extra.resourceSummary.logging.indexes[] | JSON | 1 つのインデックスサマリー。固定の uuid/name 形式を前提にできず、インデックスを操作する前にインデックス一覧から実際のパラメータを取得する必要があります。 |
| content.data[].extra.resourceSummary.rum | object | RUM リソースのサマリー。省略可能です。 |
| content.data[].extra.resourceSummary.rum.applications | array | 上流の RUM アプリケーションサマリー項目。文字列またはオブジェクトで、実際の返却に従います。 |
| content.data[].extra.resourceSummary.rum.applications[] | JSON | アプリケーションサマリー。現在のサイトのアプリケーション設定 UUID の代替にはなりません。 |
| content.data[].extra.resourceSummary.updatedAt | number | リソースサマリー生成の数値。単位は上流が決定し、Studio は単位変換や統一を保証しません。 |
| content.data[].extra.resourceSummary.sourceGrantUUID | string | リソースサマリーに関連付けられたソース認可設定識別子。 |
| content.data[].extra.sourceSite | object | 認可元/ターゲット側サイトのアイデンティティスナップショット。省略可能で、現在のリクエスト Endpoint の代替にはなりません。 |
| content.data[].extra.sourceSite.siteCode | string | サイトコード。省略可能です。 |
| content.data[].extra.sourceSite.regionCode | string | リージョンコード。省略可能です。 |
| content.data[].extra.sourceSite.name | string | サイト表示名。省略可能です。 |
| content.data[].extra.sourceSite.issuer | string | 署名発行者。省略可能です。 |
| content.data[].extra.sourceSite.baseUrl | string | サイト API のベースアドレス。省略可能です。 |
| content.data[].extra.sourceSite.jwksUri | string | 公開鍵セットアドレス。省略可能です。 |
| content.data[].extra.sourceSite.kid | string | 公開鍵識別子。省略可能です。 |
| content.data[].extra.sourceSite.publicKeys | array | 一部のサイトスナップショットには公開鍵情報が含まれます。省略可能で、秘密鍵は含まれません。 |
| content.data[].extra.sourceSite.publicKeys[] | object | 省略可能な公開鍵項目。 |
| content.data[].extra.sourceSite.publicKeys[].kid | string | 公開鍵識別子。 |
| content.data[].extra.sourceSite.publicKeys[].publicKey | string | PEM 公開鍵の本文。 |
| content.data[].extra.targetSite | object | 認可元/ターゲット側サイトのアイデンティティスナップショット。省略可能で、現在のリクエスト Endpoint の代替にはなりません。 |
| content.data[].extra.targetSite.siteCode | string | サイトコード。省略可能です。 |
| content.data[].extra.targetSite.regionCode | string | リージョンコード。省略可能です。 |
| content.data[].extra.targetSite.name | string | サイト表示名。省略可能です。 |
| content.data[].extra.targetSite.issuer | string | 署名発行者。省略可能です。 |
| content.data[].extra.targetSite.baseUrl | string | サイト API のベースアドレス。省略可能です。 |
| content.data[].extra.targetSite.jwksUri | string | 公開鍵セットアドレス。省略可能です。 |
| content.data[].extra.targetSite.kid | string | 公開鍵識別子。省略可能です。 |
| content.data[].extra.targetSite.publicKeys | array | 一部のサイトスナップショットには公開鍵情報が含まれます。省略可能で、秘密鍵は含まれません。 |
| content.data[].extra.targetSite.publicKeys[] | object | 省略可能な公開鍵項目。 |
| content.data[].extra.targetSite.publicKeys[].kid | string | 公開鍵識別子。 |
| content.data[].extra.targetSite.publicKeys[].publicKey | string | PEM 公開鍵の本文。 |
| content.data[].extra.resourceSummary.metric | object | 対応するドメインのリソースサマリー。省略可能です。 |
| content.data[].extra.resourceSummary.metric.workspaceUUIDs | array | 同期保存されたソースワークスペース識別子の集合。要素は通常文字列です。現在の Key が任意のワークスペースを操作できる認可ではありません。 |
| content.data[].extra.resourceSummary.metric.workspaceUUIDs[] | JSON | 個々のワークスペース識別子は上流の実際の返却に従います。完全に正規化されていない履歴項目は事前に確認する必要があります。 |
| content.data[].extra.resourceSummary.tracing | object | 対応するドメインのリソースサマリー。省略可能です。 |
| content.data[].extra.resourceSummary.tracing.workspaceUUIDs | array | 同期保存されたソースワークスペース識別子の集合。要素は通常文字列です。現在の Key が任意のワークスペースを操作できる認可ではありません。 |
| content.data[].extra.resourceSummary.tracing.workspaceUUIDs[] | JSON | 個々のワークスペース識別子は上流の実際の返却に従います。完全に正規化されていない履歴項目は事前に確認する必要があります。 |
| content.data[].extra.resourceSummary.lineage | object | 対応するドメインのリソースサマリー。省略可能です。 |
| content.data[].extra.resourceSummary.lineage.workspaceUUIDs | array | 同期保存されたソースワークスペース識別子の集合。要素は通常文字列です。現在の Key が任意のワークスペースを操作できる認可ではありません。 |
| content.data[].extra.resourceSummary.lineage.workspaceUUIDs[] | JSON | 個々のワークスペース識別子は上流の実際の返却に従います。完全に正規化されていない履歴項目は事前に確認する必要があります。 |
| content.data[].creatorInfo.status | integer | アイデンティティ自体の状態。アカウント/Key の実際の型に応じて解釈します。 |
| content.data[].creatorInfo.wsAccountStatus | integer または null | ワークスペースメンバー/アイデンティティ関連状態。省略可能です。 |
| content.data[].creatorInfo.username | string | アイデンティティのログイン名または Key 名。システムアイデンティティでは省略可能です。 |
| content.data[].creatorInfo.iconUrl | string | アイデンティティアイコン URL。空の場合があります。 |
| content.data[].creatorInfo.mobile | string | アイデンティティの携帯電話番号。空の場合があり、Key には通常この値はありません。 |
| content.data[].creatorInfo.countryCode | string | 携帯電話番号の国/地域コード。空の場合があります。 |
| content.data[].creatorInfo.acntWsNickname | string | 現在のワークスペースにおけるアイデンティティのニックネーム。省略可能です。 |
| content.data[].updatorInfo.status | integer | アイデンティティ自体の状態。アカウント/Key の実際の型に応じて解釈します。 |
| content.data[].updatorInfo.wsAccountStatus | integer または null | ワークスペースメンバー/アイデンティティ関連状態。省略可能です。 |
| content.data[].updatorInfo.username | string | アイデンティティのログイン名または Key 名。システムアイデンティティでは省略可能です。 |
| content.data[].updatorInfo.iconUrl | string | アイデンティティアイコン URL。空の場合があります。 |
| content.data[].updatorInfo.mobile | string | アイデンティティの携帯電話番号。空の場合があり、Key には通常この値はありません。 |
| content.data[].updatorInfo.countryCode | string | 携帯電話番号の国/地域コード。空の場合があります。 |
| content.data[].updatorInfo.acntWsNickname | string | 現在のワークスペースにおけるアイデンティティのニックネーム。省略可能です。 |
{
"code": 200,
"content": {
"data": [
{
"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": {},
"sourceWorkspaceAccess": {
"isLocked": 0,
"lockMode": "none"
}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"pageIndex": 1,
"pageSize": 20,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
一覧は現在のクエリ方向の設定のみを表します。業務上クエリできるかはターゲットデータ API で検証する必要があり、レコードが一覧に表示されても完全な権限があることは保証されません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | ストレージ/履歴認可フィールド/サイトのフォーマットまたはアイデンティティ情報の異常 | 内部エラー | フィルターを絞り込み、traceId を保持して管理者に連絡し、履歴設定およびサイトデータを確認してください。 |