各 RESTful API サービスは、サービスにアクセスするための URI (Uniform Resource Identifier) の一部としてバージョン番号を持ちます。このバージョンにはメジャー番号とマイナー番号があります。リクエストではメジャーバージョン番号を指定する必要がありますが、マイナーバージョン番号はオプションで、指定しない場合は、デフォルトで 0 の値に設定されます。メジャー番号はサービスのメジャー番号と一致する必要があります。マイナー番号はサービスのマイナー番号以下である必要があります。
たとえば、次の表は、バージョン 2.1 が動作しているサービスをクライアントがリクエストする場合、指定されたバージョンをクライアントのリクエストで使用できるかどうかを示しています。
|
次のプロパティーの変更には、サービスの API バージョンの変更は必要ありません。使用可能なプロパティーを判断するために、アプライアンスのバージョン番号とモデルを使用する必要があります。これらのプロパティーの変更は、CLI および BUI にも反映され、そのアプライアンスインスタンスの機能を示します。
新しい出力プロパティー (古いプロパティーの削除なし)。
既存のコマンドに追加された、コマンドに以前のバージョンと同じ動作をさせるデフォルト値を持つ新しい入力プロパティー。
下位互換性のあるコマンドの新しいバージョンでは、追加のプロパティーを返すことができるため、クライアントは新しいプロパティーを無視するようにコーディングしてください。マイナー番号は、サービス API への下位互換性のある変更に対して増分されます。
既存のサービスに新しいコマンドを追加する。
サービスのコマンドに新しい問合せパラメータを追加する。
メジャー番号は、サービス API への互換性のない変更に対して増分されます。
コマンド問合せパラメータの削除。
既存のサービスからのコマンドの削除。
アプライアンスソフトウェアのメジャーリリースには、互換性のないバージョンの変更が含まれることがあります。メジャー更新時には、指定されたサービスの古いバージョンが存在する場合と存在しない場合があります。各コマンドの応答には、指定されたモジュールに対応するアプライアンス API の現在のバージョンを含めた HTTP ヘッダーを含める必要があります。
X-Zfssa-Nas-Api: 1.1