リファレンスガイド(api - 富士通のソフトウェア :...

42
J2X1-8031-01Z0(01) 20161Linux FUJITSU Software ServerView Resource Orchestrator Standard powered by K5 V3.2.0 リファレンスガイド(API編)

Upload: duongdat

Post on 23-Jul-2019

226 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

J2X1-8031-01Z0(01)2016年1月

Linux

FUJITSU SoftwareServerView Resource Orchestrator Standard powered by K5 V3.2.0

リファレンスガイド(API編)

Page 2: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

まえがき

本書の目的

本書は、FUJITSU Software ServerView Resource Orchestrator Standard powered by K5(以降、本製品)がサポートするAPIの概要につ

いて説明しています。

本書の読者

本書は、本製品がサポートするAPIを知りたい方を対象としています。

本書の構成

本書は、以下の構成になっています。

第1章 本製品のAPI一覧

本製品がサポートするAPIを説明します。

各コンポーネントのAPIの詳細は、OpenStackリファレンス(http://developer.openstack.org/api-ref.html)を参照してください。

なお、本製品では、主に利用者向けのAPIをサポートしています。

HorizonおよびOpenStack CLIで使用できる、すべての機能のAPIをサポートしているわけではありません。

参照先URLについて

本文中に記載されている参照先URLは、2016年1月時点の情報です。

マニュアル体系と読み方

本製品のマニュアルには、以下のものがあります。必要に応じて、それぞれのマニュアルを読んでください。

マニュアル名称 マニュアル略称 目的・用途

FUJITSU Software ServerView Resource Orchestrator Standardpowered by K5 V3.2.0 操作ガイド

操作ガイド 製品の操作方法を知りたい場合にお

読みください。

FUJITSU Software ServerView Resource Orchestrator Standardpowered by K5 V3.2.0 リファレンスガイド (API編)

リファレンスガイド (API編)

本製品がサポートするAPIを知りたい

場合にお読みください。

本書の表記について

本書中の表記方法は以下のとおりです。

・ 参照先は「 」でくくります。

・ GUIは[ ]でくくります。

・ メニューの選択順を[ ]-[ ]の形式で示します。

・ ユーザーが入力する文字は太字で示します。

・ 可変部分は斜体で示します。

・ 特に強調が必要な文字列、数値をダブルクォーテーション( " )でくくります。

・ メニュー名には、設定、操作画面の起動を示す"..."は表記しません。

・ 使用例は、プロンプトをLinuxの"#"で表記しています。

- i -

Page 3: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

FUJITSU Integrated System PRIMEFLEX for Cloud K5モデル Webサイト

FUJITSU Integrated System PRIMEFLEX for Cloud K5モデル Webサイトでは、最新のマニュアルや技術情報を公開しています。

本製品を利用する前に、FUJITSU Integrated System PRIMEFLEX for Cloud K5モデル Webサイトを参照することをお勧めします。

URL: http://jp.fujitsu.com/platform/server/crb/products/k5/

略称

本書中の略称は以下のとおりです。

製品 略称

Red Hat(R) Enterprise Linux(R) 6.n (for Intel64) Linux

Red Hat(R) Enterprise Linux(R) 6.n (for Intel64) Red Hat Enterprise Linux

Red Hat(R) Enterprise Linux(R) 6.n (for Intel64) Red Hat Enterprise Linux 6

Red Hat(R) Enterprise Linux(R) 6.n (for Intel64) RHEL6.n(注)

Red Hat(R) Enterprise Linux(R) 6.n (for Intel64) 仮想化機能 RHEL-KVM

注: "n"には、マイナーリリースを示す数字が入ります。

輸出管理規制について

本ドキュメントを輸出または第三者へ提供する場合は、お客様が居住する国および米国輸出管理関連法規等の規制をご確認のうえ、

必要な手続きをおとりください。

商標について

・ Linuxは、Linus Torvalds氏の米国およびその他の国における登録商標または商標です。

・ Red Hat、RPMおよびRed Hatをベースとしたすべての商標とロゴは、Red Hat, Inc.の米国およびその他の国における登録商標ま

たは商標です。

・ OpenStack(R)のワードマークと OpenStack のロゴは、米国とその他の国における OpenStack Foundationの登録商標/サービスマー

クまたは商標/サービスマークのどちらかであり、OpenStack Foundation の許諾の下に使用されています。富士通株式会社は、

OpenStack Foundation にも OpenStack コミュニティにも所属しておらず、公認や出資も受けていません。

・ ServerViewは、富士通株式会社の登録商標です。

・ その他の会社名および製品名は、それぞれの会社の商標または登録商標です。

お願い

・ 本書を無断でほかに転載しないようお願いします。

・ 本書は予告なしに変更されることがあります。

出版年月および版数

版数 マニュアルコード

2015年12月 第1版 J2X1-8031-01Z0(00)

2016年1月 第1.1版 J2X1-8031-01Z0(01)

- ii -

Page 4: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

著作権表示

Copyright 2015-2016 FUJITSU LIMITED

- iii -

Page 5: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

目 次

第1章 本製品のAPI一覧............................................................................................................................................................11.1 Cinder...................................................................................................................................................................................................11.2 Nova.....................................................................................................................................................................................................51.3 Keystone............................................................................................................................................................................................ 121.4 Glance................................................................................................................................................................................................ 161.5 Neutron.............................................................................................................................................................................................. 171.6 Swift...................................................................................................................................................................................................221.7 Heat....................................................................................................................................................................................................301.8 Ceilometer..........................................................................................................................................................................................35

- iv -

Page 6: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

第1章 本製品のAPI一覧

本製品がサポートするAPIを説明します。

各コンポのAPIの詳細は、OpenStackリファレンス( http://developer.openstack.org/api-ref.html )を参照してください。

カテゴリ(コンポーネント)ごとに説明します。

・ Cinder

・ Nova

・ Keystone

・ Glance

・ Neutron

・ Swift

・ Heat

・ Ceilometer

なお、本製品では、主に利用者向けのAPIをサポートしています。

HorizonおよびOpenStack CLIで使用できる、すべての機能のAPIをサポートしているわけではありません。

ポイント

本書では、可変部分を{}を使って表記しています。

1.1 CinderCinderカテゴリについて、サブカテゴリごとに説明します。

Block Storage API v2 volume types

接続サービス: Block Storage

URI メソッド 機能

/v2/{tenant_id}/types GET ボリュームタイプを一覧表示します。

/v2/{tenant_id}/types/{volume_type_id} GET 指定されたボリュームタイプに関する情報を表示します。

Block Storage API v2 snapshots

接続サービス: Block Storage

URI メソッド 機能

/v2/{tenant_id}/snapshots GET 要求を送信したテナントがアクセス可能なすべてのブロックスト

レージのスナップショットのサマリ情報を一覧表示します。

/v2/{tenant_id}/snapshots/detail GET 要求を送信したテナントがアクセス可能なすべてのブロックスト

レージのスナップショットの詳細情報を一覧表示します。

/v2/{tenant_id}/snapshots/{snapshot_id} GET 指定されたスナップショットの情報を表示します。

/v2/{tenant_id}/snapshots/{snapshot_id} DELETE 指定されたスナップショットを削除します。

/v2/{tenant_id}/snapshots POST ボリュームのポイントインタイムのスナップショットを作成します。

/v2/{tenant_id}/snapshots/{snapshot_id} PUT 指定されたスナップショットを更新します。

- 1 -

Page 7: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Block Storage API v2 volumes

接続サービス: Block Storage

URI メソッド 機能

/v2/{tenant_id}/volumes GET 要求を送信したテナントがアクセス可能なすべてのブロックスト

レージボリュームのサマリ情報を一覧表示します。

/v2/{tenant_id}/volumes/detail GET 要求を送信したテナントがアクセス可能なすべてのブロックスト

レージボリュームの詳細情報を一覧表示します。

/v2/{tenant_id}/volumes/{volume_id} GET 指定されたボリュームの情報を表示します。

/v2/{tenant_id}/volumes/{volume_id} DELETE 指定されたボリュームを削除します。

/v2/{tenant_id}/volumes/{volume_id}/action POST 指定されたボリュームの容量を拡大します。

/v2/{tenant_id}/volumes/{volume_id}/action POST 指定されたボリュームをイメージとして登録します。

詳細は(注)を参照してください。

/v2/{tenant_id}/volumes POST ボリュームを作成します。

/v2/{tenant_id}/volumes/{volume_id} PUT ボリュームを更新します。

注)

詳細を以下に説明します。

[リクエストパラメーター(URI)]

名前 型 説明

{tenant_id} String テナントまたはアカウントで一意な識別子

{volume_id} uuid 既存のボリュームで一意な識別子

[リクエストパラメーター(ボディ)]

名前 型 説明

container_format String(省略可)

作成するイメージのコンテナ形式を指定します。

"bare"を指定します。省略した場合、"bare"が指定されたものとして動作します。

disk_format String(省略可)

作成するイメージのディスク形式を指定します。

"raw"を指定します。省略した場合、"raw"が指定されたものとして動作します。

image_name String 作成するイメージの名前を指定します。

force boolean(省略可)

Falseを指定した場合、ボリュームがインスタンスに取り付けられていると、イメージを作成で

きません。

Trueを指定した場合、ボリュームがインスタンスに取り付けられていても、イメージを作成で

きます。本パラメーターを指定する場合、事前に、OSを停止してください。

[サンプルリクエスト]

{

"os-volume_upload_image": {

"container_format": “bare”,

"disk_format": “raw”,

"image_name": “my_image”,

"force": “True”

}

}

[レスポンス]

正常に終了した場合に"202"を返します。

- 2 -

Page 8: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

異常終了した場合、以下のエラーコードを返します。

- 400: リクエストが不正である。

- 401: 認証が必要である。

- 403: 禁止されている。サイズの変更できない。

- 404: 未検出である。

- 500または上記以外: クラウドサーバにエラーが発生した。

[要素]

名前 型 説明

status String ボリュームの状態です。

ボリュームからイメージを作成し始めた直後は、"uploading"となります。

イメージの作成が完了すると、"available"または"in-use"に戻ります。

image_id uuid 作成したイメージのidです。

image_name String リクエストボディで指定した値です。

volume_type String ボリュームのボリュームタイプです。

container_format String リクエストボディで指定(または省略値)した値です。

size int ボリュームの容量(GB)です。

disk_format String リクエストボディで指定(または省略値)した値です。

[サンプルレスポンス]

{

"os-volume_upload_image": {

"status": "uploading",

"image_id": "d7d02fe6-f54e-4af5-adec-106e4a7ded1c",

"image_name": "my_image",

"volume_type": null,

"container_format": "bare",

"size": 2,

"disk_format": "raw",

"id": "3a2eee5d-814f-445e-a916-963d76df0980",

"display_description": "",

"updated_at": "2015-01-16T09:01:56.000000"

}

}

Block Storage API v2 Backups extension

接続サービス: Block Storage

URI メソッド 機能

/v2/{tenant_id}/backups POST ブロックストレージバックアップを作成します。

/v2/{tenant_id}/backups GET テナントにあるバックアップの一覧を表示します。

/v2/{tenant_id}/backups/detail GET テナントにあるバックアップの詳細を一覧表示します。

/v2/{tenant_id}/backups/{backup_id} GET 指定したバックアップの詳細を表示します。

/v2/{tenant_id}/backups/{backup_id} DELETE 指定したバックアップを削除します。

/v2/{tenant_id}/backups/{backup_id}/restore POST 既存または新規のボリュームにバックアップを復元します。

- 3 -

Page 9: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Block Storage API v2 Limits extension

接続サービス: Block Storage

URI メソッド 機能

/v2/{tenant_id}/limits GET テナントのボリュームに関する絶対的な制限値を取得します。

Block Storage API v2 Quota sets extension (os-quota-sets)

接続サービス: Block Storage

URI メソッド 機能

/v2/{tenant_id}/os-quota-sets/{tenant_id} GET テナントのクォータ値を取得します。

/v2/{tenant_id}/os-quota-sets/defaults GET テナントのクォータ値のデフォルト値を取得します。

Block Storage API v1 Volumes

接続サービス: Block Storage

URI メソッド 機能

/v1/{tenant_id}/volumes POST ボリュームを作成します。

/v1/{tenant_id}/volumes GET ボリュームの一覧を取得します。

/v1/{tenant_id}/volumes/detail GET ボリューム一覧の詳細情報を取得します。

/v1/{tenant_id}/volumes/{volume_id} GET 指定したボリュームの詳細を表示します。

/v1/{tenant_id}/volumes/{volume_id} DELETE 指定したボリュームを削除します。

/v1/{tenant_id}/volumes/{volume_id}/action POST 指定されたボリュームの容量を拡大します。

/v1/{tenant_id}/volumes/{volume_id}/action POST 指定されたボリュームをイメージとして登録します。

Block Storage API v1 Volume types

接続サービス: Block Storage

URI メソッド 機能

/v1/{tenant_id}/types GET ボリュームタイプの一覧を取得します。

/v1/{tenant_id}/types/{volume_type_id} GET 指定されたボリュームタイプに関する情報を表示します。

Block Storage API v1 Snapshot

接続サービス: Block Storage

URI メソッド 機能

/v1/{tenant_id}/snapshots POST スナップショットを作成します。

/v1/{tenant_id}/snapshots GET スナップショットの一覧を取得します。

/v1/{tenant_id}/snapshots/detail GET スナップショット一覧の詳細情報を取得します。

/v1/{tenant_id}/snapshots/{snapshot_id} GET 指定したスナップショットの詳細を表示します。

/v1/{tenant_id}/snapshots/{snapshot_id} DELETE 指定したスナップショットを削除します。

- 4 -

Page 10: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Block Storage API v1 Backups extension

接続サービス: Block Storage

URI メソッド 機能

/v1/{tenant_id}/backups POST ブロックストレージバックアップを作成します。

/v1/{tenant_id}/backups GET 要求したバックアップを表示します。

/v1/{tenant_id}/backups/detail GET テナントにあるバックアップの詳細を一覧表示します。

/v1/{tenant_id}/backups/{backup_id} GET 指定したバックアップの詳細を表示します。

/v1/{tenant_id}/backups/{backup_id} DELETE 指定したバックアップを削除します。

/v1/{tenant_id}/backups/{backup_id}/restore POST 既存または新規のボリュームにバックアップを復元します。

1.2 NovaNovaカテゴリについて、サブカテゴリごとに説明します。

Novaの詳細は、以下を参照してください。

・ http://developer.openstack.org/api-ref-compute-v2.html

・ http://developer.openstack.org/api-ref-compute-v2-ext.html

Servers

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers GET 全サーバのIDおよびサーバ名を一覧表示します。

/v2/{tenant_id}/servers{?changes-since,image,flavor,name,marker,limit,status,host}

GET 指定した情報を含むサーバ名の情報を一覧表示します。

/v2/{tenant_id}/servers POST サーバを作成します。

/v2/{tenant_id}/servers/detail{?changes-since,image,flavor,name,marker,limit,status,host}

GET すべてのサーバの詳細を一覧表示します。

/v2/{tenant_id}/servers/{server_id} GET 指定されたサーバの詳細情報を取得します。

/v2/{tenant_id}/servers/{server_id} PUT 現在のインスタンス名を変更します。

/v2/{tenant_id}/servers/{server_id} DELETE 指定されたサーバを削除します。

server actions

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/action POST ソフトウェアタイプを使って、指定されたサーバを再起動します。

/v2/{tenant_id}/servers/{server_id}/action POST 指定されたサーバをリビルドします。

/v2/{tenant_id}/servers/{server_id}/action POST 指定されたサーバのサイズを変更します。

/v2/{tenant_id}/servers/{server_id}/action POST サイズ変更されたサーバを確認します。

/v2/{tenant_id}/servers/{server_id}/action POST サイズ変更されたサーバを元のサイズに戻します。

- 5 -

Page 11: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/action POST イメージを作成します。

images

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/images/detail{?changes-since,server,name,status,marker,limit,type}

GET 利用可能なイメージの詳細を一覧表示します。

/v2/{tenant_id}/images/detail{?changes-since,server,name,status,marker,limit,type}

GET 利用可能な指定イメージの詳細を一覧表示します。

/v2/{tenant_id}/images/{image_id} GET 指定されたイメージの詳細を取得します。

/v2/{tenant_id}/images/{image_id} DELETE 指定されたイメージを削除します。

metadata

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/images/{image_id}/metadata GET 指定されたイメージのメタデータを表示します。

/v2/{tenant_id}/images/{image_id}/metadata POST イメージのメタデータを作成、または置き換します。

/v2/{tenant_id}/images/{image_id}/metadata PUT キーで指定されたイメージのメタデータを更新します。

/v2/{tenant_id}/images/{image_id}/metadata/{key}

GET キーで指定されたイメージのメタデータ項目の詳細を表示します。

/v2/{tenant_id}/images/{image_id}/metadata/{key}

PUT キーで指定されたメタデータ項目を作成、または更新します。

/v2/{tenant_id}/images/{image_id}/metadata/{key}

DELETE キーで指定されたメタデータ項目を削除します。

Servers with scheduler hints (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers POST スケジューラーに直接渡されるスケジューラーの指示を使用して、

サーバを作成します。

Servers multiple create (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers POST オプション予約IDを持つ、1つ以上のサーバを作成します。

- 6 -

Page 12: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Server extended status (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id} GET 指定したサーバの拡張ステータス属性を表示します。

/v2/{tenant_id}/servers/detail GET 全サーバの拡張ステータス属性の詳細一覧を表示します。

Server extended attributes (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers GET 全サーバの拡張サーバ属性の詳細一覧を表示します。

/v2/{tenant_id}/servers/{server_id} GET 指定したサーバの拡張サーバ属性を表示します。

Server IP type (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/detail GET 全サーバの固定IPアドレスまたはFloating IP をタイプ別に、一覧

表示します。

Servers and images with disk config (servers, images)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers POST サーバを作成します。

/v2/{tenant_id}/servers/{server_id} GET 指定したサーバの情報を表示します。

/v2/{tenant_id}/servers/detail GET サーバ一覧を表示します。

/v2/{tenant_id}/images/{image_id} GET 指定されたイメージ情報を取得します。

/v2/{tenant_id}/images/detail GET イメージの一覧を表示します。

Servers with extended availability zones (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id} GET 利用可能ゾーンを含む指定したサーバの情報を表示します。

/v2/{tenant_id}/servers/detail GET 現在の利用可能ゾーンを含むサーバの詳細一覧を表示します。

Configuration drive (servers)

接続サービス: Compute

- 7 -

Page 13: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2/{tenant_id}/servers POST ドライブ設定の拡張属性を使用して、サーバ作成します。

/v2/{tenant_id}/servers/{server_id} GET ドライブ設定の拡張属性を含む指定されたサーバの情報を表示

します。

/v2/{tenant_id}/servers/detail GET ドライブ設定の拡張属性を含むすべてのサーバの詳細を表示し

ます。

Server OS-EXT-IPS-MAC:mac_addr extended attribute (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers POST OS-EXT-IPS-MAC:mac_addrを使用して、サーバを作成します。

/v2/{tenant_id}/servers/{server_id} GET 指定したサーバの情報を表示します(OS-EXT-IPS-MAC:mac_addrを含む)。

/v2/{tenant_id}/servers/detail GET すべてのサーバの詳細一覧を表示します(OS-EXT-IPS-MAC:mac_addrを含む)。

Servers with block device mapping format (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers POST ブロックデバイスマッピングを使用して、サーバを作成します。

BlockDeviceMappingV2を利用する場合は、「1.7 Heat」の「BlockDeviceMappingV2プロパティ」を参照してください。

/v2/{tenant_id}/servers{?changes-since,image,flavor,name,marker,limit,status,host}

GET ID、名前、すべてのサーバのリンク一覧を表示します。

Volume attachments (os-volume_attachments)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments

POST 指定されたサーバにボリュームをアタッチします。

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments

GET 指定されたサーバのボリューム一覧を表示します。

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}

GET 指定されたボリュームの詳細を表示します。

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}

DELETE 指定したサーバから指定されたボリュームをデタッチします。

Volume extension (os-volumes, os-snapshots)

接続サービス: Compute

- 8 -

Page 14: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v1.1/{tenant_id}/os-volumes GET アカウントに関連付けられたボリュームを一覧表示します。

/v1.1/{tenant_id}/os-volumes/detail GET 指定したボリュームの詳細を表示します。

/v1.1/{tenant_id}/os-volumes POST ボリュームを作成します。

/v1.1/{tenant_id}/os-volumes/{volume_id} GET 指定されたボリュームの情報を表示します。

/v1.1/{tenant_id}/os-volumes/{volume_id} DELETE 指定されたボリュームを削除します。

/v1.1/{tenant_id}/os-snapshots POST スナップショットを作成します。

/v1.1/{tenant_id}/os-snapshots GET スナップショットを一覧表示します。

/v1.1/{tenant_id}/os-snapshots/detail GET 指定されたスナップショットを一覧表示します。

/v1.1/{tenant_id}/os-snapshots/{snapshot_id} GET 指定されたスナップショットの情報を表示します。

/v1.1/{tenant_id}/os-snapshots/{snapshot_id} DELETE アカウントから指定されたスナップショットを削除します。

Server start and stop (servers)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/action POST 状態をACTIVEにし、サーバを起動します。

/v2/{tenant_id}/servers/{server_id}/action POST 状態をSTOPEDにし、サーバを停止します。

Keypairs (os-keypairs)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-keypairs GET アカウントに関連付けられているキーペアを一覧表示します。

/v2/{tenant_id}/os-keypairs POST キーペアを生成またはインポートします。

/v2/{tenant_id}/os-keypairs/{keypair_name} DELETE キーペアを削除します。

/v2/{tenant_id}/os-keypairs/{keypair_name} GET アカウントに関連付けられたキーペアを表示します。

Server console output (os-console-output)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/action POST サーバインスタンスのコンソール出力を取得します。

Images with size attribute (images)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/images/detail GET 利用可能なイメージの詳細およびイメージサイズを一覧表示しま

す。

/v2/{tenant_id}/images/{image_id} GET 指定されたイメージの詳細およびイメージサイズを取得します。

- 9 -

Page 15: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Server password (os-server-password)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/os-server-password

GET 指定したサーバの管理パスワードを取得します。

os-availability-zone

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-availability-zone GET 利用可能ゾーンの情報を取得します。

Attach interfaces (os-interface)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/servers/{server_id}/os-interface POST サーバインスタンスに接続するポートを作成し、使用します。

/v2/{tenant_id}/servers/{server_id}/os-interface GET ポートの一覧を表示します。

/v2/{tenant_id}/servers/{server_id}/os-interface/{attachment_id}

GET 指定されたポートに関する情報を表示します。

/v2/{tenant_id}/servers/{server_id}/os-interface/{attachment_id}

DELETE 指定されたポートを切り離します。

Flavor access (flavors)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/flavors GET Flavorとアクセスタイプを一覧表示します。

/v2/{tenant_id}/flavors/{flavor_id} GET Flavorのアクセスタイプを取得します。

/v2/{tenant_id}/flavors/detail GET フレーバーの詳細一覧を取得します。

/v2/{tenant_id}/flavors POST プライベートFlavorを作成します。

Flavors with rxtx_factor extended attribute (flavors)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/flavors/detail GET Flavor一覧の詳細情報を取得します。

Boot from volume

接続サービス: Compute

- 10 -

Page 16: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2/{tenant_id}/os-volumes_boot POST Volumeから起動します。

Limits

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/limits GET 制限値を取得します。

Limits with project usage for administrators (limits)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/limits?tenant_id={tenant_id} GET テナントの制限値を取得します。

Networks(os-networks)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-networks GET テナント内で利用可能なネットワークの一覧を取得します。

Extensions

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/extensions GET 拡張APIの一覧を取得します。

Floating Ips

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-floating-ips GET テナントやアカウントに割当てたFloating IPアドレスの一覧を取得

します。

/v2/{tenant_id}/servers/{server_id}/action POST Floating IPアドレスを割当てます。

基本的に、NeutronのAPIの利用を推奨します。

/v2/{tenant_id}/servers/{server_id}/action POST Floating IPアドレスを解放します。

基本的に、NeutronのAPIの利用を推奨します。

Floating IP pools (os-floating-ip-pools)

接続サービス: Compute

- 11 -

Page 17: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2/{tenant_id}/os-floating-ip-pools GET floating IPプールの一覧を取得します。

Security groups

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-security-groups/{security_group_id}

GET 指定したセキュリティグループの情報を取得します。

/v2/{tenant_id}/os-security-groups GET セキュリティグループの一覧を取得します。

Quota sets (os-quota-sets)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-quota-sets/{tenant_id} GET テナントの制限値を取得します。

/v2/{tenant_id}/os-quota-sets/defaults GET テナントの制限値のデフォルト値を取得します。

Server groups (os-server-groups)

接続サービス: Compute

URI メソッド 機能

/v2/{tenant_id}/os-server-groups GET サーバグループの一覧を取得します。

/v2/{tenant_id}/os-server-groups POST サーバグループを作成します。

/v2/{tenant_id}/os-server-groups/{ServerGroup_id}

GET 指定したサーバグループの詳細情報を取得します。

/v2/{tenant_id}/os-server-groups/{ServerGroup_id}

DELETE サーバグループを削除します。

1.3 KeystoneKeystoneカテゴリについて、サブカテゴリごとに説明します。

User management functions

注意

Horizonで取得したIdentityのAPI エンドポイントを使う場合、以下とおり”v2.0”から”v3”に変更して、対象URIと合わせて使用してくだ

さい。

[Horizonから取得したAPI]

http://IPアドレス:5000/v2.0

[リクエストURLの例]

- 12 -

Page 18: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

http://IPアドレス:5000/v3/auth/tokens

接続サービス: Identity

URI メソッド 機能

/ GET すべてのAPIバージョンの詳細を表示します。

/v3 GET APIバージョンの詳細を表示します。

/v3/auth/tokens POST 認証します。

/v3/auth/tokens GET トークンの検証をします。

/v3/auth/token?nocatalog GET トークンの検証(カタログ情報なし)をします。

/v3/auth/tokens HEAD トークンの確認をします。

/v3/auth/tokens DELETE トークンの取り消しをします。

/v3/services POST サービスの追加をします。

/v3/services{?type,page,per_page} GET サービスのリストを取得します。

/v3/services/{service_id} GET 指定したサービスを取得します。

/v3/services/{service_id} PATCH 指定したサービスを更新します。

/v3/services/{service_id} DELETE 指定したサービスを削除します。

/v3/regions POST リージョンを作成します。

/v3/regions GET リージョンのリストを取得します。

/v3/regions/{region_id} GET 指定したリージョンを取得します。

/v3/regions/{region_id} PATCH 指定したリージョンを更新します。

/v3/regions/{region_id} DELETE 指定したリージョンを削除します。

/v3/endpoints POST 指定したエンドポイントを追加します。

/v3/endpoints{?interface,service_id,page,per_page} GET エンドポイントのリストを取得します。

/v3/endpoints/{endpoint_id} GET 指定したエンドポイントのリストを取得します。

/v3/endpoints/{endpoint_id} PATCH 指定したエンドポイントを更新します。

/v3/endpoints/{endpoint_id} DELETE 指定したエンドポイントを削除します。

/v3/domains{?name,enabled,page,per_page} GET ドメインのリストを取得します。

/v3/domains/{domain_id} GET 指定したドメインの詳細を取得します。

/v3/domains/{domain_id} PATCH 指定したドメインを更新します。

/v3/projects POST プロジェクトを追加します

/v3/projects{?domain_id,name,enabled,page,per_page}

GET プロジェクトのリストを取得します。

/v3/projects/{project_id} GET 指定したプロジェクトの詳細を取得します。

/v3/projects/{project_id} PATCH 指定したプロジェクトを更新します。

/v3/projects/{project_id} DELETE 指定したプロジェクトを削除します。

/v3/users POST ユーザを追加します。

/v3/users{?domain_id,email,name,enabled,page,per_page}

GET ユーザのリストを取得します。

/v3/users/{user_id} GET 指定したユーザの詳細を取得します。

/v3/users/{user_id} PATCH 指定したユーザを更新します。

/v3/users/{user_id} DELETE 指定したユーザを削除します。

- 13 -

Page 19: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v3/users/{user_id}/password POST 指定したユーザのパスワードを変更します。

/v3/users/{user_id}/groups GET ユーザのグループリストを取得します。

/v3/users/{user_id}/projects GET ユーザのプロジェクトリストを取得します。

/v3/users/{user_id}/roles{?name,project_id,domain_id}

GET ユーザのロールリストを取得します。

詳細は(注)を参照してください。

/v3/groups POST グループを追加します。

/v3/groups{?domain_id,page,per_page} GET グループのリストを取得します。

/v3/groups/{group_id} GET 指定したグループのリストを取得します。

/v3/groups/{group_id} PATCH 指定したグループを更新します。

/v3/groups/{group_id} DELETE 指定したグループを削除します。

/v3/groups/{group_id}/users{?name,page,per_page,domain_id,description,email,name,enabled,page,per_page}

GET 指定したグループのユーザリストを取得します。

/v3/groups/{group_id}/users/{user_id} PUT グループにユーザを追加します。

/v3/groups/{group_id}/users/{user_id} DELETE グループからユーザを削除します。

/v3/groups/{group_id}/users/{user_id} HEAD ユーザのグループを確認します。

/v3/credentials POST クレデンシャルを追加します。

/v3/credentials{?page,per_page} GET クレデンシャルのリストを取得します。

/v3/credentials/{credential_id} GET 指定したクレデンシャルの詳細を取得します。

/v3/credentials/{credential_id} PATCH 指定したクレデンシャルを更新します。

/v3/credentials/{credential_id} DELETE 指定したクレデンシャルを削除します。

/v3/roles POST ロールを追加します。

/v3/roles{?name,page,per_page} GET ロールのリストを取得します。

/v3/roles/{role_id} GET 指定したロールの詳細を取得します。

/v3/roles/{role_id} PATCH 指定したロールを更新します。

/v3/roles/{role_id} DELETE 指定したロールを削除します。

/v3/domains/{domain_id}/users/{user_id}/roles/{role_id}

PUT ドメインユーザにロールを付与します。

/v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}

PUT ドメイングループにロールを付与します。

/v3/domains/{domain_id}/users/{user_id}/roles GET ドメインユーザのロールのリストを取得します。

/v3/domains/{domain_id}/groups/{group_id}/roles GET ドメイングループのロールのリストを取得します。

/v3/domains/{domain_id}/users/{user_id}/roles/{role_id}

HEAD ドメインユーザのロールを確認します。

/v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}

HEAD ドメイングループのロールを確認します。

/v3/domains/{domain_id}/users/{user_id}/roles/{role_id}

DELETE ドメインユーザのロールを剥奪します。

/v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}

DELETE ドメイングループのロールを剥奪します。

/v3/projects/{project_id}/users/{user_id}/roles/{role_id}

PUT プロジェクトユーザにロールを付与します。

- 14 -

Page 20: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v3/projects/{project_id}/groups/{group_id}/roles/{role_id}

PUT プロジェクトグループにロールを付与します。

/v3/projects/{project_id}/users/{user_id}/roles GET プロジェクトユーザのロールのリストを取得します。

/v3/projects/{project_id}/groups/{group_id}/roles GET プロジェクトグループのロールのリストを取得します。

/v3/projects/{project_id}/users/{user_id}/roles/{role_id}

HEAD プロジェクトユーザのロールを確認します。

/v3/projects/{project_id}/groups/{group_id}/roles/{role_id}

HEAD プロジェクトグループのロールを確認します。

/v3/projects/{project_id}/users/{user_id}/roles/{role_id}

DELETE プロジェクトユーザのロールを剥奪します。

/v3/projects/{project_id}/groups/{group_id}/roles/{role_id}

DELETE プロジェクトグループのロールを剥奪します。

/v3/role_assignments{?group.id,role.id,scope.domain.id,scope.project.id,user.id,effective}

GET ロール割当を一覧表示します。

/v3/policies POST ポリシーを追加します。

/v3/policies{?type,page,per_page} GET ポリシーのリストを取得します。

/v3/policies/{policy_id} GET 指定したポリシーの情報を取得します。

/v3/policies/{policy_id} PATCH 指定したポリシーを更新します。

/v3/policies/{policy_id} DELETE 指定したポリシーを削除します。

/v3/OS-OAUTH1/consumers POST コンシューマーを作成します。

/v3/OS-OAUTH1/consumers GET コンシューマーのリストを取得します。

/v3/OS-OAUTH1/consumers/{consumer_id} GET 指定したコンシューマーの情報を取得します。

/v3/OS-OAUTH1/consumers/{consumer_id} PATCH 指定したコンシューマーを更新します。

/v3/OS-OAUTH1/consumers/{consumer_id} DELETE 指定したコンシューマーを削除します。

/v3/OS-OAUTH1/access_token POST アクセストークンを作成します。

/v3/OS-OAUTH1/users/{user_id}/access_tokens GET 承認されたトークンリストを取得します。

/v3/OS-OAUTH1/users/{user_id}/access_tokens/{access_token_id}

GET 承認されたアクセストークンを取得します。

/v3/OS-OAUTH1/users/{user_id}/access_tokens/{access_token_id}

DELETE アクセストークンを削除し、APIトークンの取得を防ぎます。

/v3/OS-OAUTH1/users/{user_id}/access_tokens/{access_token_id}/roles

GET アクセストークンに関連したロールリストを取得します。

/v3/OS-OAUTH1/users/{user_id}/access_tokens/{access_token_id}/roles/{role_id}

GET 指定したアクセストークンの指定したロールの情報を取得

します。

注)

詳細を以下に説明します。

[リクエストパラメーター(ヘッダー)]

名前 型 説明

X-Auth-Token String(必須)

管理ユーザの有効な認証トークン。

[リクエストパラメーター(URI)]

- 15 -

Page 21: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

名前 型 説明

{user_id} Uuid ユーザのID。

[リクエストパラメーター(ボディ)]

不要です。

[サンプルレスポンス]

[

{

"id":"--role-id--",

"name":"--role-name--",

"project_id":"--project-id--"

},

{

"domain_id":"--domain-id--",

"id":"--role-id--",

"name":"--role-name--"

}

]

[レスポンス]

正常に終了した場合に"200"を返します。

異常終了した場合、以下のエラーコードを返します。

・ 400:リクエストが不正である。

・ 401:認証が必要である。

・ 403:禁止されている。

・ 404:アイテム未検出である。

・ 405:許可されていないメソッドである。

・ 413:ペイロードが大きすぎる。

・ 503:サービス利用不可 である。

・ 400, 500, …:アイデンティティーエラーである。

Identity admin API v2.0 (STABLE)

接続サービス: Identity

URI メソッド 機能

/v2.0/tenants POST テナントを作成します。

/v2.0/tenants/{tenantId}/users{?marker,limit} GET テナントのためにすべてのユーザを一覧表示します。

/v2.0/tenants/{tenantId} DELETE テナントを削除します。

/v2.0/tenants/{tenantId} POST テナントを更新します。

1.4 GlanceGlanceカテゴリについて、サブカテゴリごとに説明します。

Image Service API v2 Images

接続サービス: Image Service

- 16 -

Page 22: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2/images POST 仮想マシンイメージを作成します。

/v2/images{?limit,marker,name,visibility,member_status,owner,status,size_min,size_max,sort_key,sort_dir,tag}

GET パブリック仮想マシンイメージを一覧表示します。

/v2/images/{image_id} GET 指定されたイメージの詳細を取得します。

/v2/images/{image_id} PATCH 指定されたイメージを更新します。

/v2/images/{image_id} DELETE 指定されたイメージを削除します。

Image Service API v2 API versions

接続サービス: Image Service

URI メソッド 機能

/ GET APIのバージョンを取得します。

Image Service API v2 Image data

接続サービス: Image Service

URI メソッド 機能

/v2/images/{image_id}/file PUT バイナリ―のイメージデータをアップロードします。

Image Service API v2 Image Members

接続サービス: Image Service

URI メソッド 機能

/v2/images/{image_id}/members POST イメージを扱うメンバーとして、テナントIDを追加します。

/v2/images/{image_id}/members GET イメージを共有しているテナントを表示します。

/v2/images/{image_id}/members/{member_id} GET 指定したイメージを扱うメンバーの詳細を取得します。

/v2/images/{image_id}/members/{member_id} DELETE 指定したイメージを扱うメンバーとして、テナントIDを削除しま

す。

/v2/images/{image_id}/members/{member_id} PUT 指定したイメージを扱うメンバーを変更します。

Image Service API v2 Image Images

接続サービス: Image Service

URI メソッド 機能

/v1/images POST イメージを登録します。

1.5 NeutronNeutronカテゴリについて、サブカテゴリごとに説明します。

- 17 -

Page 23: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Networks

接続サービス: Network

URI メソッド 機能

/v2.0/networks GET テナントがアクセスするネットワークの一覧を表示します。

/v2.0/networks POST ネットワークを作成します。

/v2.0/networks/{network_id} PUT 指定されたネットワークを更新します。

/v2.0/networks/{network_id} GET 指定されたネットワークの情報を表示します。

/v2.0/networks/{network_id} DELETE 指定されたネットワークとそれに関連付けられたリソースを削除しま

す。

Subnets

接続サービス: Network

URI メソッド 機能

/v2.0/subnets GET 指定したテナントがアクセス権を持っているサブネットの一覧を表示し

ます。

/v2.0/subnets POST 指定されたネットワーク上のサブネットを作成します。

/v2.0/subnets/{subnet_id} PUT 指定されたサブネットを更新します。

/v2.0/subnets/{subnet_id} GET 指定されたサブネットの情報を表示します。

/v2.0/subnets/{subnet_id} DELETE 指定したサブネットを削除します。

Ports

接続サービス: Network

URI メソッド 機能

/v2.0/ports GET テナントがアクセスするポートの一覧を表示します。

/v2.0/ports POST 指定されたネットワーク上のポートを作成します。

/v2.0/ports/{port_id} GET 指定したポートの情報を表示します。

/v2.0/ports/{port_id} PUT 指定されたポートを更新します。

/v2.0/ports/{port_id} DELETE 指定されたポートを削除します。

External networks (external-net)

接続サービス: Network

URI メソッド 機能

/v2.0/networks/{network_id} GET 外部ネットワーク属性を含む特定のネットワークに関する詳細情報を返し

ます。

/v2.0/networks GET そのルータの外部属性を持つネットワークのリストを返します。

- 18 -

Page 24: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Layer-3 networking

接続サービス: Network

URI メソッド 機能

/v2.0/routers POST 論理ルータを作成します。

/v2.0/routers/{router_id} GET 指定されたルータの詳細を表示します。

/v2.0/routers/{router_id} DELETE 論理ルータを削除します。

外部ゲートウェイインターフェースがある場合はそれを削除します。

/v2.0/routers/{router_id} PUT ルータの情報を更新します。

/v2.0/routers/{router_id}/add_router_interface

PUT 論理ルータへ内部インターフェースを追加します。

/v2.0/routers/{router_id}/remove_router_interface

PUT 論理ルータから内部インターフェースを削除します。

/v2.0/floatingips POST Floating IPを作成します。

ポート情報を指定した場合には、内部ポートとFloating IPを関連付けま

す。

/v2.0/floatingips/{floatingip_id} GET 指定されたFloating IPの詳細を表示します。

/v2.0/floatingips/{floatingip_id} PUT Floating IPと内部ポートとの関連付けを更新します。

/v2.0/floatingips/{floatingip_id} DELETE Floating IPが存在する場合、それに関連付けられたポートを削除しま

す。

/v2.0/routers GET テナント内でアクセス可能なルータのリストを表示します。

Security groups and rules (security-groups)

接続サービス: Network

URI メソッド 機能

/v2.0/security-groups POST ネットワークセキュリティグループを作成します。

/v2.0/security-groups/{security_group_id} GET 指定されたセキュリティグループの情報を表示します。

/v2.0/security-groups/{security_group_id} DELETE ネットワークセキュリティグループを削除します。

/v2.0/security-group-rules POST ネットワークセキュリティグループルールを作成します。

/v2.0/security-group-rules/{rules-security-groups-id}

DELETE ネットワークセキュリティグループから指定されたルールを削除します。

/v2.0/security-groups GET セキュリティグループの一覧を表示します。

/v2.0/security-group-rules GET セキュリティグループルールの一覧を表示します。

/v2.0/security-group-rules/{rules-security-groups-id}

GET セキュリティグループルールの詳細を表示します。

Virtual Private Network as a Service (VPNaaS)

接続サービス: Network

URI メソッド 機能

/v2.0/vpn/ipsecpolicies GET IPsecポリシーを一覧表示します。

/v2.0/vpn/ipsecpolicies/{ipsecpolicy-id} GET 指定されたIPsecポリシーの詳細を表示します。

/v2.0/vpn/ipsecpolicies POST IPsecポリシーを作成します。

- 19 -

Page 25: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2.0/vpn/ipsecpolicies/{ipsecpolicy-id} PUT IPsecポリシーを更新します。

/v2.0/vpn/ipsecpolicies/{ipsecpolicy-id} DELETE IPsecポリシーを削除します。

/v2.0/vpn/ipsec-siteconnections GET IPsecのサイト間の接続を一覧表示します。

/v2.0/vpn/ipsec-siteconnections/{connection-id}

GET 指定されたIPsecサイト間の接続の詳細が表示します。

/v2.0/vpn/ipsec-siteconnections POST IPsecのサイト接続を作成します。

/v2.0/vpn/ipsec-siteconnections/{connection-id}

PUT PENDING状態でないIPsecサイト間接続を更新します。

/v2.0/vpn/ipsec-siteconnections/{connection-id}

DELETE IPsecのサイト間の接続を削除します。

/v2.0/vpn/vpnservices GET VPNサービスを一覧表示します。

/v2.0/vpn/vpnservices/{service-id} GET 指定されたVPNサービスの詳細を表示します。

/v2.0/vpn/vpnservices POST VPNサービスを作成します。

/v2.0/vpn/vpnservices/{service-id} PUT PENDING状態でないVPNサービスを更新します。

/v2.0/vpn/vpnservices/{service-id} DELETE VPNサービスを削除します。

/v2.0/vpn/ikepolicies GET IKEポリシーを一覧表示します。

/v2.0/vpn/ikepolicies/{ikepolicy-id} GET 指定されたIKEポリシーの詳細を表示します。

/v2.0/vpn/ikepolicies POST IKEポリシーを作成します。

/v2.0/vpn/ikepolicies/{ikepolicy-id} PUT IKEポリシーを更新します。

/v2.0/vpn/ikepolicies/{ikepolicy-id} DELETE IKEポリシーを削除します。

Extra routes

接続サービス: Network

URI メソッド 機能

/v2.0/routers/{router_id} PUT ルーティング情報をアップデートします。

Firewall as a Service (FWaaS)

接続サービス: Network

URI メソッド 機能

/v2.0/fw/firewall_rules GET ファイアーウォールのルールを一覧表示します。

/v2.0/fw/firewall_rules/{firewall_rule-id} GET ファイアーウォールのルールの詳細を表示します。

/v2.0/fw/firewall_rules POST ファイアーウォールのルールを作成します。

/v2.0/fw/firewall_rules/{firewall_rule-id} PUT ファイアーウォールのルールを更新します。

/v2.0/fw/firewall_rules/{firewall_rule-id} DELETE ファイアーウォールのルールを削除します。

/v2.0/fw/firewall_policies GET ファイアーウォールポリシーを一覧表示します。

/v2.0/fw/firewall_policies/{firewall_policy-id} GET ファイアーウォールポリシーの詳細を表示します。

/v2.0/fw/firewall_policies POST ファイアーウォールポリシーを作成します。

/v2.0/fw/firewall_policies/{firewall_policy-id} PUT ファイアーウォールポリシーを更新します。

- 20 -

Page 26: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2.0/fw/firewall_policies/{firewall_policy-id} DELETE ファイアーウォールポリシーを削除します。

/v2.0/fw/firewall_policies/{firewall_policy-id}/insert_rule

PUT ファイアーウォールポリシーを挿入します。

/v2.0/fw/firewall_policies/{firewall_policy-id}/remove_rule

PUT ファイアーウォールポリシーを削除します。

/v2.0/fw/firewalls GET ファイアーウォールの一覧を表示します。

/v2.0/fw/firewalls/{firewall-id} GET ファイアーウォールの詳細を表示します。

/v2.0/fw/firewalls POST ファイアーウォールを作成します。

/v2.0/fw/firewalls/{firewall-id} PUT ファイアーウォールを更新します。

/v2.0/fw/firewalls/{firewall-id} DELETE ファイアーウォールを削除します。

参照

FWaaSの詳細については、以下も併せて参照してください。

http://specs.openstack.org/openstack/neutron-specs/specs/api/firewall_as_a_service__fwaas_.html

Load Balancer as a Service (LBaaS) 1.0 (STABLE)

接続サービス: Network

URI メソッド 機能

/v2.0/lb/vips GET 仮想IPを一覧表示します。

/v2.0/lb/vips POST ロードバランサーの仮想IPを作成します。

/v2.0/lb/vips/{vip_id} GET 指定された仮想IPの詳細を表示します。

/v2.0/lb/vips/{vip_id} PUT 指定されたロードバランサーの仮想IPを更新します。

/v2.0/lb/vips/{vip_id} DELETE 指定されたロードバランサーの仮想IPを削除します。

/v2.0/lb/health_monitors GET ヘルスモニターを一覧表示します。

/v2.0/lb/health_monitors POST ロードバランサーのヘルスモニターを作成します。

/v2.0/lb/health_monitors/{health_monitor_id} GET 指定されたヘルスモニターの詳細を表示します。

/v2.0/lb/health_monitors/{health_monitor_id} PUT 指定されたロードバランサーのヘルスモニターを更新します。

/v2.0/lb/health_monitors/{health_monitor_id} DELETE 指定されたロードバランサーのヘルスモニターを削除します。

/v2.0/lb/pools GET プールを一覧表示します。

/v2.0/lb/pools POST ロードバランサーのプールを作成します。

/v2.0/lb/pools/{pool_id} GET 指定されたロードバランサーのプールの詳細を表示します。

/v2.0/lb/pools/{pool_id} PUT 指定されたロードバランサーのプールを更新します。

/v2.0/lb/pools/{pool_id} DELETE 指定されたロードバランサーのプールを削除します。

/v2.0/lb/pools/{pool_id}/health_monitors POST 指定されたプールとヘルスモニターを関連付けます。

/v2.0/lb/pools/{pool_id}/health_monitors/{health_monitor_id}

DELETE プールから指定されたヘルスモニターを外します。

/v2.0/lb/members GET メンバーを一覧表示します。

/v2.0/lb/members POST ロードバランサーのメンバーを作成します。

- 21 -

Page 27: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2.0/lb/members/{member_id} GET 指定されたメンバーの詳細を表示します。

/v2.0/lb/members/{member_id} PUT 指定されたロードバランサーのメンバーを更新します。

/v2.0/lb/members/{member_id} DELETE 指定されたロードバランサーのメンバーを削除します。

1.6 SwiftSwiftカテゴリについて、サブカテゴリごとに説明します。

注意

Swiftの機能を利用する場合は、利用するユーザにadminまたはSwiftOperatorロールを設定する必要があります。

SwiftOperatorロールのみ設定されるユーザがOpenStackの一般機能も利用する場合は、adminまたは_member_ロールも合わせて設

定する必要があります。

Object Storage

接続サービス: Object Storage

URI メソッド 機能

/v1/{account}{?limit,marker,end_marker,format,prefix,delimiter}

GET 指定されたアカウントの詳細を表示し、アカウント内でコンテナを

名前でソートし、リスト表示します。

/v1/{account} POST アカウントのメタデータを作成、更新、または削除します。

/v1/{account} HEAD アカウントのメタデータを表示します。

/v1/{account}/{container}{?limit,marker,end_marker,prefix,format,delimiter,path}

GET 指定されたコンテナの詳細を表示し、コンテナ内でオブジェクトを

名前でソートし、リスト表示します。

/v1/{account}/{container} PUT コンテナを作成します。

/v1/{account}/{container} DELETE 空のコンテナを削除します。

/v1/{account}/{container} POST コンテナのカスタムメタデータを削除、作成、または更新します。

/v1/{account}/{container} HEAD コンテナに格納されたオブジェクトの数と全オブジェクトの総バイ

ト数を含めて、コンテナのメタデータを表示します。

/v1/{account}/{container}/{object}{?signature,expires,multipart-manifest}

GET オブジェクトの内容をダウンロードする、およびメタデータを取得し

ます。

詳細は(注1)を参照してください。

/v1/{account}/{container}/{object}{?multipart-manifest,signature,expires}

PUT 指定したデータの内容で新しいオブジェクトとメタデータを作成す

る、または既存のオブジェクトを指定したデータとメタデータで置

き換えます。

詳細は(注2)を参照してください。

/v1/{account}/{container}/{object} COPY オブジェクトをオブジェクトストア内の別のオブジェクトにコピーし

ます。

/v1/{account}/{container}/{object}{?multipart-manifest}

DELETE オブジェクトストアから永続的にオブジェクトを削除します。

/v1/{account}/{container}/{object}{?signature,expires}

HEAD オブジェクトのメタデータを表示します。

詳細は(注3)を参照してください。

- 22 -

Page 28: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v1/{account}/{container}/{object} POST オブジェクトのメタデータを作成または更新します。

注1)

詳細を以下に示します。

本操作によりオブジェクトメタデータをレスポンスヘッダに、オブジェクトコンテンツをレスポンスボディに返します。

ラージオブジェクトの場合、レスポンスボディはセグメントオブジェクトの連結コンテンツを含みます。

静的ラージオブジェクトの連結セグメントオブジェクトの代わりにマニフェストを取得するには、multipart-manifestクエリパラメーターを

使ってください。

[リクエストおよびレスポンスの例]

HTTP 1.1ヘッダーの定義の全体の記述については、World Wide Webコンソーシアム(W3C)のサイト( http://www.w3.org/ )の「Header Field Definitions」の説明を参照してください。

・ marktwainコンテナ配下のgoodbyeオブジェクトの詳細を示します。

curl -i $publicURL/marktwain/goodbye -X GET -H "X-Auth-Token:$token"

HTTP/1.1 200 OK

Content-Length:14

Accept-Ranges:bytes

Last-Modified:Wed, 15 Jan 2014 16:41:49 GMT

Etag:451e372e48e0f6b1114fa0724aa79fa1

X-Timestamp:1389804109.39027

X-Object-Meta-Orig-Filename:goodbyeworld.txt

Content-Type:application/octet-stream

X-Trans-Id:tx8145a190241f4cf6b05f5-0052d82a34

Date:Thu, 16 Jan 2014 18:51:32 GMT

Goodbye World!

・ janeaustenコンテナ配下にgoodbyeオブジェクトが存在しない場合の詳細を示します。

curl -i $publicURL/janeausten/goodbye -X GET -H "X-Auth-Token:$token"

HTTP/1.1 404 Not Found

Content-Length:70

Content-Type:text/html; charset=UTF-8

X-Trans-Id:tx073f7cbb850c4c99934b9-0052d82b04

Date:Thu, 16 Jan 2014 18:55:00 GMT

<html><h1>Not Found</h1><p>The resource could not be found.</p></html>

[リクエストパラメーター(ヘッダー)]

名前 型 説明

X-Auth-Token String(省略可)

認証トークン。

ヘッダーを省略した場合、アカウント所有者がACL(アクセス制御リスト)によりア

クセスを承認していない限り、ユーザのリクエストは失敗します。

X-Newest Boolean(省略可)

Trueに設定した場合、Object Storageはすべてのレプリカに問い合わせして、直

近のものを返します。

ヘッダーを省略した場合、有効なレプリカが1つ見つかると、Object Storageはよ

り速くレスポンスします。

ヘッダーをTrueに設定すると、よりバックエンドに高負荷がかかるため、確実に

必要な場合にだけ使用します。

- 23 -

Page 29: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

名前 型 説明

Range Dict(省略可)

取得するコンテンツの範囲。

1つ以上の範囲指定を使うことで、データを部分的に取得するRangeヘッダーを

使用できます。コンマで範囲の指定を区切ることで、複数の範囲を指定できま

す。

範囲指定の種類は、下記のとおりです。

・ バイト範囲指定。FIRST_BYTE_OFFSETを使って、データ範囲の開始を指

定し、LAST_BYTE_OFFSETを使って終了を指定します。

LAST_BYTE_OFFSETを省略することはできますが、省略した場合、値は

データの最後のバイトのオフセットに設定されます。

・ サフィックスバイト範囲指定。LENGTHバイトを使って、データ範囲の長さを

指定します。

下記のヘッダーの形式で、下記のデータ範囲を指定します。

・ Range:bytes=-5最後の5バイト。

・ Range:bytes=10-1510バイトオフセット以降の5バイト。

・ Range:bytes=10-15,-5最後の5バイトおよび10バイトオフセット以降の5バイトを含むマルチパート

レスポンス。

レスポンスのContent-Typeは、multipart/byterangesになります。

・ Range:bytes=4-64バイト目から6バイト目。

・ Range:bytes=2-22バイト。データの2バイト目。

・ Range:bytes=6-6バイト目以降。

・ Range:bytes=1-3,2-51バイト目から3バイト目と2バイト目から5バイト目を含むマルチパートレスポ

ンス。レスポンスのContent-Typeは、multipart/byterangesです。

If-Match Dict(省略可)

「 http://www.ietf.org/rfc/rfc2616.txt 」を参照してください。

If-None-Match String(省略可)

"Expect: 100-Continue"と組み合わせる際に、データが送られる前にサーバで

すでにコピーがあるかを問い合わせるヘッダーである"If-None-Match*"を指定

します。

If-Modified-Since Dict(省略可)

「 http://www.ietf.org/rfc/rfc2616.txt 」を参照してください。

If-Unmodified-Since Dict(省略可)

「 http://www.ietf.org/rfc/rfc2616.txt 」を参照してください。

[リクエストパラメーター(URI)]

名前 型 説明

{account} String アカウントの一意の名前。

アカウントは、プロジェクトまたはテナントとも呼ばれます。

{container} String コンテナの一意の名前。

{object} String オブジェクトの一意の名前。

- 24 -

Page 30: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

[リクエストパラメーター(クエリ)]

名前 型 説明

signature String(省略可)

temporary URLを使用して、リクエストの署名に利用します。

temporary URLの詳細については、「OpenStack Object Storage API v1Reference」を参照してください。

expires String(省略可)

temporary URLを使用して、署名の有効期限を指定します。

temporary URLの詳細については、「OpenStack Object Storage API v1Reference」を参照してください。

multipart-manifest String(省略可)

multipart-manifest=getクエリパラメーターを含み、オブジェクトがラージオブジェ

クトの場合、オブジェクトコンテンツは返されません。また、マニフェストは動的ラー

ジオブジェクトのX-Object-Manifestレスポンスヘッダ、または静的ラージオブジェ

クトのレスポンスボディに返されます。

[レスポンスパラメーター(ヘッダー)]

名前 型 説明

Content-Length String(必須)

バイト単位でのレスポンスボディのオブジェクトコンテンツの長さ。

Accept-Ranges String(必須)

オブジェクトが受け入れる範囲のタイプ。

Last-Modified String(必須)

オブジェクトが作成された日付と時刻、またはメタデータが変更された最終時

刻。

ETag String(必須)

5GBより小さいオブジェクトについては、この値はオブジェクトコンテンツのMD5チェックサムになります。値は、引用されません。

マニフェストオブジェクトについては、この値はMD5チェックサムの連結した文

字列とマニフェストの各セグメントのETagsのMD5チェックサムであり、ダウン

ロードされたコンテンツのMD5チェックサムではありません。

また、値はダブルクォートで括られた文字列です。

受け取ったとおりにレスポンスボディのMD5チェックサムを計算し、ETagヘッ

ダーの値と比較することをお勧めします。差異がある場合、コンテンツが破損

しているため、再度操作を実施してください。

Content-Type String(必須)

オブジェクトのMIMEタイプ。

Content-Encoding String(省略可)

設定した場合、Content-Encodingメタデータの値になります。

設定しない場合、この操作でこのヘッダーは返されません。

Content-Disposition String(省略可)

設定した場合、ブラウザのオーバーライドビヘイビアを指定します。

例えば、ヘッダーはデフォルトでファイルを示すためではなく、このファイルを

保存するダウンロードプログラムを使用するためのブラウザ操作を指定する可

能性があります。

設定しない場合、この操作でこのヘッダーは返されません。

X-Delete-At String(省略可)

設定した場合、オブジェクトがUNIX Epochタイムスタンプの形式でシステムに

より削除される時刻になります。

設定しない場合、この操作でこのヘッダーは返されません。

X-Object-Meta-name String(必須)

{name}がメタデータ項目の名前となる、カスタムオブジェクトメタデータ項目。

1つのX-Object-Meta-{name}レスポンスヘッダが各メタデータ項目(各{name})に表示されます。

X-Object-Manifest String(省略可)

設定した場合、動的なラージマニフェストのオブジェクトになります。

値は、container/prefix形式でセグメントオブジェクトのコンテナおよびオブジェ

クト名のプレフィックスになります。

X-Static-Large-Object Bool(必須)

オブジェクトが静的なラージマニフェストのオブジェクトの場合、Trueを設定し

ます。

- 25 -

Page 31: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

名前 型 説明

X-Trans-Id Uuid(必須)

このリクエストの一意のトランザクション識別子。

問題をレポートする場合に、サービスプロバイダがこの値を必要とする可能性

があります。

Date Datetime(必須)

トランザクションの日時。

[レスポンス]

正常に終了した場合に"200"を返します。

異常終了した場合、404(未検出)を返します。

注2)

詳細を以下に説明します。

PUT操作により、常に新規のオブジェクトを作成します。既存のオブジェクトにおける操作を利用する場合、オブジェクトを修正するの

ではなく、既存のオブジェクトとメタデータを置き換えます。引き続き、この操作では、201Created ステータスコードを返します。

この操作を使って、マニフェストオブジェクトをコピーする場合、新規のオブジェクトは通常のオブジェクトであり、マニフェストのコピー

ではありません。また、すべてのセグメントオブジェクトの連結となります。つまり、5GB以上のオブジェクトをコピーできません。

[リクエストおよびレスポンスの例]

HTTP 1.1ヘッダーの定義の全体の記述については、World Wide Webコンソーシアム(W3C)のサイト( http://www.w3.org/ )の「Header Field Definitions」の説明を参照してください。

・ オブジェクトの作成

curl -i $publicURL/janeausten/helloworld.txt -X PUT -H "Content-Length:1" -H "Content-Type:text/html; charset=UTF-8"

-H "XAuth-Token:$token"

HTTP/1.1 201 Created

Last-Modified:Fri, 17 Jan 2014 17:28:35 GMT

Content-Length:116

Etag:d41d8cd98f00b204e9800998ecf8427e

Content-Type:text/html; charset=UTF-8

X-Trans-Id:tx4d5e4f06d357462bb732f-0052d96843

Date:Fri, 17 Jan 2014 17:28:35 GMT

・ オブジェクトの置換

curl -i $publicURL/janeausten/helloworld -X PUT -H "Content-Length:0" -H "X-Auth-Token:$token"

HTTP/1.1 201 Created

Last-Modified:Fri, 17 Jan 2014 17:28:35 GMT

Content-Length:116

Etag:d41d8cd98f00b204e9800998ecf8427e

Content-Type:text/html; charset=UTF-8

X-Trans-Id:tx4d5e4f06d357462bb732f-0052d96843

Date:Fri, 17 Jan 2014 17:28:35 GMT

[リクエストパラメーター(ヘッダー)]

名前 型 説明

X-Object-Manifest String(省略可)

動的なラージマニフェストのオブジェクトを指定するために設定します。

値は、container/prefix形式でセグメントオブジェクトのコンテナおよびオブ

ジェクト名のプレフィックスになります。UTF-8エンコードした後、ヘッダーに

入れる前にコンテナおよびプレフィックスの名前をURLエンコードする必要

があります。

- 26 -

Page 32: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

名前 型 説明

X-Auth-Token String(省略可)

認証トークン。

ヘッダーを省略した場合、アカウント所有者がACL(アクセス制御リスト)によ

りアクセスを承認していない限り、ユーザのリクエストは失敗します。

Content-Length Int(省略可)

オブジェクトコンテンツの長さを指定します。

chunked transfer encodingを使用する場合、設定をしないでください。

Transfer-Encoding String(省略可)

chunked transfer encodingを有効にする場合、chunkedに設定してください。

使用する場合、Content-Length ヘッダーの値にゼロ以外の値を設定しない

でください。

Content-Type String(省略可)

オブジェクトのMIMEタイプを変更します。

X-Detect-Content-Type Boolean(省略可)

trueを設定した場合、Object Storageはファイルの拡張子を元にコンテンツ

タイプを推測し、Content-Type ヘッダーに送られた値がある場合は、その

値を無視します。

X-Copy-From String(省略可)

設定した場合、X-Copy-Fromオブジェクトをコピーすることによって新規の

オブジェクトを作成するために使用するオブジェクトの名前になります。

値は、{container}/ {object}形式です。UTF-8エンコードした後、ヘッダーに

入れる前にコンテナおよびオブジェクトの名前をURLエンコードする必要が

あります。

X-Copy-Fromと併せてPUTを使うことで、オブジェクトをコピーしてCOPY操

作を実施することと同じ効果が得られます。

ETag String(省略可)

リクエストボディのMD5チェックサム値。

例えば、オブジェクトコンテンツのMD5チェックサム値など。オブジェクトコ

ンテンツのMD5チェックサム値を計算し、リクエストに値を入れることをお勧

めします。これにより、Object Storage APIがアップロードのインテグリティを

確認できます。値は、引用されません。

Content-Disposition String(省略可)

設定した場合、ブラウザのオーバーライドビヘイビアを指定します。

例えば、ヘッダーはデフォルトでファイルを示すためではなく、このファイル

を保存するダウンロードプログラムを使用するためのブラウザ操作を指定す

る可能性があります。

Content-Encoding String(省略可)

設定した場合、Content-Encodingメタデータの値になります。

X-Delete-At Int(省略可)

オブジェクトを削除した時のUNIX Epochタイムスタンプの形式での日付。

X-Delete-After Int(省略可)

オブジェクトが削除された後、秒数を指定します。

内部的には、Object StorageシステムはX-Delete-Atメタデータ項目にこの

値を格納します。

X-Object-Meta-name String(省略可)

{name}がメタデータ項目の名前となる、コンテナメタデータ。

追加またはアップデートする各メタデータの項目(各{name})に、X-Object-Meta-{name}ヘッダーを指定してください。

If-None-Match String(省略可)

"Expect:100-Continue"と組み合わせる際に、データが送られる前にサーバ

ですでにコピーがあるかを問い合わせるヘッダーである"If-None-Match*"を指定します。

[リクエストパラメーター(URI)]

名前 型 説明

{account} String アカウントの一意の名前。アカウントは、プロジェクトまたはテナントとも呼ばれます。

{container} String コンテナの一意の名前。

{object} String オブジェクトの一意の名前。

- 27 -

Page 33: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

[リクエストパラメーター(クエリ)]

名前 型 説明

multipart-manifest

String(省略可)

multipart-manifest=putの場合、オブジェクトは静的なラージマニフェストオブジェク

トであり、ボディはマニフェストを含みます。

signature String(省略可)

temporary URLを使用して、リクエストの署名に利用します。

temporary URLの詳細については、「OpenStack Object Storage API v1 Reference」を参照してください。

expires String(省略可)

temporary URLを使用して、署名の有効期限を指定します。

temporary URLの詳細については、「OpenStack Object Storage API v1 Reference」を参照してください。

[レスポンスパラメーター(ヘッダー)]

名前 型 説明

Content-Length String(必須)

操作が成功した場合、値はゼロ(0)になります。

操作が失敗した場合、値はレスポンスボディのエラーテキストの長さになります。

ETag String(必須)

5GBより小さいオブジェクトについては、この値はアップロードしたオブジェクトコン

テンツのMD5チェックサムになります。値は、引用されません。

ETagリクエストヘッダを提供し、操作が成功した場合、同じ値になります。

ETagリクエストヘッダを提供しない場合、直近でアップロードしたオブジェクトコンテ

ンツに対してETagレスポンスヘッダを確認してください。

静的なラージオブジェクトについては、この値はMD5チェックサムの連結した文字

列とマニフェストの各セグメントのETagsのMD5チェックサムであり、アップロードされ

たコンテンツのMD5チェックサムではありません。また、値はダブルクォートで括られ

ます。動的なラージオブジェクトについては、値は空の文字列のMD5チェックサム

になります。

Content-Type String(必須)

オブジェクトのMIMEタイプ。

X-Trans-Id Uuid(必須)

このリクエストの一意のトランザクション識別子。

問題をレポートする場合に、サービスプロバイダがこの値を必要とする可能性があり

ます。

Date Datetime(必須)

トランザクションの日時。

[レスポンス]

正常に終了した場合、"201"を返します。

異常終了した場合、以下のエラーコードを返します。

- 408:タイムアウトである。

- 411:長さが必要である。

(Transfer-EncodingまたはContent-Lengthリクエストヘッダが不足している場合)

- 422:処理できないエンティティーである。 (オブジェクトストアに書き込まれたデータのMD5チェックサムがオプションETag値に一致しない場合)

注3)

詳細を以下に説明します。

Content-Lengthレスポンスヘッダがゼロでない場合、レスポンスボディを待機中のため、cURLコマンドはレスポンスヘッダをプリントした

あと停止します。Object Storageシステムは、HEAD操作のレスポンスボディを返しません。

- 28 -

Page 34: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

[リクエストおよびリクエストの例]

HTTP 1.1ヘッダーの定義の全体の記述については、World Wide Webコンソーシアム(W3C)のサイト( http://www.w3.org/ )の「Header Field Definitions」の説明を参照してください。

・ オブジェクトメタデータの表示

curl -i $publicURL/marktwain/goodbye -X HEAD -H "X-Auth-Token:$token"

HTTP/1.1 200 OK

Content-Length:14

Accept-Ranges:bytes

Last-Modified:Thu, 16 Jan 2014 21:12:31 GMT

Etag:451e372e48e0f6b1114fa0724aa79fa1

X-Timestamp:1389906751.73463

X-Object-Meta-Book:GoodbyeColumbus

Content-Type:application/octet-stream

X-Trans-Id:tx37ea34dcd1ed48ca9bc7d-0052d84b6f

Date:Thu, 16 Jan 2014 21:13:19 GMT

[リクエストパラメーター(ヘッダー)]

名前 型 説明

X-Auth-Token String(必須)

認証トークン。

X-Newest Boolean(省略可)

Trueに設定した場合、Object Storageはすべてのレプリカに問い合わせして、直近のもの

を返します。

このヘッダーを省略した場合、有効なレプリカが1つ見つかると、Object Storageはより速

くレスポンスします。ヘッダーをTrueに設定すると、よりバックエンドに高負荷がかかるた

め、確実に必要な場合にだけ使用します。

[リクエストパラメーター(URI)]

名前 型 説明

{account} String アカウントの一意の名前。

アカウントは、プロジェクトまたはテナントとも呼ばれます。

{container} String コンテナの一意の名前。

{object} String オブジェクトの一意の名前。

[リクエストパラメーター(クエリ)]

名前 型 説明

signature String(省略可)

temporary URLを使用して、リクエストの署名に利用します。

temporary URLの詳細については、「OpenStack Object Storage API v1 Reference」を参照してください。

expires String(省略可)

temporary URLを使用して、署名の有効期限を指定します。

temporary URLの詳細については、「OpenStack Object Storage API v1 Reference」を参照してください。

[レスポンスパラメーター(ヘッダー)]

名前 型 説明

Last-Modified String(必須)

オブジェクトが作成された日付、時刻またはメタデータが変更された最終時

刻。

Content-Length String(必須)

バイト単位でのレスポンスボディのオブジェクトコンテンツの長さ。

- 29 -

Page 35: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

名前 型 説明

Content-Length String(必須)

HEAD操作では、コンテンツを返しません。この操作では、Content-Lengthヘッダーの値はレスポンスボディのサイズではありません。

バイト単位のオブジェクトのサイズを含みます。

Content-Type String(必須)

オブジェクトのMIMEタイプ。

ETag String(必須)

5GBより小さいオブジェクトについては、この値はオブジェクトコンテンツの

MD5チェックサムになります。値は、引用されません。

マニフェストオブジェクトについては、この値はMD5チェックサムの連結した

文字列とマニフェストの各セグメントのETagsのMD5チェックサムであり、ダ

ウンロードされたコンテンツのMD5チェックサムではありません。

また、値はダブルクォートで括られた文字列です。

受け取ったとおりにレスポンスボディのMD5チェックサムを計算し、ETagヘッ

ダーの値と比較することをお勧めします。差異がある場合、コンテンツが破

損しているため、再度操作を実施してください。

Content-Encoding String(省略可)

設定した場合、Content-Encodingメタデータの値を返します。

設定しない場合、この操作でこのヘッダーは返されません。

Content-Disposition String(省略可)

設定した場合、ブラウザのオーバーライドビヘイビアを指定します。例えば、

ヘッダーはデフォルトでファイルを示すためではなく、このファイルを保存

するダウンロードプログラムを使用するためのブラウザ操作を指定する可能

性があります。

設定しない場合、この操作でこのヘッダーは返されません。

X-Delete-At String(省略可)

設定した場合、オブジェクトがUNIX Epochタイムスタンプの形式でシステム

により削除される時刻になります。

設定しない場合、この操作でこのヘッダーは返されません。

X-Object-Manifest String(省略可)

設定した場合、動的なラージマニフェストのオブジェクトになります。値は、

container/prefix形式でセグメントオブジェクトのコンテナおよびオブジェクト

名のプレフィックスになります。

X-Object-Meta-name String(必須)

{name}がメタデータ項目の名前となる、カスタムオブジェクトメタデータ項目。

1つのX-Object-Meta-{name}レスポンスヘッダが各メタデータ項目(各{name})に表示されます。

X-Static-Large-Object Bool(必須)

オブジェクトが静的なラージマニフェストのオブジェクトの場合、Trueを設定

します。

X-Trans-Id Uuid(必須)

このリクエストの一意のトランザクション識別子。

問題をレポートする場合に、サービスプロバイダがこの値を必要とする可能

性があります。

Date Datetime(必須)

トランザクションの日時。

[レスポンス]

正常に終了した場合、"204"を返します。

1.7 HeatHeatカテゴリについて、サブカテゴリごとに説明します。

注意

Heatの機能を利用する場合は、利用するユーザにheat_stack_ownerロールを設定する必要があります。

OpenStackの一般機能も利用する場合は、adminまたは_member_ロールも合わせて設定する必要があります。

- 30 -

Page 36: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

template service

接続サービス: Orchestration

URI メソッド 機能

/v1/{tenant_id}/stacks POST 指定したテンプレートでスタックを作成します。

(注)

/v1/{tenant_id}/stacks GET スタックのサマリ情報を一覧取得します。

/v1/{tenant_id}/stacks/{stack_name} GET 指定されたスタックのURLを取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id} GET 指定されたスタックの詳細を取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id} PUT 指定されたスタックを更新します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id} DELETE 指定されたスタックを削除します。

