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).
consistency_group

consistency_group

Interface for Disabling Secondary Resource Protection for a Consistency Group of Remote Replication

Function

This interface is used to disable secondary resource protection fro a consistency group of remote replication.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
SECRESACCESS

Mandatory

 enum

Read/write setting for a secondary LUN, used to set disabling write protection for the secondary LUN.

The value is described as follows:

3: read/write
ID

Mandatory

 string

Remote replication consistency group ID.

Result

N/A

Example

  • Disabling secondary resource protection fro a consistency group of remote replication.

    Request: PUT /deviceManager/rest/210235843910E6000009/CONSISTENTGROUP/4846fb8c15c0001
{
    "SECRESACCESS": "3"
}

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

Interface for Enabling Secondary Resource Protection for a Consistency Group of Remote Replication

Function

This interface is used to enable secondary resource protection for a consistency group of remote replication.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
SECRESACCESS

Mandatory

 enum

Read/write setting for a secondary LUN, used to set enabling write protection for the secondary LUN.

The value is described as follows:

2: read-only
ID

Mandatory

 string

Remote replication consistency group ID.

Result

N/A

Example

  • Enabling secondary resource protection for a consistency group of remote replication.

    Request: PUT /deviceManager/rest/210235843910E6000009/CONSISTENTGROUP/4846fb8c15c0001
{
    "SECRESACCESS": "2"
}

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

Interface for Splitting a Consistency Group of Remote Replication

Function

This interface is used to split a remote replication consistency group.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.

Result

N/A

Example

  • Splitting a remote replication consistency group.

    Request: PUT /deviceManager/rest/210235843910E6000009/SPLIT_CONSISTENCY_GROUP
{
    "ID": "4846fb8ca15c0000"
}

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

Interface for Performing a Primary_Secondary Switchover on a Consistency Group of Remote Replication

Function

This interface is used to perform primary_secondary switchover for remote replication consistency groups.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.

Result

N/A

Example

  • Performing primary_secondary switchover for remote replication consistency groups.

    Request: PUT /deviceManager/rest/210235843910E6000009/SWITCH_GROUP_ROLE
{
    "ID": "4846fb8ca15c0000"
}

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

Interface for Synchronizing a Consistency Group of Remote Replication

Function

This interface is used to synchronize remote replication consistency groups.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.

Result

N/A

Example

  • Synchronizing remote replication consistency groups.

    Request: PUT /deviceManager/rest/210235843910E6000009/SYNCHRONIZE_CONSISTENCY_GROUP
{
    "ID": "4846fb8ca15c0000"
}

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

Interface for Adding a Remote Replication Pair to a Consistency Group of Remote Replication

Function

This interface is used to add a remote replication pair to a remote replication consistency group.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.
RMLIST

Mandatory

 array

List of remote replication pair IDs. Only one remote replication pair can be added every time.

Result

N/A

Example

  • Adding a remote replication pair to a remote replication consistency group.

    Request: PUT /deviceManager/rest/210235843910E6000009/ADD_MIRROR
{
    "ID": "4846fb8ca15c0000",
    "RMLIST": ["4846fb8ca15c0004"]
}

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

Interface for Removing a Remote Replication Pair from a Consistency Group of Remote Replication

Function

This interface is used to remove a remote replication pair from a remote replication consistency group.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.
RMLIST

Mandatory

 array

List of remote replication pair IDs. Only one remote replication pair can be removed every time.

Result

N/A

Example

  • Removing a remote replication pair from a remote replication consistency group.

    Request: PUT /deviceManager/rest/210235843910E6000009/DEL_MIRROR
{
    "ID": "4846fb8ca15c0000",
    "RMLIST": ["4846fb8ca15c0004"]
}

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

Interface for Querying Available Consistency Groups

Function

This interface is used to query the remote replication consistency groups which can be used as members of the DR Star trio.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
consistencyGroupID

Mandatory

 string

ID of a HyperMetro or synchronous remote replication consistency group.
consistencyGroupType

Mandatory

 enum

Type of the consistency group.

The value is described as follows:

1: HYPERMETROCG

2: SYNCCONSISTENCYGROUP
otherRmCgID

Optional

 string

ID of the other remote replication consistency group.
remoteDeviceWWN

Mandatory

 string

WWN of the remote device at the third-party site.

Result

Parameter

Mandatory/Conditional

Type

Description

availableCGID

Mandatory

 string

IDs of remote replication consistency groups which can be used as members of the DR Star trio.

Example

  • Querying available remote replication consistency groups which can be used as members of the DR Star trio.

    Request: GET /deviceManager/rest/2102350AFH10H6000257/get_available_cg?remoteDeviceWWN=2100ad0203040506&consistencyGroupType=1&consistencyGroupID=21002102030405060000000100000000

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

Interface for Querying the Number of Consistency Groups of Remote Replication

Function

This interface is used to query the number of remote replication consistency groups.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Parameters NAME, ID, HEALTHSTATUS, REPLICATIONMODEL, ISPRIMARY, DRRINGID, and resourceSubtype are supported.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(int)

Number of queried remote replication consistency groups.

Example

  • Querying the number of remote replication consistency groups.

    Request: GET /deviceManager/rest/1016964156/CONSISTENTGROUP/count

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

Interface for Querying a Consistency Group of Remote Replication

Function

This interface is used to query a remote replication consistency group.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.
timeConversion

