No relevant resource is found in the selected language.
Enterprise
Worldwide
Huawei Global - English
Support Documentation
OceanStor Dorado 6.1.0 REST Interface Reference

This document describes the concept, architecture, development preparation, and interface reference of Huawei OceanStor DeviceManager RESTful APIs and provides some code examples. Users can follow instructions in this document to develop applications for Huawei unified storage systems based on OceanStor DeviceManager RESTful APIs.

Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
system

system

Interface for Modifying the Equipment Time Zone

Function

This interface is used to modify the equipment time zone.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
CMO_SYS_TIME_ZONE_NAME

Mandatory

 string

Time zone name.

Note:When an interface is used to modify the device time zone, the delivered parameter is one of the returned values when an interface is used to query device time zone information.

Result

N/A

Example

  • Modifying the equipment time zone.

    Request: PUT /deviceManager/rest/210235843710E7000007/system_timezone
{
    "CMO_SYS_TIME_ZONE_NAME": "Asia/Beijing"
}

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

Interface for Querying the Equipment UTC Time

Function

This interface is used to query the equipment UTC time.

URL

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

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

CMO_SYS_UTC_TIME

Mandatory

 string

Equipment UTC time.

The value is described as follows:

946656000~3000000000

Unit:seconds

Example

  • Querying the equipment UTC time.

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

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

Interface for Modifying the Equipment UTC Time

Function

This interface is used to modify the equipment UTC time.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
CMO_SYS_UTC_TIME

Mandatory

 uint64

Equipment UTC time.

The value is described as follows:

946656000~3000000000

Unit:seconds

Result

N/A

Example

  • Modifying the equipment UTC time.

    Request: PUT /deviceManager/rest/210235843710E7000007/system_utc_time
{
    "CMO_SYS_UTC_TIME": 1478179247
}

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

Interface for Setting NTP Server

Function

This interface is used to set automatic NTP synchronization.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
CMO_SYS_NTP_CLNT_CONF_SWITCH

Mandatory

 uint32

NTP service status.

The value is described as follows:

0: Disabled

1: Enabled
CMO_SYS_NTP_CLNT_CONF_SERVER_IP

Conditional

 string

NTP server address.

The value is described as follows:

The value can be a domain name or an IPv4 or IPv6 address.

The domain name is a case-insensitive string of 1 to 255 characters, including letters, digits, and hyphens (-). Domain names at various levels are separated by periods (.). Hyphens (-) cannot be the start or end of the domain name.

Length:1~511

Note:A maximum of two addresses can be configured for an NTP server. The addresses are separated by commas (,). Each address contains a maximum of 255 characters.When the NTP service is set as enabled, this parameter must be delivered.
CMO_SYS_NTP_SYNC_PERIOD

Optional

 uint32

Synchronization period.

The value is described as follows:

60~864000

Default:60

Unit:seconds

Note:This parameter has been deprecated, NTP synchronizes the time automatically.
CMO_SYS_NTP_CLNT_CONF_AUTH_SWITCH

Optional

 enum

NTP authentication status.

The value is described as follows:

0: Disabled

1: Enabled

Note:The NTP version needs to be NTPv4 (included) or later.

Result

N/A

Example

  • Setting automatic NTP synchronization.

    Request: PUT /deviceManager/rest/210235843910E6000009/ntp_client_config
{
    "CMO_SYS_NTP_CLNT_CONF_SERVER_IP": "10.169.2.1,10.169.60.22",
    "CMO_SYS_NTP_CLNT_CONF_SWITCH": "1",
    "CMO_SYS_NTP_SYNC_PERIOD": "7200"
}

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

Interface for Querying NTP Server Information

Function

This interface is used to query NTP server configurations.

URL

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

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

CMO_SYS_NTP_CLNT_CONF_SWITCH

Mandatory

 uint32

NTP switch.

The value is described as follows:

0: Disabled

1: Enabled

CMO_SYS_NTP_CLNT_CONF_SERVER_IP