/v1/{tenant_id}/stacks/{stack_name}/resources GET 指定されたスタックのリソース一覧のURLを取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources

GET スタックのリソース一覧を取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}

GET 指定されたリソースのデータを取得します。

/v1/{tenant_id}/stacks/{stack_name}/events GET 指定されたスタックのイベント一覧のURLを取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/events GET スタックのイベント一覧を取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events

GET 指定されたリソースのイベント一覧を取得します。

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/template GET 指定されたスタックのテンプレートを取得します。

/v1/{tenant_id}/validate POST 指定されたテンプレートを検証します。

注)

・ AWS::AutoScaling::LaunchConfigurationでは、BlockDeviceMappingV2パラメーターが必須です。

BlockDeviceMappingsプロパティは使用できません。

[BlockDeviceMappingV2プロパティ]

名前 型 説明

BlockDeviceMappingV2 List インスタンスに接続するボリュームを定義します。

Listコンテンツとして、以下に記載するMapプロパティを指定します。

省略可能プロパティ。

[BlockDeviceMappingV2のListコンテンツで指定するMapプロパティ一覧]

名前 型 説明

destination_type String 作成するリソースの種類を指定します。volumeのみ指定可能。必須プロパティ。

boot_index String デバイスのブートオーダーを示す数字(0から連続した値)を指定します。

