Cisco UCS Invicta API ガイド バージョン 1.6
概要
概要
発行日;2015/02/18 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 955KB) | フィードバック

目次

概要

API の構造

API のバージョン

JSON

cURL の例

API のアクセス/権限

サポートされる HTTP メソッド

サポートされる着信データ形式

概要

API の構造

このマニュアルでは、Cisco UCS Invicta シリーズ ソリッド ステート システムを維持し、操作する際に使用できる、アプリケーション プログラミング インターフェイス(API)とそのすべてのプロパティについて説明します。

Cisco UCS Invicta シリーズ ソリッド ステート システムの API は、RESTful Web サービスとして設計され、実装されました。すべての API メソッドは、次の部分で構成される URL を使用して、HTTPS 要求によりアクセス可能です。

ドメイン:Cisco UCS Invicta シリーズ ソリッド ステート システムの IP

URI:/restapi/<API_version>/<token>/<methodName>/<URI_reminder>

URI リマインダは必須でない場合もありますが、PUT または DELETE で要求されるメソッドには必須です。

API のバージョン

URI での <API_version>(例:16)は、一貫した API サポートと互換性を維持するために重要です。今後の API メソッドの機能拡張および更新が実装されると、以前のバージョンのサポートが利用可能になります。すべての拡張機能や変更は、新しい API のバージョン番号で使用できますが、各 API メソッドは、リリースされたバージョンで、その署名および応答データ構造を維持します。

<token> URI 要素は、API の不正使用から基本レベルで保護するためのセキュリティ手段として追加されています。詳細については、認証メソッドの章を参照してください。

JSON

入力で必要なデータ エンベロープ(POST および PUT 要求の未加工データ)は、JSON オブジェクト表記ラベル付きデータです。

応答オブジェクトの構造は、envelope_version、status、message、および data で構成されています。返すデータがない場合、データ部分は空になる可能性があることに注意してください。

検索する API メソッドの呼び出しに続く JSON の未加工文字列の出力例は次のとおりです。

{"status":1,"message":"OK","data":{"unitName":"devMachine","apiVersions":["15","16"]},"envelope_version":"15"}

cURL の例

cURL を使用する場合は、次の例に従ってください。<ip_address> および <token> のエンティティは、実際の IP アドレスおよびトークンで置き換えることに注意してください。

GET

curl -k -X GET --url https://<ip_address>/restapi/16/<token>/raidshealth -H "Accept: application/json"

POST

curl -X POST -d data='{"name":"lun1","vg":"ssd1","size":2,"striping":true}' -k --url https://<ip_address>/restapi/16/<token>/lun -H "Accept: application/json"

PUT

curl -X PUT -d data='{"size":3}' -k --url https://<ip_address>/restapi/16/<token>/lun/lun1 -H "Accept: application/json"

DELETE

curl -X DELETE -d data='{"name":"bond0:1"}' -k --url https://<ip_address>/restapi/16/<token>/virtualinterface/0 -H "Accept: application/json"

API のアクセス/権限

ユーザ アカウントは、API アクセス権限が付与されている役割に割り当てる必要があります。それぞれの API メソッドの権限は、UI でユーザに割り当てたロールとその関連の権限に依存し、直接関連します。たとえば、UI で、ユーザが LUN 設定ページにアクセスする権限のある役割に割り当てられない場合、そのユーザは、LUN 設定の API メソッドに関連するどの LUN 設定にもアクセスできません。同様に、UI で、ユーザに LUN の追加と編集の権限がある役割が割り当てられても、LUN の削除権限がない場合、同じ制限が API に適用されます。

サポートされる HTTP メソッド

バージョン
GET /list
POST
PUT
DELETE

1.5

X

X

X

X

1.6

X

X

X

X

サポートされる着信データ形式

バージョン
JSON
XML

1.5

X

1.6

X