追加¶
POST /api/v1/wksp_share/add
概要¶
現在のサイトで別のワークスペースにデータクエリ認可を追加します。
呼び出し前の準備と使用手順¶
作成/変更/削除には、データ認可元ワークスペースの API Key を使用します。読み取りの場合は、現在の Key のワークスペースにおける認可方向に従って操作します。このグループで認可するのはワークスペース間のデータクエリ機能であり、メンバーの招待、アカウントロールの付与、データのコピーではありません。レスポンスの workspaceUUID は認可元、toWorkspaceUUID は認可先です。追加時の Body.workspaceUUID だけが認可先のターゲットワークスペースを表し、レスポンスの同名フィールドとは方向が異なります。クエリが有効になるかは、データドメイン、ログインデックス、フィルター条件、実際の認可状態、およびソースワークスペースの状態によっても制限されます。
作成/変更/削除には dataRightsManage.workspaceConfigManage が必要です。まず認可リストを type=grant で読み取り、現在のワークスペース自身が発行したレコードを取得し、content.data[].uuid を取得します。認可先リスト内の他のソースワークスペースの UUID を、自分が変更可能な設定と見なさないでください。結果が不明な場合はまず設定を読み戻し、重複認可や、失敗してまったく実行されなかったという誤解を避けてください。
この追加は同一サイト内の異なる有効なターゲットワークスペースのみをサポートします(ターゲットの versionType=freeEdition の場合は拒否されます)。regionCode で新しいクロスサイト関係を作成することはできません。クロスサイトの場合はmeta の生成とmeta のインポートのフローを使用してください。workspaceUUID は 1 回に 1 つです。type/indexes は完全な認可範囲であり、保存成功時にインデックスの実在は検証されず、下流のクエリがすでに成功したことを意味するものでもありません。
追加ではまずレコードを送信し、その後サイト名/任意の通知と監査を準備します。通知の内部エラーはログに記録されるだけの場合があり、API の成功はメール配信を保証しません。送信後のその他の準備失敗も 500 を返すことがありますが、設定はすでに存在します。同じソース/ターゲットサイトの組み合わせで再度作成すると 406(認可済み)になります。結果が不明な場合は既存のレコードを先に読み取ってください。
conditions を省略するか {} を指定すると、追加条件なしを意味します。変更時に省略すると古い条件はクリアされ、保持されるわけではありません。公開されるのは metric/tracing/rum の 3 つの配列のみです。lineage サブ条件は公開されません(共有の内部バリデータはこの名前を認識しますが)。追加の Body フィールドは拒否されます。配列要素はオブジェクトを推奨します。op は in/not in が必須で、value は配列が必須です。同じカテゴリ内では logic を一致させる必要があり、and/or を推奨します。現在は logic の列挙値/name の必須/配列要素のオブジェクト形状を厳密に検証しておらず、不正な形式の要素は 500 になる可能性があります。保存成功をもって条件が必ず有効であると証明することはできません。異なるデータドメインの条件は相互に認可するものではなく、条件が未設定のデータドメインを禁止するものでもありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: ターゲットワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| conditions.metric[*] | json | 1 つの条件オブジェクト。以下のサブフィールドは意味上の指針であり、現在は完全な事前の項目別検証はありません。 例: {"name": "host", "op": "in", "logic": "and", "value": ["example-value"]}取得または入力方法: 配列内の各項目に 1 組の条件を入力します。 |
|
| conditions.metric[*].name | string | 実際のフィールド名であり、フィールド設定 UUID ではありません。 例: host取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
|
| conditions.metric[*].op | string | 条件付き必須 | in または not in が必須で、省略/その他の値は 406 になります。 例: in取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
| conditions.metric[*].logic | string | and/or を推奨します。同じドメイン内では一致している必要があり、現在は列挙値を厳密に検証していませんが、省略値も一致性の比較対象になります。 例: and取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
|
| conditions.metric[*].value | array | 条件付き必須 | 配列が必須で、要素は実際のフィールド型に従って入力します。空の配列を「すべて」と解釈することはできません。 例: ["example-value"]取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
| conditions.tracing[*] | json | 1 つの条件オブジェクト。以下のサブフィールドは意味上の指針であり、現在は完全な事前の項目別検証はありません。 例: {"name": "service", "op": "in", "logic": "and", "value": ["example-value"]}取得または入力方法: 配列内の各項目に 1 組の条件を入力します。 |
|
| conditions.tracing[*].name | string | 実際のフィールド名であり、フィールド設定 UUID ではありません。 例: service取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
|
| conditions.tracing[*].op | string | 条件付き必須 | in または not in が必須で、省略/その他の値は 406 になります。 例: in取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
| conditions.tracing[*].logic | string | and/or を推奨します。同じドメイン内では一致している必要があり、現在は列挙値を厳密に検証していませんが、省略値も一致性の比較対象になります。 例: and取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
|
| conditions.tracing[*].value | array | 条件付き必須 | 配列が必須で、要素は実際のフィールド型に従って入力します。空の配列を「すべて」と解釈することはできません。 例: ["example-value"]取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
| conditions.rum[*] | json | 1 つの条件オブジェクト。以下のサブフィールドは意味上の指針であり、現在は完全な事前の項目別検証はありません。 例: {"name": "app_id", "op": "in", "logic": "and", "value": ["example-value"]}取得または入力方法: 配列内の各項目に 1 組の条件を入力します。 |
|
| conditions.rum[*].name | string | 実際のフィールド名であり、フィールド設定 UUID ではありません。 例: app_id取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
|
| conditions.rum[*].op | string | 条件付き必須 | in または not in が必須で、省略/その他の値は 406 になります。 例: in取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
| conditions.rum[*].logic | string | and/or を推奨します。同じドメイン内では一致している必要があり、現在は列挙値を厳密に検証していませんが、省略値も一致性の比較対象になります。 例: and取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
|
| conditions.rum[*].value | array | 条件付き必須 | 配列が必須で、要素は実際のフィールド型に従って入力します。空の配列を「すべて」と解釈することはできません。 例: ["example-value"]取得または入力方法: そのドメインのフィールドおよび業務上許可される値に従って構築します。 |
| conditions | json | conditions を省略するか {} を指定すると、追加条件なしを意味します。変更時に省略すると古い条件はクリアされ、保持されるわけではありません。公開されるのは metric/tracing/rum の 3 つの配列のみです。lineage サブ条件は公開されません(共有の内部バリデータはこの名前を認識しますが)。追加の Body フィールドは拒否されます。配列要素はオブジェクトを推奨します。op は in/not in が必須で、value は配列が必須です。同じカテゴリ内では logic を一致させる必要があり、and/or を推奨します。現在は logic の列挙値/name の必須/配列要素のオブジェクト形状を厳密に検証しておらず、不正な形式の要素は 500 になる可能性があります。保存成功をもって条件が必ず有効であると証明することはできません。異なるデータドメインの条件は相互に認可するものではなく、条件が未設定のデータドメインを禁止するものでもありません。 null を許可: False 例: {"metric": [{"name": "host", "op": "in", "logic": "and", "value": ["host-example"]}]}取得または入力方法: 認可元の実際のフィールドと値に基づいて、最小限の許可範囲を構築します。 |
|
| conditions.metric | array | 任意の条件配列。省略または[]の場合、このカテゴリにフィルターを追加しません。変更時は conditions 全体が送信値で置き換えられます。 null を許可: False 例: [{"name": "host", "op": "in", "logic": "and", "value": ["example-value"]}]取得または入力方法: metric の実際のフィールドと値からフィルター条件を選択します。 |
|
| conditions.rum | array | 任意の条件配列。省略または[]の場合、このカテゴリにフィルターを追加しません。変更時は conditions 全体が送信値で置き換えられます。 null を許可: False 例: [{"name": "app_id", "op": "in", "logic": "and", "value": ["example-value"]}]取得または入力方法: rum の実際のフィールドと値からフィルター条件を選択します。 |
|
| conditions.tracing | array | 任意の条件配列。省略または[]の場合、このカテゴリにフィルターを追加しません。変更時は conditions 全体が送信値で置き換えられます。 null を許可: False 例: [{"name": "service", "op": "in", "logic": "and", "value": ["example-value"]}]取得または入力方法: tracing の実際のフィールドと値からフィルター条件を選択します。 |
|
| indexes | array | Y | 必須の配列。type に*または logging が含まれる場合は保存され、それ以外では強制的に[]にクリアされます。*はすべてのインデックスを表し、[]は「すべて」と等しくありません。保存時に各インデックスの実在は確認されません。null を許可: False 例: ["default"]取得または入力方法: 認可元のログインデックスリストから name を取得し、設定 UUID ではありません。明示的にページングする場合のパスは content.data[].name、ページングしない場合は元の content[].name です。 |
| regionCode | string | 任意。省略/空文字列の場合は現在のサイトを採用します。他のサイトの Code は 406 になり、以前の説明にあった任意のクロスサイト作成ではありません。 空文字列を許可: True null を許可: False 例: SITE-CODE取得または入力方法: 省略して現在のサイトを使用することを推奨します。明示的な値が必要な場合は、サイト管理者が現在のサイトと完全に一致する Code を提供する必要があります。 |
|
| type | array | Y | 必須の配列。*はすべてを表し、[]は「すべて」ではありません。公開宣言では null を許可していますが、後続の業務処理で 500 になる可能性があるため、必ず配列を送信してください。列挙値は項目別に検証されないため、任意の未知の値は推奨しません。 null を許可: True 例: ["metric", "logging"]取得または入力方法: 実際に認可するドメインに応じて選択します(metric/logging/tracing/rum/object/custom_object/lineage など)。ターゲットのクエリ機能が対応している必要があります。 |
| workspaceUUID | commaArray | Y | 必須の単一ワークスペース UUID 文字列。歴史的な型名 commaArray は文字列検証のみを行い、このエントリポイントではカンマで分割して一括作成しません。配列や複数の ID を送信しないでください。 null を許可: False 例: wksp_target取得または入力方法: 認可先がそのワークスペース情報/コンソールから実際の UUID を提供します。現在の認可元自身を指定することはできません。 |
パラメータ補足説明¶
同一サイトでの追加と条件範囲については本ページを参照してください。以前のクロスサイト入力パラメータの説明は適用されません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/wksp_share/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"workspaceUUID":"wksp_target","type":["metric","logging"],"indexes":["default"],"conditions":{"metric":[{"name":"host","op":"in","logic":"and","value":["host-example"]}]}}'
レスポンス¶
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 | 保存された認可データドメイン。*はすべてを表します。履歴データは正規化されていない可能性があり、ステータス 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 または履歴アカウント/システム ID の場合があります。 |
| 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.authorizationCode | stringまたはnull | 書き込みレスポンスの履歴認証フィールド。顧客の通常のクエリパラメータとしては使用されません。公開して共有しないでください。 |
| content.name | string | 作成時に付加されたターゲットワークスペース名。 |
| content.declaration | objectまたはnull | 最外層の共通宣言。 |
| 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 | 署名 ID。省略可能です。 |
| 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 | 署名 ID。省略可能です。 |
| 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 | 個々のワークスペース識別子は上流の実際の返却値に従います。完全に正規化されていない履歴項目は事前に確認する必要があります。 |
{
"code": 200,
"content": {
"id": 10,
"uuid": "grant_example",
"workspaceUUID": "wksp_source",
"toWorkspaceUUID": "wksp_target",
"regionCode": "SITE-CODE",
"toRegionCode": "SITE-CODE",
"workspaceName": "授权方示例空间",
"toWorkspaceName": "被授权方示例空间",
"authorizationCode": null,
"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,
"name": "被授权方示例空间",
"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 オブジェクトを送信してください。 |
| 406 | ft.WorkspaceGrantConditionOperatorInvalid | 条件要素の op が欠落しているか、in/not in ではありません | 認可範囲 {} 条件の演算子は in または not in のみをサポートします | 各項目に in または not in を入力し、フィールドが業務範囲と一致するようにしてください。 |
| 406 | ft.WorkspaceGrantConditionValueMustBeList | 条件要素の value が配列ではありません | 認可範囲 {} 条件の value フィールドはリストである必要があります | JSON 配列を使用し、カンマ区切り文字列を送信しないでください。 |
| 406 | ft.WorkspaceGrantConditionLogicMixed | 同じカテゴリの logic に複数の異なる値が存在します(省略値と and の混用を含む) | 認可範囲 {} 条件では異なる論理演算子の混用をサポートしません | 同じカテゴリのすべての条件で logic を and または or に統一してください。 |
| 406 | ft.WKSPShareInvalid | ソースまたはターゲットワークスペースが無効/存在しない/非アクティブ、ターゲットの versionType=freeEdition、ターゲットが不正/ソースと同一以外の検証失敗、または regionCode が現在のサイトではない | 無効なワークスペース uuid | 現在のソースレコードと実際のターゲットワークスペースの状態を確認してください。公開 Body でサポートされる範囲フィールドを使用し、ターゲットワークスペース/サイトの置き換えを試みないでください。 |
| 406 | ft.WKSPIllegalAuthorization | 現在の認可元ワークスペースを自身に認可しようとしています | データ認可には現在のワークスペース以外の ID を入力してください。再入力してください | 異なる認可先ターゲットワークスペース UUID を入力してください。 |
| 406 | ft.WKSPRepeatAuthorization | 同じソース/ターゲット/サイトに status=0 のレコードがすでに存在します(grantStatus は追加確認しません) | ワークスペースはすでに認可されています。重複して認可しないでください! | まず既存の設定を読み取り、必要に応じて変更し、重複作成しないでください。 |
| 500 | ft.InternalServerError | type=null が後続コードで処理される、条件要素の構造異常、ストレージエラー、または送信後のキャッシュ/サイト情報準備失敗 | 内部エラー | まずリスト/詳細を読み戻して保存済みか確認し、traceId を保持したうえで再試行を判断してください。操作全体がロールバックされたと見なさないでください。 |