起動ディスクには、"0"を指定してください。必須プロパティ。

source_type String ボリュームソースの種類を指定します。"image"、"volume", "snapshot"のどれかを

指定します。必須プロパティ。

delete_on_termination Boolean インスタンスの終了時に、ボリュームを削除するかどうかを"True"または"False"で指定します。省略可能プロパティ。デフォルト値はFalse。・"True"を指定した場合、スケールアウトおよびスタック作成時に作成されたボリュー

ムは、スケールインおよびスタック削除時に削除されます。ただし、スナップショッ

トが採取されているボリュームは、削除されません。

・"False"を指定した場合、スケールインおよびスタック削除時にボリュームを削除

- 31 -

Page 37: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

名前 型 説明

しません。インスタンスの削除後もボリュームの内容を保持したい場合は、"False"を指定してください。

volume_size String ボリュームサイズをGB単位で指定します。省略可能プロパティ。

・source_typeに"image"を指定した場合は、必ず指定してください。使用するイメー

ジのmin_diskパラメーター以上の値を指定してください。なお、使用するイメージ

のmin_diskパラメーターが0、または値がない場合、イメージの提供元に最小サイ

ズを確認し、指定してください。

・source_typeに"volume"を指定した場合、本パラメーターは無効です。

・source_typeに"snapshot"を指定した場合、本パラメーターを省略すると、スナッ

