データストレージ API 概要
本サービスが提供するAPIはREST（Representational State Transfer）をサポートしており、全てのAPIはXML形式のレスポンスボディを返します。
Gateway API経由でデータストレージに蓄積されたデータに対し、本ページで説明するREST APIでアクセスすることができます。
基本リクエストヘッダー
本サービスのREST APIに対するリクエストには以下のヘッダーを含めなければなりません。
なお、以下の表で必須項目はリクエスト側での設定が必須かどうかを指しており、○は必須、×は必須ではない、△は条件により必須を意味します。
またデフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しない事を意味し、null値や空文字列がデフォルト値であるという意味ではありません。
表. 基本リクエストヘッダー一覧
| HTTPヘッダー | 説明 | 必須 |
|---|---|---|
| Authorization | リクエスト認証に用いる文字列
|
○ |
| Content-Length | RFC 2616に準拠したヘッダー部を除いたメッセージ長
|
△ |
| Content-Type | リソースのコンテントタイプ
|
× |
| Date | リクエスト側で生成した現在日時
|
○ |
| Host | 対象となるリソースのホスト ホスト名は「ds.iot.iij.jp」となります。
|
△ |
基本レスポンスヘッダー
本サービスのREST APIのレスポンスは、必ず以下のヘッダーを含みます。
なお、デフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しないことを意味し、null値や空文字列がデフォルト値であるという意味ではありません。
表. 基本レスポンスヘッダー一覧
| HTTPヘッダー | 説明 |
|---|---|
| Content-Length | レスポンスのボディの長さ（サイズ）
|
| Connection | サーバとの接続コネクションが開いているかどうか
|
| Date | サーバがレスポンスを返した日時 (サーバ側で生成されます。)
|
| ETag | オブジェクトから生成されたMD5ハッシュ値（ETag: Entity Tag）
|
| Server | このレスポンスを生成したサーバ名
|
| x-iijgio-id-2 | サーバ側でのトラブルシュートの為の特別な値
|
| x-iijgio-request-id | サーバ側が一意に生成する識別子問題が発生した場合に利用する為の値です。
|
エラーレスポンス
Content-Typeヘッダーは”application/xml”として返されます。
また、ステータスコードは300, 400, 500番台が返されます。
サンプル
<?xml version="1.0" encoding="UTF-8"?> |
<Error> |
<Code>NoSuchKey</Code> |
<Message>The resource you requested does not exist</Message> |
<Resource>/mybucket/myfoto.jpg</Resource> |
<RequestId>4442587FB7D0A2F9</RequestId> |
</Error> |
レスポンスエレメント
表. エラーレスポンスエレメント一覧
| 名前 | 説明 |
|---|---|
| Code | エラー状態をユニークに表す文字列これはプログラムによって解釈できるようにするためのものです。
|
| Error | すべてのエラー要素を持つコンテナ
|
| Message | エラーの状態の一般的な説明
|
| RequestId | エラーに関連するリクエストの識別子
|
| Resource | エラーに関連するリソース（バケットまたはオブジェクト）リクエストURLで指定されたリソースを表示します。
|
エラーコード
エラーレスポンスにはエラーの内容を示すエラーコードが含まれています。エラーコードについては以下をご覧ください。
認証
本サービスが提供するAPIは以下の認証をサポートしています。
以下は現行のマニュアルです。データストレージ新環境移行後はご利用いただけません。
本サービスが提供するAPIはREST（Representational State Transfer）をサポートしており、全てのAPIはXML形式のレスポンスボディを返します。
Gateway API経由でデータストレージに蓄積されたデータに対し、本ページで説明するREST APIでアクセスすることができます。
基本リクエストヘッダー
本サービスのREST APIに対するリクエストには以下のヘッダーを含めなければなりません。
なお、以下の表で必須項目はリクエスト側での設定が必須かどうかを指しており、○は必須、×は必須ではない、△は条件により必須を意味します。
またデフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しない事を意味し、null値や空文字列がデフォルト値であるという意味ではありません。
表. 基本リクエストヘッダー一覧
| HTTPヘッダー | 説明 | 必須 |
|---|---|---|
| Authorization | リクエスト認証に用いる文字列
|
○ |
| Content-Length | RFC 2616に準拠したヘッダー部を除いたメッセージ長
|
△ |
| Content-Type | リソースのコンテントタイプ
|
× |
| Date | リクエスト側で生成した現在日時
|
○ |
| Host | 対象となるリソースのホスト ホスト名は「s3api.iot.iij.jp」となります。
|
△ |
基本レスポンスヘッダー
本サービスのREST APIのレスポンスは、必ず以下のヘッダーを含みます。
| HTTPヘッダー | 説明 |
|---|---|
| Content-Length | レスポンスのボディの長さ（サイズ）
|
| Connection | サーバとの接続コネクションが開いているかどうか
|
| Date | サーバがレスポンスを返した日時 (サーバ側で生成されます。)
|
| ETag | オブジェクトから生成されたMD5ハッシュ値（ETag: Entity Tag）
|
| Server | このレスポンスを生成したサーバ名
|
| x-iijgio-id-2 | サーバ側でのトラブルシュートの為の特別な値
|
| x-iijgio-request-id | サーバ側が一意に生成する識別子問題が発生した場合に利用する為の値です。
|
エラーレスポンス
Content-Typeヘッダーは”application/xml”として返されます。
また、ステータスコードは300, 400, 500番台が返されます。
サンプル
<?xml version="1.0" encoding="UTF-8"?> |
<Error> |
<Code>NoSuchKey</Code> |
<Message>The resource you requested does not exist</Message> |
<Resource>/mybucket/myfoto.jpg</Resource> |
<RequestId>4442587FB7D0A2F9</RequestId> |
</Error> |
レスポンスエレメント
| 名前 | 説明 |
|---|---|
| Code | エラー状態をユニークに表す文字列これはプログラムによって解釈できるようにするためのものです。
|
| Error | すべてのエラー要素を持つコンテナ
|
| Message | エラーの状態の一般的な説明
|
| RequestId | エラーに関連するリクエストの識別子
|
| Resource | エラーに関連するリソース（バケットまたはオブジェクト）リクエストURLで指定されたリソースを表示します。
|