自動エクスポート設定の照会

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

Cloud Log Analyticsサービスで照会したログの自動エクスポート設定を照会します。

リクエスト

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

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

リクエストヘッダ

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/config' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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.exportConfigInfo`	Array	-	自動エクスポート設定履歴

`exportConfigInfo`

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

フィールド	タイプ	必須の有無	説明
`startymdt`	Integer	-	自動エクスポート設定日時
`exportStatus`	String	Required	自動エクスポートの設定状態
`regionNo`	Integer	-	リージョン番号
`exportBucket`	String	-	Object Storageのバケット名
`logTypes`	String	-	自動エクスポートログタイプ
`obsPathType`	String	-	自動エクスポートの保存パス

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

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

レスポンス例

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

{
  "code": 0,
  "message": "リクエストが正常に処理されました。",
  "result": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 1,
    "totalCount": 1,
    "isPaged": true,
    "exportConfigInfo": [
      {
        "configKey": "5338e2fabd0a4070af67013e61adccbf",
        "start_ymdt": "2025-01-06 16:25:44",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "catalog-cdbmy",
        "folderName": null,
        "log_types": "Application,SYSLOG",
        "obsPathType": 3
      }
    ]
  }
}