プショット採取元のボリュームサイズとなります。

uuid String source_typeに指定したリソースのuuid。必須プロパティ。

device_name String 作成するインスタンスのシステム上でボリュームに付与されるデバイス名を/dev/vdxの形式で指定します。必須プロパティ。

/dev/vdまでは固定値、xにはデバイス名として有効な文字を指定してください。作

成するインスタンスに複数のボリュームを割当てる場合、起動ディスクには、すべ

てのボリュームのデバイス名のうち優先度が最も高い文字を指定してください。優

先度は「a > b > c > ...」の順です。

[記述例]

type: AWS::AutoScaling::LaunchConfiguration

properties:

BlockDeviceMappingV2: [

{ device_name: '/dev/vda',

boot_index: '0',

source_type: 'image',

destination_type: 'volume',

volume_size: '20',

uuid: '6cbf9710-87e3-4a36-8116-9b3396882621',

delete_on_termination: true }

]

・ インスタンス名の命名規約は、以下のとおりです。以下の組み合わせで生成されます。最大53文字です。

- スタック名

- AutoScalingGroupのリソース名

- ハイフン

- 12文字のID(ランダム)

[生成ルール]

1. "スタック名" + "-" + "AutoScalingGroupのリソース名" + "-" + "ランダムID(12文字)" + "-" + "ランダムID(12文字)" + "-" + "ランダムID(12文字)"

