POST log_download
API情報
| HTTPメソッド | API名 | パス | 目的 |
|---|---|---|---|
| POST | log_download_url | /r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/log_download_url.json |
ログダウンロード用URLの発行 |
APIバージョン:20190625
個別パラメータ
URL
| パラメータ | 必須 | タイプ | 説明 | 例 |
|---|---|---|---|---|
| APIVersion | 〇 | String | APIバージョン | 20190625 |
| ServiceCode | 〇 | String | ログダウンロード用URLを発行する対象契約の親サービスコード | yemXXXXXXXX |
| ChildServiceCode | 〇 | String | ログダウンロード用URLを発行する対象契約の子サービスコード |
|
HTTPリクエストボディ
| パラメータ | 必須 | タイプ | 説明 | 例 |
|---|---|---|---|---|
| LogDate | 〇 | String | ダウンロード対象とするログの日付(YYYYMMDD) |
20190624 |
| Acl | String | ダウンロードを許可するIPアドレス (IPアドレス, IPアドレス/ネットマスク) |
|
レスポンス
| パラメータ | タイプ | 説明 | 例 |
|---|---|---|---|
| APIResult.EncryptKey | String | ログダウンロード用URLにアクセスする際に利用する暗号化用のキー | 英数字及び以下の記号の12桁
|
| APIResult.LogDownloadURL | String | ログダウンロード用URL |
https://api.secureep.jp/public_api/v1/log-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
エラーコード
- 共通エラーコードはエラーレスポンスを参照してください。
| エラー | HTTP Status Code | ErrorType | ErrorMessage | ErrorDetail.Reason | 意味 | 備考 |
|---|---|---|---|---|---|---|
| パラメータエラー | 200 | BadRequest | Specified parameter has some errors. | Required parameter 'LogDate' not found. | リクエストパラメータにLogDateが存在しない | |
| Parameter 'LogDate' must be of yyyymmdd format. | リクエストパラメータのLogDateのフォーマットエラー | |||||
| Parameter 'LogDate' must be in the past 35 days. | リクエストパラメータのLogDateが過去35日以内の日付ではない | |||||
| Parameter 'Acl' must be IPv4 ipaddress or network address. | リクエストパラメータのAclのフォーマットエラー | |||||
| Log download is not provided for [ChildServiceCode]. | 指定された子サービスコードがログダウンロードに対応していない | 以下の子サービスはログダウンロードに対応していません
|
||||
| 存在しない | 200 | NotFound | Specified child service code is not contracted. | [ServiceCode] is not found under [ChildServiceCode]. | 指定された子サービスコードが親サービスコードの配下に存在しない |
|
| システム障害 | 200 | SystemError | System error occurred. | API設備のシステム障害 | サポートセンターへお問い合わせください |
制限
- なし
サンプル
リクエスト
POST /r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/log_download_url.json HTTP/1.1
Host: ep.api.iij.jp
x-iijapi-Expire: 2019-06-06T09:52:01Z
x-iijapi-SignatureMethod: [SignatureMethod]
x-iijapi-SignatureVersion: [SignatureVersion]
Authorization:IIJAPI [AccessKeyId]:[Signature]
Content-Type: application/json
{"LogDate":"xxxxxxxx","Acl":"xxx.xxx.xxx.xxx"}
レスポンス
{ |
"APIResult": { |
"EncryptKey": "xxxxxxxxxxxx", |
"LogDownloadURL": "https://api.secureep.jp/public_api/v1/log-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", |
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx" |
} |
} |
ログダウンロード
ログのダウンロードを行うには本ページのlog_download_urlを利用し、ログをダウンロードするためのURLを取得して以下の形式でAPIにアクセスしてください。
API情報
| HTTPメソッド | アクセス先 |
|---|---|
| GET | [取得したログダウンロードURL]?MasterID=XXXXXXXXXXXXXXXXXXXXXXXX |
リクエストパラメータ
| パラメータ | 必須 | 説明 | 例 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 取得したログダウンロードURL | 〇 | log_download_url で取得したLogDownloadURLの値 | https://api.secureep.jp/public_api/v1/log-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | ||||||||||
| MasterID | 〇 | マスターIDをAES-128-CBCで暗号化した結果をbase64でエンコードした値
|
生成例
|
レスポンス
- 指定した日付のログをzip形式でダウンロードできます
エラーコード
| エラー | HTTP Status Code | ErrorType | ErrorMessage | ErrorDetail.Reason | 意味 | 備考 |
|---|---|---|---|---|---|---|
| クエリパラメータ不正 | 400 | BadRequest | There are invalid parameters. |
以下のいずれかの場合
|
||
| 認証エラー | 403 | PermissionDenied | Access denied to specified log. | 以下のいずれかの場合
|
||
| パラメータエラー | 404 | NotFound | Log download request not found. | ログダウンロード用IDが正しくない |
||
| URL不正 | URL is not valid. | 以下のいずれかの場合
|
||||
| システム障害 | 500 | SystemError | System error occurred. | API設備のシステム障害 |
IIJサポートセンターへお問い合わせください |