エクスポート履歴の照会

Prev Next

Classic/VPC環境で利用できます。

Cloud Log Analyticsサービスで照会したログを Object Storageにエクスポートした履歴を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/{regionCode}-v1/export/history

リクエストヘッダ

Cloud Log Analytics APIで共通して使用されるヘッダの詳細は、Cloud Log Analyticsのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Required リージョンコード
  • kr | sgn | jpn | uswn | den
    • kr: 韓国リージョン
    • sgn: シンガポールリージョン
    • jpn: 日本リージョン
    • uswn: 米国西部リージョン
    • den: ドイツリージョン

リクエストクエリパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pageNo Integer Optional ページ番号
  • 1~100 (デフォルト: 1)
pageSize Integer Optional ページごとの項目数
  • 20~100 (デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/export/history' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
-date '{
  "bucketname": "asdcx"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスステータスコード
message String - レスポンスステータスメッセージ
result Object - レスポンス結果
result.pageSize Integer - ページごとの項目数
result.currentPage Integer - 現在のページ番号
result.totalPage Integer - 総ページ番号
result.totalCount Integer - 総項目数
result.isPaged Boolean - 追加ページは存在するかどうか
  • true | false
    • true: 存在する
    • false: 存在しない
result.exporthistoryInfo Array - エクスポート履歴

exporthistoryInfo

exporthistoryInfoの説明は次の通りです。

フィールド タイプ 必須の有無 説明
start_ymdt Integer - エクスポート日時
export_types String - エクスポートタイプ
regionNo Integer - リージョン番号
bucketname String - Object Storageのバケット名
folderName String - フォルダ名
log_types String - エクスポートログタイプ
status String - エクスポート進捗状況
progress String - エクスポート進捗率(%)
description String - Object Storageのバケット名

レスポンスステータスコード

Cloud Log Analytics APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Log Analyticsのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "code": 0,
  "message": "リクエストが正常に処理されました。",
  "result": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 3,
    "totalCount": 29,
    "isPaged": true,
    "exporthistoryInfo": [
      {
        "start_ymdt": "2024-11-19 03:30:30",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "CLA-20241119033030/",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": ""
      },
      {
        "start_ymdt": "2024-11-18 03:10:24",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-17 03:08:57",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-16 02:52:43",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-15 03:34:59",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-14 03:27:51",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-13 03:25:57",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-12 03:33:46",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-11 03:08:42",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-10 03:02:56",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      }
    ]
  }
}