2. 1.の名前が53文字を超える場合(スタック名とAutoScalingGroupのリソース名の文字数合計が13文字を超える場合)

"2文字" + "-" + "11文字" + "-" + "ランダムID(12文字)" + "-" + "ランダムID(12文字)" + "-" + "ランダムID(12文字)"

^^^^^^^^^^^^^^^^^^^^^^^^

「"スタック名" + "-" + "AutoScalingGroupのリソース名"」 の "先頭2文字" + "-" + "末尾11文字"

例)

au-aling_group-knu4eeueo2c5-cyrtttd6lwbu-xsge7xcbkxum

2 <----11---> <----12----> <----12----> <----12---->

<----------------------53--------------------------->

- 32 -

Page 38: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Autoscale

接続サービス: Orchestration

URI メソッド 機能

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/signal

POST リソースにシグナルを送ります。

接続サービス: Autoscale

注意

Autoscaleの接続先エンドポイントは、以下のとおりです。

http://<サービスLANのIPアドレス>:43461

URI メソッド 機能

/autoscale_schedulers POST スケジュールを登録します。

富士通独自のAPI。詳細は(注1)を参照してください。

/autoscale_schedulers/{name} DELETE スケジュールを削除します。

富士通独自のAPI。詳細は(注2)を参照してください。

