每个服务都有一个作为统一资源标识符 (Uniform Resource Identifier, URI) 的一部分、用于访问服务的版本号。版本有主要版本号和次要版本号。请求必须提供主要版本号,但次要版本号是可选的,如果未提供次要版本号,则默认值为 "0"。请求中的主要版本号必须与服务的主要版本号匹配。请求中的次要版本号必须与服务的次要版本号匹配。
示例:客户机针对版本号为 "2.1" 的服务提出了一些请求。
|
更改以下属性时,无需更改任何服务 API 版本。必须使用设备版本号和型号来确定哪些属性可用。这些属性发生更改时,也会反映到 CLI 和 BUI 中,这些属性也可作为设备实例功能的指示。
新的输出属性(不会删除旧属性)。
在现有命令中添加的新的输入属性,这些属性具有默认值,以使此命令执行其先前版本中所执行的操作。
由于新版本的向后兼容命令可以返回其他属性,因此应对客户机进行编码以忽略新属性。如果对服务 API 进行向后兼容的更改,则次要版本号将递增。
向现有服务添加新命令。
向服务命令添加新的查询参数。
如果对服务 API 进行不兼容的更改,则主要版本号将递增。
删除命令查询参数。
从现有服务中删除命令。
设备软件的主要版本可能包括不兼容的版本更改。执行主要更新期间,给定服务可能有也可能没有较早的版本。每个命令响应都必须包含 HTTP 头和给定模块的设备 API 的当前版本:
X-Zfssa-Nas-Api: 1.1