Optional

 uint32

Time conversion.

The value is described as follows:

0: UTC

1: Local time

Result

Parameter

Mandatory/Conditional

Type

Description

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

221: consistency group

ID

Mandatory

 string

Remote replication consistency group ID.

NAME

Mandatory

 string

Name.

HEALTHSTATUS

Mandatory

 string(enum)

Health status.

The value is described as follows:

1: normal

2: faulty

14: invalid

RUNNINGSTATUS

Mandatory

 string(enum)

Running status.

The value is described as follows:

1: Normal

23: Synchronizing

33: To be recovered

34: Interrupted

26: Split

35: Invalid

110: Standby

DESCRIPTION

Mandatory

 string

Description.

RECOVERYPOLICY

Mandatory

 string(enum)

Recovery policy.

The value is described as follows:

1: automatic

2: manual

REPLICATIONMODEL

Mandatory

 string(enum)

Replication mode.

The value is described as follows:

1: synchronous remote replication

2: asynchronous remote replication

SPEED

Mandatory

 string(enum)

Rate.

The value is described as follows:

1: low

2: medium

3: high

4: highest

SYNCHRONIZETYPE

Mandatory

 string(enum)

Synchronization type.

The value is described as follows:

1: Manual.

2: Timed wait after synchronization begins.

3: Timed wait after synchronization ends.

4: Specific time policy.

Note:This field is valid for asynchronous remote replication only. "255" indicates an invalid value.

ISPRIMARY

Mandatory

 string(bool)

Indicates whether it is a primary end.

The value is described as follows:

true: yes

false: no

TIMINGVAL

Conditional

 string(uint32)

Timing period. The timing period takes effect when the synchronization type is not manual.

Unit:minutes

Note:This parameter is returned when the replication mode is asynchronous.

TIMINGVALINSEC

Conditional

 string(uint32)

Timing period. The timing period takes effect when the synchronization type is not manual.

Unit:seconds

Note:This parameter is returned when the replication mode is asynchronous.

ISEMPTY

Mandatory

 string(bool)

Indicates whether a consistency group is empty.

The value is described as follows:

true: yes

false: no

ENABLECOMPRESS

Conditional

 string(bool)

Link compression.

The value is described as follows:

true: enables compression.

false: disables compression.

Note:This field is valid for asynchronous remote replication only.

COMPRESSVALID

Conditional

 string(bool)

Indicates whether compression has taken effect.

The value is described as follows:

true: valid

false: invalid

Note:This field is returned for asynchronous remote replication.

STARTTIME

Mandatory

 string(uint64)

Start time.

Note:"-1" indicates an invalid value.

ENDTIME

Mandatory

 string(uint64)

End time.

Note:"-1" indicates an invalid value.

TIMEDIFFERENCE

Conditional

 string

Time difference.

Note:"-1" indicates an invalid value. This field is returned when the replication mode is asynchronous and the consistency group has been synchronized.

REMTIMEOUTPERIOD

Mandatory

 uint32

I/O timeout threshold for the secondary LUN.

The value is described as follows:

The value ranging from 10 to 30 indicates that the I/O timeout threshold for remote resources is enabled and the timeout threshold is set to the specified value. 255 indicates that the I/O timeout threshold for remote resources is not enabled.

Unit:seconds

cg_type

Mandatory

 string(enum)

Type of the consistency group.

The value is described as follows:

0: common consistency group

DRRINGID

Mandatory

 string

ID of the DR Star trio.

bandwidth

Mandatory

 uint64

Indicates the bandwidth.

Unit:MB/s

localPgId

Mandatory

 uint64_t

Local protection group ID.

The value is described as follows:

0 to 8191.

rmtpgId

Mandatory

 uint64_t

Remote protection group ID.

The value is described as follows:

0 to 8191.

localpgName

Mandatory

 string

Local protection group name.

rmtpgName

Mandatory

 string

Remote protection group name.

SYNCHRONIZESCHEDULE

Conditional

 json

Schedule for starting the synchronization of an asynchronous remote replication consistency group..

The value is described as follows:

Delivery by week:

{"WEEK":{"WEEKDAY":"[0,1,2,3,4,5,6]","TIME":"11:00"}}.

Delivery by day:

{"DAY":"01:00"}.

Delivery by hour:

{"HOUR":"9"}.

Note:This parameter is returned when the replication mode is asynchronous.

asyncToSyncBandwidth

Conditional

 string(uint32)

Host bandwidth when asynchronous remote replication switches to synchronous remote replication.

The value is described as follows:

1..10485760

Note:This parameter is returned when the switch for automatically converting asynchronous replication to synchronous replication is enabled.

transferCycle

Conditional

 string(uint32)

Duration during which the automatic switchover condition is met when asynchronous remote replication switches to synchronous remote replication.

The value is described as follows:

1..1440

Note:This parameter is returned when the switch for automatically converting asynchronous replication to synchronous replication is enabled.

syncToAsynclatency

Conditional

 string(uint32)

Host latency when synchronous remote replication switches to asynchronous remote replication.

The value is described as follows:

1..5000

Note:This parameter is returned when the switch for automatically converting synchronous replication to asynchronous replication is enabled.

asyncToSyncLatency

Conditional

 string(uint32)

Host latency when asynchronous remote replication switches to synchronous remote replication.

The value is described as follows:

1..5000

