一覧¶
GET /api/v1/log_backup_cfg/list
概要¶
データ転送ルールを一覧表示します。
Query リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| search | string | 一般検索フィールド 例: xxxxx_text 空を許可: False 空文字列を許可: True |
|
| storeType | commaArray | ストレージタイプ 空を許可: False $commaArrayIn: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris'] |
|
| dataType | commaArray | データタイプ 空を許可: False $commaArrayIn: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am'] |
|
| storageFormat | commaArray | ストレージフォーマット 空を許可: False $commaArrayIn: ['json', 'parquet'] |
|
| storageClass | commaArray | アーカイブタイプ 空を許可: False 空文字列を許可: True |
|
| pageIndex | integer | ページ番号 空を許可: False 例: 1 $minValue: 1 |
|
| pageSize | integer | 1ページあたりの返却件数 空を許可: False 例: 10 $minValue: 1 $maxValue: 100 |
パラメータ補足説明¶
データの説明.*
- リクエストパラメータの説明
| パラメータ名 | type | 説明 |
|---|---|---|
| search | string | ルール名を検索します |
| storeType | commaArray | ルールのストレージタイプでフィルタリングします。複数の値はカンマ区切りで指定します |
| dataType | commaArray | データタイプでフィルタリングします。複数の値はカンマ区切りで指定します |
| storageFormat | commaArray | ストレージフォーマットでフィルタリングします。複数の値はカンマ区切りで指定します |
| storageClass | commaArray | アーカイブタイプでフィルタリングします。複数の値はカンマ区切りで指定します |
| pageIndex | string | ページ番号 |
| pageSize | string | 1ページあたりの返却件数 |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/log_backup_cfg/list?pageIndex=1&pageSize=3&storeType=s3,oss&dataType=logging,tracing&storageFormat=json,parquet&storageClass=STANDARD,IA' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
レスポンス¶
{
"code": 200,
"content": [
{
"conditions": "",
"createAt": 1697543205,
"creator": "xx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"dataType": "logging",
"deleteAt": -1,
"duration": "180d",
"extend": {
"filterLogic": "and",
"filters": []
},
"externalResourceAccessCfgUUID": "erac_xxx212",
"id": 684,
"name": "ssfda***",
"status": 0,
"storeType": "obs",
"syncExtensionField": false,
"taskErrorCode": "NoSuchBucket",
"taskStatusCode": 404,
"updateAt": 1697610912,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgbp_xxx275",
"workspaceUUID": "wksp_xxx115"
},
{
"conditions": "",
"createAt": 1694588429,
"creator": "xx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"dataType": "logging",
"deleteAt": -1,
"duration": "180d",
"extend": {
"filterLogic": "and",
"filters": []
},
"externalResourceAccessCfgUUID": "erac_xxxfca",
"id": 669,
"name": "test-21-02",
"status": 0,
"storeType": "obs",
"syncExtensionField": false,
"taskErrorCode": "AccessDenied",
"taskStatusCode": 403,
"updateAt": 1695290409,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgbp_xxxf0a",
"workspaceUUID": "wksp_xxx115"
},
{
"conditions": "{ `source` in [ 'mysql' ] }",
"createAt": 1692686192,
"creator": "xx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"dataType": "logging",
"deleteAt": -1,
"duration": "180d",
"extend": {
"filterLogic": "and",
"filters": [
{
"condition": "and",
"name": "source",
"operation": "in",
"value": [
"mysql"
]
}
]
},
"externalResourceAccessCfgUUID": "erac_xxx6d1",
"id": 518,
"name": "osstest-xjp",
"status": 0,
"storeType": "oss",
"syncExtensionField": true,
"taskErrorCode": "",
"taskStatusCode": -1,
"updateAt": 1695286731,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgbp_xxx5ae",
"workspaceUUID": "wksp_xxx115"
}
],
"errorCode": "",
"message": "",
"pageInfo": {
"count": 3,
"pageIndex": 1,
"pageSize": 3,
"totalCount": 66
},
"success": true,
"traceId": "TRACE-ADC98BC2-1772-4E2E-9737-F80D3CC5453F"
}