/autoscale_schedulers GET スケジュールの一覧を取得します。

富士通独自のAPI。詳細は(注3)を参照してください。

注1) 詳細を以下に説明します。

[リクエストパラメーター(ボディ)]

名前 型 説明

name String 名前は、リージョン内の全テナントで一意です。

半角英数字で構成される64文字以内で指定します。大文字小文字は区別されます。

method String POSTを指定します。

url String スタック内のScalingPolicyリソースに対してシグナルを送るAPIのURLを記載します。

詳細は、サブカテゴリAutoscaleのAPI一覧を参照してください。

URLスキームは、httpを指定してください。

time String REST APIを実行する日時を指定します。

書式は、cronコマンドに準拠します。

project_id String スケジュール処理を実行するプロジェクトIDを指定します。

[サンプルリクエスト]

{

"name": "sample2",

"time": "*/5 * * * *",

"url":"http://host1:8004/v1/2801e5de00d142a388b17b65256f7ad4/stacks/s1_step2/0ffc2720-a7ba-4e0f-8ca6-82142f14f6eb/

resources/web_server_scaleup_policy/signal",

"method":"POST",

"project_id":"2801e5de00d142a388b17b65256f7ad4"

}

[レスポンス]

正常に終了した場合に"200"を返します。

- 33 -