Note:This parameter is returned when the switch for automatically converting asynchronous replication to synchronous replication is enabled.

syncToAsyncBandwidth

Conditional

 string(uint32)

Host bandwidth when synchronous remote replication switches to asynchronous remote replication.

The value is described as follows:

1..10485760

Note:This parameter is returned when the switch for automatically converting synchronous replication to asynchronous replication is enabled.

switchToSync

Mandatory

 string(enum)

Whether asynchronous remote replication automatically switches to synchronous remote replication.

The value is described as follows:

1: open

0: close

switchToAsync

Mandatory

 string(enum)

Whether synchronous remote replication automatically switches to asynchronous remote replication.

The value is described as follows:

1: open

0: close

resourceSubtype

Mandatory

 enum

Resource subtype.

The value is described as follows:

0: common LUN

1: VVol LUN

syncSnapPolicy

Mandatory

 enum

User snapshot synchronization policy.

The value is described as follows:

0:"NOT_SYNC_SNAP": User snapshots are not synchronized.

1:"SAME_AS_SOURCE": Snapshots on the secondary storage system must be the same as those on the primary storage system.

2:"USER_SNAP_RETENTION_NUM": A specified number of user snapshots are retained on the secondary storage system.

userSnapRetentionNum

Conditional

 uint32

Number of retained user snapshots on the secondary storage system.

The value is described as follows:

1 to 512.

Note:This parameter is returned when the user snapshot synchronization policy is that a specified number of user snapshots are retained on the secondary storage system.

backupCopyPolicy

Mandatory

 enum

Retention policy of copy snapshots on the secondary storage system.

The value is described as follows:

0:"NO_RETENTION": Copy snapshots are not retained on the secondary storage system.

1:"COPY_SNAP_RETENTION_NUM": A specified number of copy snapshots are retained on the secondary storage system.

Note:This parameter is not supported in this version.

copySnapRetentionNum

Conditional

 uint32

Number of copy snapshots retained on the secondary storage system.

The value is described as follows:

1 to 512.

Note:This parameter is returned when the snapshot retention policy of the secondary storage system is that a specified number of copy snapshots are retained at the secondary storage system. This parameter is not supported in this version.

remoteArrayID

Mandatory

 uint32

Specifies the ID of the remote storage array.

The value is described as follows:

0 to 64.

Example

  • Querying a remote replication consistency group.

    Request: GET /deviceManager/rest/210235843910E6000009/CONSISTENTGROUP/4846fb8ca15c0000

