メール配信ログの取得 (POST /)

メール配信ログを取得します。

配信期間と配信結果を指定すると、条件に一致するログだけが抽出されます。

取得するログの件数や混雑状況によって、応答に時間がかかることがあります。

Request Headers

「API共通リクエストヘッダー」を参照。

Request Parameter

Action

実行するAPI名。

"GetDeliveryLog"

Data Type Cardinality
String 1..1

Version

APIバージョン。

"v1.0"（任意）

Data Type Cardinality
String 0..1

StartDate

ログ取得を開始する日時（UTC）。

”YYYY-MM-DDThh:mm”の形式で指定します。

現在より90日前の0時00分まで指定できます。

例：2020-01-11T00:00

Data Type Cardinality
String 1..1

EndDate

ログ取得を終了する日時（UTC）。

”YYYY-MM-DDThh:mm”の形式で指定します。

StartDateから24時間未満の日時を指定できます。

StartDateよりも前の日時は指定できません。

例：2020-01-11T23:59

Data Type Cardinality
String 1..1

Status

取得したいログのステータス。

省略した場合は、全ステータスのログが取得されます。

以下のどれか1つの数字を指定します。
  • 1：sent
  • 2：retry
  • 3：faild
Data Type Cardinality
Int 0..1

MaxItems

取得ログ最大数。

最大10000件取得できます。

省略した場合は、10000が指定されます。

10000件より少ないログ数を取得したい場合に指定します。

Data Type Cardinality
Int 0..1

NextToken

前回の呼び出し時に取得できなかったログを取得するためのトークン。

レスポンスで返された値をURLエンコードし、指定します。

StartDateおよびEndDateは、前回と同じ日時を指定します。

Data Type Cardinality
String 0..1

Request Elements

なし

HTTPステータス

ステータス

リクエストのステータスを返却します。

以下の値を返却します。
200:
正常終了
400:
リクエストのパラメーターエラー
401:
認証エラー
403:
アクセス拒否
500:
内部エラー
配信ログの続きを取得する際、リクエストパラメーターに指定したStartDate / EndDateと、NextTokenを取得したときに指定したStartDate / EndDateが、一致しない場合を含みます。
Data Type Cardinality
Int 1..1

Response Elements（正常終了時）

GetDeliveryLogResponse

レスポンスのエンベロープ。

Data Type Cardinality Parent Element Child Element(s)
- 1..1 None

GetDeliveryLogResult

ResponseMetadata

GetDeliveryLogResult

結果のエンベロープ。

Data Type Cardinality Parent Element Child Element(s)
- 1..1 GetDeliveryLogResponse

LogCount

Log

NextToken

LogCount

取得したログの件数。

Data Type Cardinality Parent Element Child Element(s)
Int 1..1 GetDeliveryLogResult None

Log

1宛先ごとのログの内容。

以下の情報がスペース区切りで記録されます。
  • 配信日
  • 配信時間
  • 送信結果
  • ステータスコード
  • トランザクションID
  • 送信元メールアドレス
  • 宛先メールアドレス
  • 付加情報

ステータスコードは、以下の3桁の数字です。

ステータスコード 説明
2xx 成功
4xx 一時的なエラー
5xx 恒久的なエラー
6xx 配信サーバー内部で発生したエラー
7xx
8xx

2xxから5xxまでは、SMTPプロトコルの応答コードです。

6xx以降の番号は、独自の応答コードです。

ヒント: ステータスコードの詳細は、「応答コード一覧」を参照してください。

Data Type Cardinality Parent Element Child Element(s)
String 0..10000 GetDeliveryLogResult None

NextToken

取得できなかったログを取得するためのトークン。

条件に一致するログの件数が、MaxItemsを超える場合に出力されます。

ログの続きを取得したい場合、リクエストパラメーターに指定します。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 GetDeliveryLogResult None

ResponseMetadata

メタデータのエンベロープ。

Data Type Cardinality Parent Element Child Element(s)
- 1..1 GetDeliveryLogResponse RequestId

RequestId

リクエストを一意に識別するID。

問題が発生した場合の問い合わせの際にトラブルシューティングを行うために必要です。

UUID形式　例：647cd254-e0d1-44a9-af61-1d6d86ea6b77

Data Type Cardinality Parent Element Child Element(s)
xsd:string 1..1 ResponseMetadata None

Example of Request

NextTokenなしの場合

