取得¶
GET /api/v1/log_backup_cfg/{cfg_uuid}/get
概要¶
単一の転送ルールの設定、マスク済み接続情報、アイデンティティ概要を読み取ります。
呼び出し前の確認と使用手順¶
一覧から cfg_uuid を選択します。未削除かつ deleting 中ではないルールを返します。Iceberg は存在しないものとして扱います。詳細には転送先接続の非シークレット設定が表示されます。トップレベルの SK/パスワード/サービスアカウント JSON は返しません。LogBamboo のネストされた Token は、設定されている場合でもマスク文字列のみです。レガシー TiDB DSN もマスクのみです。詳細全体をそのまま返して変更しないでください。本ページで公開されている Body フィールドを使用し、認証情報の継承ルールに従って構成してください。
このエンドポイントでルール設定を読み取れることは、転送後のデータを読み取る権限があることを意味しません。実際のクエリタスクでは、転送先と readPermissionSet も検証されます。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfg_uuid | string | Y | このワークスペースで未削除かつ deleting 状態ではないルールの UUID。name ではありません。 例: lgbp_example取得または入力方法: データ転送ルール一覧 の content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
レスポンスボディ構造の説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| accessCfg | dict | サードパーティストレージ設定情報 |
| name | string | 転送ルール名 |
| uuid | string | 転送ルールの一意な UUID |
| status | string | 転送ルールのステータス、0:有効、2:無効 |
| dataType | string | データ型 |
| conditions | string | dql 形式のフィルター条件 |
| storeType | string | ストレージ型 |
| externalResourceAccessCfgUUID | string | 外部リソースアクセス設定 UUID |
| workspaceUUID | string | 転送ルールが属するワークスペース UUID |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/log_backup_cfg/lgbp_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。作成スナップショットはコミット前に生成されるため、null になる場合があります。呼び出しには uuid を使用します。 |
| content.uuid | string | lgbp_ ルール UUID。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | ルール名。作成後、この公開更新インターフェースでは名前を変更できません。 |
| content.conditions | string | extend.filters から生成される条件。追加フィルターがない場合は空文字列または {} です。 |
| content.syncExtensionField | boolean | 拡張フィールドを同期するかどうか。 |
| content.externalResourceAccessCfgUUID | string | アクセス設定の識別子。認証情報ではありません。 |
| content.storeType | string | 保存される転送先の型。レガシー TiDB は読み取り可能な場合がありますが、現在の OpenAPI では作成できません。 |
| content.storageClass | string | 転送先のアーカイブクラス。 |
| content.storageFormat | string | json/parquet。Kafka または LogBamboo では空の場合があります。Iceberg はこの公開一覧/詳細から除外されます。 |
| content.dataType | string | ルールで固定されるデータカテゴリ。レガシーデータで空値の場合は logging として扱われます。 |
| content.taskStatusCode | integer | バックエンドの転送タスクが報告するステータス。作成時は通常 -1 で、現在の HTTP ステータスではありません。 |
| content.taskErrorCode | string | バックエンド転送のエラーコード。空文字列は現在のエラー記録がないことを示します。保存成功はタスク成功を保証しません。 |
| content.openPermissionSet | boolean | データ読み取りのカスタム権限スイッチ。 |
| content.readPermissionSet | array<string> |
保存された読み取り主体。 |
| content.readPermissionSet[] | string | 個々のロール/メンバー/チーム識別子。 |
| content.deleteStatus | string | 削除処理ステータス。deleting は組み込みストレージルールが非同期削除中であることを示します。レガシーデータでは空または completed の場合があります。 |
| content.status | integer | 0:有効、2:無効、3:削除。 |
| content.creator | string | 作成者のアイデンティティ。 |
| content.updator | string | 更新者のアイデンティティ。初期状態では空の場合があります。 |
| content.createAt | integer | 作成日時の Unix 秒。 |
| content.updateAt | integer | 更新日時の Unix 秒。未更新の場合は -1。 |
| content.deleteAt | integer | 削除日時の Unix 秒。未削除の場合は -1。 |
| content.extend | object | 保存された範囲/条件設定。省略可能で、作成時は通常 {} です。変更時に渡すと全体を置き換えます。レガシーのインデックス選択には専用の継承ルールがあり、使用説明を参照してください。省略時は保持されます。作成時に null を渡すと、後続の extend.get で 500 になる可能性があります。変更時に明示的に null を指定すると {} として全体を置き換えますが、新版インデックス選択の専用継承ルールは引き続き適用されます。 |
| content.extend.filters | array | 保存された範囲/条件設定:実際のフィルター条件配列です。[] は追加のフィールド条件がないことを示し、カテゴリ全体を転送する場合があります。match/not match およびその正規化エイリアスは拒否されます。ログインデックスの advancedFilter 構造をここに混在させないでください。 |
| content.extend.filters[] | json | 保存された範囲/条件設定:完全な name/condition/operation/value を推奨します。query_task.search 構造ではありません。 |
| content.extend.filters[].name | string | 保存された範囲/条件設定:実際のフィールドキー。 |
| content.extend.filters[].condition | string | 保存された範囲/条件設定:and/or による直前の条件との関係。先頭項目では無視されます。 |
| content.extend.filters[].operation | string | 保存された範囲/条件設定:一般的な =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist。match/contain 系はサポートされません。 |
| content.extend.filters[].value | array | 保存された範囲/条件設定:一致値。等値/比較では先頭項目を使用し、集合演算では複数項目を使用します。 |
| content.extend.filters[].value[] | JSON | 保存された範囲/条件設定:単一の文字列/数値。実際の型を保持します。 |
| content.extend.indexs | array | 保存された範囲/条件設定:ログネイティブの直接書き込みインデックス名の配列。新版では [] がそのカテゴリ全体を表し、非空は指定を表します。レガシープロトコルで regularLogIndexNames がない場合、動作が異なります。使用方法を参照してください。UUID 配列ではありません。 |
| content.extend.indexs[] | string | 保存された範囲/条件設定:実際の名前。trim して重複排除します。新版で追加する選択は、現在利用可能なカタログ内に存在する必要があります。 |
| content.extend.regularLogIndexNames | array または null | 保存された範囲/条件設定:ログ専用の新版通常インデックス選択。[] は通常カテゴリ全体、非空は指定を表します。null を indexs 配列と同時に渡すと直接書き込みのみを表します。変更時にこのキーのみ null を渡すとインデックス制限をクリアします。このキーがない場合はレガシープロトコルまたは変更時の保持を表します。詳細は使用説明を参照してください。 |
| content.extend.regularLogIndexNames[] | string | 保存された範囲/条件設定:現在選択可能な単一の通常インデックス名。クローンを含む場合、ソース A が有効である必要があります。UUID ではありません。 |
| content.creatorInfo | object | 関連するアイデンティティ概要。一致しない場合は {}。 |
| content.creatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.creatorInfo.status | integer | アカウントステータス。省略可能。 |
| content.creatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.creatorInfo.name | string | 表示名。 |
| content.creatorInfo.username | string | ログイン名。 |
| content.creatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.creatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.creatorInfo.iconUrl | string | アバター URL。省略可能。 |
| content.creatorInfo.acntWsNickname | string | ワークスペースでのニックネーム。省略可能。 |
| content.updatorInfo | object | 関連するアイデンティティ概要。一致しない場合は {}。 |
| content.updatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.updatorInfo.status | integer | アカウントステータス。省略可能。 |
| content.updatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.updatorInfo.name | string | 表示名。 |
| content.updatorInfo.username | string | ログイン名。 |
| content.updatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.updatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.updatorInfo.iconUrl | string | アバター URL。省略可能。 |
| content.updatorInfo.acntWsNickname | string | ワークスペースでのニックネーム。省略可能。 |
| content.readPermissionSetInfo | object | 読み取り主体が非空の場合に識別子→概要のマッピングを返します。解析可能な識別子がない場合は {} に対応し、空配列の場合は省略できます。 |
| content.readPermissionSetInfo.主体 | object | メンバー概要、またはロール/チームの name/status 概要。この主体が現在も有効であることを証明するものではありません。 |
| content.readPermissionSetInfo.主体.name | string | ロール/チーム/メンバーの表示名。 |
| content.readPermissionSetInfo.主体.status | integer | アイデンティティステータス。省略可能。 |
| content.allow_operation | boolean または null | 共有権限エンジンによる操作表示。操作主体が未設定の場合は null になることがあり、API 権限チェックの代わりにはなりません。 |
| content.readPermissionSetInfo.主体.uuid | string | アイデンティティ UUID。省略可能。 |
| content.readPermissionSetInfo.主体.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.readPermissionSetInfo.主体.username | string | ログイン名。 |
| content.readPermissionSetInfo.主体.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.readPermissionSetInfo.主体.mobile | string | 携帯電話番号。空の場合があります。 |
| content.readPermissionSetInfo.主体.countryCode | string | 国/地域コード。省略可能。 |
| content.readPermissionSetInfo.主体.iconUrl | string | アバター URL。省略可能。 |
| content.readPermissionSetInfo.主体.acntWsNickname | string | ワークスペースでのニックネーム。省略可能。 |
| content.accessCfg | object | 転送先に応じて存在し、省略可能です。オプションですが、外部転送先では通常、条件付きで必須です。OpenAPI は認証情報の原文を HTTPS 経由で直接送信し、Front の Web AES ラッピングを使用しません。変更時にオブジェクト全体を省略すると保持されます。指定した場合は全体を置き換え、機密値/パーティション/待機時間を指定した場合のみ継承できます。 |
| content.accessCfg.provider | string | 転送先に応じて存在し、省略可能です。オブジェクトストレージでは転送先プロバイダーと一致する必要があり、GCS は google 固定です。 |
| content.accessCfg.grantType | string | 転送先に応じて存在し、省略可能です。既存の非特殊ターゲットを変更する場合、旧 grantType を継承します。このフィールドに依存して認可モードを切り替えないでください。具体的な認可の組み合わせは、事前にコンソールで検証してください。 |
| content.accessCfg.cloudAccountId | string | 転送先に応じて存在し、省略可能です。ロール/アカウント認可では転送先の要件に従って指定します。DF-API-KEY ではありません。 |
| content.accessCfg.bucket | string | 転送先に応じて存在し、省略可能です。GCS では必須です。オブジェクトストレージでは実際にアクセス可能なバケットを指定する必要があり、サイトプラットフォームが予約した転送バケットは使用できません。 |
| content.accessCfg.externalId | string | 転送先に応じて存在し、省略可能です。ロール認可では入力が必要です。s3/oss のロール設定を変更する場合、レガシー externalId の概要が保持される可能性があります。 |
| content.accessCfg.role | string | 転送先に応じて存在し、省略可能です。ロール認可のアイデンティティ識別子。コンソールで要求される名前/識別子を使用し、このワークスペースの RBAC ロールではありません。 |
| content.accessCfg.ak | string | 転送先に応じて存在し、省略可能です。キー認可では sk と組み合わせて使用します。詳細では AK 識別子が返される場合がありますが、すべてのシークレットが返されるわけではありません。 |
| content.accessCfg.topic | string | 転送先に応じて存在し、省略可能です。Kafka では転送先の転送設定に従って入力します。空値の場合に転送先を自動作成するかは下流に依存します。保存されたことを書き込み可能であることの証明とみなさないでください。 |
| content.accessCfg.url | string | 転送先に応じて存在し、省略可能です。Kafka 接続アドレス。ネットワーク/認可とプロトコルが一致する必要があります。 |
| content.accessCfg.securityProtocol | string | 転送先に応じて存在し、省略可能です。Kafka 認証プロトコル。2 つの sasl モードでは空でない username/password が必要です。 |
| content.accessCfg.ca | string | 転送先に応じて存在し、省略可能です。Kafka/Doris では転送先の要件に応じて指定します。秘密キーではなく、未使用の場合は省略します。 |
| content.accessCfg.mechanism | string | 転送先に応じて存在し、省略可能です。Kafka SASL メカニズム。クラスタの要件に従って選択します。 |
| content.accessCfg.username | string | 転送先に応じて存在し、省略可能です。Kafka SASL および Doris では条件付きで必須です。変更時にユーザー名は自動継承されません。 |
| content.accessCfg.endpoints | string | 転送先に応じて存在し、省略可能です。Doris では条件付きで必須です。認証情報、サブパス、query、fragment を含まず、ポートが有効である必要があります。 |
| content.accessCfg.database | string | 転送先に応じて存在し、省略可能です。Doris データベース名は [A-Za-z_][A-Za-z0-9_]{0,63} に一致する必要があります。 |
| content.accessCfg.table | string | 転送先に応じて存在し、省略可能です。Doris テーブル名は [A-Za-z][A-Za-z0-9_]{0,63} に一致する必要があります。後続の作成/書き込み動作は転送先サービスによって実行されます。 |
| content.accessCfg.replicationNum | integer | 転送先に応じて存在し、省略可能です。Doris でのみ指定できます。非負整数で、省略または 0 の場合はクラスタのデフォルトを使用します。bool は無効です。 |
| content.accessCfg.region | string | 転送先に応じて存在し、省略可能です。オブジェクトストレージでは明示的に指定する必要があります。現在の検証では、後続のデフォルト補完前に非空が要求され、宣言テキスト内のデフォルトサイトリージョンには依存しません。 |
| content.accessCfg.endpoint | string | 転送先に応じて存在し、省略可能です。s3/obs/oss/tos で ram を設定する場合、実際のネットワーク要件に応じて指定します。Kafka broker や LogBamboo サブオブジェクトの endpoint ではありません。 |
| content.accessCfg.bucketPath | string | 転送先に応じて存在し、省略可能です。オプション。空文字列はバケットルートのプレフィックスです。変更時に完全なオブジェクトを指定する場合は再設定する必要があります。 |
| content.accessCfg.dataWaitSeconds | integer | 転送先に応じて存在し、省略可能です。オブジェクトストレージでのみ有効です。新規作成時のデフォルトは 3600 で、変更時に省略すると旧有効値を継承し、それ以外は 3600 です。オブジェクト以外の転送先ではこのキーが削除されます。bool またはその他の値は無効です。 |
| content.accessCfg.isEncrypt | boolean | 転送先に応じて存在し、省略可能です。オプションで、デフォルトでは暗号化しません。認証情報の転送/保存時暗号化のスイッチではなく、キー管理パラメータは提供しません。 |
| content.accessCfg.partitionFields | array | 転送先に応じて存在し、省略可能です。オプション。変更時に省略すると旧値を継承し、明示的な [] はルールレベルのパーティションをクリアします。Kafka 以外で指定すると 406 になり、メンバーは空でない文字列である必要があります。 |
| content.accessCfg.partitionFields[] | string | 転送先に応じて存在し、省略可能です。単一のパーティションフィールド。パーティション番号ではありません。 |
| content.accessCfg.logbamboo | json | 転送先に応じて存在し、省略可能です。このターゲットでは、このサブオブジェクトとシステムが補足するフィールドのみが許可されます。エンドポイントとインデックスは事前に作成する必要があり、query には独立した searchToken が必要です。 |
| content.accessCfg.logbamboo.endpoint | string | 転送先に応じて存在し、省略可能です。ユーザーパスワード、サブパス、query/fragment/空白を含まず、末尾の / は正規化して削除されます。 |
| content.accessCfg.logbamboo.index | string | 転送先に応じて存在し、省略可能です。1..128 文字。英数字、ドット、アンダースコア、ハイフンを使用でき、. または .. は使用できません。 |
| content.accessCfg.logbamboo.ingestToken | string | 設定されている場合でもマスク文字列のみで、実際の Token は返しません。変更時はこのフィールドの省略/空値ルールに従って処理します。 |
| content.accessCfg.logbamboo.searchToken | string | 設定されている場合でもマスク文字列のみで、実際の Token は返しません。変更時はこのフィールドの省略/空値ルールに従って処理します。 |
| content.accessCfg.logbamboo.ca | string | 転送先に応じて存在し、省略可能です。ロード可能な PEM CA である必要があり、PRIVATE KEY を含みません。省略時は空に正規化され、完全なオブジェクト更新時は明示的に保持する必要があります。 |
| content.accessCfg.storeType | string | 基盤接続の転送先型。プラットフォーム組み込みオブジェクトは実際のプロバイダーにマッピングされる場合があります。 |
| content.accessCfg.storageFormat | string | レガシー互換のアクセスオブジェクト形式フィールド。 |
| content.accessCfg.storageClass | string | レガシー互換のアーカイブフィールド。 |
| content.accessCfg.dataType | string | アクセスオブジェクトのデータカテゴリ。 |
| content.accessCfg.storeLocation | string | 組み込みオブジェクトストレージ接続の位置マーカー。サービスが管理し、クライアントは入力しません。 |
| content.accessCfg.tidb | object | レガシー TiDB の読み取り専用互換オブジェクト。これに基づいて現在の公開 Body で TiDB を作成/変更することはできません。 |
| content.accessCfg.tidb.dsn | string | 詳細ではマスク済み DSN が提供される場合があります。実際のパスワードはこの値を通じて返されません。 |
| content.accessCfg.tidb.table | string | レガシーの転送先テーブル。 |
| content.accessCfg.tidb.role | string | レガシーのロール識別子。 |
| content.oldAccessCfg | object または null | s3/oss などでのみ、前回のロール認可の externalId 概要が返される場合があります。キャッシュがない場合は null です。 |
| content.oldAccessCfg.externalId | string | レガシー認可の外部 ID。空の場合があります。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": 100,
"uuid": "lgbp_example",
"workspaceUUID": "wksp_example",
"name": "production_archive",
"conditions": "",
"extend": {
"filters": [],
"regularLogIndexNames": [
"default"
]
},
"syncExtensionField": false,
"externalResourceAccessCfgUUID": "erac_example",
"storeType": "s3",
"storageFormat": "json",
"storageClass": "STANDARD",
"dataType": "logging",
"taskStatusCode": -1,
"taskErrorCode": "",
"openPermissionSet": false,
"readPermissionSet": [],
"deleteStatus": "",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"accessCfg": {
"provider": "aws",
"grantType": "ram",
"region": "us-east-1",
"bucket": "customer-archive-example",
"ak": "<EXTERNAL-AK>",
"dataWaitSeconds": 3600,
"storeType": "s3",
"dataType": "logging",
"storageFormat": "json",
"storageClass": "STANDARD"
},
"oldAccessCfg": null,
"creatorInfo": {},
"updatorInfo": {},
"allow_operation": null,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している場合 | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 404 | ft.LogBackupCfgNoExists | ルールが存在しない/別ワークスペース/削除済み/削除中、または除外された Iceberg である場合 | 指定されたデータ転送設定は存在しません | 現在の公開一覧から有効な UUID を再選択してください。 |
| 404 | ft.ObjectNotExists | ルールに関連する接続設定が存在しない場合 | 指定されたオブジェクトは存在しません | 管理者がリソースのライフサイクルを確認してください。 |
| 500 | ft.InternalServerError | 設定、アイデンティティ情報、キャッシュ、またはレスポンスフォーマットの読み取りに失敗した場合 | 内部エラー | クエリパラメータを確認し、失敗が続く場合は traceId を提供してください。 |