Response:
{
    "data": {
        DESCRIPTION: "1133"
        DRRINGID: "--"
        ENDTIME: "1592806999"
        HEALTHSTATUS: "1"
        ID: "21004b02030405060000000300000000"
        ISEMPTY: "false"
        ISPRIMARY: "true"
        NAME: "cg_rep_Huaage_whj160"
        RECOVERYPOLICY: "1"
        REMTIMEOUTPERIOD: "255"
        REPLICATIONMODEL: "1"
        RUNNINGSTATUS: "1"
        SPEED: "2"
        STARTTIME: "1592806998"
        SYNCHRONIZETYPE: "3"
        TIMEDIFFERENCE: "72718"
        TIMINGVALINSEC: "3600"
        TYPE: 221
        asyncToSyncBandwidth: "800"
        bandwidth: "-1"
        localPgName: "whj"
        localpgId: "0"
        remoteArrayID: "0"
        rmtPgName: "Huaage_whj516"
        rmtpgId: "0"
        switchToSync: "1"
        swtichToAsync: "1"
        transferCycle: "60"
        syncSnapPolicy: "0"
        userSnapRetentionNum: "--"
        backupCopyPolicy: "0"
        copySnapRetentionNum: "--"
        resourceSubtype: "0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Batch Querying a Consistency Group of Remote Replication

Function

This interface is used to batch query remote replication consistency groups.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Parameters NAME, ID, HEALTHSTATUS, REPLICATIONMODEL, ISPRIMARY, cg_type, DRRINGID, and resourceSubtype are supported.
range

Optional

 string

Query scope.

The value is described as follows:

range:[i-j],"range" specifies that objects with subscripts from i to j-1 in the query result are returned. This parameter is used for paging query.

Note:A maximum of 10000 results can be returned.
timeConversion

Optional

 uint32

Time conversion.

The value is described as follows:

0: UTC

1: Local time
localpgId

Optional

 string

Local protection group ID.

The value is described as follows:

0 to 8191.

Length:32

Result

Parameter

Mandatory/Conditional

Type

Description

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

221: consistency group

ID

Mandatory

 string

Remote replication consistency group ID.

NAME

Mandatory

 string

Name.

HEALTHSTATUS

Mandatory

 string(enum)

Health status.

The value is described as follows:

1: Normal

2: Faulty

14: Invalid

RUNNINGSTATUS

Mandatory

 string(enum)

Running status.

The value is described as follows:

1: Normal

23: Synchronizing

33: To be recovered

34: Interrupted

26: Split

35: Invalid

110: Standby

DRRINGID

Mandatory

 string

ID of the DR Star trio.

DESCRIPTION

Mandatory

 string

Description.

RECOVERYPOLICY

Mandatory

 string(enum)

Recovery policy.

The value is described as follows:

1: automatic

2: manual

REPLICATIONMODEL

Mandatory

 string(enum)

Replication model.

The value is described as follows:

1: synchronous replication

2: asynchronous replication

SPEED

Mandatory

 string(enum)

Rate.

The value is described as follows:

1: low

2: medium

3: high

4: highest

SYNCHRONIZETYPE

Mandatory

 string(enum)

Synchronization type.

The value is described as follows:

1: Manual.

2: Timed wait after synchronization begins.

3: Timed wait after synchronization ends.

Note:This field is valid for asynchronous remote replication only."255" indicates an invalid value.

ISPRIMARY

Mandatory

 string(bool)

Indicates whether it is a primary end.

The value is described as follows:

true: yes

false: no

TIMINGVAL

Conditional

 string(uint32)

Timing period, expressed in minutes. The timing period takes effect when the synchronization type is not manual.

Unit:minutes

Note:This parameter is returned when the replication mode is asynchronous.

TIMINGVALINSEC

Conditional

 string(uint32)

Timing period, expressed in seconds. The timing period takes effect when the synchronization type is not manual.

Unit:seconds

Note:This parameter is returned when the replication mode is asynchronous.

ISEMPTY

Mandatory

 string(bool)

Indicates whether a consistency group is empty.

The value is described as follows:

true: yes

false: no

ENABLECOMPRESS

Conditional

 string(bool)

Link compression.

The value is described as follows:

true: enables compression.

false: disables compression.

Note:This field is valid for asynchronous replication only.

COMPRESSVALID

Conditional

 string(bool)

Indicates whether compression has taken effect.

The value is described as follows:

true: valid

false: invalid

Note:This field is returned for asynchronous replication.

STARTTIME

Mandatory

 string(uint64)

Start time.

Note:"-1" indicates an invalid value.

ENDTIME

Mandatory

 string(uint64)

End time.

Note:"-1" indicates an invalid value.

TIMEDIFFERENCE

Conditional

 string

Time difference.

Note:"-1" indicates an invalid value. This field is returned when the replication mode is asynchronous and the consistency group has been synchronized.

REMTIMEOUTPERIOD

Mandatory

 uint32

I/O timeout threshold for the secondary LUN.

The value is described as follows:

The value ranging from 10 to 30 indicates that the I/O timeout threshold for remote resources is enabled and the timeout threshold is set to the specified value. 255 indicates that the I/O timeout threshold for remote resources is not enabled.

Unit:seconds

cg_type

Mandatory

 string(enum)

Type of the consistency group.

The value is described as follows:

0: common consistency group

1: cloud consistency group

remoteArrayID

Mandatory

 string

Remote device ID.

The value is described as follows:

0 to 9 characters.

localpgId

Mandatory

 string

Local protection group ID.

rmtpgId

Mandatory

 string

Remote protection group ID.

bandwidth

Mandatory

 uint64_t

Bandwidth.

The value is described as follows:

2-500

Unit:MB/s

localPgName

Mandatory

 string

Local protection group name.

rmtPgName

Mandatory

 string

Remote protection group name.

resourceSubtype

Mandatory

 enum

Resource subtype.

The value is described as follows:

0: common LUN

1: VVol LUN

syncSnapPolicy

Mandatory

 enum

User snapshot synchronization policy.

The value is described as follows:

0:"NOT_SYNC_SNAP": User snapshots are not synchronized.

1:"SAME_AS_SOURCE": Snapshots on the secondary storage system must be the same as those on the primary storage system.

2:"USER_SNAP_RETENTION_NUM": A specified number of user snapshots are retained on the secondary storage system.

copySnapRetentionNum

Conditional

 uint32

Number of copy snapshots retained on the secondary storage system.

The value is described as follows:

1 to 512.

Note:This parameter is returned when the user snapshot synchronization policy is to retain a specified number of user snapshots at the secondary storage system. This parameter is not supported in this version.

backupCopyPolicy

Mandatory

 enum

Retention policy of copy snapshots on the secondary storage system.

The value is described as follows:

0:"NO_RETENTION": Snapshot copies are not retained on the secondary storage system.

1:"COPY_SNAP_RETENTION_NUM": A specified number of snapshot copies are retained on the secondary storage system.

Note:This parameter is not supported in this version.

userSnapRetentionNum

Conditional

 uint32

Number of retained user snapshots on the secondary storage system.

The value is described as follows:

1 to 512.

Note:This parameter is returned when the snapshot retention policy of the secondary storage system is that a specified number of copy snapshots are retained at the secondary storage system.

Example

  • Batch querying remote replication consistency groups.

    Request: GET/deviceManager/rest/210235843910E6000009/CONSISTENTGROUP?filter=REPLICATIONMODEL: : 2&localpgId: : 1&cg_type: : 1&range=[
    0-100
]Response: {
    "data": [
        {
            "COMPRESSVALID": "false",
            "DESCRIPTION": "",
            "ENABLECOMPRESS": "false",
            "HEALTHSTATUS": "1",
            "ID": "4846fb8ca15c0000",
            "ISEMPTY": "false",
            "ISPRIMARY": "true",
            "NAME": "ConsistentGroup001",
            "RECOVERYPOLICY": "1",
            "REPLICATIONMODEL": "2",
            "RUNNINGSTATUS": "26",
            "SPEED": "2",
            "SYNCHRONIZETYPE": "1",
            "TIMINGVAL": "-1",
            "TIMINGVALINSEC": "-1",
            "TYPE": 221,
            "TIMEDIFFERENCE": "-1",
            "REMTIMEOUTPERIOD": "255",
            "STARTTIME": "1487859783",
            "ENDTIME": "1487859806",
            "cg_type": "1",
            "DRRINGID": "4846fb8ca15c0001",
            "syncSnapPolicy": "0",
            "userSnapRetentionNum": "--",
            "backupCopyPolicy": "0",
            "copySnapRetentionNum": "--",
            "resourceSubtype": "0"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying a Consistency Group of Remote Replication

Function

This interface is used to modify a remote replication consistency group.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Remote replication consistency group ID.
NAME

Optional

 string

Name.

The value is described as follows:

The value cannot be empty and must start with a letter or digit. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

Length:1~31
DESCRIPTION

Optional

 string

Description.

Length:0~127
RECOVERYPOLICY

Optional

 enum

Recovery policy.

The value is described as follows:

1: automatic

2: manual
SPEED

Optional

 enum

Rate.

The value is described as follows:

1: low

2: medium

3: high

4: highest
SYNCHRONIZETYPE

Optional

 enum

Synchronization type.

The value is described as follows:

1: Manual.

2: Timed wait after synchronization begins.

3: Timed wait after synchronization ends.

4: Specific time policy.

Note:This parameter must be delivered for asynchronous remote replication.
SYNCHRONIZESCHEDULE

Conditional

 json

Schedule for starting the synchronization of an asynchronous remote replication consistency group.

The value is described as follows:

Delivery by week:

{"WEEK":{"WEEKDAY":"[0,1,2,3,4,5,6]","TIME":"11:00"}}.

Delivery by day:

{"DAY":"01:00"}.

Delivery by hour:

{"HOUR":"9"}.

Note:Only when "SYNCHRONIZETYPE" is set to "4", this parameter is valid. Only one of the three schedules can be configured.
TIMINGVAL

Conditional

 uint32

Timing period. The timing period takes effect when the synchronization type is not manual.

The value is described as follows:

1 to 1440 minutes.

Unit:minutes

Note:This field must be delivered when the synchronization type is changed from manual to timed wait when synchronization begins or timed wait when synchronization ends. Parameters TIMINGVAL and TIMINGVALINSEC cannot be delivered at the same time.
TIMINGVALINSEC

Conditional

 uint32

Timing period. The timing period takes effect when the synchronization type is not manual.

The value is described as follows:

10 to 86400 seconds. If the value is greater than or equals to 60, it must be a multiple of 60.

Unit:seconds

Note:This field must be delivered when the synchronization type is changed from manual to timed wait when synchronization begins or timed wait when synchronization ends. Parameters TIMINGVAL and TIMINGVALINSEC cannot be delivered at the same time.
ENABLECOMPRESS

Optional

 bool

Link compression. (only asynchronous).

The value is described as follows:

true: enables compression.

false: disables compression.

Note:This field is valid for asynchronous remote replication only.
REMTIMEOUTPERIOD

Conditional

 uint32

I/O timeout threshold for the secondary LUN.

The value is described as follows:

The value ranging from 10 to 30 indicates that the I/O timeout threshold for remote resources is enabled and the timeout threshold is set to the specified value. 255 indicates that the I/O timeout threshold for remote resources is not enabled or not supported.

Unit:seconds

Note:This field must be delivered when you set the I/O timeout threshold for synchronous remote replication.
bandwidth

Optional

 uint64

Bandwidth.

The value is described as follows:

1 to 1024.

Unit:MB/s
asyncToSyncBandwidth

Conditional

 uint32

Host bandwidth when asynchronous remote replication restores to synchronous remote replication.

The value is described as follows:

0 to 10485760.

Note:This parameter is mandatory when asynchronous remote replication automatically restores to synchronous remote replication.
transferCycle

Conditional

 uint32

Duration during which the automatic switchover condition is met when asynchronous remote replication restores to synchronous remote replication.

The value is described as follows:

1 to 1440.

Note:This parameter is mandatory when asynchronous remote replication automatically restores to synchronous remote replication.
syncToAsynclatency

Conditional

 uint32

Host latency when synchronous remote replication switches to asynchronous remote replication.

The value is described as follows:

0 to 5000.

Note:This parameter is mandatory when synchronous remote replication automatically switches to asynchronous remote replication.
asyncToSyncLatency

Conditional

 uint32

Host latency when asynchronous remote replication restores to synchronous remote replication.

The value is described as follows:

0 to 5000.

Note:This parameter is mandatory when asynchronous remote replication automatically restores to synchronous remote replication.
syncToAsyncBandwidth

Conditional

 uint32

Host bandwidth when synchronous remote replication switches to asynchronous remote replication.

The value is described as follows:

0 to 10485760.

Note:This parameter is mandatory when synchronous remote replication automatically switches to asynchronous remote replication.
switchtosync

Optional

 enum

Whether asynchronous remote replication automatically restores to synchronous remote replication.

The value is described as follows:

1: open

0: close

Note:This parameter can be set to ON only when the replication mode is sync.
switchtoasync

Optional

 enum

Whether synchronous remote replication automatically switches to asynchronous remote replication.

The value is described as follows:

1: open

0: close

Note:This parameter can be set to ON only when the replication mode is sync.
backupCopyPolicy

Optional

 enum

Retention policy of copy snapshots on the secondary storage system.

The value is described as follows:

0:"NO_RETENTION": Copy snapshots are not retained on the secondary storage system.

1:"COPY_SNAP_RETENTION_NUM": A specified number of copy snapshots are retained on the secondary storage system.

Note:This parameter is not supported in this version.
copySnapRetentionNum

Conditional

 uint32

Number of copy snapshots retained on the secondary storage system.

The value is described as follows:

1 to 512.

Note:Only when "backupCopyPolicy" is set to "1", this parameter is valid. This parameter is not supported in this version.
syncSnapPolicy

Optional

 enum

User snapshot synchronization policy.

The value is described as follows:

0:"NOT_SYNC_SNAP": User snapshots are not synchronized.

1:"SAME_AS_SOURCE": Snapshots on the secondary storage system must be the same as those on the primary storage system.

2:"USER_SNAP_RETENTION_NUM": A specified number of user snapshots are retained on the secondary storage system.
userSnapRetentionNum

Conditional

 uint32

Number of retained user snapshots on the secondary storage system.

The value is described as follows:

1 to 512.

Note:Only when "syncSnapPolicy" is set to "2", this parameter is valid.

Result

N/A

Example

  • Modifying a remote replication consistency group.

    Request: PUT /deviceManager/rest/210235843910E6000009/CONSISTENTGROUP/4846fb8c15c0001
{
    "SYNCHRONIZETYPE": "2",
    "TIMINGVALINSEC": "3600"
}

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

Interface for Deleting a Consistency Group of Remote Replication

Function

This interface is used to delete a remote replication consistency group.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ISLOCALDELETE

Optional

 bool

Indicates whether a remote replication consistency group can be locally deleted when the link is disconnected. When this parameter is not delivered, the default value is no, indicating a remote replication consistency group cannot be locally deleted.

The value is described as follows:

false: no

true: yes

Default:false: no
ID

Mandatory

 string

Remote replication consistency group ID.
resourceSubtype

Optional

 enum

Resource subtype.

The value is described as follows:

0: common LUN

1: VVol LUN

Result

N/A

Example

  • Deleting a remote replication consistency group.

    Request: DELETE /deviceManager/rest/210235843910E6000009/CONSISTENTGROUP/4846fb8c15c0001?ISLOCALDELETE=false

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

Interface for Creating a Consistency Group of Remote Replication

Function

This interface is used to create a remote replication consistency group.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Name.

The value is described as follows:

The value cannot be empty, includes only digits, underscores (_), hyphens (-), and periods (.), and must start with a letter or digit.

Length:1~31
DESCRIPTION

Optional

 string

Description.

Length:0~127
RECOVERYPOLICY

Optional

 enum

Recovery policy.

The value is described as follows:

1: automatic

2: manual

Default:1: automatic

Note:The default value is automatic recovery.
REPLICATIONMODEL

Optional

 enum

Replication mode.

The value is described as follows:

1: synchronous remote replication

2: asynchronous remote replication

Default:2: asynchronous

Note:The default value is asynchronous.
SPEED

Optional

 enum

Rate.

The value is described as follows:

1: low

2: medium

3: high

4: highest

Default:2: medium
SYNCHRONIZETYPE

Optional

 enum

Synchronization type.

The value is described as follows:

1: manual

2: timed wait when synchronization begins

3: timed wait when synchronization ends

4: specific time policy.

Default:1: manual

Note:This parameter is valid for asynchronous remote replication only. The default value is manual synchronization.
TIMINGVAL

Conditional

 uint32

Timing period. The timing period takes effect when the synchronization type is not manual.

The value is described as follows:

1 to 1440 min.

Unit:minutes

Note:This field must be delivered when the synchronization type is timed wait.
TIMINGVALINSEC

Conditional

 uint32

Timing period. The timing period takes effect when the synchronization type is not manual. This parameter and the parameter TIMINGVAL cannot be delivered at the same time.

The value is described as follows:

10 to 86400s. If the value is greater than or equals to 60, it must be a multiple of 60.

Unit:seconds

Note:This field must be delivered when the synchronization type is timed wait. This parameter and the parameter TIMINGVAL cannot be delivered at the same time.
ENABLECOMPRESS

Optional

 bool

Link compression (for asynchronous remote replication only).

The value is described as follows:

true: enables compression.

false: disables compression.

Default:false: disables compression.

Note:This field is valid for asynchronous remote replication only.
cg_type

Optional

 enum

Type of the consistency group.

The value is described as follows:

0: common consistency group

Default:0: common consistency group
localpgId

Optional

 string

Local protection group ID.

The value is described as follows:

0 to 16383.

Length:32
rmtpgId

Optional

 string

Remote protection group ID.

The value is described as follows:

0 to 16383.

Length:32
remoteArrayID

Optional

 string

Remote device ID.

The value is described as follows:

0 to 63.

Length:16
SYNCHRONIZESCHEDULE

Conditional

 json

Schedule for starting the synchronization of an asynchronous consistency group.

The value is described as follows:

Delivery by week:

{"WEEK":{"WEEKDAY":"[0,1,2,3,4,5,6]","TIME":"11:00"}}.

Delivery by day:

{"DAY":"01:00"}.

Delivery by hour:

{"HOUR":"9"}.

Note:Only when "SYNCHRONIZETYPE" is set to "4", this parameter is valid. Only one of the three schedules can be configured.
syncSnapPolicy

Optional

 enum

User snapshot synchronization policy.

The value is described as follows:

0:"NOT_SYNC_SNAP": User snapshots are not synchronized.

1:"SAME_AS_SOURCE": Snapshots on the secondary storage system must be the same as those on the primary storage system.

2:"USER_SNAP_RETENTION_NUM": A specified number of user snapshots are retained on the secondary storage system.
userSnapRetentionNum

Conditional

 uint32

Number of retained user snapshots on the secondary storage system.

The value is described as follows:

1 to 512.

Note:Only when "syncSnapPolicy" is set to "2", this parameter is valid.
backupCopyPolicy

Optional

 enum

Retention policy of copy snapshots on the secondary storage system.

The value is described as follows:

0:"NO_RETENTION": Copy snapshots are not retained on the secondary storage system.

1:"COPY_SNAP_RETENTION_NUM": A specified number of copy snapshots are retained on the secondary storage system.

Note:Note: This parameter is not supported in this version.
copySnapRetentionNum

Conditional

 uint32

Number of copy snapshots retained on the secondary storage system.

The value is described as follows:

1 to 512.

Note:Only when "backupCopyPolicy" is set to "1", this parameter is valid. This parameter is not supported in this version.
resourceSubtype

Optional

 enum

Resource subtype.

The value is described as follows:

0: common LUN

1: VVol LUN

Result

Parameter

Mandatory/Conditional

Type

Description

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

221: consistency group

ENDTIME

Mandatory

 time

End time.

Note:This field is returned when the value is a valid value.

STARTTIME

Mandatory

 time

Start time.

Note:This field is returned when the value is a valid value.

ID

Mandatory

 string

ID.

NAME

Mandatory

 string

Name.

HEALTHSTATUS

Mandatory

 string(enum)

Health status.

The value is described as follows:

1: Normal

2: Faulty

14: Invalid

RUNNINGSTATUS

Mandatory

 string(enum)

Running status.

The value is described as follows:

1: Normal

23: Synchronizing

33: To be recovered

34: Interrupted

26: Split

35: Invalid

DESCRIPTION

Mandatory

 string

Description.

RECOVERYPOLICY

Mandatory

 string(enum)

Recovery policy.

The value is described as follows:

1: automatic

2: manual

REPLICATIONMODEL

Mandatory

 string(enum)

Replication mode.

The value is described as follows:

1: synchronous remote replication

2: asynchronous remote replication

SPEED

Mandatory

 string(enum)

Rate.

The value is described as follows:

1: low

2: medium

3: high

4: highest

SYNCHRONIZETYPE

Mandatory

 string(enum)

Synchronization type.

The value is described as follows:

1: manual

2: timed wait when synchronization begins

3: timed wait when synchronization ends

Note:This field is valid for asynchronous remote replication only. "255" indicates an invalid value.

ISPRIMARY

Mandatory

 string(bool)

Indicates whether it is a primary end.

The value is described as follows:

true: yes

false: no

TIMINGVAL

Conditional

 string(uint32)

Timing period. The timing period takes effect when the synchronization type is not manual.

Unit:minutes

Note:This field is returned for asynchronous remote replication.

TIMINGVALINSEC

Conditional

 string(uint32)

Timing period. The timing period takes effect when the synchronization type is not manual.

Unit:seconds

Note:This field is returned for asynchronous remote replication.

ISEMPTY

Mandatory

 string(bool)

Indicates whether a consistency group is empty.

The value is described as follows:

true: yes

false: no

ENABLECOMPRESS

Conditional

 string(bool)

Link compression (for asynchronous remote replication only).

The value is described as follows:

true: enables compression.

false: disables compression.

Note:This field is valid for asynchronous remote replication only.

COMPRESSVALID

Conditional

 string(bool)

Indicates whether compression has taken effect.

The value is described as follows:

true: valid

false: invalid

Note:This field is returned for asynchronous remote replication.

TIMEDIFFERENCE

Conditional

 string

Time difference.

Note:

This field is returned for asynchronous remote replication.

This field is returned when the value is a valid value.

REMTIMEOUTPERIOD

Mandatory

 string(uint32)

I/O timeout threshold for the secondary LUN.

The value is described as follows:

The value ranging from 10 to 30 indicates that the I/O timeout threshold for remote resources is enabled and the timeout threshold is set to the specified value. 255 indicates that the I/O timeout threshold for remote resources is not enabled or supported.

Unit:seconds

Note:This field is returned for synchronous remote replication.

cg_type

Mandatory

 string(enum)

Type of the consistency group.

The value is described as follows:

0: common consistency group

DRRINGID

Mandatory

 string

ID of the DR Star trio.

syncSnapPolicy

Mandatory

 enum

User snapshot synchronization policy.

The value is described as follows:

0:"NOT_SYNC_SNAP": User snapshots are not synchronized.

1:"SAME_AS_SOURCE": Snapshots on the secondary storage system must be the same as those on the primary storage system.

2:"USER_SNAP_RETENTION_NUM": A specified number of user snapshots are retained on the secondary storage system.

userSnapRetentionNum

Conditional

 uint32

Number of retained user snapshots on the secondary storage system.

The value is described as follows:

1 to 512.

Note:This parameter is returned when the user snapshot synchronization policy is that a specified number of user snapshots are retained on the secondary storage system.

backupCopyPolicy

Mandatory

 enum

Retention policy of copy snapshots on the secondary storage system.

The value is described as follows:

0:"NO_RETENTION": Copy snapshots are not retained on the secondary storage system.

1:"COPY_SNAP_RETENTION_NUM": A specified number of copy snapshots are retained on the secondary storage system.

copySnapRetentionNum

Conditional

 uint32

Number of copy snapshots retained on the secondary storage system.

The value is described as follows:

1 to 512.

Note:This parameter is returned when the snapshot retention policy of the secondary storage system is that a specified number of copy snapshots are retained at the secondary storage system.

resourceSubtype

Mandatory

 enum

Resource subtype.

The value is described as follows:

0: common LUN

1: VVol LUN

Example

  • Creating a remote replication consistency group.

    Request: POST/deviceManager/rest/210235843910E6000009/CONSISTENTGROUP{
    "DESCRIPTION": "",
    "ENABLECOMPRESS": "false",
    "NAME": "ConsistentGroup001",
    "RECOVERYPOLICY": "1",
    "REPLICATIONMODEL": "2",
    "SPEED": "2",
    "SYNCHRONIZETYPE": "1"
}Response: {
    "data": {
        "COMPRESSVALID": "false",
        "DESCRIPTION": "",
        "ENABLECOMPRESS": "false",
        "HEALTHSTATUS": "1",
        "ID": "4846fb8ca15c0000",
        "ISEMPTY": "true",
        "ISPRIMARY": "true",
        "NAME": "ConsistentGroup001",
        "RECOVERYPOLICY": "1",
        "REPLICATIONMODEL": "2",
        "RUNNINGSTATUS": "1",
        "SPEED": "2",
        "STARTTIME": "-1",
        "ENDTIME": "-1",
        "SYNCHRONIZETYPE": "1",
        "TIMINGVAL": "-1",
        "TIMINGVALINSEC": "-1",
        "TYPE": 221,
        "TIMEDIFFERENCE": "-1",
        "REMTIMEOUTPERIOD": "255",
        "cg_type": "0",
        "DRRINGID": "4846fb8ca15c0002""localpgId": "1",
        "rmtpgId": "1",
        "syncSnapPolicy": "0",
        "userSnapRetentionNum": "--",
        "backupCopyPolicy": "0",
        "copySnapRetentionNum": "--",
        "resourceSubtype": "0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Changing the Replication Mode of a Remote Replication Consistency Group

Function

This interface is used to change the replication mode of a remote replication consistency group.

URL

https://${ip}:${port}/deviceManager/rest/${deviceId}/CONSISTENTGROUP/transfer

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

221: consistency group
ID

Mandatory

 string

ID of a remote replication consistency group.
REPLICATIONMODEL

Mandatory

 string(enum)

Remote replication mode.

The value is described as follows:

LUN-based remote replication:

1:"synchronization": indicates synchronous remote replication.

2:"asynchronization": indicates asynchronous remote replication.
SYNCHRONIZETYPE

Conditional

 enum

Synchronization type.

The value is described as follows:

The value can be:

1:"manual": Data needs to be synchronized manually.

2:"timed_wait_when_synchronization_begins": The system starts timing as soon as data synchronization starts.

3:"timed_wait_when_synchronization_ends": The system starts timing as soon as data synchronization ends.

4:"specified_time": Specific time policy.

Note:This parameter is mandatory when the remote replication mode is changed to asynchronous remote replication.
timingVal

Conditional

 uint32

Timing period. The timing period takes effect when the synchronization type is not manual.

The value is described as follows:

1 to 1440 minutes.

Unit:minutes

Note:This field must be delivered when the synchronization type is changed from manual to timed wait when synchronization begins or timed wait when synchronization ends. Parameters TIMINGVAL and TIMINGVALINSEC cannot be delivered at the same time.
TIMINGVALINSEC

Conditional

 uint32

Timing period. The timing period takes effect when the synchronization type is not manual.

The value is described as follows:

10 to 86400 seconds. If the value is greater than or equals to 60, it must be a multiple of 60.

Unit:seconds

Note:This field must be delivered when the synchronization type is changed from manual to timed wait when synchronization begins or timed wait when synchronization ends. Parameters TIMINGVAL and TIMINGVALINSEC cannot be delivered at the same time.
SYNCHRONIZESCHEDULE

Conditional

 json

Schedule for starting the synchronization of an asynchronous remote replication consistency group.

The value is described as follows:

Delivery by week:

{"WEEK":{"WEEKDAY":"[0,1,2,3,4,5,6]","TIME":"11:00"}}.

Delivery by day:

{"DAY":"01:00"}.

Delivery by hour:

{"HOUR":"9"}.

Note:Only when "SYNCHRONIZETYPE" is set to "4", this parameter is valid. Only one of the three schedules can be configured.

Result

N/A

Example

  • Changing the replication mode of consistency group "200bc79b99520000" to "asynchronization".

    Request: PUT /deviceManager/rest/210235843910E6000009/CONSISTENTGROUP/transfer
{
    "ID":"200bc79b99520000",
    "TYPE":221,
    "REPLICATIONMODEL":"2",
    "SYNCHRONIZETYPE": "1"
}

Response:
{
    "data": {},
    "error": {
        "code": 0,
        "description": "0"
    }
}
Download
Updated: 2021-02-09

Document ID: EDOC1100144155

Views: 33834

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 :