Mandatory

 string

NTP server address.

CMO_SYS_NTP_SYNC_PERIOD

Mandatory

 uint32

NTP synchronization period.

Unit:seconds

Note:This parameter has been deprecated, NTP synchronizes the time automatically.

CMO_SYS_NTP_CLNT_CONF_AUTH_SWITCH

Mandatory

 enum

NTP authentication status.

The value is described as follows:

0: Disabled

1: Enabled

Example

  • Querying NTP server configurations.

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

Response: 
{
    "data": {
        "CMO_SYS_NTP_CLNT_CONF_SERVER_IP": "10.169.2.1,10.169.60.22",
        "CMO_SYS_NTP_CLNT_CONF_SWITCH": "1",
        "CMO_SYS_NTP_SYNC_PERIOD": "7200",
        "CMO_SYS_NTP_CLNT_CONF_AUTH_SWITCH":"0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Equipment Time Zone

Function

This interface is used to query the equipment time zone.

URL

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

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

CMO_SYS_TIME_ZONE

Mandatory

 string

Time zone.

CMO_SYS_TIME_ZONE_NAME

Mandatory

 string

Time zone name.

CMO_SYS_TIME_ZONE_NAME_STYLE

Mandatory

 string(uint32)

Display style of the time zone name.

The value is described as follows:

0: short name (three letters)

1: long name

CMO_SYS_TIME_ZONE_USE_DST

Mandatory

 string(uint32)

Whether the time zone uses the DST.

The value is described as follows:

0: not used

1: used

Example

  • Querying the equipment time zone.

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

Response: 
{
    "data": {
        "CMO_SYS_TIME_ZONE": "+08:00",
        "CMO_SYS_TIME_ZONE_NAME": "Asia/Shanghai",
        "CMO_SYS_TIME_ZONE_NAME_STYLE": "1",
        "CMO_SYS_TIME_ZONE_USE_DST": "0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying NTP Status

Function

The show ntp status command is used to query the NTP status.

URL

https://${ip}:${port}/deviceManager/rest/${deviceId}/ntp_client_config/get_ntp_status

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

CMO_SYS_NTP_CLNT_CONF_SERVER_IP

Mandatory

 string

NTP server address.

currentConnectedNTPServer

Mandatory

 string

Current connected NTP server.

offset

Mandatory

 string

Time difference between the disk array and the current connected NTP server.

If "+xxx.xxx second (s)" is displayed, it indicates that the time of the disk array is xxx.xxx second (s) slower than that of the NTP server.

If "-xxx.xxx second (s)" is displayed, it indicates that the time of the disk array is xxx.xxx second (s) faster than that of the NTP server.

status

Mandatory

 enum

NTP status.

The value is described as follows:

0: Normal

1: Abnormal

2: --

Usage Guidelines

If the NTP configuration is modified, query the NTP status one minute later.

Example

  • Query the NTP status.

    Request: GET/deviceManager/rest/2102350BSJ1057233051/ntp_client_config/get_ntp_status

Response: {
    "data": {
        "CMO_SYS_NTP_CLNT_CONF_SERVER_IP": "8.46.3.172",
        "currentConnectedNTPServer": "8.46.3.172",
        "offset": "+0.001856 second(s)",
        "status": "0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying Basic System Information

Function

This interface is used to modify basic system information.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Optional

 string

System name.

The value is described as follows:

Contains letters, digits, underscores (_), hyphens (-), and periods (.).

Length:1~127
LOCATION

Optional

 string

Location.

Length:1~511
DESCRIPTION

Optional

 string

System description.

Length:0~255
WRITETHROUGHSW

Optional

 bool

Write through switch.

The value is described as follows:

true:write through when single controller

false:wiite cache when single controller
WRITETHROUGHTIME

Optional

 uint32

Write through timeout period.

The value is described as follows:

The value ranges from 0 to 2160. 0 indicates that write through never times out.

Unit:hours

Result

N/A

Usage Guidelines

Do not miss the last slash (/) at the end of the URL.

Example

  • Modifying the name and location of a system.

    Request: PUT /deviceManager/rest/210235843910E6000009/system/
{
    "NAME": "RESTful_test",
    "LOCATION": "chengdu"
}

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

Interface for Querying the Equipment Status

Function

This interface is used to query the equipment status.

URL

https://${ip}:${port}/deviceManager/rest/${deviceId}/server/status

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

status

Mandatory

 enum

Equipment status.

The value is described as follows:

0: Normal

1: Abnormal

2: Powering on

3: Powering off

4: Security Mode

5: Upgrading

6: Power supply failing

7: Offline

description

Mandatory

 string

description.

Example

  • Querying the equipment status.

    Request: GET /deviceManager/rest/210235843710E7000007/server/status

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

Interface for Restarting Equipment

Function

This interface is used to restart equipment.

URL

https://${ip}:${port}/deviceManager/rest/${deviceId}/SYSTEM/REBOOT

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
IMPORTANTPSW

Mandatory

 string

Password of the login user.

Result

N/A

Example

  • Restarting equipment.

    Request: PUT /deviceManager/rest/210235843710E7000007/SYSTEM/REBOOT
{
    "IMPORTANTPSW": "Admin@123"
}

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

Interface for Powering Off Equipment

Function

This interface is used to power off equipment.

URL

https://${ip}:${port}/deviceManager/rest/${deviceId}/SYSTEM/POWEROFF

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
IMPORTANTPSW

Mandatory

 string

Super administrator password.

Result

N/A

Example

  • Powering off equipment.

    Request: PUT /deviceManager/rest/210235843710E7000007/SYSTEM/POWEROFF
{
    "IMPORTANTPSW": "Admin@123"
}

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

Interface for Testing NTP Server Address

Function

This interface is used to Testing NTP server address.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
CMO_SYS_NTP_CLNT_CONF_SERVER_IP

Mandatory

 string

NTP Server Address.

The value is described as follows:

The value can be a domain name or an IPv4 or IPv6 address.

The domain name is a case-insensitive string of 1 to 255 characters, including letters, digits, and hyphens (-). Domain names at various levels are separated by periods (.). Hyphens (-) cannot be the start or end of the domain name.

Length:1~255

Result

N/A

Example

  • Testing NTP server address.

    Request: PUT /deviceManager/rest/210235843910E6000009/check_ntp_server_address_connective
{
    "CMO_SYS_NTP_CLNT_CONF_SERVER_IP": "10.169.2.1"
}

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

Interface for Querying Power Consumption in Real Time

Function

This interface is used to query system power consumption in real time.

URL

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

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

powerConsumptionValue

Mandatory

 uint32

System power consumption.

Unit:W

Example

  • Querying system power consumption in real time.

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

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

Interface for Querying Basic System Information

Function

This interface is used to query basic information about a system.

URL

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

Access Method

GET

Parameters

N/A

Result

Parameter

Mandatory/Conditional

Type

Description

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

201: System

ID

Mandatory

 string

System ID.

NAME

Mandatory

 string

System name.

LOCATION

Mandatory

 string

Location.

HEALTHSTATUS

Mandatory

 string(enum)

System health status.

The value is described as follows:

1: Normal

2: Faulty

RUNNINGSTATUS

Mandatory

 string(enum)

System running status.

The value is described as follows:

1: Normal

3: Not running

12: Powering on

47: Powering off

51: Upgrading

DESCRIPTION

Mandatory

 string

System description.

PRODUCTMODE

Mandatory

 string(enum)

Product model.

The value is described as follows:

812: Dorado 5000 V6 (NVMe)

813: Dorado 6000 V6 (SAS)

814: Dorado 6000 V6 (NVMe)

815: Dorado 8000 V6 (SAS)

816: Dorado 8000 V6 (NVMe)

817: Dorado 18000 V6 (SAS)

818: Dorado 18000 V6 (NVMe)

819: Dorado 3000 V6 (SAS)

821: Dorado 5000 V6 (IP SAS)

822: Dorado 6000 V6 (IP SAS)

823: Dorado 8000 V6 (IP SAS)

824: Dorado 18000 V6 (IP SAS)

825: Dorado 3000 V6

826: Dorado 5000 V6

827: Dorado 6000 V6

828: Dorado 6000 V6

829: Dorado 8000 V6

830: Dorado 18000 V6

831: Dorado 18000 V6

832: Dorado 18000 V6

PRODUCTVERSION

Mandatory

 string

Product version.

DOMAINNAME

Mandatory

 string

Domain name.

CACHEWRITEQUOTA

Mandatory

 string(uint64)

Cache write quota.

MEMBERDISKSCAPACITY

Mandatory

 string(uint64)

Total raw capacity of all member disks in a disk domain.

Unit:sectors

HOTSPAREDISKSCAPACITY

Mandatory

 string(uint64)

Total raw capacity of all hot spare disks (If no hot spare disks exist in the system, the value is 0. The value is fixed to 0 for systems built based on the XVE architecture.).

Unit:sectors

FREEDISKSCAPACITY

Mandatory

 string(uint64)

Total raw capacity of all free disks (If no free disks exist in the system, the value is 0.).

Unit:sectors

UNAVAILABLEDISKSCAPACITY

Mandatory

 string(uint64)

Total raw capacity of all unavailable disks (If no unavailable disks exist in the system, the value is 0. An unavailable disk is a malfunctioning member disk or free disk.).

Unit:sectors

STORAGEPOOLRAWCAPACITY

Mandatory

 string(uint64)

Total raw capacity of disks in all storage pools.

Unit:sectors

STORAGEPOOLCAPACITY

Mandatory

 string(uint64)

Available capacity after RAID groups are created in all storage pools.

Unit:sectors

STORAGEPOOLUSEDCAPACITY

Mandatory

 string(uint64)

Total used capacity of all storage pools (after RAID groups are created).

Unit:sectors

STORAGEPOOLFREECAPACITY

Mandatory

 string(uint64)

Total free capacity of all storage pools (after RAID groups are created).

Unit:sectors

STORAGEPOOLHOSTSPARECAPACITY

Mandatory

 string(uint64)

Total hot spare capacity reserved of all storage pools (after RAID groups are created).

Unit:sectors

THICKLUNSALLOCATECAPACITY

Mandatory

 string(uint64)

Total capacity allocated to all thick LUNs.

Unit:sectors

THICKLUNSUSEDCAPACITY

Mandatory

 string(uint64)

Total used capacity of all thick LUNs.

Unit:sectors

THINLUNSMAXCAPACITY

Mandatory

 string(uint64)

Total thin LUN capacity visible to the host.

Unit:sectors

THINLUNSALLOCATECAPACITY

Mandatory

 string(uint64)

Total capacity allocated to all thin LUNs.

Unit:sectors

THINLUNSUSEDCAPACITY

Mandatory

 string(uint64)

Total used capacity of all thin LUNs.

Unit:sectors

SECTORSIZE

Mandatory

 string(uint64)

Sector size.

Unit:bytes

VASA_SUPPORT_BLOCK

Mandatory

 string

Type of the block-based access interface. If multiple types exist, separate them from each other using a comma (,).

The value is described as follows:

FC

FCOE

ISCSI

Others

VASA_SUPPORT_FILESYSTEM

Mandatory

 string

Type of the supported file system interface.

VASA_ALTERNATE_NAME

Mandatory

 string

Disk array alias.

VASA_SUPPORT_PROFILE

Mandatory

 string

Type of the supported configuration file.

wwn

Mandatory

 string

WWN.

WRITETHROUGHSW

Mandatory

 string

Write through switch.

The value is described as follows:

0: off

false: off

1: on

true: on

WRITETHROUGHTIME

Mandatory

 string(uint64)

Write through timeout period.

The value is described as follows:

The value ranges from 0 to 2160. 0 indicates that write through never times out. The default value for entry-level and mid-range storage systems is 72.

Unit:hours

TOTALCAPACITY

Mandatory

 string(uint64)

Total system capacity.

Unit:sectors

USEDCAPACITY

Mandatory

 string(uint64)

Used system capacity.

Unit:sectors

CONFIGMODEL

Mandatory

 string(enum)

Single controller or multiple controllers.

The value is described as follows:

0: single controller

1: multiple controllers

mappedLunsCountCapacity

Mandatory

 string(uint64)

Total capacity of mapped LUNs.

Unit:sectors

unMappedLunsCountCapacity

Mandatory

 string(uint64)

Total capacity of unmapped LUNs.

Unit:sectors

userFreeCapacity

Mandatory

 string(uint64)

Available system capacity.

Unit:sectors

patchVersion

Conditional

 string

Patch version.

Note:This field is returned when it is a patch version.

pointRelease

Mandatory

 string

Point release.

productModeString

Mandatory

 string

Product model name.

Usage Guidelines

Do not miss the last slash (/) at the end of the URL.

Example

  • Querying basic information about a system.

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

Response:
{
    "data": {
        "CACHEWRITEQUOTA": "333",
        "CONFIGMODEL": "1",
        "DESCRIPTION": "",
        "DOMAINNAME": "",
        "FREEDISKSCAPACITY": "0",
        "HEALTHSTATUS": "1",
        "HOTSPAREDISKSCAPACITY": "0",
        "ID": "2102351PDW10HC000002",
        "LOCATION": "",
        "MEMBERDISKSCAPACITY": "43593750000",
        "NAME": "Huawei.Storage",
        "PRODUCTMODE": "805",
        "PRODUCTVERSION": "V600R005C01",
        "RUNNINGSTATUS": "1",
        "SECTORSIZE": "512",
        "STORAGEPOOLCAPACITY": "19546791701",
        "STORAGEPOOLFREECAPACITY": "19546791700",
        "STORAGEPOOLHOSTSPARECAPACITY": "6515597233",
        "STORAGEPOOLRAWCAPACITY": "39093583402",
        "STORAGEPOOLUSEDCAPACITY": "1",
        "THICKLUNSALLOCATECAPACITY": "0",
        "THICKLUNSUSEDCAPACITY": "-1",
        "THINLUNSALLOCATECAPACITY": "0",
        "THINLUNSMAXCAPACITY": "4201472",
        "THINLUNSUSEDCAPACITY": "-1",
        "TOTALCAPACITY": "43593750000",
        "TYPE": 201,
        "UNAVAILABLEDISKSCAPACITY": "0",
        "USEDCAPACITY": "1",
        "VASA_ALTERNATE_NAME": "Huawei.Storage",
        "VASA_SUPPORT_BLOCK": "FC,FCOE,ISCSI,Others",
        "VASA_SUPPORT_FILESYSTEM": "",
        "VASA_SUPPORT_PROFILE": "BlockDeviceProfile,CapabilityProfile,VirtualVolumeProfile",
        "WRITETHROUGHSW": "1",
        "WRITETHROUGHTIME": "192",
        "mappedLunsCountCapacity": "6144",
        "patchVersion": "",
        "pointRelease": "6.1.RC2",
        "productModeString": "Dorado5000 V3",
        "unMappedLunsCountCapacity": "4195328",
        "userFreeCapacity": "52124776935",
        "wwn": "2100602e2028e30f"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}
Download
Updated: 2021-02-09

Document ID: EDOC1100144155

Views: 33840

Downloads: 503

Average rating:
This Document Applies to these Products

Related Version

Related Documents

Share
Previous Next
Huawei e+ App Huawei e+

Copyright © 2022 Huawei Technologies Co., Ltd. All rights reserved.

You are going to visit :