REST API 概要¶
本サービスが提供するAPIはREST(Representational State Transfer)をサポートしており、全てのAPIはXML形式のレスポンスボディを返します。
基本リクエストヘッダー¶
本サービスのREST APIに対するリクエストには以下のヘッダーを含めなければなりません。
なお、以下の表で必須項目はリクエスト側での設定が必須かどうかを指しており、○は必須、×は必須ではない、△は条件により必須を意味します。
またデフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しない事を意味し、null値や空文字列がデフォルト値であるという意味ではありません。
HTTPヘッダー | 説明 | 必須 | ||||||
---|---|---|---|---|---|---|---|---|
Authorization |
|
○ | ||||||
Content-Length |
|
△ | ||||||
Content-Type |
|
× | ||||||
Date |
|
○ | ||||||
Host |
|
△ |
基本レスポンスヘッダー¶
本サービスのREST APIのレスポンスは、必ず以下のヘッダーを含みます。
なお、デフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しないことを意味し、null値や空文字列がデフォルト値であるという意味ではありません。
HTTPヘッダー | 説明 | ||||||
---|---|---|---|---|---|---|---|
Content-Length |
|
||||||
Connection |
|
||||||
Date |
|
||||||
ETag |
|
||||||
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 |
|
API 一覧¶
名前 | 概要 |
---|---|
GET Service (List Buckets) | バケットの一覧を返します。 |
GET Service space | 現在のストレージの使用状況を返します。 |
GET Service traffic | 転送量を取得します。 |
名前 | 概要 |
---|---|
GET Bucket (List Objects) | 指定したバケットの一部または全ての オブジェクトをリストで返します。 |
HEAD Bucket | バケットが存在するかどうかおよびアクセス可能かどうかを返します。 |
PUT Bucket | 新しいバケットを作成します。 |
DELETE Bucket | バケットを削除します。 |
GET Bucket location | バケットが配置されているリージョン情報を返します。 |
GET Bucket acl | バケットのACL設定内容を返します。 |
PUT Bucket acl | 既存のバケットのACLを設定します。 |
GET Bucket policy | バケットポリシー設定内容を返します。 |
PUT Bucket policy | バケットポリシーを追加、更新します。 |
DELETE Bucket policy | 既存のバケットポリシーを削除します。 |
GET Bucket cors | Cross-Origin Resource Sharing(CORS)の設定を取得します。 |
PUT Bucket cors | CORSの設定を登録します。 |
DELETE Bucket cors | 既に登録されているCORSの設定を削除します。 |
GET Bucket website | ウェブサイト設定を取得します。 |
PUT Bucket website | ウェブサイト設定を登録します。 |
DELETE Bucket website | 既に登録されているウェブサイト設定を削除します。 |
List Multipart Uploads | 進行中のマルチパートアップロードの一覧を返します。 |
名前 | 概要 |
---|---|
GET Object | オブジェクトを取得します。 |
HEAD Object | オブジェクトのメタデータを取得します。 |
OPTIONS Object | CORSが有効の場合に、アクセス可能なサーバのURI(Origin)、HTTPメソッドおよびHTTPヘッダーを返します。 |
PUT Object | バケットにオブジェクトを追加します。 |
PUT Object (Copy) | 既に保管されているオブジェクトを複製します。 |
POST Object | HTML形式を使用して指定のバケットにオブジェクトを追加します。 |
DELETE Object | 指定のオブジェクトを削除します。 |
Delete Multiple Objects | 複数のオブジェクトを指定して削除します。 |
GET Object acl | オブジェクトのACL設定内容を取得します。 |
PUT Object acl | 既存のオブジェクトのACLを設定します。 |
List Parts | 指定のマルチパートアップロードのパートの一覧を返します。 |
Initiate Multipart Upload | 新しくマルチパートアップロードを開始します。 |
Upload Part | 指定のマルチパートアップロードにパートを追加します。 |
Upload Part (Copy) | 既存のオブジェクトをパートとして指定のマルチパートアップロードに追加します。 |
Complete Multipart Upload | 追加したパートからオブジェクトを構成します。 |
Abort Multipart Upload | 進行中のマルチパートアップロードを中止します。 |