POST / HTTP/1.1
Date: Tue, 07 Jul 2020 06:23:01 GMT
Content-Length: …
Host: mail.jp-east-1.cloud-f.net
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY…

Action=GetDeliveryLog
&StartDate=2020-07-07T00%3A00
&EndDate=2020-07-07T23%3A59

NextTokenありの場合

POST / HTTP/1.1
Date: Tue, 07 Jul 2020 06:33:01 GMT
Content-Length: …
Host: mail.jp-east-1.cloud-f.net
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY…

Action=GetDeliveryLog
&StartDate=2020-07-07T00%3A00
&EndDate=2020-07-07T23%3A59
&NextToken=rO0ABXNyADljb20ubmlmdHkuY2xvdWQuZXNzLmFwaS5hY3Rpb24ucGFyYW0uRGVsaXZlcnlMb2dOZXh0VG9rZW5y%2B2b9GqGp5wIABUoACWxhc3RDb3VudEwAB2VuZERhdGV0ABJMamF2YS9sYW5nL1N0cmluZztMAAhtYXhJdGVtc3EAfgABTAAJc3RhcnREYXRlcQB%2BAAFMAAZzdGF0dXNxAH4AAXhwAAAAAAAAJxB0ABAyMDIwLTA3LTEwVDAxOjQ5cHQAEDIwMjAtMDctMDlUMDE6NTBw

Example of Response

NextTokenなしの場合

HTTP/1.1 200 OK
Date: Tue, 07 Jul 2020 06:33:05 GMT
Content-Type: application/xml
x-fj-request-id: 647cd254-e0d1-44a9-af61-1d6d86ea6b77
Transfer-Encoding: chunked

<?xml version="1.0" encoding="UTF-8"?>
<GetDeliveryLogResponse>
  <GetDeliveryLogResult>
    <LogCount>1</LogCount>
    <Log>2020-07-10 00:17:13 sent 250 a123.example.jp.1234567890123456 user@example.com allan@example.com 250_ok:__Message_81234567_accepted</Log>
  </GetDeliveryLogResult>
  <ResponseMetadata>
    <RequestId>647cd254-e0d1-44a9-af61-1d6d86ea6b77</RequestId>
  </ResponseMetadata>
</GetDeliveryLogResponse>

NextTokenありの場合

HTTP/1.1 200 OK
Date: Tue, 07 Jul 2020 06:23:05 GMT
Content-Type: application/xml
x-fj-request-id: 547cd254-e0d1-44a9-af61-1d6d86ea6b77
Transfer-Encoding: chunked

<?xml version="1.0" encoding="UTF-8"?>
<GetDeliveryLogResponse>
  <GetDeliveryLogResult>
    <LogCount>10000</LogCount>
    <Log>2020-07-09 01:52:02 sent 250 a123.example.jp.1234567890123456 user1@example.com allan@example.com 250_ok:__Message_12345678_accepted</Log>
    <Log>2020-07-09 01:53:49 sent 250 a123.example.jp.1234567890123456 user2@example.com allan@example.com 250_ok:__Message_23456789_accepted</Log>
　　(省略)
    <Log>2020-07-10 00:17:12 sent 250 a123.example.jp.1234567890123456 user3@example.com allan@example.com 250_ok:__Message_34567891_accepted</Log>
    <NextToken>rO0ABXNyADljb20ubmlmdHkuY2xvdWQuZXNzLmFwaS5hY3Rpb24ucGFyYW0uRGVsaXZlcnlMb2dO
ZXh0VG9rZW5y+2b9GqGp5wIABUoACWxhc3RDb3VudEwAB2VuZERhdGV0ABJMamF2YS9sYW5nL1N0
cmluZztMAAhtYXhJdGVtc3EAfgABTAAJc3RhcnREYXRlcQB+AAFMAAZzdGF0dXNxAH4AAXhwAAAA
AAAAJxB0ABAyMDIwLTA3LTEwVDAxOjQ5cHQAEDIwMjAtMDctMDlUMDE6NTBw</NextToken>
  </GetDeliveryLogResult>
  <ResponseMetadata>
    <RequestId>547cd254-e0d1-44a9-af61-1d6d86ea6b77</RequestId>
  </ResponseMetadata>
</GetDeliveryLogResponse>

NextTokenは改行されていますが、リクエストパラメーターに指定する場合は、改行を削除してください。