一覧表示¶
GET /api/v1/log_backup_cfg/list
概要¶
現在のワークスペースのデータ転送ルールおよびタスクステータスをページングして一覧表示します。
呼び出し前と使用手順¶
削除されていないすべてのルール(無効化済みおよび deleting 中のレコードを含む)を返し、最終更新日時/作成日時の降順、次に id の降順で並べます。ターゲット、タイプ、フォーマット、ストレージクラス、ルール名でフィルタリングできます。OpenAPI の一覧には Front 専用の accessCfg サマリーは含まれません。接続情報は詳細インターフェースを使用してください。Iceberg 形式は除外されます。
一覧は readPermissionSet でルール設定をフィルタリングしません。この権限は主にデータクエリタスク時に検証されます。duration はワークスペースの backup_log 保持期間を表示し、外部バケットのライフサイクルや各ルール固有の期限ではありません。taskStatusCode/taskErrorCode はバックエンドの転送タスクに由来し、保存成功はタスクが正常に実行されたことを示しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dataType | commaArray | 省略可能な完全一致タイプフィルターです。履歴上の空の dataType を自動的に logging としてフィルタリング対象に含めることはありません。 null を許可: False $commaArrayIn: ['lineage', 'metric', 'llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am'] 例: logging取得または入力方法: 実際のルールのデータカテゴリでフィルタリングし、複数指定する場合はカンマで区切ります。 |
|
| pageIndex | integer | 省略可能で、デフォルトは 1、最小値は 1 です。 null を許可: False $minValue: 1 例: 1取得または入力方法: 1 から開始し、トップレベルの pageInfo に従って続行します。 |
|
| pageSize | integer | 省略可能で、デフォルトは 10、最大値は 100 です。 null を許可: False $maxValue: 100 $minValue: 1 例: 10取得または入力方法: 1 ページあたり 1~100 の範囲で選択します。 |
|
| search | string | 省略可能で、name の部分一致で検索します。ターゲットバケットや UUID では検索しません。前後の空白は必ずしも除去されません。 空文字列を許可: True null を許可: False 例: production取得または入力方法: ルール名のキーワード。 |
|
| storageClass | commaArray | 省略可能で、複数指定する場合はカンマで区切ります。統一された固定列挙ではありません。 空文字列を許可: True null を許可: False 例: STANDARD取得または入力方法: 実際のルールまたはターゲットベンダーのストレージクラスコードから値を取得します。 |
|
| storageFormat | commaArray | 省略可能です。Iceberg は公開一覧に含まれません。Kafka/LogBamboo は空のフォーマットになる場合があり、未指定でも表示できます。 null を許可: False $commaArrayIn: ['json', 'parquet'] 例: json,parquet取得または入力方法: 公開ファイルフォーマットを指定し、複数指定する場合はカンマで区切ります。 |
|
| storeType | commaArray | 省略可能で、省略した場合は削除されていないすべてのルールを検索します。Iceberg は常に除外され、履歴上の TiDB はターゲットでフィルタリングしていない場合に表示されることがあります。 null を許可: False $commaArrayIn: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris', 'logbamboo'] 例: s3,kafka取得または入力方法: このページで公開されているターゲットタイプから選択し、複数指定する場合は半角カンマで区切ります。 |
パラメータ補足説明¶
データ説明.*
- リクエストパラメータ説明
| パラメータ名 | type | 説明 |
|---|---|---|
| search | string | ルール名を検索 |
| storeType | commaArray | ルールのストレージタイプをフィルタリングします。複数の値は半角カンマで区切ります |
| dataType | commaArray | データタイプ。複数の値は半角カンマで区切ります |
| storageFormat | commaArray | ストレージフォーマット。複数の値は半角カンマで区切ります |
| storageClass | commaArray | ストレージクラス。複数の値は半角カンマで区切ります |
| pageIndex | string | ページ番号 |
| pageSize | string | 1 ページあたりの返却件数 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/log_backup_cfg/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode dataType=logging \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
このページのルール配列。結果が空の場合は []。 |
| content.data[].id | integer または null | レコード番号。作成スナップショットはコミット前に生成されるため、null になる場合があります。呼び出しには uuid を使用します。 |
| content.data[].uuid | string | lgbp_ルールUUID。 |
| content.data[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].name | string | ルール名。作成後、この公開更新インターフェースでは名前を変更できません。 |
| content.data[].conditions | string | extend.filters から生成される条件。追加フィルターがない場合は空文字列または {} です。 |
| content.data[].syncExtensionField | boolean | 拡張フィールドを同期するかどうか。 |
| content.data[].externalResourceAccessCfgUUID | string | アクセス設定識別子。資格情報ではありません。 |
| content.data[].storeType | string | 保存先のターゲットタイプ。履歴上の TiDB は読み取り可能な場合がありますが、現在の OpenAPI では作成できません。 |
| content.data[].storageClass | string | ターゲットのストレージクラス。 |
| content.data[].storageFormat | string | json/parquet。Kafka または LogBamboo では空になる場合があります。Iceberg はこの公開一覧/詳細では除外されます。 |
| content.data[].dataType | string | ルールに固定されたデータカテゴリ。履歴上の空値は logging として扱われます。 |
| content.data[].taskStatusCode | integer | バックエンドの転送タスクが報告するステータス。作成時は通常 -1 で、現在の HTTP ステータスではありません。 |
| content.data[].taskErrorCode | string | バックエンドの転送エラーコード。空文字列の場合は現在のエラー記録がありません。保存成功はタスクの成功を保証しません。 |
| content.data[].openPermissionSet | boolean | データ読み取りのカスタム権限スイッチ。 |
| content.data[].readPermissionSet | array<string> |
保存された読み取りプリンシパル。 |
| content.data[].readPermissionSet[] | string | 単一のロール/メンバー/チーム識別子。 |
| content.data[].deleteStatus | string | 削除処理ステータス。deleting は組み込みストレージルールが非同期削除中であることを示し、履歴上は空または completed の場合があります。 |
| content.data[].status | integer | 0 は有効、2 は無効、3 は削除。 |
| content.data[].creator | string | 作成者のアイデンティティ。 |
| content.data[].updator | string | 更新者のアイデンティティ。初期値は null の場合があります。 |
| content.data[].createAt | integer | 作成日時の Unix 秒。 |
| content.data[].updateAt | integer | 更新日時の Unix 秒。未更新の場合は -1。 |
| content.data[].deleteAt | integer | 削除日時の Unix 秒。未削除の場合は -1。 |
| content.data[].extend | object | 保存された範囲/条件設定:省略可能で、作成時は通常 {} です。更新時は全体を置き換える形で渡し、旧インデックス選択には専用の継承ルールがあります(使用説明を参照)。省略した場合は保持されます。作成時に null を渡すと、後続の extend.get で 500 が発生する可能性があります。更新時に明示的に null を渡すと {} として全体を置き換えますが、新しいバージョンのインデックス選択に対する専用の継承ルールは引き続き保持されます。 |
| content.data[].extend.filters | array | 保存された範囲/条件設定:実際のフィルター条件配列。[] は追加のフィールド条件がないことを示し、カテゴリ全体を転送する可能性があります。match/not match およびその正規化エイリアスは拒否され、ログインデックスの advancedFilter 構造をここに混在させることはありません。 |
| content.data[].extend.filters[] | json | 保存された範囲/条件設定:完全な name/condition/operation/value を推奨します。query_task.search 構造ではありません。 |
| content.data[].extend.filters[].name | string | 保存された範囲/条件設定:実際のフィールドキー。 |
| content.data[].extend.filters[].condition | string | 保存された範囲/条件設定:and/or と前の条件との関係。先頭項目では無視されます。 |
| content.data[].extend.filters[].operation | string | 保存された範囲/条件設定:よく使用される =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist。match/contain 系はサポートされません。 |
| content.data[].extend.filters[].value | array | 保存された範囲/条件設定:一致値。等値/比較では先頭項目を使用し、集合演算では複数項目を使用します。 |
| content.data[].extend.filters[].value[] | JSON | 保存された範囲/条件設定:単一の文字列/数値。実際の型を保持します。 |
| content.data[].extend.indexs | array | 保存された範囲/条件設定:ログのネイティブ直接書き込みインデックス名の配列。新しいバージョンでは [] はそのカテゴリ全体を示し、非空は指定を示します。旧プロトコルで regularLogIndexNames が欠落している場合は動作が異なります(使用方法を参照)。UUID 配列ではありません。 |
| content.data[].extend.indexs[] | string | 保存された範囲/条件設定:実際の名前。trim して重複を除去します。新しいバージョンで追加選択する場合は、現在利用可能な一覧内である必要があります。 |
| content.data[].extend.regularLogIndexNames | array または null | 保存された範囲/条件設定:ログのみを対象とする新しいバージョンの通常インデックス選択。[] は通常カテゴリ全体、非空は指定を示します。indexs 配列と同時に null を渡すと直接書き込みのみを表します。更新時にこのキーのみ null を渡すとインデックス制限を解除します。このキーが欠落している場合は旧プロトコルまたは更新時の保持を示します(詳細は使用説明を参照)。 |
| content.data[].extend.regularLogIndexNames[] | string | 保存された範囲/条件設定:現在選択可能な単一の通常インデックス名。クローンを含む場合は、ソース A が有効である必要があります。UUID ではありません。 |
| content.data[].creatorInfo | object | 関連付けられたアイデンティティの概要。一致しない場合は {}。 |
| content.data[].creatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.data[].creatorInfo.status | integer | アカウントステータス。省略可能。 |
| content.data[].creatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.username | string | ログイン名。 |
| content.data[].creatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。null の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].creatorInfo.iconUrl | string | アバター URL。省略可能。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.data[].updatorInfo | object | 関連付けられたアイデンティティの概要。一致しない場合は {}。 |
| content.data[].updatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.data[].updatorInfo.status | integer | アカウントステータス。省略可能。 |
| content.data[].updatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.username | string | ログイン名。 |
| content.data[].updatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。null の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].updatorInfo.iconUrl | string | アバター URL。省略可能。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.data[].readPermissionSetInfo | object | 読み取りプリンシパルが空でない場合に識別子→概要のマッピングを返します。解析可能な識別子がない場合は {} に対応し、空配列の場合は省略できます。 |
| content.data[].readPermissionSetInfo.主体 | object | メンバー概要、またはロール/チームの name/status 概要。このプリンシパルが現在も有効であることを証明するものではありません。 |
| content.data[].readPermissionSetInfo.主体.name | string | ロール/チーム/メンバーの表示名。 |
| content.data[].readPermissionSetInfo.主体.status | integer | アイデンティティステータス。省略可能。 |
| content.data[].allow_operation | boolean または null | 共有権限エンジンによる操作表示。操作プリンシパルが未設定の場合は null になることがあり、インターフェースの権限検証を代替するものではありません。 |
| content.data[].readPermissionSetInfo.主体.uuid | string | アイデンティティ UUID。省略可能。 |
| content.data[].readPermissionSetInfo.主体.wsAccountStatus | integer | ワークスペースメンバーステータス。省略可能。 |
| content.data[].readPermissionSetInfo.主体.username | string | ログイン名。 |
| content.data[].readPermissionSetInfo.主体.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.data[].readPermissionSetInfo.主体.mobile | string | 携帯電話番号。null の場合があります。 |
| content.data[].readPermissionSetInfo.主体.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].readPermissionSetInfo.主体.iconUrl | string | アバター URL。省略可能。 |
| content.data[].readPermissionSetInfo.主体.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.data[].duration | string または null | ワークスペースの backup_log 保持期間。未設定の場合があります。 |
| content.declaration | object | ワークスペースの共通宣言。 |
| pageInfo.pageIndex | integer | 現在のページ。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | このページの件数。 |
| pageInfo.totalCount | integer | フィルターに一致する総数。 |
{
"code": 200,
"content": {
"data": [
{
"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,
"duration": "180d",
"creatorInfo": {},
"updatorInfo": {},
"allow_operation": null
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用したか、パラメータがルールに違反しています | パラメータ解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | 設定、アイデンティティ情報、キャッシュ、またはレスポンスフォーマットの読み取りに失敗しました | 内部エラー | クエリパラメータを確認し、失敗が続く場合は traceId を提供してください。 |