Page 39: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

異常終了した場合、以下のエラーコードを返します。

- 400: リクエストが不正である。

- 401: 認証が必要である。

- 403: 禁止されている。サイズの変更できない。

- 404: 未検出である。

- 405: 許可されていないメソッドを使用した。

- 409: 要求が矛盾している。

- 413: 大きすぎる。

- 415: サポートしていないメディアタイプである。

- 501: 実装されていない。

- 503: サービスが利用できない。

- 500または上記以外: クラウドサーバにエラーが発生した。

[サンプルレスポンス]

{

"name":"sample2",

"method":"POST",

"url":"http://192.168.3.104:8004/v1/2801e5de00d142a388b17b65256f7ad4/stacks/s1_step2/0ffc2720-

a7ba-4e0f-8ca6-82142f14f6eb/resources/web_server_scaleup_policy/signal",

"time":"*/5 * * * *",

"project_id":"2801e5de00d142a388b17b65256f7ad4"

}

注2) 詳細を以下に説明します。

[リクエストパラメーター(URI)]

名前 型 説明

name String スケジュールを識別するための名前を指定します。

名前は、リージョン内の全テナントで一意です。

半角英数字で構成される64文字以内で指定します。大文字小文字は区別されます。

[レスポンス]

正常に終了した場合に"204"を返します。

