ユーザーガイド/リファレンスガイド

API

Description

リクエストに指定したメタデータですべてのメタデータを上書きします。

ボリュームの自動イメージ保存スケジュールの設定方法:

  • 各ボリュームにつき、3セットまで(backup_schedule1とbackup1_xxx~backup_schedule3とbackup3_xxx)を登録可能。
  • backup_schedule1: FalseまたはTrue
  • backup1_day: 曜日{“sun”,”mon”,”tue”,”wed”,”thu”,”fri”,”sat”} または日付{“1″~”31”} または毎日{“*”}(カンマ区切りで複数指定可能。ただし曜日と日付、日付と毎日、曜日と毎日を組み合わせることはできない。)
  • backup1_hour: “0”~”23″
  • backup1_rotate: “1”~”255″ または “0” “0”の場合はローテートしない。
  • backup1_name: 255バイトまでの文字列 大文字小文字英数字と、”_”と”-“が使用可能

Request URL

Block Storage API v2
PUT /v2/{tenant_id}/volumes/{volume_id}/metadata

Request Json

{
        “metadata”: {
            “backup_schedule1”: “true”,
            “backup1_day”: “取得日“,
            “backup1_hour”: “取得時間“,
            “backup1_rotate”: “最大保存数“,
            “backup1_name”: “ネームタグ
}

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
tenant_id テナントID URI テナントID
volume_id ボリュームID URI ボリュームID
metadata ボリュームメタデータ plain ボリュームメタデータ

Response

Normal response codes

200

Example

Request

curl -i -X PUT \
-H “Accept: application/json” \
-H “X-Auth-Token: トークンID” \
-H “Content-Type: application/json” \
-d ‘{
        “metadata”: {
            “backup_schedule1”: “true”,
            “backup1_day”: “取得日“,
            “backup1_hour”: “取得時間“,
            “backup1_rotate”: “最大保存数“,
            “backup1_name”: “ネームタグ
        }
    }’ \
https://block-storage.odc01.eva-clouds.com/v2/テナントID/volumes/ボリュームID/metadata

Response

HTTP/1.1 200 OK
Date: Fri, 08 Jul 2016 08:53:20 GMT
Server: Apache
Content-Length: 3785
Content-Type: application/json

{
    “metadata”: {
        “backup_schedule1”: “True”,
        “backup1_day”: “取得日“,
        “backup1_hour”: “取得時間“,
        “readonly”: “False”,
        “backup1_rotate”: “最大保存数“,
        “backup1_name”: “ネームタグ
        “attached_mode”: “rw”
    }
}

 

Description

指定したキーのボリュームメタデータを削除します。

ボリュームの自動イメージ保存スケジュールの設定方法:

  • 各ボリュームにつき、3セットまで(backup_schedule1とbackup1_xxx~backup_schedule3とbackup3_xxx)を登録可能。
  • backup_schedule1: FalseまたはTrue
  • backup1_day: 曜日{“sun”,”mon”,”tue”,”wed”,”thu”,”fri”,”sat”} または日付{“1″~”31”} または毎日{“*”}(カンマ区切りで複数指定可能。ただし曜日と日付、日付と毎日、曜日と毎日を組み合わせることはできない。)
  • backup1_hour: “0”~”23″
  • backup1_rotate: “1”~”255″ または “0” “0”の場合はローテートしない。
  • backup1_name: 255バイトまでの文字列 大文字小文字英数字と、”_”と”-“が使用可能

Request URL

Block Storage API v2
DELETE /v2/{tenant_id}/volumes/{volume_id}/metadata/{key_name}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
tenant_id テナントID URI テナントID
volume_id ボリュームID URI ボリュームID
key_name {backup_schedule1,
backup1_day,
backup1_hour,
backup1_rotate,
backup1_name}
URI ボリュームメタデータ名

Response

Normal response codes

200

Example

Request

curl -i -X DELETE \
-H “Accept: application/json” \
-H “X-Auth-Token: トークンID” \
-H “Content-Type: application/json” \
https://block-storage.odc01.eva-clouds.com/v2/テナントID/volumes/ボリュームID/metadata/ボリュームメタデータ名

Response

HTTP/1.1 200 OK
Date: Fri, 08 Jul 2016 08:53:20 GMT
Server: Apache
Content-Length: 3785
Content-Type: application/json

 

Description

キーに一致するメタデータのみ置き換えます。
リクエストに含まれていないメタデータは変更されません。

ボリュームの自動イメージ保存スケジュールの設定方法:

  • 各ボリュームにつき、3セットまで(backup_schedule1とbackup1_xxx~backup_schedule3とbackup3_xxx)を登録可能。
  • backup_schedule1: FalseまたはTrue
  • backup1_day: 曜日{“sun”,”mon”,”tue”,”wed”,”thu”,”fri”,”sat”} または日付{“1″~”31”} または毎日{“*”}(カンマ区切りで複数指定可能。ただし曜日と日付、日付と毎日、曜日と毎日を組み合わせることはできない。)
  • backup1_hour: “0”~”23″
  • backup1_rotate: “1”~”255″ または “0” “0”の場合はローテートしない。
  • backup1_name: 255バイトまでの文字列 大文字小文字英数字と、”_”と”-“が使用可能

Request URL

Block Storage API v2
POST /v2/{tenant_id}/volumes/{volume_id}/metadata

Request Json

{
        “metadata”: {
            “backup_schedule1”: “true”,
            “backup1_day”: “取得日“,
            “backup1_hour”: “取得時間“,
            “backup1_rotate”: “最大保存数“,
            “backup1_name”: “ネームタグ
        }
}

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
tenant_id テナントID URI テナントID
volume_id ボリュームID URI ボリュームID
metadata ボリュームメタデータ plain ボリュームメタデータ

 

Response

Normal response codes

202

Example

Request

curl -i -X POST \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
-d ‘{
        “metadata”: {
            “backup_schedule1”: “true”,
            “backup1_day”: “取得日“,
            “backup1_hour”: “取得時間“,
            “backup1_rotate”: “最大保存数“,
            “backup1_name”: “ネームタグ
        }
    }’ \
https://block-storage.odc01.eva-clouds.com/v2/テナントID/volumes/ボリュームID/metadata

Response

HTTP/1.1 202 Accepted
Date: Wed, 06 Jul 2016 08:41:43 GMT
Server: Apache
Content-Length: 778
Content-Type: application/json

{
    “metadata”: {
        “backup_schedule1”: “True”,
        “backup1_day”: “取得日“,
        “backup1_hour”: “取得時間“,
        “readonly”: “False”,
        “backup1_rotate”: “最大保存数“,
        “backup1_name”: “ネームタグ“,
        “attached_mode”: “rw”
    }
}

 

Description

オブジェクトをアップロードします。

Request URL

ObjectStorage API v1
PUT /v1/ze_{account}/{container}/ {object}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
account テナントID URI テナントID
container コンテナ名 URI コンテナ名
object オブジェクト名 URI オブジェクト名

Response

Normal response codes

201

Example

Request

curl -i -X PUT \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://object-storage.odc01.eva-clouds.com/v1/ze_テナントID/コンテナ名/ \-T オブジェクト名

Response

HTTP/1.1 201 Created
Last-Modified: Mon, 22 Aug 2016 07:58:03 GMT
Content-Length: 0
Etag: c813cd88fc19e6b5d9b0a079871560cc
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txb6eae321003442c6bfd5e-0057bab08a
Date: Mon, 22 Aug 2016 07:58:18 GMT

 

Description

オブジェクトをダウンロードします。
curlコマンドで実行する場合は -O オプションを利用することで保存が可能です。

Request URL

ObjectStorage API v1
GET /v1/ze_{account}/{container}/{object}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
account テナントID URI テナントID
container コンテナ名 URI コンテナ名
object オブジェクト名 URI オブジェクト名

Response

Normal response codes

200

Example

Request

curl -X GET \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://object-storage.odc01.eva-clouds.com/v1/ze_テナントID/コンテナ名/オブジェクト名 -O

Response 

% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  102M  100  102M    0     0  10.9M      0  0:00:09  0:00:09 –:–:– 11.2M

 

Description

コンテナを削除します。
コンテナ内のオブジェクトがすべて削除されている必要があります。

Request URL

ObjectStorage API v1
DELETE /v1/ze_{account}/{container}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
account テナントID URI テナントID
container コンテナ名 URI コンテナ名

Response

Normal response codes

204

Example

Request

curl -i -X DELETE \
-H “Accept: application/json” \
-H “X-Auth-Token: トークンID” \
https://object-storage.odc01.eva-clouds.com/v1/ze_テナントID/コンテナ名

Response

HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx301b2538fabe494dba632-0057b6ceb8
Date: Fri, 19 Aug 2016 09:17:45 GMT

 

Description

オブジェクト情報を取得します。

Request URL

ObjectStorage API v1
GET /v1/ze_{account}/{container}/{object}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
X-Newest(Optional) boolean header  
Accept(Optional) string header  
account テナントID URI テナントID
container コンテナ名 URI コンテナ名
object オブジェクト名 URI オブジェクト名
signature(Optional) string query  
expires(Optional) string query  
multipart-manifest(Optional) string query  
Range(Optional) string header  
If-Match(Optional) string header  
If-Modified-Since(Optional) date header  
If-Unmodified-Since(Optional) date header  

Response

Normal response codes

200

Example

Request

curl -i -X GET \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://object-storage.odc01.eva-clouds.com/v1/ze_テナントID/コンテナ名/オブジェクト名

Response

HTTP/1.1 200 OK
Content-Length: 20
Accept-Ranges: bytes
Last-Modified: Tue, 30 Aug 2016 06:59:30 GMT
Etag: 3de8f8b0dc94b8c2230fab9ec0ba0506
X-Timestamp: 1472540369.31743
Content-Type: application/json
X-Trans-Id: txee9be737701b49f28f403-0057c52ee1
Date: Tue, 30 Aug 2016 06:59:45 GMT

This is a test file.

 

Description

ボリュームメタデータ情報を取得します。

ボリュームの自動イメージ保存スケジュールの設定方法:

  • 各ボリュームにつき、3セットまで(backup_schedule1とbackup1_xxx~backup_schedule3とbackup3_xxx)を登録可能。
  • backup_schedule1: FalseまたはTrue
  • backup1_day: 曜日{“sun”,”mon”,”tue”,”wed”,”thu”,”fri”,”sat”} または日付{“1″~”31”} または毎日{“*”}
    (カンマ区切りで複数指定可能。ただし曜日と日付、日付と毎日、曜日と毎日を組み合わせることはできない。)
  • backup1_hour: “0”~”23″
  • backup1_rotate: “1”~”255″ または “0” “0”の場合はローテートしない。
  • backup1_name: 255バイトまでの文字列 大文字小文字英数字と、”_”と”-“が使用可能
  • タイムゾーンはUTCとなります。

Request URL

Block Storage API v2
GET /v2/{tenant_id}/volumes/{volume_id}/metadata

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
tenant_id テナントID URI テナントID
volume_id ボリュームID URI ボリュームID

Response

Normal response codes

200

Example

Request

curl -i -X GET \
-H “Accept: application/json” \
-H “X-Auth-Token: トークンID” \
-H “Content-Type: application/json” \
https://block-storage.odc01.eva-clouds.com/v2/テナントID/volumes/ボリュームID/metadata

Response

HTTP/1.1 200 OK
Date: Fri, 08 Jul 2016 08:53:20 GMT
Server: Apache
Content-Length: 3785
Content-Type: application/json

{
    “metadata”: {
        “backup1_name”: “ネームタグ“,
        “backup1_day”: “取得日“,
        “backup1_hour”: “取得時間“,
        “readonly”: “False”,
        “backup1_rotate”: “最大保存数“,
        “backup_schedule1”: “True”,
        “attached_mode”: “rw”
    }
}

 

Description

tenant_id とアップロードするボリュームの volume_id を指定し Glance イメージとして保存します。

Request URL

Block Storage API v2
POST /v2/{tenant_id}/volumes/{volume_id}/action

Request Json

{
  “os-volume_upload_image”: {
    “image_name”: “イメージ名“,
    “disk_format”: “diskフォーマット“,
    “container_format”: “コンテナフォーマット
  }
}

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
tenant_id テナントID URI テナントID
volume_id ボリュームID URI ボリュームID
image_name イメージ名 plain イメージ名

Response

Normal response codes

202

Example

Request

curl -i -X POST \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
-d ‘{“os-volume_upload_image”: {“image_name”: “イメージ名“}}’ \
https://block-storage.odc01.eva-clouds.com/v2/テナントID/volumes/ボリュームID/action

Response

HTTP/1.1 202 Accepted
Date: Fri, 08 Jul 2016 05:54:26 GMT
Server: Apache
Content-Length: 529
Content-Type: application/json

{
    “os-volume_upload_image”: {
        “container_format”: “コンテナフォーマット“,
         “disk_format”: “diskフォーマット“,
         “display_description”: null,
         “id”: “ボリュームID“,
         “image_id”: “イメージID“,
         “image_name”: “イメージ名“,
         “size”: ボリュームサイズ,
         “status”: “uploading”,
         “updated_at”: “2016-07-07T07:17:48.00000000”,
         “volume_type”: {
            “created_at”: “2016-06-24T06:35:10.00000000”,
             “deleted”: 0,
             “deleted_at”: null,
             “id”: “ボリュームタイプID“,
             “name”: “ボリューム名“,
             “qos_specs_id”: null,
             “updated_at”: null
        }
    }
}

 

Description

コンテナ一覧を取得します。
ヘッダーからアカウント情報を参照することができます。

Request URL

ObjectStorage API v1
GET /v1/ze_{account}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
X-Newest(Optional) boolean header  
Accept (Optional) string header  
account テナントID URI テナントID
limit(Optional) int query  
marker(Optional) string query  
end_maker(Optional) string query  
format(Optional) string query  
prefix(Optional) string query  
delimiter(Optional) char query  

Response

Normal response codes

200

Example

Request

curl -i -X GET \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://object-storage.odc01.eva-clouds.com/v1/ze_テナントID

Response

HTTP/1.1 200 OK
Content-Length: 157
X-Account-Object-Count: 2
X-Account-Storage-Policy-Policy-0-Bytes-Used: 80831520
X-Account-Storage-Policy-Policy-0-Container-Count: 3
X-Timestamp: 1467082679.70992
X-Account-Storage-Policy-Policy-0-Object-Count: 2
X-Account-Bytes-Used: 80831520
X-Account-Container-Count: 3
Content-Type: application/json; charset=utf-8
Accept-Ranges: bytes
X-Trans-Id: tx24378a39f50f429995f0d-0057b6be81
Date: Fri, 19 Aug 2016 08:08:33 GMT

[
    {
        “bytes”: 80831520,
        “count”: 1,
        “name”: “container-001”
    },
    {
        “bytes”: 0,
        “count”: 1,
        “name”: “container-002”
    }
]