概要
NAVERクラウドプラットフォームは、NAVERの最新コンピューティング技術や運用ノウハウが蓄積されたクラウドサービスです。
NAVERクラウドプラットフォームが提供するサービスとソリューションを活用できるようにサポートするアプリケーションインターフェース(API)を、NAVERクラウドプラットフォーム APIといいます。
NAVERクラウドプラットフォーム APIは RESTfulの形式で提供され、HTTP方式の GET/POSTメソッド呼び出しにより実行されます。
共通の設定
API URL
https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/
リクエストヘッダ
ヘッダ名 | 説明 |
---|
x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表したもの API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
x-ncp-apigw-api-key | API Gatewayから発行されたキー |
x-ncp-iam-access-key | NAVERクラウドプラットフォームで発行された APIキーまたは IAMで発行された AccessKey |
x-ncp-apigw-signature-v2 | 上記例のボディを AccessKeyとマッピングする SecretKeyで暗号化した署名 HMAC暗号化アルゴリズムは、HmacSHA256を使用 |
Content-Type | Request body content typeは application/jsonに指定 |
リクエストヘッダ作成の詳細は、NAVERクラウドプラットフォーム APIをご参照ください。
regionCode
ドメイン | リージョン | regionCode |
---|
民間 | KR | kr |
| JPN | jpn |
| SGN | sgn |
- Cloud Log Analyticsの apiは、リージョン別 endpointが分離されています。
- 他リージョンの apiを呼び出す場合、そのリージョンの endpointを呼び出す必要があります。
- リージョン別 endpointと regionCodeが一致しない場合、処理されません。
オペレーション
サーバリストの照会
API名 | 説明 |
---|
getClassicServers | Classicサーバリストを照会 |
getClassicServersMysql | Classic CDB-MySQLサーバリストを照会 |
getClassicServersMssql | Classic CDB-MSSQLサーバリストを照会 |
getClassicServersBaremetal | Classic Baremetalサーバリストを照会 |
getVPCServers | VPCサーバリストを照会 |
getVPCServersMysql | VPC CDB-MySQLサーバリストを照会 |
getVPCServersMssql | VPC CDB-MSSQLサーバリストを照会 |
getVPCServersMongoDB | VPC CDB-MongoDBサーバリストを照会 |
getVPCServersPostgresql | VPC CDB-PostgreSQLサーバリストを照会 |
getVPCServersBaremetal | VPC Baremetalサーバリストを照会 |
getVPCServersSES | VPC Search Engine Serviceサーバリストを照会 |
getVPCServersCDSS | VPC Cloud Data Streaming Serviceサーバリストを照会 |
getVPCServersKubernetes | VPC Ncloud Kubernetes Serviceサーバリストを照会 |
サーバログ収集の設定
API名 | 説明 |
---|
postClassicServersCollectingInfos | Classicサーバログ収集情報を設定 |
postVPCServersCollectingInfos | VPCサーバログ収集情報を設定 |
setUpClassicCla | Classic Linuxサーバ agentをインストール |
setUpClaVPC | VPC Linuxサーバ agentをインストール |
setUpwinCla | Classic Windowsサーバ agentをインストール |
setUpwinClaVPC | VPC Windowsサーバ agentをインストール |
サーバログ収集の解除
API名 | 説明 |
---|
deleteClassicServerColleectingInfos | Classicサーバログ収集情報を解除 |
deleteVPCServerCollectingInfos | VPCサーバログ収集情報を解除 |
removeCla | Classic Linux agentを削除 |
removewinCla | VPC Linux agentを削除 |
removewinCla | Classic Windows agentを削除 |
ログ数の照会
API名 | 説明 |
---|
getLogsCountTotal | 発生ログ量の合計を照会 |
getLogsCountRecent | 最近のログ量を照会 |
getLogsCountInterval | 期間別のログ量を照会 |
getLogsCountAggregation | タイプ別ログ量を照会 |
ログの検索
バケットリストの照会
API名 | 説明 |
---|
getExportBuckets | バケットリストの照会 |
使用量の照会
ログのエクスポート
API名 | 説明 |
---|
postLogsSearchExport | ログの検索結果をエクスポート |
エクスポート履歴の照会
API名 | 説明 |
---|
getExportHistory | エクスポート履歴の照会 |
自動エクスポート設定の照会
API名 | 説明 |
---|
getExportConfig | 自動エクスポート設定の照会 |
自動エクスポート設定
API名 | 説明 |
---|
postExportConfig | 自動エクスポート設定 |
自動エクスポートの解除
API名 | 説明 |
---|
deleteExportConfig | 自動エクスポートの解除 |
エラーレスポンスの形式
APIリクエストに誤りがあるか、処理中にエラーが発生した場合、HTTPステータスコードで成功/失敗を、JSON形式で詳細メッセージを返します。
レスポンス例
{
"error": {
"errorCode": "integer",
"message": "string"
}
}
あなたのフィードバックをありがとう!私たちのチームはあなたに戻って取得します