異常終了した場合、以下のエラーコードを返します。

- 400: リクエストが不正である。

- 401: 認証が必要である。

- 403: 禁止されている。サイズの変更できない。

- 404: 未検出である。

- 405: 許可されていないメソッドを使用した。

- 409: 要求が矛盾している。

- 413: 大きすぎる。

- 415: サポートしていないメディアタイプである。

- 501: 実装されていない。

- 503: サービスが利用できない。

- 34 -

Page 40: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

- 500または上記以外: クラウドサーバにエラーが発生した。

注3) 詳細を以下に説明します。

[リクエストパラメーター]

不要です。

[レスポンス]

正常に終了した場合に"200"を返します。

異常終了した場合、以下のエラーコードを返します。

- 400: リクエストが不正である。

- 401: 認証が必要である。

- 403: 禁止されている。サイズの変更できない。

- 404: 未検出である。

- 405: 許可されていないメソッドを使用した。

- 409: 要求が矛盾している。

- 413: 大きすぎる。

- 415: サポートしていないメディアタイプである。

- 501: 実装されていない。

- 503: サービスが利用できない。

- 500または上記以外: クラウドサーバにエラーが発生した。

[サンプルレスポンス]

{

"schedulers":[

{

"name":"sample2",

"time":"*/5 * * * *",

"method":"POST",

"url":"http://192.168.3.104:8004/v1/2801e5de00d142a388b17b65256f7ad4/stacks/s1_step2/0ffc2720-

a7ba-4e0f-8ca6-82142f14f6eb/resources/web_server_scaleup_policy/signal",

"project_id":"2801e5de00d142a388b17b65256f7ad4"

}

]

1.8 CeilometerCeilometerカテゴリについて、サブカテゴリごとに説明します。

Ceilometerの詳細は、以下を参照してください。

・ http://docs.openstack.org/developer/aodh/webapi/v2.html

・ http://docs.openstack.org/developer/ceilometer/webapi/v2.html

Resources

接続サービス: Telemetry

URI メソッド 機能

/v2/resources GET 指定されたクエリに基づいて、すべてのリソースの情報を取得します。

- 35 -

Page 41: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

URI メソッド 機能

/v2/resources/(resource_id) GET 指定されたリソースの情報を取得します。

Monitoring items

接続サービス: Telemetry

URI メソッド 機能

/v2/meters GET 指定されたクエリに基づいて、すべての監視項目を取得します。

/v2/meters/(meter_name) GET 指定された監視項目のサンプルを取得します。

/v2/meters/(meter_name) POST 新しいサンプルを登録します。

/v2/meters/(meter_name)/statistics GET 指定された期間内サンプルの統計値を取得します。

Function list

接続サービス: Telemetry

URI メソッド 機能

/v2/capabilities GET APIとストレージの機能一覧を表示します。

Alarms

接続サービス: Telemetry

URI メソッド 機能

/v2/alarms GET 指定されたクエリに基づいて、すべてのアラームを取得します。

/v2/alarms POST 新しいアラームを登録します。

/v2/alarms/{alarm_id} GET 指定したアラームの詳細を取得します。

/v2/alarms/{alarm_id} PUT 既存のアラームの内容を変更します。

/v2/alarms/{alarm_id} DELETE 指定したアラームを削除します。

Alarm status

接続サービス: Telemetry

URI メソッド 機能

/v2/alarms/{alarm_id}/state GET 指定されたアラームの状態を取得します。

/v2/alarms/{alarm_id}/state PUT 指定されたアラームの状態を設定します。

Alarm history

接続サービス: Telemetry

URI メソッド 機能

/v2/alarms/{alarm_id}/history GET 指定されたクエリに基づいて、アラーム履歴を取得します。

- 36 -

Page 42: リファレンスガイド(API - 富士通のソフトウェア : …software.fujitsu.com/jp/manual/manualfiles/m160000/j2x...FUJITSU Software ServerView Resource Orchestrator Standard

Queries

接続サービス: Telemetry

URI メソッド 機能

/v2/query/samples POST 複雑なクエリでサンプルを取得します。

/v2/query/alarms POST 複雑なクエリでアラームを取得します。

/v2/query/alarms/history POST 複雑なクエリでアラーム履歴を取得します。

- 37 -