REST API 呼び出し

ztC Edge システムは以下の Representational State Transfer (REST) アプリケーション プログラム インタフェース (API) 呼び出しをサポートしています。

login

リソース情報へのアクセスのためのログイン情報をポストします。この認証呼び出しによって、不正なユーザがシステムにアクセスするのを未然に防ぎます。最初にこの呼び出しを実行し、応答 JSON 文字列から session-id をコピーして、この値をそれ以降の呼び出しのヘッダで JSESSIONID として使用します。
ヘッダ 値 必須
Content-type application/json はい
要求 値 必須
Username ztC コンソールにログオンするためのユーザ名 はい
Password ユーザ名のパスワード。 はい

エンドポイント

次は /restapi のベース URL を指定された場合のエンドポイントです。

POST /login

例

要求 URL:

https://{hostname or IP address}/restapi/login

overview

物理マシンのプロパティ、統計、システム パフォーマンス、現在のアラート リストなどを含むシステム情報を取得します。多量 (約 14 KB) の情報が返されることがあります。
ヘッダ 値 必須
Locale de (ドイツ語)、en-US (英語)、ja (日本語)、zh-CN (中国語)、または pt-br (ポルトガル語)。デフォルトのロケールは en-US です。 いいえ
Content-type application/json はい

エンドポイント

GET /system/overview

例

要求 URL:

https://{hostname or IP address}/restapi/system/overview

vms

システム内に存在する VM のリストを取得します。

ヘッダ 値 必須
JSESSIONID login 呼び出しの応答にある session-id の値 はい
Content-type application/json はい

エンドポイント

GET /v1/vms

例

要求 URL:

https://{hostname or IP address}/restapi/v1/vms