技术支持文档中心闪存存储融合存储OceanStor 5510 V5二次开发接口参考

OceanStor V500R007C70 Kunpeng REST 接口参考

本文档介绍华为 OceanStor DeviceManager RESTful APIs的概念、架构、开发准备、接 口参考并提供了示例代码，第三方应用系统可基于此文档开发面向华为统一存储的基 于DeviceManager RESTful APIs的应用。

storage_pool

storage_pool

开启或停止SmartTier

接口功能

开启或停止SmartTier。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/smarttier/start

访问方法

PUT

用户权限

Super administrator,Administrator

参数说明

名称

必选/可选/条件必选

类型

说明
ID 必选 uint32

存储池 ID。
IMMEDIATEMIGRATION 可选 string(bool)

立即迁移开关。

参数取值：

false：关闭

true：开启

默认值：false：关闭
IMMEDIATEMIGRATIONDURATIONTIME 条件必选 uint32

立即迁移持续时间。

参数取值：

取值在1800和86400之间，并且必须是60的整数倍。

单位：seconds

备注：开启立即迁移时必须下发。

返回结果

无。

使用指南

V3全闪存系列不支持此接口。

使用实例

  • 开启SmartTier。

    Request: PUT /deviceManager/rest/210235843710E7000007/smarttier/start
{
    "ID": "2",
    "IMMEDIATEMIGRATION": "true",
    "IMMEDIATEMIGRATIONDURATIONTIME": 1800
}

Response:
 {
    "data": {},
    "error": {
        "code": 0,
        "description": "0"
    }
}

暂停或继续SmartTier

接口功能

暂停或继续SmartTier。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/smarttier/pause

访问方法

PUT

用户权限

Super administrator,Administrator

参数说明

名称

必选/可选/条件必选

类型

说明
ID 必选 uint32

存储池 ID。
PAUSEMIGRATIONSWITCH 可选 string(bool)

暂停迁移开关。

参数取值：

false：关闭

true：开启

默认值：false：关闭

返回结果

无。

使用指南

V3全闪存系列不支持此接口。

使用实例

  • 继续SmartTier。

    Request: PUT/deviceManager/rest/210235843710E7000007/smarttier/pause
{
    "ID": "2",
    "PAUSEMIGRATIONSWITCH": "false"
}
Response: {
    "data": {},
    "error": {
        "code": 0,
        "description": "0"
    }
}

查询存储池个数

接口功能

查询存储池的个数。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool/count

访问方法

GET

用户权限

Super administrator,Administrator,Read-only user

参数说明

名称

必选/可选/条件必选

类型

说明
filter 可选 string

过滤查询条件。

参数取值：

支持如下字段：ID、NAME、HEALTHSTATUS、RUNNINGSTATUS。

返回结果

名称

返回/条件返回

类型

说明

COUNT

 返回 string(uint32)

指定查询条件下存储池个数。

使用实例

  • 查询存储池的个数。

    Request: GET /deviceManager/rest/210235843910E6000009/storagepool/count

