技术支持文档中心闪存存储全闪存存储OceanStor Dorado 5300 V6二次开发接口参考

OceanStor Dorado 6.1.0 REST接口参考

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

security_rule

security_rule

删除IP规则

接口功能

删除IP规则。

URL路径

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

访问方法

DELETE

参数说明

名称

必选/可选/条件必选

类型

说明
ID 必选 string

ID。

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 string(enum)

管理对象类型编号。

参数取值：

236：IP规则

使用实例

  • 删除IP规则。

    Request: DELETE /deviceManager/rest/210235843910E6000009/iprule/7

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

查询IP规则

接口功能

查询IP规则。

URL路径

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

访问方法

GET

参数说明

无。

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 string(enum)

管理对象类型编号。

参数取值：

236：IP规则

ID

 返回 string

ID。

SECUREIP

 返回 string

IP白名单。

备注：

支持IPv4和IPv6。

格式举例：

如是单个IP则形式为

10.1.1.1，

如是IP段则形式为

10.1.1.1-10.1.2.1。

STRATEGY

 返回 string(enum)

规则策略。

参数取值：

1：白名单

使用实例

  • 查询IP规则。

    Request: GET /deviceManager/rest/210235843910E6000009/iprule

Response: 
{
    "data": [
        {
            "ID": "1",
            "SECUREIP": "10.0.0.1",
            "STRATEGY": "1",
            "TYPE": 236
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

增加IP规则

接口功能

增加IP规则。

URL路径

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

访问方法

POST

参数说明

名称

必选/可选/条件必选

类型

说明
SECUREIP 必选 string

IP白名单。

备注：

支持IPv4和IPv6。

格式举例：

如是单个IP则形式为

10.1.1.1，

如是IP段则形式为

10.1.1.1-10.1.2.1。
STRATEGY 必选 enum

规则策略。

参数取值：

1：白名单

返回结果

名称

返回/条件返回

类型

说明

ID

 返回 string

ID。

SECUREIP

 返回 string

IP白名单。

备注：

支持IPv4和IPv6。

格式举例：

如是单个IP则形式为

10.1.1.1，

如是IP段则形式为

10.1.1.1-10.1.2.1。

STRATEGY

 返回 string(enum)

规则策略。

参数取值：

1：白名单

使用实例

  • 增加IP规则。

    Request: POST /deviceManager/rest/210235843910E6000009/iprule
{
    "SECUREIP": "10.0.0.1",
    "STRATEGY": "1"
}

Response:
{
    "data": {
        "ID": "7",
        "SECUREIP": "10.0.0.1",
        "STRATEGY": "1"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

设置IP规则开关

接口功能

设置IP规则开关。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/iprule/switch

访问方法

PUT

参数说明

名称

必选/可选/条件必选

类型

说明
ENABLE 必选 bool

安全规则开关。

参数取值：

true：开启

false：关闭

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 string(enum)

管理对象类型编号。

参数取值：

236：IP规则

使用实例

  • 设置IP规则开关。

    Request: PUT /deviceManager/rest/210235843910E6000009/iprule/switch
{
    "ENABLE": "false"
}

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

查询IP规则开关

接口功能

查询IP规则开关。

URL路径

https://${ip}:${port}/deviceManager/rest/${deviceId}/iprule/switch

访问方法

GET

参数说明

无。

返回结果

名称

返回/条件返回

类型

说明

TYPE

 返回 string(enum)

管理对象类型编号。

参数取值：

236：IP规则

ENABLE

 返回 string(bool)

　安全规则开关。

参数取值：

true：开启

false：关闭

使用实例

  • 查询IP规则开关。

    Request: GET /deviceManager/rest/210235843910E6000009/iprule/switch

Response:
{
    "data": [
        {
            "ENABLE: "false",
            "TYPE": 236
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}
收藏
下载文档
更新时间：2021-02-09
文档编号：EDOC1100144154
浏览量：28067
下载量：426
平均得分：4.0分

相关文档