OceanStor Dorado 6.1.0 REST接口参考
本文档介绍华为 OceanStor DeviceManager RESTful APIs的概念、架构、开发准备、接 口参考并提供了示例代码,第三方应用系统可基于此文档开发面向华为统一存储的基 于DeviceManager RESTful APIs的应用。
OceanStor-Dorado-V6.1.0(2021-01-18发布)
相对于OceanStor-Dorado-V6.1.0(2020-10-30发布)版本,2021年01月18日发布的OceanStor-Dorado-V6.1.0 REST接口的变化点如下表。
本文档涉及到的接口名称 |
主要差异点 |
接口差异点对比详情 |
---|---|---|
修改域认证服务器配置 |
接口功能及文档描述 |
修改BINDPASSWD的参数类型为必选 |
测试域认证服务器配置 |
接口功能及文档描述 |
将参数bindPassword修改为BINDPASSWD,参数类型为必选 |
创建用户 |
接口功能及文档描述 |
新增返回字段: authenticateFactor、LOGINMETHODLIST、isPasswordNeverExpire、EMAIL 新增参数NAME的取值范围:不能以空格开头或结尾,不支持问号,单双引号,井号,星号,冒号,左右圆括 |
查询绑定端口信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 |
查询双活域信息 |
接口功能及文档描述 |
修改参数DESCRIPTION由返回修改为条件返回 |
批量查询IP链路信息 |
接口功能及文档描述 |
删除参数:LOCALPORTID、REMOTEPORTID、BANDWIDTHLIMITUNIT、BANDWIDTHLIMITUTILIZATION、BANDWIDTHLIMITSIZE |
查询IP链路信息 |
接口功能及文档描述 |
删除参数:REMOTEPORTID、BANDWIDTHLIMITUNIT、BANDWIDTHLIMITUTILIZATION、BANDWIDTHLIMITSIZE |
测试NIS域服务器地址 |
接口功能及文档描述 |
新增参数controller 新增产品型号 |
(不推荐使用)查询映射视图个数 |
接口功能及文档描述 |
高危提示添加为否 新增参数filter的支持返回字段:hostName,lunGroupName,portGroupName,hostGroupName。 |
(不推荐使用)批量查询映射视图 |
接口功能及文档描述 |
高危提示添加为否 新增参数filter的支持返回字段:hostName,lunGroupName,portGroupName,hostGroupName。 |
从快照一致性组中移除快照 |
接口功能及文档描述 |
告警ID由0xF000B71修改为0xF001B3D |
创建SmartQoS策略关联 |
接口功能及文档描述 |
新增参数subType |
解除SmartQoS策略关联 |
接口功能及文档描述 |
新增参数subType |
创建SmartQoS策略 |
接口功能及文档描述 |
新增参数subType |
修改SmartQoS策略 |
接口功能及文档描述 |
新增参数subType |
批量查询VLAN信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 |
查询VLAN信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 |
修改文件系统快照 |
接口功能及文档描述 |
删除接口 |
删除SmartQoS |
接口功能及文档描述 |
新增参数subType |
激活SmartQoS |
接口功能及文档描述 |
新增参数subType |
取消激活SmartQoS |
接口功能及文档描述 |
新增参数subType |
批量查询双活Pair |
接口功能及文档描述 |
参数REMOTEHOSTACCESSSTATE新增枚举值:5:未知 |
测试AD域全域名 |
接口功能及文档描述 |
新增参数controller 新增产品型号 |
关联查询双活Pair |
接口功能及文档描述 |
参数REMOTEHOSTACCESSSTATE新增枚举值:5:未知 |
添加USM用户 |
接口功能及文档描述 |
新增高危提示0xF00F207 |
修改USM用户信息 |
接口功能及文档描述 |
新增高危提示0xF00F208 |
查询双活Pair |
接口功能及文档描述 |
参数REMOTEHOSTACCESSSTATE新增枚举值:5:未知 |
创建绑定端口 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 |
测试NAS业务DNS服务器连通性 |
接口功能及文档描述 |
新增产品型号:Dorado 3000 V6、Dorado 5300 V6 新增参数controller |
批量查询绑定端口信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 |
lun扩容复制预检查 |
接口功能及文档描述 |
参数expandRemote、expandLocal的新增枚举值: 4:该lun所属复制特性支持lun迁移,不允许执行。 |
删除LUN |
接口功能及文档描述 |
修改参数isDelayDelete的默认值为随回收站策略开关 |
创建文件系统快照 |
接口功能及文档描述 |
参数NAME取值范围修改:只支持字母、数字、“_”、“-”。 参数PARENTNAME取值范围修改:只能包含字母,数字,下划线和多国语言字符 |
创建逻辑端口 |
接口功能及文档描述 |
参数ROLE的新增枚举值:4:复制 |
查询逻辑端口信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS的新增枚举值:33:待恢复 参数ROLE的新增枚举值:4:复制 |
查询CIFS服务设置 |
接口功能及文档描述 |
新增参数: enableSMB2ForDCConnections、SMBGLOBALCAENABLE |
修改CIFS服务 |
接口功能及文档描述 |
新增参数: enableSMB2ForDCConnections、SMBGLOBALCAENABLE |
创建双活Pair |
接口功能及文档描述 |
新增参数ISISOLATION的默认值false 删除错误码:50334234、50334251、50334236 |
创建双活一致性组 |
接口功能及文档描述 |
新增参数ISISOLATION的默认值false 新增参数ISISOLATIONTHRESHOLDTIME的默认值200 删除错误码:50334235、50334236、50334234 |
查询升级过程详细信息 |
接口功能及文档描述 |
将参数CMO_QUERY_TYPE由可选修改为必选 |
执行升级流程 |
接口功能及文档描述 |
新增可选参数:CMO_EXE_APOLLO_VER |
修改安全策略 |
接口功能及文档描述 |
新增可选参数:isSessionBindToIP |
查询安全策略 |
接口功能及文档描述 |
新增可选参数:isSessionBindToIP |
(不推荐使用)创建硬盘域 |
接口功能及文档描述 |
新增返回字段:FORMATPROGRESS、FREECAPACITYLIST、TIER0RAIDLV、 SCMHOTSPARESTRATEGY、FORMATREMAINTIME |
执行升级检查 |
接口功能及文档描述 |
参数checkType和checkCMD由可选修改为必选 |
创建快照一致性组 |
接口功能及文档描述 |
参数PARENTID和PARENTNAME的返回字段解释由LUN一致性组修改为保护组 |
创建LUN克隆 |
接口功能及文档描述 |
新增参数WORKLOADTYPEID的取值范围 修改参数说明 |
创建LUN |
接口功能及文档描述 |
新增参数WORKLOADTYPEID的取值范围 修改参数说明 |
创建存储池 |
接口功能及文档描述 |
参数disks取值范围修改为: "all":true,使用所有盘创建存储池 "byNumber":按数量创建存储池 "byId":按盘id创建存储池 |
创建配额 |
接口功能及文档描述 |
参数DOMAINTYPE由条件必选修改为可选,参数新增枚举值:0、本地 新增可选参数NAMETYPE |
修改主机组 |
接口功能及文档描述 |
删除错误码1077949103 |
修改LUN组 |
接口功能及文档描述 |
删除错误码1077936853 |
创建LUN组 |
接口功能及文档描述 |
删除错误码1077936853 |
修改端口组 |
接口功能及文档描述 |
删除错误码1077949103 |
创建端口组 |
接口功能及文档描述 |
删除错误码1077949103 |
创建远程复制一致性组 |
接口功能及文档描述 |
参数RECOVERYPOLICY新增默认值为1:自动 参数REPLICATIONMODEL新增默认值为2:异步 参数TIMINGVAL由返回修改为条件返回 参数TIMINGVALINSEC由返回修改为条件返回 |
查询远程复制一致性组 |
接口功能及文档描述 |
返回字段Bandwidth修改为bandwidth 参数TIMINGVAL由返回修改为条件返回 参数TIMINGVALINSEC由返回修改为条件返回 |
修改远程复制一致性组 |
接口功能及文档描述 |
新增备注信息 |
批量查询远程复制一致性组 |
接口功能及文档描述 |
参数TIMINGVAL由返回修改为条件返回 参数TIMINGVALINSEC由返回修改为条件返回 |
删除远程复制一致性组 |
接口功能及文档描述 |
新增错误码1077937968 |
创建远程复制Pair |
接口功能及文档描述 |
新增返回字段:switchToAsync、switchToSync 参数userSnapRetentionNum由条件可选修改为条件必选 参数copySnapRetentionNum由条件可选修改为条件必选 参数SYNCHRONIZETYPE、DRRINGID、vstoreId、vstoreName由返回修改为条件返回,并修改备注 |
查询远程复制Pair |
接口功能及文档描述 |
参数SYNCHRONIZETYPE、vstoreId、vstoreName由返回修改为条件返回,并修改备注 |
批量查询远程复制Pair |
接口功能及文档描述 |
参数SYNCHRONIZETYPE由返回修改为条件返回,并修改备注 |
关联查询远程复制pair |
接口功能及文档描述 |
参数SYNCHRONIZETYPE由返回修改为条件返回,并修改备注 |
修改远程复制Pair |
接口功能及文档描述 |
参数vstoreId由条件可选修改为条件必选 |
远程复制pair复制模式转换 |
接口功能及文档描述 |
修改执行实例 修改参数名字为大写字母:ID、TYPE、REPLICATIONMODEL 新增错误码50331651 |
删除远程复制Pair |
接口功能及文档描述 |
新增错误码1077937947 |
批量查询双活一致性组 |
接口功能及文档描述 |
参数ISISOLATIONTHRESHOLDTIME新增备注 |
批量查询双活域信息 |
接口功能及文档描述 |
参数STANDBYCPSID、 STANDBYCPSNAME修改备注 |
查询快照一致性组 |
接口功能及文档描述 |
参数PARENTID、PARENTNAME修改返回字段解释 |
批量查询快照一致性组信息 |
接口功能及文档描述 |
参数PARENTID、PARENTNAME修改返回字段解释 |
关联查询快照一致性组 |
接口功能及文档描述 |
参数 ASSOCIATEOBJTYPE、PARENTID、PARENTNAME修改返回字段解释 |
创建主机 |
接口功能及文档描述 |
删除错误码1077949103 |
查询配额信息 |
接口功能及文档描述 |
删除参数USRGRPNAMETYPE、vstoreName 新增参数NAMETYPE |
创建仲裁服务器链路 |
接口功能及文档描述 |
参数lifPortName新增类型为可选及备注信息 |
批量查询远端设备信息 |
接口功能及文档描述 |
删除返回字段REMOTEUSERNAME |
创建文件系统 |
接口功能及文档描述 |
参数workloadTypeId取值范围修改:0~2048 修改参数ENABLETIMINGSNAPSHOT、 ENABLECOMPRESSION的说明信息 |
通过ID修改dtree |
接口功能及文档描述 |
参数securityStyle、unixPermissions由可选修改为条件必选 参数PARENTID、PARENTNAME由条件必选修改为可选 |
通过名称修改dtree |
接口功能及文档描述 |
参数NAME由必选修改为条件必选 参数securityStyle、unixPermissions由可选修改为条件必选 删除参数newName 新增参数oldName |
通过名称修改文件系统快照 |
接口功能及文档描述 |
参数NAME的参数取值范围删除中文字符 |
批量查询配额信息 |
接口功能及文档描述 |
删除参数USRGRPNAMETYPE、vstoreName 新增参数NAMETYPE 参数USRGRPTYPE取值范围修改: 1:本地用户和本地用户组 2:域用户和域用户组 |
修改主机 |
接口功能及文档描述 |
删除错误码1077949103 |
创建克隆Pair |
接口功能及文档描述 |
参数workloadTypeId取值范围修改:0~2048 |
重建克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
修改克隆Pair对象属性 |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
同步克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
反向同步克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
删除克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
查询克隆Pair个数 |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
查询克隆Pair信息 |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
批量查询克隆Pair信息 |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
关联查询克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
查询保护组与克隆组差异Pair信息 |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
查询保护组与克隆组差异Pair个数 |
接口功能及文档描述 |
所属对象由HYPER_COPY修改为HYPER_CLONE |
查询克隆一致性组 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
修改克隆一致性组 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
创建克隆一致性组 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
批量查询克隆一致性组信息 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
删除克隆一致性组 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
查询克隆一致性组个数 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
反向同步克隆一致性组 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
同步克隆一致性组 |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
往克隆一致性组中添加克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
从克隆一致性组中移除克隆Pair |
接口功能及文档描述 |
所属对象由HYPER_COPY_CONSISTENCY_GROUP修改为HYPER_CLONE_CONSISTENCY_GROUP |
创建VLAN信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS的新增枚举值:33:待恢复 |
关联查询绑定端口信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS的新增枚举值:33:待恢复 |
关联查询VLAN信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS的新增枚举值:33:待恢复 |
删除应用类型 |
接口功能及文档描述 |
新增参数ID的取值范围:16至1024 |
查询存储池数据信息 |
接口功能及文档描述 |
新增返回字段lunSpaceReductionRate、fsSpaceReductionRate |
查询定时HyperCDP计划的具体信息 |
接口功能及文档描述 |
新增参数vstoreName |
批量查询定时HyperCDP计划的具体信息 |
接口功能及文档描述 |
新增参数vstoreName |
关联查询逻辑端口信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 参数ROLE新增枚举值:4:复制 |
批量查询逻辑端口信息 |
接口功能及文档描述 |
参数RUNNINGSTATUS新增枚举值:33:待恢复 参数ROLE新增枚举值:4:复制 |
批量查询存储池信息 |
接口功能及文档描述 |
新增返回字段lunSpaceReductionRate、fsSpaceReductionRate |
创建应用类型 |
接口功能及文档描述 |
新增参数ID的取值范围:16至1024 |
查询应用类型 |
接口功能及文档描述 |
新增参数ID的取值范围:0至2048 新增参数BLOCKSIZE的备注信息 |
修改应用类型 |
接口功能及文档描述 |
新增参数ID的取值范围:16至1024 |
批量查询应用类型 |
接口功能及文档描述 |
新增参数ID的取值范围:0至2048 新增参数BLOCKSIZE的备注信息 |
查询存储池信息 |
接口功能及文档描述 |
新增返回字段lunSpaceReductionRate、fsSpaceReductionRate |
查询双活一致性组 |
接口功能及文档描述 |
新增参数ISISOLATIONTHRESHOLDTIME的备注信息 |
删除双活一致性组 |
接口功能及文档描述 |
新增错误码1077675013 |
一致性组复制模式转换 |
接口功能及文档描述 |
修改执行实例 修改参数名字为大写字母:ID、TYPE、REPLICATIONMODEL |
创建NFS共享 |
接口功能及文档描述 |
新增发布接口。 |
修改NFS共享 |
接口功能及文档描述 |
新增发布接口。 |
查询操作日志的存储策略 |
接口功能及文档描述 |
新增发布接口。 |
设置操作日志的存储策略 |
接口功能及文档描述 |
新增发布接口。 |
查询文件系统的容量缩减信息 |
接口功能及文档描述 |
新增发布接口。 |
批量删除快照 |
接口功能及文档描述 |
新增发布接口。 |
获取导出配置数据路径 |
接口功能及文档描述 |
新增发布接口。 |
下载配置数据文件 |
接口功能及文档描述 |
新增发布接口。 |
升级前获取导出配置数据路径 |
接口功能及文档描述 |
新增发布接口。 |
升级前下载配置数据文件 |
接口功能及文档描述 |
新增发布接口。 |
查询所有引擎中智能缓存池支持的盘信息 |
接口功能及文档描述 |
新增发布接口。 |
测试LDAP域服务器地址 |
接口功能及文档描述 |
新增发布接口。 |
修改文件系统快照 |
接口功能及文档描述 |
新增发布接口。 |
扩容存储池 |
接口功能及文档描述 |
新增发布接口。 |
获取登录令牌 |
接口功能及文档描述 |
新增发布接口。 |