Response: 
{
    "data": {
        "COUNT": "10"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

查询全局迁移速率

接口功能

查询全局迁移速率。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool/getmigrationlevel

访问方法

PUT

用户权限

Super administrator,Administrator,Read-only user

参数说明

无。

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 string(enum)

管理对象类型编号。

参数取值：

32785：迁移策略

ALLMIGRATIONSPEEDLEVEL

 返回 string(enum)

全局迁移速度。

参数取值：

1：低

2：中

3：高

使用指南

V3全闪存系列不支持此接口。

使用实例

  • 查询全局迁移速率。

    Request: PUT /deviceManager/rest/210235843710E7000007/storagepool/getmigrationlevel

Response:
{
    "data": {
        "ALLMIGRATIONSPEEDLEVEL": "2",
        "TYPE": 32785
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

修改全局迁移速率

接口功能

修改全局迁移速率。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool/setmigrationlevel

访问方法

PUT

用户权限

Super administrator,Administrator

参数说明

名称

必选/可选/条件必选

类型

说明
ALLMIGRATIONSPEEDLEVEL 必选 string(enum)

全局迁移速度。

参数取值：

1：低

2：中

3：高

返回结果

无。

使用指南

V3全闪存系列不支持此接口。

使用实例

  • 修改全局迁移速率。

    Request: PUT /deviceManager/rest/210235843710E7000007/storagepool/setmigrationlevel
{
    "ALLMIGRATIONSPEEDLEVEL": "1"
}

Response:
{
    "data": {
        "ALLMIGRATIONSPEEDLEVEL": "1",
        "TYPE": 32785
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

删除存储池

接口功能

删除存储池。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool/${id}

访问方法

DELETE

用户权限

Super administrator,Administrator

参数说明

名称

必选/可选/条件必选

类型

说明
ID 必选 uint32

存储池ID。

返回结果

无。

使用实例

  • 删除存储池。

    Request: DELETE /deviceManager/rest/210235843710E7000007/storagepool/2

Response: 
{
    "data": {},
    "error": {
        "code": 0,
        "description": "0"
    }
}

批量查询存储层信息

接口功能

批量查询存储层的基本信息。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagetier

访问方法

GET

用户权限

Super administrator,Administrator,Read-only user

参数说明

无。

返回结果

名称

返回/条件返回

类型

说明

DISKTYPE

 返回 string(enum)

硬盘类型。

参数取值：

1：SAS

2：SATA

3：SSD

4：NL-SAS

8：SAS SED

10：SSD SED

11：NL-SAS SED

备注：无效返回0。

HEALTHSTATUS

 返回 string(enum)

健康状态。

参数取值：

1：正常

2：故障

5：降级

ID

 返回 string

ID。

参数取值：

0层为pooid.0

1层为pooid.1

2层为pooid.2

MAXSHRINKCAPACITY

 返回 string(uint64)

可缩容的最大容量

单位：Byte

NAME

 返回 string

名称。

参数取值：

0层为tier0

1层为tier1

2层为tier2

PARENTID

 返回 string

父对象ID。

参数取值：

存储池ID。

PARENTTYPE

 返回 enum

父对象类型编号。

参数取值：

216：存储池

RAIDDISKNUM

 返回 string(uint32)

RAID逻辑成员盘数量。

备注：无效返回0。

RAIDLV

 返回 string(enum)

RAID级别。

参数取值：

1：RAID10

2：RAID5

3：RAID0

4：RAID1

5：RAID6

6：RAID50

7：RAID3

备注：无效返回0。

RUNNINGSTATUS

 返回 string(enum)

运行状态。

参数取值：

14：预拷贝

16：重构

27：在线

28：离线

32：正在均衡

53：初始化中

STRIPEDEPTH

 返回 string(uint32)

分条深度。

单位：sectors

备注：无效返回0。

TIERAVAILABLECAPACITY

 返回 string(uint64)

可用容量

单位：sectors

TIERCONSUMEDCAPACITY

 返回 string(uint64)

已用容量。

单位：sectors

TIERMOVEDOWNDATA

 返回 string(uint64)

待下迁数据量。

单位：sectors

TIERMOVEUPDATA

 返回 string(uint64)

待上迁数据量。

单位：sectors

TIERUSERCAPACITY

 返回 string(uint64)

用户容量

单位：sectors

TYPE

 返回 enum

管理对象类型编号。

参数取值：

217：存储层

使用指南

V3全闪存系列不支持此接口。

使用实例

  • 批量查询存储层的基本信息。

    Request: GET /deviceManager/rest/210235843710E7000007/storagetier

Response:
 {
    "data": [
        {
            "DISKTYPE": "1",
            "HEALTHSTATUS": "1",
            "ID": "0.1",
            "MAXSHRINKCAPACITY": "997506154496",
            "NAME": "tier1",
            "PARENTID": "0",
            "PARENTTYPE": 216,
            "RAIDDISKNUM": "5",
            "RAIDLV": "2",
            "RUNNINGSTATUS": "27",
            "STRIPEDEPTH": "256",
            "TIERAVAILABLECAPACITY": "2048720896",
            "TIERCONSUMEDCAPACITY": "333643776",
            "TIERMOVEDOWNDATA": "0",
            "TIERMOVEUPDATA": "0",
            "TIERUSERCAPACITY": "2382364672",
            "TYPE": 217
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

查询存储池RAID级别信息

接口功能

获取适合数据持久度要求的RAID级别。

适用型号

所有型号都适用。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/STORAGEPOOL/get_data_persistence_raid_level

访问方法

GET

用户权限

Super administrator,Administrator,Read-only user

参数说明

名称

必选/可选/条件必选

类型

说明
parentID 必选 string

父对象ID。

参数取值：

硬盘域ID。
tier0RaidLv 必选 enum

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3
tier0RaidDiskNum 必选 uint32

Tier0的RAID逻辑成员盘数量。
tier1RaidLv 必选 enum

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3
tier1RaidDiskNum 必选 uint32

Tier1的RAID逻辑成员盘数量。
tier2RaidLv 必选 enum

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3
tier2RaidDiskNum 必选 uint32

Tier2的RAID逻辑成员盘数量。

返回结果

名称

返回/条件返回

类型

说明

tier0RaidLv

 返回 enum

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

tier0RaidDiskNum

 返回 uint32

Tier0的RAID逻辑成员盘数量。

tier1RaidLv

 返回 enum

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

tier1RaidDiskNum

 返回 uint32

Tier1的RAID逻辑成员盘数量。

tier2RaidLv

 返回 enum

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

tier2RaidDiskNum

 返回 uint32

Tier2的RAID逻辑成员盘数量。

使用实例

  • 获取存储池适合数据持久度要求的RAID级别。

    Request: GET/deviceManager/rest/210235843710E7000007/storagepool/get_data_persistence_raid_level?PARENTID=0&TIER0RAIDLV=1&TIER0RAIDDISKNUM=10&TIER1RAIDLV=2&TIER1RAIDDISKNUM=10&TIER2RAIDLV=2&TIER2RAIDDISKNUM=10Response: {
    "data": {
        "TIER0RAIDDISKNUM": "10",
        "TIER0RAIDLV": "1",
        "TIER1RAIDDISKNUM": "10",
        "TIER1RAIDLV": "2",
        "TIER2RAIDDISKNUM": "10",
        "TIER2RAIDLV": "2"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

创建存储池

接口功能

创建存储池。

适用型号

适用于 V5全系列。

高危提示

您将要使用{0}盘创建存储池。

建议：根据{0}盘的运行可靠性，推荐采用RAID6级别，以更好地确保系统的数据安全性。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool

访问方法

POST

用户权限

Super administrator,Administrator

参数说明

名称

必选/可选/条件必选

类型

说明
NAME 必选 string

存储池名称。

参数取值：

长度1~31位，包含字母、数字、“_”、“-”、“.”和中文字符。

长度：1~31
PARENTID 可选 string

父对象ID。

参数取值：

硬盘域ID。

默认值：0
ID 可选 uint32

存储池ID。

参数取值：

-

默认值：0
DESCRIPTION 可选 string

描述。

参数取值：

-

长度：0~255
USERCONSUMEDCAPACITYTHRESHOLD 必选 uint32

已用容量阈值。

参数取值：

[1,95]

单位：%
EXTENTSIZE 可选 uint32

迁移粒度。

参数取值：

[512K,64M]，倍数取值。

默认值：4MB

单位：sectors

备注：如果是非典型配置（IS_DEFAULT_RAID_POLICY）则不应下发该参数。V3全闪存系列不支持此字段。
PAUSEMIGRATIONSWITCH 可选 bool

暂停迁移开关。

参数取值：

false：关闭

true：开启

默认值：false：关闭

备注：文件系统不支持。V3全闪存系列不支持此字段。
TIER0RAIDLV 可选 enum

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

默认值：1：RAID 10
TIER0RAIDDISKNUM 可选 uint32

Tier0的RAID逻辑成员盘数量。

参数取值：

-
TIER0DISKTYPE 条件必选 enum

Tier0对应的硬盘类型。

参数取值：

3：SSD

10：SSD SED

14：NVMe SSD

16：NVMe SSD SED

备注：在要选择该层级的时候必须下发。
TIER1RAIDLV 可选 enum

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

默认值：2：RAID 5

备注：V3全闪存系列不支持此字段。
TIER1RAIDDISKNUM 可选 uint32

Tier1的RAID逻辑成员盘数量。

参数取值：

-

备注：V3全闪存系列不支持此字段。
TIER1DISKTYPE 条件必选 enum

Tier1对应的硬盘类型。

参数取值：

1：SAS

8：SAS SED

备注：

在要选择该层级的时候必须下发。

V3全闪存系列不支持此字段。
TIER2RAIDLV 可选 enum

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

默认值：5：RAID 6

备注：V3全闪存系列不支持此字段。
TIER2RAIDDISKNUM 可选 uint32

Tier2的RAID逻辑成员盘数量。

参数取值：

-

备注：V3全闪存系列不支持此字段。
TIER2DISKTYPE 条件必选 enum

Tier2对应的硬盘类型。

参数取值：

2：SATA

4：NL-SAS

11：NL-SAS SED

备注：

在要选择该层级的时候必须下发。

V3全闪存系列不支持此字段。
TIER0STRIPEDEPTH 可选 uint32

Tier0分条深度。

参数取值：

[32K,512K]，倍数取值。

单位：KB
TIER1STRIPEDEPTH 可选 uint32

Tier1分条深度。

参数取值：

[32K,512K]，倍数取值。

单位：KB

备注：V3全闪存系列不支持此字段。
TIER2STRIPEDEPTH 可选 uint32

Tier2分条深度。

参数取值：

[32K,512K]，倍数取值。

单位：KB

备注：V3全闪存系列不支持此字段。
TIER0CAPACITY 条件必选 uint64

Tier 0 裸容量。

参数取值：

-

单位：sectors

备注：在要选择该层级的盘的时候必须下发。
TIER1CAPACITY 条件必选 uint64

Tier 1 裸容量。

参数取值：

-

单位：sectors

备注：

在要选择该层级的盘的时候必须下发。

V3全闪存系列不支持此字段。
TIER2CAPACITY 条件必选 uint64

Tier 2 裸容量。

参数取值：

-

单位：sectors

备注：

在要选择该层级的盘的时候必须下发。

V3全闪存系列不支持此字段。
USAGETYPE 可选 enum

存储池用途。

参数取值：

1：LUN

2：文件系统

默认值：1：LUN

备注：2100 V3，2200 V3 (8GB内存)，2800 V3不支持文件系统。
REPCAPACITYTHRESHOLD 可选 uint32

存储池中所有LUN由于做数据保护而消耗的容量告警阈值。

参数取值：

[1,100]

默认值：100

单位：%
AUTODEACTIVESNAPSHOTSWITCH 可选 bool

是否在storage_pool写满时自动去激活没有映射给主机的快照。

参数取值：

1：开启

0：关闭

默认值：0: off
enhancedDataProtectionPolicy 可选 enum

是否使用增强的数据保护策略。

参数取值：

0：不使用

1：使用

默认值：1：使用

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 enum

管理对象类型编号。

参数取值：

216：存储池

ID

 返回 string(uint32)

存储池ID。

NAME

 返回 string

存储池名称。

参数取值：

长度1~31位，包含字母、数字、“_”、“-”、“.”和中文字符。

PARENTID

 返回 string

父对象ID。

参数取值：

硬盘域ID。

PARENTNAME

 返回 string

父对象名称。

参数取值：

硬盘域名称。

HEALTHSTATUS

 返回 string(enum)

健康状态。

参数取值：

1：正常

2：故障

5：降级

RUNNINGSTATUS

 返回 string(enum)

运行状态。

参数取值：

14：预拷贝

16：重构

27：在线

28：离线

32：正在均衡

53：初始化中

MOVEUPDATA

 返回 string(uint64)

待上迁数据量，池中所有Tier待上迁数据量总和。

单位：sectors

备注：V3全闪存系列不支持此字段。

MOVEDOWNDATA

 返回 string(uint64)

待下迁数据量，池中所有Tier待下迁数据量总和。

单位：sectors

备注：V3全闪存系列不支持此字段。

DESCRIPTION

 返回 string

描述。

USERTOTALCAPACITY

 返回 string(uint64)

总容量。

单位：sectors

USERFREECAPACITY

 返回 string(uint64)

空闲容量。

单位：sectors

USERCONSUMEDCAPACITY

 返回 string(uint64)

已用容量。

单位：sectors

USERCONSUMEDCAPACITYPERCENTAGE

 返回 string(uint32)

已用容量百分比。

单位：%

USERCONSUMEDCAPACITYTHRESHOLD

 返回 string(uint32)

已用容量阈值。

参数取值：

[1,95]

单位：%

DSTSTATUS

 返回 string(enum)

DST特性状态。

参数取值：

1：激活

2：未激活

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

DSTRUNNINGSTATUS

 返回 string(enum)

迁移运行状态。

参数取值：

1：准备

2：迁移

3：暂停

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

EXTENTSIZE

 返回 string(uint32)

迁移粒度。

参数取值：

[512K,64M]，倍数取值。

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONMODE

 返回 string(enum)

迁移触发模式。

参数取值：

1：定时

2：手动

备注：V3全闪存系列不支持此字段。

IMMEDIATEMIGRATION

 返回 string(bool)

立即迁移开关。

参数取值：

false：关闭

true：开启

备注：V3全闪存系列不支持此字段。

PAUSEMIGRATIONSWITCH

 返回 string(bool)

暂停迁移开关。

参数取值：

false：关闭

true：开启

备注：V3全闪存系列不支持此字段。

MIGRATIONESTIMATEDTIME

 返回 string(uint64)

迁移时间。

单位：seconds

备注：V3全闪存系列不支持此字段。

TIER0RAIDLV

 返回 string(enum)

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：无效返回0。

TIER0RAIDDISKNUM

 返回 string(uint32)

Tier0的RAID逻辑成员盘数量。

备注：无效返回0。

TIER0DISKTYPE

 返回 string(enum)

Tier0对应的硬盘类型。

参数取值：

3：SSD

10：SSD SED

备注：无效值时返回0。

TIER1RAIDLV

 返回 string(enum)

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER1RAIDDISKNUM

 返回 string(uint32)

Tier1的RAID逻辑成员盘数量。

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER1DISKTYPE

 返回 string(enum)

Tier1对应的硬盘类型。

参数取值：

1：SAS

8：SAS SED

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER2RAIDLV

 返回 string(enum)

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER2RAIDDISKNUM

 返回 string(uint32)

Tier2的RAID逻辑成员盘数量。

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER2DISKTYPE

 返回 string(enum)

Tier2对应的硬盘类型。

参数取值：

2：SATA

4：NL-SAS

11：NL-SAS SED

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER0STRIPEDEPTH

 返回 string(uint32)

Tier0分条深度。

单位：sectors

备注：无效返回0。

TIER1STRIPEDEPTH

 返回 string(uint32)

Tier1分条深度。

单位：sectors

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER2STRIPEDEPTH

 返回 string(uint32)

Tier2分条深度。

单位：sectors

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

MOVEDUPDATA

 返回 string(uint64)

已上迁数据量。

单位：sectors

备注：V3全闪存系列不支持此字段。

MOVEDDOWNDATA

 返回 string(uint64)

已下迁数据量。

单位：sectors

备注：V3全闪存系列不支持此字段。

TIER0CAPACITY

 返回 string(uint64)

Tier 0 裸容量。

单位：sectors

备注：无效返回0。

TIER1CAPACITY

 返回 string(uint64)

Tier 1 裸容量。

单位：sectors

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

TIER2CAPACITY

 返回 string(uint64)

Tier 2 裸容量。

单位：sectors

备注：

无效值时返回0。

V3全闪存系列不支持此字段。

REPLICATIONCAPACITY

 返回 string(uint64)

数据保护容量，池中所有LUN由于做数据保护而消耗的容量。

单位：sectors

备注：目前指用于快照COW的容量。

DATASPACE

 返回 string(uint64)

存储池上创建LUN或者文件系统时的可用容量。

单位：sectors

备注：此值为Pool剩余容量减去元数据。2200 V3 (8GB内存)，2800 V3不支持文件系统。

USAGETYPE

 返回 string(enum)

存储池用途。

参数取值：

1：LUN

2：文件系统

备注：2100 V3，2200 V3 (8GB内存)，2800 V3不支持文件系统。

REPCAPACITYTHRESHOLD

 返回 string(uint32)

存储池中所有LUN由于做数据保护而消耗的容量告警阈值。

参数取值：

[1,100]

单位：%

TOTALFSCAPACITY

 返回 string(uint64)

FS总容量。

单位：sectors

LUNCONFIGEDCAPACITY

 返回 string(uint64)

LUN的配置容量。

单位：sectors

ENABLESMARTCACHE

 返回 string(bool)

是否启动smartCache。

参数取值：

true：开启

false：关闭

备注：

V3全闪存系列不支持此字段。

2100 V3不支持此字段。

ENABLESSDBUFFER

 返回 string(bool)

是否启动SSD缓存模式。

参数取值：

true：开启

false：关闭

备注：V3全闪存系列不支持此字段。

IMMEDIATEMIGRATIONDURATIONTIME

 返回 string(uint32)

立即迁移持续时间。

单位：seconds

备注：V3全闪存系列不支持此字段。

ISSMARTTIERENABLE

 返回 string(bool)

SmartTier特性是否在该存储池生效(license控制)。

参数取值：

true：有效

false：无效

备注：V3全闪存系列不支持此字段。

MIGRATIONSCHEDULEID

 返回 string(array)

迁移时刻表ID。

备注：V3全闪存系列不支持此字段。

MONITORSCHEDULEID

 返回 string(array)

监控时刻表ID。

备注：V3全闪存系列不支持此字段。

RESERVEDCAPACITY

 返回 string(uint64)

预留容量。

单位：sectors

reductionInvolvedCapacity

 返回 string(uint64)

重删压缩总体节省容量。

单位：sectors

备注：2100 V3不支持此字段。

dedupedCapacity

 返回 string(uint64)

重删节省容量。

单位：sectors

备注：2100 V3不支持此字段。

compressedCapacity

 返回 string(uint64)

压缩节省容量。

单位：sectors

备注：2100 V3不支持此字段。

dedupRatio

 返回 string(uint32)

存储池重复数据删除节省的容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

compressRatio

 返回 string(uint32)

存储池数据压缩节省的容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

dedupCompressRatio

 返回 string(uint32)

存储池重删压缩总体节省容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

AUTODEACTIVESNAPSHOTSWITCH

 返回 string(bool)

是否在storage_pool写满时自动去激活没有映射给主机的快照。

参数取值：

1：开启

0：关闭

使用实例

  • 创建存储池。

    Request: POST /deviceManager/rest/210235843710E7000007/storagepool
{
    "DESCRIPTION": "",
    "EXTENTSIZE": 8192,
    "NAME": "StoragePool003",
    "PARENTID": "0",
    "REPCAPACITYTHRESHOLD": 100,
    "TIER1CAPACITY": 2097152,
    "TIER1DISKTYPE": "1",
    "TIER1RAIDDISKNUM": "5",
    "TIER1RAIDLV": "2",
    "USAGETYPE": 1,
    "USERCONSUMEDCAPACITYTHRESHOLD": 80
}

Response: 
{
    "data": {
        "DATASPACE": "1703936",
        "DESCRIPTION": "",
        "DSTRUNNINGSTATUS": "1",
        "DSTSTATUS": "2",
        "ENABLESMARTCACHE": "false",
        "ENABLESSDBUFFER": "false",
        "EXTENTSIZE": "8192",
        "HEALTHSTATUS": "1",
        "ID": "2",
        "IMMEDIATEMIGRATION": "0",
        "IMMEDIATEMIGRATIONDURATIONTIME": "0",
        "ISSMARTTIERENABLE": "false",
        "LUNCONFIGEDCAPACITY": "0",
        "MIGRATIONESTIMATEDTIME": "0",
        "MIGRATIONMODE": "2",
        "MIGRATIONSCHEDULEID": "[]",
        "MONITORSCHEDULEID": "[]",
        "MOVEDDOWNDATA": "0",
        "MOVEDOWNDATA": "0",
        "MOVEDUPDATA": "0",
        "MOVEUPDATA": "0",
        "NAME": "StoragePool003",
        "PARENTID": "0",
        "PARENTNAME": "Default_DiskDomain001",
        "PAUSEMIGRATIONSWITCH": "0",
        "REPCAPACITYTHRESHOLD": "100",
        "REPLICATIONCAPACITY": "0",
        "RESERVEDCAPACITY": "0",
        "RUNNINGSTATUS": "27",
        "TIER0CAPACITY": "0",
        "TIER0DISKTYPE": "0",
        "TIER0RAIDDISKNUM": "0",
        "TIER0RAIDLV": "0",
        "TIER0STRIPEDEPTH": "0",
        "TIER1CAPACITY": "2097152",
        "TIER1DISKTYPE": "1",
        "TIER1RAIDDISKNUM": "5",
        "TIER1RAIDLV": "2",
        "TIER1STRIPEDEPTH": "256",
        "TIER2CAPACITY": "0",
        "TIER2DISKTYPE": "0",
        "TIER2RAIDDISKNUM": "0",
        "TIER2RAIDLV": "0",
        "TIER2STRIPEDEPTH": "0",
        "TOTALFSCAPACITY": "0",
        "TYPE": 216,
        "USAGETYPE": "1",
        "USERCONSUMEDCAPACITY": "0",
        "USERCONSUMEDCAPACITYPERCENTAGE": "0",
        "USERCONSUMEDCAPACITYTHRESHOLD": "80",
        "USERFREECAPACITY": "2097152",
        "USERTOTALCAPACITY": "2097152",
        "compressRatio":"50",
        "compressedCapacity":"42949672",
        "dedupCompressRatio":"50",
        "dedupRatio":"50",
        "dedupedCapacity":"42949672",
        "reductionInvolvedCapacity":"85899344",
        "AUTODEACTIVESNAPSHOTSWITCH": "0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

批量查询存储池信息

接口功能

批量查询存储池的基本信息。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool

访问方法

GET

用户权限

Super administrator,Administrator,Read-only user

参数说明

名称

必选/可选/条件必选

类型

说明
filter 可选 string

过滤查询条件。

参数取值：

支持如下字段：ID、NAME、RUNNINGSTATUS、HEALTHSTATUS。
range 可选 string

查询范围。

参数取值：

查询范围：[i-j]，"range"指定返回在查询结果中顺序下标为i到j-1的对象，用于对数据分页查询。

备注：查询结果最多支持返回10000条数据。

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 enum

管理对象类型编号。

参数取值：

216：存储池

ID

 返回 string(uint32)

存储池ID。

参数取值：

-

NAME

 返回 string

存储池名称。

参数取值：

长度1~31位，包含字母、数字、“_”、“-”、“.”和中文字符。

PARENTID

 返回 string

父对象ID。

参数取值：

硬盘域ID。

PARENTNAME

 返回 string

父对象名称。

参数取值：

硬盘域名称。

HEALTHSTATUS

 返回 string(enum)

健康状态。

参数取值：

1：正常

2：故障

5：降级

RUNNINGSTATUS

 返回 string(enum)

运行状态。

参数取值：

14：预拷贝

16：重构

27：在线

28：离线

32：正在均衡

53：初始化中

DESCRIPTION

 返回 string

描述。

参数取值：

-

USERTOTALCAPACITY

 返回 string(uint64)

总容量。

参数取值：

-

单位：sectors

USERFREECAPACITY

 返回 string(uint64)

空闲容量。

参数取值：

-

单位：sectors

USERCONSUMEDCAPACITY

 返回 string(uint64)

已用容量。

参数取值：

-

单位：sectors

USERCONSUMEDCAPACITYPERCENTAGE

 返回 string(uint32)

已用容量百分比。

参数取值：

-

单位：%

USERCONSUMEDCAPACITYTHRESHOLD

 返回 string(uint32)

已用容量阈值。

参数取值：

[1,95]

单位：%

DSTSTATUS

 返回 string(enum)

DST特性状态。

参数取值：

1：激活

2：未激活

备注：V3全闪存系列不支持此字段。

DSTRUNNINGSTATUS

 返回 string(enum)

迁移运行状态。

参数取值：

1：准备

2：迁移

3：暂停

备注：V3全闪存系列不支持此字段。

EXTENTSIZE

 返回 string(uint32)

迁移粒度。

参数取值：

[512K,64M]，倍数取值。

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONMODE

 返回 string(enum)

迁移触发模式。

参数取值：

1：定时

2：手动

备注：V3全闪存系列不支持此字段。

IMMEDIATEMIGRATION

 返回 string(bool)

立即迁移开关。

参数取值：

false：关闭

true：开启

备注：V3全闪存系列不支持此字段。

PAUSEMIGRATIONSWITCH

 返回 string(bool)

暂停迁移开关。

参数取值：

false：关闭

true：开启

备注：V3全闪存系列不支持此字段。

MOVEUPDATA

 返回 string(uint64)

待上迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MOVEDOWNDATA

 返回 string(uint64)

待下迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONESTIMATEDTIME

 返回 string(uint64)

迁移时间。

参数取值：

-

单位：seconds

备注：V3全闪存系列不支持此字段。

TIER0RAIDLV

 返回 string(enum)

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：无效返回0。

TIER0RAIDDISKNUM

 返回 string(uint32)

Tier0的RAID逻辑成员盘数量。

参数取值：

-

备注：无效返回0。

TIER0DISKTYPE

 返回 string(enum)

Tier0对应的硬盘类型。

参数取值：

3：SSD

10：SSD SED

14：NVMe SSD

16：NVMe SSD SED

备注：支持选择SSD、SSD SED、NVMe或NVMe SSD SED盘（四种盘类型互斥）。无效返回0。

TIER1RAIDLV

 返回 string(enum)

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER1RAIDDISKNUM

 返回 string(uint32)

Tier1的RAID逻辑成员盘数量。

参数取值：

-

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER1DISKTYPE

 返回 string(enum)

Tier1对应的硬盘类型。

参数取值：

1：SAS

8：SAS SED

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2RAIDLV

 返回 string(enum)

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2RAIDDISKNUM

 返回 string(uint32)

Tier2的RAID逻辑成员盘数量。

参数取值：

-

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2DISKTYPE

 返回 string(enum)

Tier2对应的硬盘类型。

参数取值：

2：SATA

4：NL-SAS

11：NL-SAS SED

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER0STRIPEDEPTH

 返回 string(uint32)

Tier0分条深度。

参数取值：

-

单位：sectors

备注：无效返回0。

TIER1STRIPEDEPTH

 返回 string(uint32)

Tier1分条深度。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2STRIPEDEPTH

 返回 string(uint32)

Tier2分条深度。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

MOVEDUPDATA

 返回 string(uint64)

已上迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MOVEDDOWNDATA

 返回 string(uint64)

已下迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONSCHEDULEID

 返回 string(array)

迁移时刻表ID。

参数取值：

-

备注：V3全闪存系列不支持此字段。

MONITORSCHEDULEID

 返回 string(array)

监控时刻表ID。

参数取值：

-

备注：V3全闪存系列不支持此字段。

RESERVEDCAPACITY

 返回 string(uint64)

Pool的预留容量。

参数取值：

-

单位：sectors

TIER0CAPACITY

 返回 string(uint64)

Tier 0 裸容量。

参数取值：

-

单位：sectors

备注：无效返回0。

TIER1CAPACITY

 返回 string(uint64)

Tier 1 裸容量。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2CAPACITY

 返回 string(uint64)

Tier 2 裸容量。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

REPLICATIONCAPACITY

 返回 string(uint64)

数据保护容量，池中所有LUN由于做数据保护而消耗的容量。

参数取值：

-

单位：sectors

备注：目前指用于快照COW的容量。

ENABLESSDBUFFER

 返回 string(bool)

是否启动SSD缓存模式。

参数取值：

false：关闭

true：启动

备注：V3全闪存系列不支持此字段。

DATASPACE

 返回 string(uint64)

存储池上创建LUN或者文件系统时的可用容量。

参数取值：

-

单位：sectors

备注：此值为Pool剩余容量减去元数据。2200 V3 (8GB内存)，2800 V3不支持文件系统。

ENABLESMARTCACHE

 返回 string(bool)

是否启动smartCache。

参数取值：

false：关闭

true：启动

备注：

V3全闪存系列不支持此字段。

2100 V3不支持此字段。

USAGETYPE

 返回 string(enum)

存储池用途。

参数取值：

1：LUN

2：文件系统

备注：2100 V3，2200 V3 (8GB内存)，2800 V3不支持文件系统。

LUNCONFIGEDCAPACITY

 返回 string(uint64)

LUN的配置容量。

参数取值：

-

单位：sectors

TOTALFSCAPACITY

 返回 string(uint64)

FS总容量。

参数取值：

-

单位：sectors

IMMEDIATEMIGRATIONDURATIONTIME

 返回 string(uint32)

立即迁移持续时间。

参数取值：

-

单位：seconds

备注：V3全闪存系列不支持此字段。

REPCAPACITYTHRESHOLD

 返回 string(uint32)

存储池中所有LUN由于做数据保护而消耗的容量告警阈值。

参数取值：

[1,100]

单位：%

ISSMARTTIERENABLE

 返回 string(bool)

SmartTier特性是否在该存储池生效(license控制)。

参数取值：

true：有效

false：无效

备注：V3全闪存系列不支持此字段。

reductionInvolvedCapacity

 返回 string(uint64)

重删压缩总体节省容量。

参数取值：

-

单位：sectors

备注：2100 V3不支持此字段。

dedupedCapacity

 返回 string(uint64)

重删节省容量。

参数取值：

-

单位：sectors

备注：2100 V3不支持此字段。

compressedCapacity

 返回 string(uint64)

压缩节省容量。

参数取值：

-

单位：sectors

备注：2100 V3不支持此字段。

dedupRatio

 返回 string(uint32)

存储池重复数据删除节省的容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

compressRatio

 返回 string(uint32)

存储池数据压缩节省的容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

dedupCompressRatio

 返回 string(uint32)

存储池重删压缩总体节省容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

AUTODEACTIVESNAPSHOTSWITCH

 返回 string(bool)

是否在storage_pool写满时自动去激活没有映射给主机的快照。

参数取值：

1：开启

0：关闭

totalSizeWithoutSnap

 返回 uint64

配置在该存储池上的Thin LUN的总大小。

参数取值：

-

mappedCapacity

 返回 uint64

存储池中所有已映射的LUN和已映射并激活的快照容量之和。

参数取值：

-

单位：sectors

mappedRatio

 返回 string(uint32)

存储池中所有已映射的LUN和已映射并激活的快照容量占存储池容量比例。

参数取值：

-

单位：%

使用实例

  • 批量查询存储池的基本信息。

    Request: GET /deviceManager/rest/210235843710E7000007/storagepool?range=[0-100]

Response: 
{
    "data": [
        {
            "DATASPACE": "1048576",
            "DESCRIPTION": "adsf",
            "DSTRUNNINGSTATUS": "1",
            "DSTSTATUS": "2",
            "ENABLESMARTCACHE": "false",
            "ENABLESSDBUFFER": "false",
            "EXTENTSIZE": "8192",
            "HEALTHSTATUS": "1",
            "ID": "0",
            "IMMEDIATEMIGRATION": "0",
            "IMMEDIATEMIGRATIONDURATIONTIME": "0",
            "ISSMARTTIERENABLE": "false",
            "LUNCONFIGEDCAPACITY": "16777216",
            "MIGRATIONESTIMATEDTIME": "0",
            "MIGRATIONMODE": "2",
            "MIGRATIONSCHEDULEID": "[]",
            "MONITORSCHEDULEID": "[]",
            "MOVEDDOWNDATA": "0",
            "MOVEDOWNDATA": "0",
            "MOVEDUPDATA": "0",
            "MOVEUPDATA": "0",
            "NAME": "StoragePool001",
            "PARENTID": "0",
            "PARENTNAME": "Default_DiskDomain001",
            "PAUSEMIGRATIONSWITCH": "0",
            "REPCAPACITYTHRESHOLD": "100",
            "REPLICATIONCAPACITY": "0",
            "RESERVEDCAPACITY": "0",
            "RUNNINGSTATUS": "27",
            "TIER0CAPACITY": "0",
            "TIER0DISKTYPE": "0",
            "TIER0RAIDDISKNUM": "0",
            "TIER0RAIDLV": "0",
            "TIER0STRIPEDEPTH": "0",
            "TIER1CAPACITY": "20971520",
            "TIER1DISKTYPE": "1",
            "TIER1RAIDDISKNUM": "5",
            "TIER1RAIDLV": "2",
            "TIER1STRIPEDEPTH": "256",
            "TIER2CAPACITY": "0",
            "TIER2DISKTYPE": "0",
            "TIER2RAIDDISKNUM": "0",
            "TIER2RAIDLV": "0",
            "TIER2STRIPEDEPTH": "0",
            "TOTALFSCAPACITY": "0",
            "TYPE": 216,
            "USAGETYPE": "1",
            "USERCONSUMEDCAPACITY": "19529728",
            "USERCONSUMEDCAPACITYPERCENTAGE": "93",
            "USERCONSUMEDCAPACITYTHRESHOLD": "80",
            "USERFREECAPACITY": "1441792",
            "USERTOTALCAPACITY": "20971520",
            "compressRatio":"50",
            "compressedCapacity":"42949672",
            "dedupCompressRatio":"50",
            "dedupRatio":"50",
            "dedupedCapacity":"42949672",
            "reductionInvolvedCapacity":"85899344",
            "AUTODEACTIVESNAPSHOTSWITCH":"0",
            "totalSizeWithoutSnap": "16777216"
            "mappedCapacity": "16777216"
            "mappedRatio": "10.00"
        }
    ],
        "error": {
            "code": 0,
            "description": "0"
        }
}

查询存储池信息

接口功能

查询存储池的基本信息。

适用型号

适用于 V5全系列。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool/${id}

访问方法

GET

用户权限

Super administrator,Administrator,Read-only user

参数说明

名称

必选/可选/条件必选

类型

说明
ID 必选 uint32

存储池ID。

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 enum

管理对象类型编号。

参数取值：

216：存储池

ID

 返回 string(uint32)

存储池ID。

参数取值：

-

NAME

 返回 string

存储池名称。

参数取值：

长度1~31位，包含字母、数字、“_”、“-”、“.”和中文字符。

PARENTID

 返回 string

父对象ID。

参数取值：

硬盘域ID。

PARENTNAME

 返回 string

父对象名称。

参数取值：

硬盘域名称。

HEALTHSTATUS

 返回 string(enum)

健康状态。

参数取值：

1：正常

2：故障

5：降级

RUNNINGSTATUS

 返回 string(enum)

运行状态。

参数取值：

14：预拷贝

16：重构

27：在线

28：离线

32：正在均衡

53：初始化中

DESCRIPTION

 返回 string

描述。

参数取值：

字符长度0~255位。

USERTOTALCAPACITY

 返回 string(uint64)

总容量。

参数取值：

-

单位：sectors

USERFREECAPACITY

 返回 string(uint64)

空闲容量。

参数取值：

-

单位：sectors

USERCONSUMEDCAPACITY

 返回 string(uint64)

已用容量。

参数取值：

-

单位：sectors

USERCONSUMEDCAPACITYPERCENTAGE

 返回 string(uint32)

已用容量百分比。

参数取值：

-

单位：%

USERCONSUMEDCAPACITYTHRESHOLD

 返回 string(uint32)

已用容量阈值。

参数取值：

[1,95]

单位：%

DSTSTATUS

 返回 string(enum)

DST特性状态。

参数取值：

1：激活

2：未激活

备注：V3全闪存系列不支持此字段。

DSTRUNNINGSTATUS

 返回 string(enum)

迁移运行状态。

参数取值：

1：准备

2：迁移

3：暂停

备注：V3全闪存系列不支持此字段。

EXTENTSIZE

 返回 string(uint32)

迁移粒度。

参数取值：

[512K,64M]，倍数取值。

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONMODE

 返回 string(enum)

迁移触发模式。

参数取值：

1：定时

2：手动

备注：V3全闪存系列不支持此字段。

IMMEDIATEMIGRATION

 返回 string(bool)

立即迁移开关。

参数取值：

false：关闭

true：开启

备注：V3全闪存系列不支持此字段。

PAUSEMIGRATIONSWITCH

 返回 string(bool)

暂停迁移开关。

参数取值：

false：关闭

true：开启

备注：V3全闪存系列不支持此字段。

MOVEUPDATA

 返回 string(uint64)

待上迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MOVEDOWNDATA

 返回 string(uint64)

待下迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONESTIMATEDTIME

 返回 string(uint64)

迁移时间。

参数取值：

-

单位：seconds

备注：V3全闪存系列不支持此字段。

TIER0RAIDLV

 返回 string(enum)

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：无效返回0。

TIER0RAIDDISKNUM

 返回 string(uint32)

Tier0的RAID逻辑成员盘数量。

参数取值：

-

备注：无效返回0。

TIER0DISKNUM

 条件返回 string(uint32)

Tier0上的硬盘数量。

参数取值：

-

备注：当存在TIER0时返回该属性。

TIER0DISKTYPE

 返回 string(enum)

Tier0对应的硬盘类型。

参数取值：

3：SSD

10：SSD SED

14：NVMe SSD

16：NVMe SSD SED

备注：无效返回0。

TIER0DISKLIST

 条件返回 array

Tier0磁盘列表。

参数取值：

-

备注：当存在TIER0时返回该属性。

TIER1RAIDLV

 返回 string(enum)

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER1RAIDDISKNUM

 返回 string(uint32)

Tier1的RAID逻辑成员盘数量。

参数取值：

-

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER1DISKNUM

 条件返回 string(uint32)

Tier1上的硬盘数量。

参数取值：

-

备注：

当存在TIER1时返回该属性。

V3全闪存系列不支持此字段。

TIER1DISKTYPE

 返回 string(enum)

Tier1对应的硬盘类型。

参数取值：

1：SAS

8：SAS SED

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER1DISKLIST

 条件返回 array

Tier1磁盘列表。

参数取值：

-

备注：

当存在TIER1时返回该属性。

V3全闪存系列不支持此字段。

TIER2RAIDLV

 返回 string(enum)

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2RAIDDISKNUM

 返回 string(uint32)

Tier2的RAID逻辑成员盘数量。

参数取值：

-

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2DISKNUM

 条件返回 string(uint32)

Tier2上的硬盘数量。

参数取值：

-

备注：

当存在TIER2时返回该属性。

V3全闪存系列不支持此字段。

TIER2DISKTYPE

 返回 string(enum)

Tier2对应的硬盘类型。

参数取值：

2：SATA

4：NL-SAS

11：NL-SAS SED

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2DISKLIST

 条件返回 array

Tier2磁盘列表。

参数取值：

-

备注：

当存在TIER2时返回该属性。

V3全闪存系列不支持此字段。

TIER0STRIPEDEPTH

 返回 string(uint32)

Tier0分条深度。

参数取值：

-

单位：sectors

备注：无效返回0。

TIER1STRIPEDEPTH

 返回 string(uint32)

Tier1分条深度。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2STRIPEDEPTH

 返回 string(uint32)

Tier2分条深度。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

MOVEDUPDATA

 返回 string(uint64)

已上迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MOVEDDOWNDATA

 返回 string(uint64)

已下迁数据量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。

MIGRATIONSCHEDULEID

 返回 string(array)

迁移时刻表ID。

参数取值：

-

备注：V3全闪存系列不支持此字段。

MONITORSCHEDULEID

 返回 string(array)

监控时刻表ID。

参数取值：

-

备注：V3全闪存系列不支持此字段。

TIER0CAPACITY

 返回 string(uint64)

Tier 0 裸容量。

参数取值：

-

单位：sectors

备注：无效返回0。

TIER1CAPACITY

 返回 string(uint64)

Tier 1 裸容量。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

TIER2CAPACITY

 返回 string(uint64)

Tier 2 裸容量。

参数取值：

-

单位：sectors

备注：

无效返回0。

V3全闪存系列不支持此字段。

REPLICATIONCAPACITY

 返回 string(uint64)

数据保护容量，池中所有LUN由于做数据保护而消耗的容量。

参数取值：

目前指用于快照COW的容量。

单位：sectors

DATASPACE

 返回 string(uint64)

存储池上创建LUN或者文件系统时的可用容量。

参数取值：

此值为Pool剩余容量减去元数据。

单位：sectors

备注：此值为Pool剩余容量减去元数据。2200 V3 (8GB内存)，2800 V3不支持文件系统。

USAGETYPE

 返回 string(enum)

存储池用途。

参数取值：

1：LUN

2：文件系统

备注：2100 V3，2200 V3 (8GB内存)，2800 V3不支持文件系统。

LUNCONFIGEDCAPACITY

 返回 string(uint64)

LUN的配置容量。

参数取值：

-

单位：sectors

TOTALFSCAPACITY

 返回 string(uint64)

FS总容量。

参数取值：

-

单位：sectors

ENABLESSDBUFFER

 返回 string(bool)

是否启动SSD缓存模式。

参数取值：

false：关闭

true：启动

备注：V3全闪存系列不支持此字段。

ENABLESMARTCACHE

 返回 string(bool)

是否启动smartCache。

参数取值：

true：开启

false：关闭

备注：

V3全闪存系列不支持此字段。

2100 V3不支持此字段。

RESERVEDCAPACITY

 返回 string(uint64)

预留容量。

参数取值：

-

单位：sectors

IMMEDIATEMIGRATIONDURATIONTIME

 返回 string(uint32)

立即迁移持续时间。

参数取值：

-

单位：seconds

备注：V3全闪存系列不支持此字段。

ISSMARTTIERENABLE

 返回 string(bool)

SmartTier特性是否在该存储池生效(license控制)。

参数取值：

true：有效

false：无效

备注：V3全闪存系列不支持此字段。

REPCAPACITYTHRESHOLD

 返回 string(uint32)

存储池中所有LUN由于做数据保护而消耗的容量告警阈值。

参数取值：

[1,100]

单位：%

reductionInvolvedCapacity

 返回 string(uint64)

重删压缩总体节省容量。

参数取值：

-

单位：sectors

备注：2100 V3不支持此字段。

dedupedCapacity

 返回 string(uint64)

重删节省容量。

参数取值：

-

单位：sectors

备注：2100 V3不支持此字段。

compressedCapacity

 返回 string(uint64)

压缩节省容量。

参数取值：

-

单位：sectors

备注：2100 V3不支持此字段。

dedupRatio

 返回 string(uint32)

存储池重复数据删除节省的容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

compressRatio

 返回 string(uint32)

存储池数据压缩节省的容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

dedupCompressRatio

 返回 string(uint32)

存储池重删压缩总体节省容量占系统已使用容量的百分比。

参数取值：

[0,100]

单位：%

备注：2100 V3不支持此字段。

AUTODEACTIVESNAPSHOTSWITCH

 返回 string(bool)

是否在storage_pool写满时自动去激活没有映射给主机的快照。

参数取值：

1：开启

0：关闭

totalSizeWithoutSnap

 返回 uint64

配置在该存储池上的Thin LUN的总大小。

参数取值：

-

mappedCapacity

 返回 uint64

存储池中所有已映射的LUN和已映射并激活的快照容量之和。

参数取值：

-

单位：sectors

mappedRatio

 返回 string(uint32)

存储池中所有已映射的LUN和已映射并激活的快照容量占存储池容量比例。

参数取值：

-

单位：%

使用实例

  • 查询存储池的基本信息。

    Request: GET /deviceManager/rest/210235843710E7000007/storagepool/0

Response:
 {
    "data": {
        "DATASPACE": "1048576",
        "DESCRIPTION": "adsf",
        "DSTRUNNINGSTATUS": "1",
        "DSTSTATUS": "2",
        "ENABLESMARTCACHE": "false",
        "ENABLESSDBUFFER": "false",
        "EXTENTSIZE": "8192",
        "HEALTHSTATUS": "1",
        "ID": "0",
        "IMMEDIATEMIGRATION": "0",
        "IMMEDIATEMIGRATIONDURATIONTIME": "0",
        "ISSMARTTIERENABLE": "false",
        "LUNCONFIGEDCAPACITY": "16777216",
        "MIGRATIONESTIMATEDTIME": "0",
        "MIGRATIONMODE": "2",
        "MIGRATIONSCHEDULEID": "[]",
        "MONITORSCHEDULEID": "[]",
        "MOVEDDOWNDATA": "0",
        "MOVEDOWNDATA": "0",
        "MOVEDUPDATA": "0",
        "MOVEUPDATA": "0",
        "NAME": "StoragePool001",
        "PARENTID": "0",
        "PARENTNAME": "Default_DiskDomain001",
        "PAUSEMIGRATIONSWITCH": "0",
        "REPCAPACITYTHRESHOLD": "100",
        "REPLICATIONCAPACITY": "0",
        "RESERVEDCAPACITY": "0",
        "RUNNINGSTATUS": "27",
        "TIER0CAPACITY": "0",
        "TIER0DISKTYPE": "0",
        "TIER0RAIDDISKNUM": "0",
        "TIER0RAIDLV": "0",
        "TIER0STRIPEDEPTH": "0",
        "TIER1CAPACITY": "20971520",
        "TIER1DISKTYPE": "1",
        "TIER1RAIDDISKNUM": "5",
        "TIER1RAIDLV": "2",
        "TIER1STRIPEDEPTH": "256",
        "TIER2CAPACITY": "0",
        "TIER2DISKTYPE": "0",
        "TIER2RAIDDISKNUM": "0",
        "TIER2RAIDLV": "0",
        "TIER2STRIPEDEPTH": "0",
        "TOTALFSCAPACITY": "0",
        "TYPE": 216,
        "USAGETYPE": "1",
        "USERCONSUMEDCAPACITY": "19529728",
        "USERCONSUMEDCAPACITYPERCENTAGE": "93",
        "USERCONSUMEDCAPACITYTHRESHOLD": "80",
        "USERFREECAPACITY": "1441792",
        "USERTOTALCAPACITY": "20971520",
        "compressRatio":"50",
        "compressedCapacity":"42949672",
        "dedupCompressRatio":"50",
        "dedupRatio":"50",
        "dedupedCapacity":"42949672",
        "reductionInvolvedCapacity":"85899344",
        "AUTODEACTIVESNAPSHOTSWITCH":"0",
        "totalSizeWithoutSnap": "16777216"
        "mappedCapacity": "16777216"
        "mappedRatio": "10.00"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

修改存储池信息

接口功能

修改存储池。

适用型号

适用于 V5全系列。

高危提示

你将执行修改（扩容或缩容）存储池XXX的容量。如果该存储池的自动分层存储功能是开启的，执行缩容操作会使向缩容的层级迁移的数据减少。

建议：执行该操作之前一定要确认选择的存储池和容量是正确的。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/storagepool/${id}

访问方法

PUT

用户权限

Super administrator,Administrator

参数说明

名称

必选/可选/条件必选

类型

说明
ID 必选 uint32

存储池ID。

参数取值：

-
NAME 可选 string

存储池名称。

参数取值：

长度1~31位，包含字母、数字、“_”、“-”、“.”和中文字符。

长度：1~31
DESCRIPTION 可选 string

描述。

参数取值：

-

长度：0~255
USERCONSUMEDCAPACITYTHRESHOLD 可选 uint32

已用容量阈值。

参数取值：

[1,95]

单位：%
TIER0CAPACITY 可选 uint64

Tier 0 裸容量。

参数取值：

-

单位：sectors
TIER1CAPACITY 可选 uint64

Tier 1 裸容量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。
TIER2CAPACITY 可选 uint64

Tier 2 裸容量。

参数取值：

-

单位：sectors

备注：V3全闪存系列不支持此字段。
TIER0RAIDLV 可选 enum

Tier0的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3
TIER0RAIDDISKNUM 可选 uint32

Tier0的RAID逻辑成员盘数量。

参数取值：

-
TIER0DISKTYPE 可选 enum

Tier0对应的硬盘类型。

参数取值：

3：SSD

10：SSD SED

14：NVMe SSD

16：NVMe SSD SED

备注：支持选择SSD、SSD SED、NVMe或NVMe SSD SED盘（四种盘类型互斥）。无效返回-1。
TIER1RAIDLV 可选 enum

Tier1的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：V3全闪存系列不支持此字段。
TIER1RAIDDISKNUM 可选 uint32

Tier1的RAID逻辑成员盘数量。

参数取值：

-

备注：V3全闪存系列不支持此字段。
TIER1DISKTYPE 可选 enum

Tier1对应的硬盘类型。

参数取值：

1：SAS

8：SAS SED

备注：V3全闪存系列不支持此字段。
TIER2RAIDLV 可选 enum

Tier2的RAID级别。

参数取值：

1：RAID 10

2：RAID 5

3：RAID 0

4：RAID 1

5：RAID 6

6：RAID 50

7：RAID 3

备注：V3全闪存系列不支持此字段。
TIER2RAIDDISKNUM 可选 uint32

Tier2的RAID逻辑成员盘数量。

参数取值：

-

备注：V3全闪存系列不支持此字段。
ENABLESSDBUFFER 可选 bool

是否启动SSD缓存模式。

参数取值：

false：关闭

true：启动

备注：V3全闪存系列不支持此字段。
TIER2DISKTYPE 可选 enum

Tier2对应的硬盘类型。

参数取值：

2：SATA

4：NL-SAS

11：NL-SAS SED

备注：V3全闪存系列不支持此字段。
AUTODEACTIVESNAPSHOTSWITCH 可选 bool

是否在storage_pool写满时自动去激活没有映射给主机的快照。

参数取值：

1：开启

0：关闭
enhancedDataProtectionPolicy 可选 enum

是否使用增强的数据保护策略。

参数取值：

0：不使用

1：使用

默认值：1：使用

返回结果

无。

使用实例

  • 修改存储池。

    Request: PUT /deviceManager/rest/210235843710E7000007/storagepool/2
{
    "DESCRIPTION": "123123"
}

Response:
 {
    "data": {},
    "error": {
        "code": 0,
        "description": "0"
    }
}
收藏
下载文档
更新时间：2021-02-22
文档编号：EDOC1100141310
浏览量：44704
下载量：340
平均得分：0.0分