公開
マニュアル一覧へ

ご契約者向け
マニュアル一覧へ

IIJ IoTサービス オンラインマニュアル

GET Service traffic

この操作により転送量を取得することが出来ます。
転送量とは、本サービスから取り出した情報のbyte数を指します。
オブジェクトのダウンロード、レスポンスの受信に伴い増加します。
ACL、Policyなどの設定確認やエラーメッセージの受信によっても増加します。
取得範囲は、2種類の方式で指定可能です。
  • 指定した日の1日分の転送量を返す
  • 指定した月の1日から、本APIの実行当日までの転送量を返す
転送量は、上記いずれの指定の場合でも日単位で集計されて返却されます。
転送量は2ヶ月前の1日から遡って取得することが可能です。
例えば、実行日が11月30日の場合であれば、取得可能な最も古い転送量情報は同年の9月1日の情報です。
レスポンスの形式はXMLです。
なお、認証時のシグネチャにはサブリソースとしてtrafficを計算に含めて下さい。
chargeDate、backwardToはシグネチャに含める必要は有りません。

 

リクエスト情報

シンタックス
GET /?traffic&chargeDate=20141010 HTTP/1.1
Host: s3api.iot.iij.jp
Date: {date}
Authorization: {authorization string}

 

リクエストパラメータ
以下のHTTPリクエストパラメータが指定可能です。
両パラメータともに指定が無い場合は、実行当月の1日から当日までの転送量を返却します。


表. Get Traffic Charge リクエストパラメータ一覧

パラメータ名説明必須
chargeDate

集計対象の日付

1日分の集計結果を取得する際に指定します。
指定された日付の1日分の転送量を集計して返却します。
日付の指定はYYYYMMDD形式で行います。有効な日付でない場合はエラーが返却されます。
backwordToを指定する場合に、本項目を指定するとエラーが返却されます。
backwordToが指定されていない場合は、本項目は必須です。

  • 型:String
  • デフォルト値:なし
×
backwardTo

転送量の取得対象となる月が、当月から何ヵ月前にあたるか

本パラメータは、何か月前のデータから集計するかを示しています。0は当月を示します。
例えば、実行時点が2014年の11月10日の場合に、0を指定すれば2014年11月の転送量を返します。
つまり結果には、2014年11月1日から同年11月10日の実行時点までの通信量が日単位で集計され、返却されます。
1を指定すれば2014年10月1日から本API実行当日までの転送量を取得することが出来ます。
この場合、2014年10月1日から同年11月10日の実行時点までの通信量が返却されます。
前月の当日(2014年10月10日)を検索範囲の始まりとするわけではありません。
chargeDateを指定する場合に、本項目を指定するとエラーが返却されます。
chargeDateが指定されていない場合は、本項目は必須です。
なお、負数を本パラメータに指定した場合はエラーが返却されます。

  • 型:String
  • デフォルト値:なし
×

 

リクエストヘッダー

この操作では基本リクエストヘッダーのみ使用します。

リクエストエレメント

この操作ではリクエストエレメントは使用しません。
Authorizationヘッダーは必須です。

 

レスポンス情報

レスポンスヘッダー

この操作では基本レスポンスヘッダーのみ返します。

レスポンスエレメント

この操作では以下のレスポンスエレメントを返します。

 

表. Get Traffic Charge レスポンスレメント一覧

名前説明
ListTrafficResult

転送量情報(DownTraffics)を含むコンテナ型:Container

DownTraffics

転送量の日毎の情報を含むコンテナ型:Container親:ListTrafficResult

ChargeDate

日付型:String親:DownTraffics

Amount

転送量(Bytes)型:String親:DownTraffics

エラー情報

この操作では以下のエラーを返します。

 

表. GET Service エラーコード一覧
コードステータス内容
InvalidBackwardMonth400 Bad RequestbackwardToの指定値が正の整数、もしくは0ではありません。
InvalidChargeDate400 Bad RequestchargeDateの指定値が、日付として無効です。

 

サンプル

2014年11月10日の転送量情報を取得する

リクエスト
GET /?traffic&chargeDate=20141110 HTTP/1.1
Host: s3api.iot.iij.jp
Date: Wed, 12 Oct 2009 17:50:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
<ListTrafficResult>
  <DownTraffics>
    <ChargeDate>20141125</ChargeDate>
    <Amount>20707</Amount>
  </DownTraffics>
</ListTrafficResult>

 

2014年10月1日から実行当日(サンプルは2014年11月10日を当日とする)までの転送量情報を取得する。

リクエスト
GET /?traffic&backwardTo=1 HTTP/1.1
Host: s3api.iot.iij.jp
Date: Wed, 12 Oct 2009 17:50:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
<ListTrafficResult>
  <DownTraffics>
    <ChargeDate>20141101</ChargeDate>
    <Amount>20707</Amount>
  </DownTraffics>
  <DownTraffics>
    <ChargeDate>20141102</ChargeDate>
    <Amount>107</Amount>
  </DownTraffics>
  <DownTraffics>
    <ChargeDate>20141103</ChargeDate>
    <Amount>11900</Amount>
  </DownTraffics>
  <DownTraffics>
    <ChargeDate>20141104</ChargeDate>
    <Amount>0</Amount>
  </DownTraffics>
  ～～～～～(略)～～～～～
  <DownTraffics>
    <ChargeDate>20141110</ChargeDate>
   <Amount>10</Amount>
  </DownTraffics>
</ListTrafficResult>