No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Enterprise
Worldwide
Huawei Global - English
Search
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).
share

share

Interface for Querying NFS Share Client Information

Function

This interface is used to query information about NFS share authorized clients.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

NFS Share Client ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

NFS Share Client ID.

NAME

Mandatory

 string

Client IP address, host name, or network group name.

PARENTID

Mandatory

 string

ID of the parent object.

ACCESSVAL

Mandatory

 string(uint32)

Permission.

The value is described as follows:

0: read-only

1: read/write

SYNC

Mandatory

 string(uint32)

Write Mode.

The value is described as follows:

0: synchronization

1: asynchronous

ALLSQUASH

Mandatory

 string(uint32)

Permission Constraint.

The value is described as follows:

0: all_squash

1: no_all_squash

ROOTSQUASH

Mandatory

 string(uint32)

root Permission Constraint.

The value is described as follows:

0: root_squash

1: no_root_squash

SECURE

Mandatory

 string(uint32)

Source Port Verification.

The value is described as follows:

0: secure

1: insecure

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:

1.This field must be returned in vStore scenarios.

2.This field is not supported temporarily.

ANONYMOUSID

Mandatory

 string(uint32)

Anonymous User ID.

Note:This field is not supported temporarily.

Example

  • Querying information about NFS share authorized clients.

    Request: GET /deviceManager/rest/210235843910E6000009/NFS_SHARE_AUTH_CLIENT/3

Response:
 {
    "data": {
        "ACCESSVAL": "0",
        "ALLSQUASH": "1",
        "ID": "3",
        "NAME": "*",
        "PARENTID": "1",
        "ROOTSQUASH": "0",
        "SYNC": "0",
        "SECURE": "1"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of NFS Share Clients

Function

This interface is used to query the number of NFS share clients.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by PARENTID and NAME is supported.

Exact matching: PARENTID

Fuzzy matching: NAME
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried NFS shares.

Example

  • Querying the number of NFS share clients.

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

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

Interface for Deleting an NFS Share Client

Function

This interface is used to delete an NFS share client.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Object ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Deleting an NFS share client.

    Request: DELETE /deviceManager/rest/210235843910E6000009/NFS_SHARE_AUTH_CLIENT/1

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

Interface for Batch Querying NFS Share Client Information

Function

This interface is used to batch query information about NFS share clients.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by PARENTID and NAME is supported.

Exact matching: PARENTID

Fuzzy matching: NAME
range

Conditional

 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:

If filter is delivered, range is mandatory.

A maximum of 10000 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.
sort

Optional

 string

Sorting condition.

The value is described as follows:

sort by NAME, PARENTID is supported.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

NFS Share Client ID.

NAME

Mandatory

 string

Client IP address, host name, or network group name.

PARENTID

Mandatory

 string

ID of the parent object.

ACCESSVAL

Mandatory

 string(uint32)

Permission.

The value is described as follows:

0: read-only

1: read/write

SYNC

Mandatory

 string(uint32)

Write Mode.

The value is described as follows:

0: synchronization

1: asynchronous

ALLSQUASH

Mandatory

 string(uint32)

Permission Constraint.

The value is described as follows:

0: all_squash

1: no_all_squash

ROOTSQUASH

Mandatory

 string(uint32)

root Permission Constraint.

The value is described as follows:

0: root_squash

1: no_root_squash

SECURE

Mandatory

 string(uint32)

Source Port Verification.

The value is described as follows:

0: secure

1: insecure

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:

1.This field must be returned in vStore scenarios.

2.This field is not supported temporarily。

ANONYMOUSID

Mandatory

 string(uint32)

Anonymous User ID.

Note:This field is not supported temporarily.

Example

  • Batch querying information about NFS share clients.

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

Response:
 {
    "data": [
        {
            "ACCESSVAL": "0",
            "ALLSQUASH": "1",
            "ID": "3",
            "NAME": "*",
            "PARENTID": "1",
            "ROOTSQUASH": "0",
            "SYNC": "0",
            "SECURE": "0"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of NFS Shares

Function

This interface is used to query the number of NFS shares.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by DESCRIPTION, SHAREPATHor FSID is supported.

Exact matching: PARENTID

Fuzzy matching: NAME, DESCRIPTION
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried NFS shares.

Example

  • Querying the number of NFS shares.

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

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

Interface for Modifying NFS Share Client Information

Function

This interface is used to modify a NFS share client.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ACCESSVAL

Mandatory

 uint32

Permission.

The value is described as follows:

0: read-only

1: read/write
SYNC

Mandatory

 uint32

Write Mode.

The value is described as follows:

0: synchronization

1: asynchronous
ALLSQUASH

Mandatory

 uint32

Permission Constraint.

The value is described as follows:

0: all_squash

1: no_all_squash
ROOTSQUASH

Mandatory

 uint32

root Permission Constraint.

The value is described as follows:

0: root_squash

1: no_root_squash
SECURE

Optional

 uint32

Source Port Verification.

The value is described as follows:

0: secure

1: insecure
ANONYMOUSID

Optional

 uint32

Anonymous User ID.

Length:0~4294967294

Note:This field is not supported temporarily.
ID

Mandatory

 string

NFS Share Client ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Modifying an NFS share client.

    Request: PUT /deviceManager/rest/210235843910E6000009/NFS_SHARE_AUTH_CLIENT
{
    "ACCESSVAL": 1,
    "ALLSQUASH": 1,
    "ROOTSQUASH": 0,
    "SYNC": 0,
    "ID": "1"
}

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

Interface for Deleting an NFS Share

Function

This interface is used to delete an NFS share.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

NFS Share ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Deleting an NFS share.

    Request: DELETE /deviceManager/rest/210235843910E6000009/NFSHARE/2

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

Interface for Adding an NFS Share Client

Function

This interface is used to add an NFS share client.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Host name, client IP address, or network group name.

The value is described as follows:

The host name must meet the following requirements:

1. The value contains 1 to 255 letters, digits, hyphens (-), periods (.) and underscores (_).

2. The value must start with a letter or digit and cannot end with an underscore (_) or hyphen (-).

3. The value cannot contain consecutive periods (.), pure digits, or a period (.) before or after an underscore (_) or a hyphen (-), for example, '_.', '._', '-.' or '.-'.

The IP address must meet the following requirements:

1. You can enter a single client IP address, a client IP address segment, or use asterisk (*) that represents all client IP addresses.

2. You can enter IPv4, IPv6, or their mixed IP addresses.

3. The mask of IPv4 ranges from 1 to 32. The mask of IPv6 ranges from 1 to 128.

For example, 192.168.0.10, 192.168.0.0/24, or *.

The network group name contains 1 to 254 letters, digits, underscores (_), hyphens (-), and periods (.), and must start with an at sign (@).

Length:1~25600
PARENTID

Mandatory

 string

ID of the parent object.
ACCESSVAL

Mandatory

 uint32

Permission.

The value is described as follows:

0: read-only

1: read/write
SYNC

Mandatory

 uint32

Write mode.

The value is described as follows:

0: synchronization

1: asynchronization
ALLSQUASH

Mandatory

 uint32

Permission constraint.

The value is described as follows:

0: all_squash

1: no_all_squash
ROOTSQUASH

Mandatory

 uint32

root permission constraint.

The value is described as follows:

0: root_squash

1: no_root_squash
TYPE

Optional

 enum

Type number of the managed object.

The value is described as follows:

16409: NFS_SHARE_AUTH_CLIENT

Default:16409

Note:The field is not used.
SECURE

Optional

 uint32

Source port verification.

The value is described as follows:

0: secure

1: insecure

Default:1
ANONYMOUSID

Optional

 uint32

Anonymous user ID.

Default:65534

Length:0~4294967294

Note:This field is not supported temporarily.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

Example

  • Adding an NFS share client.

    Request: POST /deviceManager/rest/210235843910E6000009/NFS_SHARE_AUTH_CLIENT
{
    "ACCESSVAL": 0,
    "ALLSQUASH": 1,
    "NAME": "*",
    "PARENTID": "1",
    "ROOTSQUASH": 0,
    "SYNC": 0
}

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

Interface for Querying the Number of CIFS Share Users (Groups)

Function

This interface is used to query the number of CIFS share users (user groups).

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by PARANTID and NAME is supported.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried CIFS share users (user groups).

Example

  • Querying the number of CIFS share users (user groups).

    Request: GET /deviceManager/rest/210235843910E6000009/CIFS_SHARE_AUTH_CLIENT/count?filter=PARENTID: : 1

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

Interface for Deleting a CIFS Share User (Group)

Function

This interface is used to delete a CIFS share user (user group).

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Object ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a CIFS share user (user group).

    Request: DELETE /deviceManager/rest/210235843910E6000009/CIFS_SHARE_AUTH_CLIENT/21474836483

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

Interface for Modifying CIFS Share User (Group) Information

Function

This interface is used to modify a CIFS share user (user group).

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Object ID.
PERMISSION

Mandatory

 enum

Permission.

The value is described as follows:

0: read

1: full control

2: forbidden

5: read/write (cannot be deleted or renamed)
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Modifying a CIFS share user (user group).

    Request: PUT /deviceManager/rest/210235843910E6000009/CIFS_SHARE_AUTH_CLIENT/21474836483
{
    "PERMISSION": 5
}

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

Interface for Deleting a CIFS Share

Function

This interface is used to delete a CIFS share.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

CIFS share ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a CIFS share.

    Request: DELETE /deviceManager/rest/210235843910E6000009/CIFSHARE/1

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

Interface for Adding a CIFS Share User (Group)

Function

This interface is used to add a CIFS share user (user group).

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Name of a user or user group.

Length:1~256

Note:The user group name must start with an at sign (@).
PARENTID

Mandatory

 string

ID of the parent object.
DOMAINTYPE

Optional

 enum

Domain type.

The value is described as follows:

0: AD domain user or user group.

1: LDAP domain user or user group.

2: local user or user group.

3: NIS domain user or user group.

Default:2
PERMISSION

Mandatory

 enum

Permission.

The value is described as follows:

0: read

1: full control

2: forbidden

5: read/write (cannot be deleted or renamed)
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

Object ID.

NAME

Mandatory

 string

Name of a user or user group.

PARENTID

Mandatory

 string

ID of the parent object.

DOMAINTYPE

Mandatory

 string(uint32)

Domain type.

The value is described as follows:

0: AD domain user or user group.

1: LDAP domain user or user group.

2: local user or user group.

3: NIS domain user or user group.

PERMISSION

Mandatory

 string(uint32)

Permission.

The value is described as follows:

0: read

1: full control

2: forbidden

5: read/write

vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be delivered in multi-vStore scenarios.

Example

  • Adding a CIFS share user (user group).

    Request: POST /deviceManager/rest/210235843910E6000009/CIFS_SHARE_AUTH_CLIENT
{
    "NAME": "jordan",
    "PARENTID": "1",
    "DOMAINTYPE": "2",
    "PERMISSION": "0"
}

Response:
 {
    "data": {
        "DOMAINTYPE": "2",
        "ID": "4294967297",
        "NAME": "jordan",
        "PARENTID": "1",
        "PERMISSION": "0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of CIFS Shares

Function

This interface is used to query the number of CIFS shares.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by NAME, DESCRIPTION, subType, and FSID is supported.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried CIFS shares.

Example

  • Querying the number of CIFS shares.

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

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

Interface for Adding CIFS Homedir Share Mapping Rule

Function

This interface is used to add a mapping rule to the CIFS homedir share.

HighRisk

You are about to set rules for the Homedir to support the path mapping of multiple file systems. Creating rules with high priority and improving the rule priority may cause interruption of services accessed by users that have been configured with mapping rules of low priority. Deleting mapping rules and lowering priority of existing rules may cause interruption of services accessed by users that have been configured with these mapping rules.

Suggestion: Before performing this operation, confirm that users that have been configured with mapping rules of low priority are not accessing the share.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Mapping rule name of the CIFS homedir share.

Length:1~255
parentID

Mandatory

 string

Homedir share ID.
fsId

Optional

 string

File system ID.
fsPath

Mandatory

 string

Share path.

Length:1~1023
priority

Optional

 uint32

Priority.

Default:32

Length:1~1024
autoCreate

Optional

 bool

Whether to automatically create the directory.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

Mapping rule ID of the CIFS homedir share.

parentID

Mandatory

 string

Homedir share ID.

NAME

Mandatory

 string

Mapping rule name of the CIFS homedir share.

fsId

Mandatory

 string

File system ID.

fsPath

Mandatory

 string

Share path.

priority

Mandatory

 string(uint32)

Priority.

autoCreate

Mandatory

 string（bool）

Whether to automatically create the directory.

The value is described as follows:

true: enabled

false: disabled

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreNAME

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Adding a mapping rule to the CIFS homedir share.

    Request: POST /deviceManager/rest/210235843910E6000009/cifsshare_homedir_rule
{
       "NAME": "adsfasdf",
       "autoCreate": "false",
       "fsId": "0",
       "fsPath": "/FileSystem001/",
       "parentID": "0",
       "priority": "20"
}

Response:
 {
    "data": {
       "ID": "0",
       "NAME": "adsfasdf",
       "autoCreate": "false",
       "fsId": "0",
       "fsPath": "/FileSystem001/",
       "parentID": "0",
       "priority": "20"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of CIFS Homedir Share Mapping Rule

Function

This interface is used to query the number of mapping rules of the CIFS homedir share.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Filtering criteria. Query by specifying the parentID and NAME is supported. parentID must be queried precisely.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried mapping rules of the CIFS homedir share.

Example

  • Querying the number of mapping rules of the CIFS homedir share.

    Request: GET /deviceManager/rest/210235843910E6000009/cifsshare_homedir_rule/count?filter=parentID::1

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

Interface for Deleting CIFS Homedir Share Mapping Rule

Function

This interface is used to delete a mapping rule from the CIFS homedir share.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Mapping rule ID of the CIFS homedir share.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a mapping rule from the CIFS homedir share.

    Request: DELETE /deviceManager/rest/210235843910E6000009/cifsshare_homedir_rule/0

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

Interface for Modifying the CIFS Homedir Share Mapping Rule

Function

This interface is used to modify a mapping rule of the CIFS homedir share.

HighRisk

You are about to set rules for the Homedir to support the path mapping of multiple file systems. Creating rules with high priority and improving the rule priority may cause interruption of services accessed by users that have been configured with mapping rules of low priority. Deleting mapping rules and lowering priority of existing rules may cause interruption of services accessed by users that have been configured with these mapping rules.

Suggestion: Before performing this operation, confirm that users that have been configured with mapping rules of low priority are not accessing the share.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Mapping rule ID of the CIFS homedir share.
priority

Optional

 uint32

Priority.

Length:1~1024
autoCreate

Optional

 bool

Whether to automatically create the directory.

The value is described as follows:

true: enabled

false: disabled
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Modifying a mapping rule of the CIFS homedir share.

    Request: PUT /deviceManager/rest/210235843910E6000009/cifsshare_homedir_rule/0
{
    "ID": "0",
    "priority": 32,
    "autoCreate": true
}

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

Interface for Batch Querying the CIFS Homedir Share Mapping Rule

Function

This interface is used to query mapping rules of the CIFS homedir share in batches.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Filtering criteria. Query by specifying the parentID and NAME is supported. parentID must be queried precisely.
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.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

Mapping rule ID of the CIFS homedir share.

parentID

Mandatory

 string

Homedir share ID.

NAME

Mandatory

 string

Mapping rule name of the CIFS homedir share.

fsId

Mandatory

 string

File system ID.

fsPath

Mandatory

 string

Share path.

priority

Mandatory

 string(uint32)

Priority.

autoCreate

Mandatory

 string（bool）

Whether to automatically create the directory.

The value is described as follows:

true: enabled

false: disabled

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreNAME

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying mapping rules of the CIFS homedir share in batches.

    Request: GET /deviceManager/rest/210235843910E6000009/cifsshare_homedir_rule?filter=parentID::0

Response: 
{
    "data": [
        {
            "ID": "0",
            "NAME": "adsfasdf",
            "autoCreate": "false",
            "fsId": "0",
            "fsPath": "/FileSystem001/",
            "parentID": "0",
            "priority": "20"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying CIFS Homedir Share Mapping Rule

Function

This interface is used to query basic information about a mapping rule of the CIFS homedir share.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Mapping rule ID of the CIFS homedir share.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

Mapping rule ID of the CIFS homedir share.

parentID

Mandatory

 string

Homedir share ID.

NAME

Mandatory

 string

Mapping rule name of the CIFS homedir share.

fsId

Mandatory

 string

File system ID.

fsPath

Mandatory

 string

Share path.

priority

Mandatory

 string(uint32)

Priority.

autoCreate

Mandatory

 string（bool）

Whether to automatically create the directory.

The value is described as follows:

true: enabled

false: disabled

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreNAME

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying basic information about a mapping rule of the CIFS homedir share.

    Request: GET/deviceManager/rest/210235843910E6000009/cifsshare_homedir_rule/0
Response: {
    "data": {
            "ID": "0",
            "NAME": "adsfasdf",
            "autoCreate": "false",
            "fsId": "0",
            "fsPath": "/FileSystem001/",
            "parentID": "0",
            "priority": "20"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Batch Querying NFS Share Information

Function

This interface is used to batch query basic information about NFS shares.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by SHAREPATH, DESCRIPTION,and FSID is supported.

Exact matching: FSID

Fuzzy matching: SHAREPATH, DESCRIPTION
range

Conditional

 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:

If filter is delivered, range is mandatory.

A maximum of 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.
sort

Optional

 string

Sorting condition.

The value is described as follows:

sort by SHAREPATH is supported.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

NFS Share ID.

DESCRIPTION

Mandatory

 string

Description.

SHAREPATH

Mandatory

 string

Share path.

FSID

Mandatory

 string

File system ID.

NAME

Mandatory

 string

SHARE alias.

Note:This field is not supported temporarily.

LOCKPOLICY

Mandatory

 string(enum)

NFS LOCK POLICY.

The value is described as follows:

0: Advisory locking

1: Mandatory locking

Note:This field is not supported temporarily.

CHARACTERENCODING

Mandatory

 string(enum)

Character Encoding.

The value is described as follows:

0: UTF-8

11: ZH

12: GBK

13: EUC-TW

14: BIG5

21: EUC-JP

22: JIS

23: S-JIS

30: DE

31: PT

32: ES

33: FR

34: IT

40: KO

Note:This field is not supported temporarily.

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

16401: NFSHARE

AUDITITEMS

Mandatory

 string(array)

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

Note:This field is not supported temporarily.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:

1.This field must be returned in vStore scenarios.

2.This field is not supported temporarily.

ENABLESHOWSNAPSHOT

Mandatory

 string(bool)

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

DTREEID

Mandatory

 string

Example

  • Batch querying basic information about NFS shares.

    Request: GET/deviceManager/rest/210235843910E6000009/NFSHARE?range=[
    0-100
]Response: {
    "data": [
        {
            "DESCRIPTION": "",
            "FSID": "20",
            "ID": "1",
            "DTREEID:20@0",
            "SHAREPATH": "/VMwareApp_001_ALL_200/",
            "TYPE": 16401
        },
        {
            "DESCRIPTION": "",
            "FSID": "21",
            "ID": "2",
            "DTREEID:21@0",
            "SHAREPATH": "/VMwareApp_002_ALL_210/",
            "TYPE": 16401
        },
        {
            "DESCRIPTION": "",
            "FSID": "22",
            "ID": "3",
            "DTREEID:22@0",
            "SHAREPATH": "/VMwareApp_001_ALL_220/",
            "TYPE": 16401
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying NFS Share Information

Function

This interface is used to query basic information about NFS shares.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

NFS Share ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

Object ID.

The value is described as follows:

NFS Share ID.

DESCRIPTION

Mandatory

 string

Description.

SHAREPATH

Mandatory

 string

Share path.

FSID

Mandatory

 string

File system ID.

NAME

Mandatory

 string

SHARE alias.

Note:This field is not supported temporarily.

LOCKPOLICY

Mandatory

 string(enum)

NFS LOCK POLICY.

The value is described as follows:

0: Advisory locking

1: Mandatory locking

Note:This field is not supported temporarily.

CHARACTERENCODING

Mandatory

 string

Character coding used by the current share.

The value is described as follows:

0: UTF-8

11: ZH

12: GBK

13: EUC-TW

14: BIG5

21: EUC-JP

22: JIS

23: S-JIS

30: DE

31: PT

32: ES

33: FR

34: IT

40: KO

Note:This field is not supported temporarily.

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

16401: NFSHARE

AUDITITEMS

Mandatory

 string(array)

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

Note:This field is not supported temporarily.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:

1.This field must be returned in vStore scenarios.

2.This field is not supported temporarily.

ENABLESHOWSNAPSHOT

Mandatory

 string(bool)

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

DTREEID

Mandatory

 string

Example

  • Querying basic information about NFS shares.

    Request: GET/deviceManager/rest/210235843910E6000009/NFSHARE/1Response: {
    "data": {
        "DESCRIPTION": "",
        "FSID": "20",
        "ID": "1",
        "SHAREPATH": "/VMwareApp_001_ALL_200/",
        "DTREEID:20@0",
        "TYPE": 16401
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Deleting a User or Group from a Windows User Group

Function

This interface is used to delete a user or group from a Windows user group.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Name of the Windows user, AD domain user, or AD domain user group.

The value is described as follows:

The value contains 1 to 256 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1-256
GROUPNAME

Mandatory

 string

Name of the Windows user group.

The value is described as follows:

The value contains 1 to 256 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1-256
ACCOUNTTYPE

Mandatory

 enum

Account type.

The value is described as follows:

0: WINDOWS_USER

2: AD_USER

3: AD_GROUP

Note:The "ACCOUNTTYPE" field indicates the Windows local user, AD domain user, or AD domain user group.
vstoreId

Conditional

 string

vStore ID.

Default:0

Length:1-10

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a Windows user from a Windows user group.

    Request: DELETE/deviceManager/rest/210235843910E6000009/WINDOWS_USER_GROUP_MAP{
    "NAME": "userWindows",
    "GROUPNAME": "groupWindows",
    "ACCOUNTTYPE":"0"
}
}Response: {
"data": {
    
},
"error": {
    "code": 0,
    "description": "0"
}
}

Interface for Batch Querying Windows User Information

Function

This interface is used to batch query basic information about Windows users.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter NAME is supported.
range

Optional

 string

Search 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 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

RID

Mandatory

 string

Windows user RID.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

NAME

Mandatory

 string

Windows user name.

DESCRIPTION

Mandatory

 string

Description.

STATUSENABLE

Mandatory

 string(bool)

User status.

The value is described as follows:

true: enabled

false: locked

PASSWORDVALIDPERIOD

Mandatory

 string(uint32)

Remaining password validity period.

The value is described as follows:

The value ranges from 0 to 999. FFFFFFFF(4294967295) indicates disabled.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Batch querying basic information about Windows users.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_USER?range=[0-100]
Response: {
    "data": [
        {
            "DESCRIPTION": "",
            "ID": "100000",
            "NAME": "test",
            "PASSWORDVALIDPERIOD": "175",
            "STATUSENABLE": "true",
            "USERTYPE": "2"
        },
        {
            "DESCRIPTION": "",
            "ID": "100001",
            "NAME": "TFW123456",
            "PASSWORDVALIDPERIOD": "179",
            "STATUSENABLE": "true",
            "USERTYPE": "2"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying Windows User Information

Function

This interface is used to query basic information about a Windows user.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Optional

 string

Windows user name.

The value is described as follows:

The name contains a maximum of 20 case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_), and cannot contain spaces, control characters, or any of the following special characters: "/\[]:|<>+=;?*@,.

Length:1~20

Note:The parameter must contain one of the NAME and RID.
RID

Optional

 string

Windows user RID.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

Note:The parameter must contain one of the NAME and RID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

NAME

Mandatory

 string

Windows user name.

RID

Mandatory

 string

Windows user RID.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

DESCRIPTION

Mandatory

 string

Description.

STATUSENABLE

Mandatory

 string(bool)

User status.

The value is described as follows:

true: enabled

false: locked

PASSWORDVALIDPERIOD

Mandatory

 string(uint32)

Remaining password validity period.

The value is described as follows:

The value ranges from 0 to 999. FFFFFFFF(4294967295) indicates disabled.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

GROUPNAMES

Conditional

 string(array)

Indicates the names of the groups of the Windows user.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying basic information about a Windows user by name.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_USER?NAME=test
Response: {
    "data": {
        "DESCRIPTION": "",
        "RID": "100000",
        "NAME": "test",
        "PASSWORDVALIDPERIOD": "175",
        "STATUSENABLE": "true",
        “GROUPNAMES”:"group1,group2,group3"
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

  • Querying basic information about a Windows user by RID.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_USER?RID=100000
Response: {
    "data": {
        "DESCRIPTION": "",
        "RID": "100000",
        "NAME": "test",
        "PASSWORDVALIDPERIOD": "175",
        "STATUSENABLE": "true",
         “GROUPNAMES”:"group1,group2,group3"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of Members in a Windows User Group

Function

This interface is used to query the number of members in a Windows user group.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Mandatory

 enum

Query criteria.

The value is described as follows:

Parameters ACCOUNTTYPE and GROUPNAME are supported.

Note:The ACCOUNTTYPE and GROUPNAME fields must be delivered.
vstoreId

Conditional

 string

vStore ID.

Default:0

Length:1-10

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

Number of queried members in a Windows user group.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying the number of members in a Windows user group.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_USER_GROUP_MAP/count
Response: {
    "data": {
        "COUNT": "1"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Batch Querying Members of a Windows User Group

Function

This interface is used to batch query members of a Windows user group.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
range

Optional

 string

Search 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.
GROUPNAME

Mandatory

 string

Name of the Windows user group.

The value is described as follows:

The value contains 1 to 256 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1-256
ACCOUNTTYPE

Mandatory

 enum

Account type.

The value is described as follows:

0: WINDOWS_USER

2: AD_USER

3: AD_GROUP

Note:The "ACCOUNTTYPE" field indicates the Windows local user, AD domain user, or AD domain user group.
vstoreId

Conditional

 string

vStore ID.

Default:0

Length:1-10

Note:This field must be delivered in multi-vStore scenarios.
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter NAME is supported.

Result

Parameter

Mandatory/Conditional

Type

Description

ACCOUNTTYPE

 enum

Account type.

The value is described as follows:

0: WINDOWS_USER

2: AD_USER

3: AD_GROUP

Note:The "ACCOUNTTYPE" field indicates the Windows local user, AD domain user, or AD domain user group.

NAME

 string

Name of the Windows user, AD domain user, or AD domain user group.

The value is described as follows:

The value contains 1 to 256 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Unit:1-256

RID

 int

User RID.

The value is described as follows:

1000 to 4294967295.

vstoreId

vStore ID.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Batch querying members of a Windows user group.

    Request: GET /deviceManager/rest/210235843910E6000009/WINDOWS_USER_GROUP_MAP?range=[0-100]{
    "ACCOUNTTYPE": "0",
    "GROUPNAME": "groupWindows"
}
}Response: {
"data": {
    
},
"error": {
    "code": 0,
    "description": "0"
}
}

Interface for Querying Windows User Group Information

Function

This interface is used to query basic information about a Windows user group.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Optional

 string

Windows user group name.

The value is described as follows:

The value can neither include "/\[]:|<>+=;?*@, and control characters nor end with a period (.).

Length:1~256

Note:The parameter must contain one of the NAME and RID.
RID

Optional

 string

Windows user group RID.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

Note:The parameter must contain one of the NAME and RID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

NAME

Mandatory

 string

Windows user group name.

RID

Mandatory

 string

Windows user group RID.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

DESCRIPTION

Mandatory

 string

Description.

GROUPTYPE

Mandatory

 enum

User group type.

The value is described as follows:

0: common user group

1: built-in user group

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying basic information about a Windows user group by name.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP?NAME=default_group
Response: {
    "data": {
        "DESCRIPTION": "",
        "GROUPTYPE": "1",
        "NAME": "default_group",
        "RID": "1000"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

  • Querying basic information about a Windows user group by RID.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP?RID=1000
Response: {
    "data": {
        "DESCRIPTION": "",
        "GROUPTYPE": "1",
        "NAME": "default_group",
        "RID": "1000"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Batch Querying Windows User Group Information

Function

This interface is used to batch query basic information about Windows user groups.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by NAME is supported.
range

Conditional

 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:

If filter is delivered, range is mandatory.

A maximum of 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

RID

Mandatory

 string

Windows user group RID.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

NAME

Mandatory

 string

Windows user group name.

DESCRIPTION

Mandatory

 string

Description.

GROUPTYPE

Mandatory

 string(enum)

User group type.

The value is described as follows:

1: default

2: created by an administrator

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Batch querying basic information about Windows user groups.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP?range=[0-100]
Response: {
    "data": [
        {
            "DESCRIPTION": "",
            "GROUPTYPE": "1",
            "RID": "99997",
            "NAME": "Backup Operators"
        },
        {
            "DESCRIPTION": "the antivirus group",
            "GROUPTYPE": "1",
            "RID": "99998",
            "NAME": "AntivirusGroup"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying Security Policies of Windows Users

Function

This interface is used to query security policies of Windows users.

URL

https://${ip}:${port}/deviceManager/rest/${deviceId}/WINDOWS_USER_SECURITY_POLICY/${vstoreId}

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
vstoreId

Optional

 string

vStore ID.

Default:0

Result

Parameter

Mandatory/Conditional

Type

Description

USERMINLENGTH

Mandatory

 uint32

Minimum length of a user name.

PASSWORDMINLENGTH

Mandatory

 uint32

Minimum length of a password.

PASSWORDMAXLENGTH

Mandatory

 uint32

Maximum length of a password.

PWDCOMPLEX

Mandatory

 uint32

Password strength.

The value is described as follows:

0: normal, containing any two of special characters, uppercase letters, lowercase letters, and digits.

1: high, containing special characters and any two of uppercase letters, lowercase letters, and digits.

REDUPLICATECHARCOUNT

Mandatory

 uint32

Maximum number of consecutive same characters.

Note:Maximum number of consecutive same characters in a password (0 indicates no restriction).

PWDINCORRECTTIMES

Mandatory

 uint32

Maximum number of incorrect password attempts.

Note:0 indicates no restriction.

PWDVALIDPERIOD

Mandatory

 uint32

Password validity period of a man-machine user.

Unit:days

Note:Validity periods are required for passwords and 0 indicates that passwords are permanently valid.

INACTIVEUSERLOCKTIME

Mandatory

 uint32

Idle lock interval.

The value is described as follows:

0: disabled

Unit:days

USERMODIFYPWDVALIDPERIOD

Mandatory

 uint32

Password change interval.

The value is described as follows:

0: disabled

Unit:minutes

vstoreId

 string

vStore ID.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

SIDPREFIX

Conditional

 string

SID prefix of the windows user.

The value is described as follows:

The value can contain uppercase letters, lowercase letters, digits, and hyphens (-).

Example

  • Querying security policies of Windows users.

    Request: GET /deviceManager/rest/210235843710E7000007/WINDOWS_USER_SECURITY_POLICY/?vstoreId=1
Response: 
{
    "data": {
"USERMINLENGTH":"3"
"PASSWORDMINLENGTH":"8"
"PASSWORDMAXLENGTH":"32"
"PWDCOMPLEX":"0"
"REDUPLICATECHARCOUNT":"3"
"PWDINCORRECTTIMES":"3"
"PWDVALIDPERIOD":"3"
"INACTIVEUSERLOCKTIME":"10"
"USERMODIFYPWDVALIDPERIOD":"5"
"SRDPREFIX":"S-1-6-88"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of Windows User Groups

Function

This interface is used to query the number of Windows user groups.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter NAME is supported.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 uint32

Number of queried local user groups.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying the number of Windows user groups.

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

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

Interface for Adding a User or Group to a Windows User Group

Function

This interface is used to add a user or group to a Windows user group.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Name of the Windows user, AD domain user, or AD domain user group.

The value is described as follows:

The value contains 1 to 256 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1-256
GROUPNAME

Mandatory

 string

Name of the Windows user group.

The value is described as follows:

The value contains 1 to 256 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1-256
ACCOUNTTYPE

Mandatory

 enum

Account type.

The value is described as follows:

0: WINDOWS_USER

2: AD_USER

3: AD_GROUP

Note:The "ACCOUNTTYPE" field indicates the Windows local user, AD domain user, or AD domain user group.
vstoreId

Conditional

 string

vStore ID.

Default:0

Length:1-10

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Adding a Windows user to a Windows user group.

    Request: POST /deviceManager/rest/210235843910E6000009/WINDOWS_USER_GROUP_MAP{
    "NAME": "userWindows",
    "GROUPNAME": "groupWindows",
    "ACCOUNTTYPE": "0"
}
}Response: {
"data": {
    
},
"error": {
    "code": 0,
    "description": "0"
}
}

Interface for Deleting a Windows User

Function

This interface is used to delete a Windows user.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
RID

Optional

 string

Windows user RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

Note:The parameter must contain one of the NAME and RID.
NAME

Optional

 string

Windows user name.

The value is described as follows:

The name contains a maximum of 20 case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_), and cannot contain spaces, control characters, or any of the following special characters: "/\[]:|<>+=;?*@,,and the last character cannot be a period (.).

Length:1~20

Note:The parameter must contain one of the NAME and RID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a Windows user by name.

    Request: DELETE/deviceManager/rest/210235843910E6000009/WINDOWS_USER?NAME=test
Response: {
    "data": {
      },
    "error": {
        "code": 0,
        "description": "0"
    }
}

  • Deleting a Windows user by RID.

    Request: DELETE/deviceManager/rest/210235843910E6000009/WINDOWS_USER?RID=100000
Response: {
    "data": {
      },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Creating a Windows User Group

Function

This interface is used to create a Windows user group.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Windows user group name.

The value is described as follows:

The value can neither include "/\[]:|<>+=;?*@, and control characters nor end with a period (.).

Length:1~256
RID

Optional

 string

Windows user group RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.
DESCRIPTION

Optional

 string

Description.

Length:0~255
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

NAME

Mandatory

 string

Windows user group name.

RID

Mandatory

 string

Windows user group RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

DESCRIPTION

Mandatory

 string

Description.

vstoreId

Conditional

 string

User group type.

The value is described as follows:

1: default

2: created by an administrator

GROUPTYPE

Mandatory

 string(enum)

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Creating a Windows user group.

    Request: POST/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP{
    "DESCRIPTION": "xzczc",
    "NAME": "test00000""RID": "1001"
}
Response: {
    "data": {
        "DESCRIPTION": "xzczc",
        "NAME": "test00000",
        "RID": "1001"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying Windows User Group Information

Function

This interface is used to modify a Windows user group.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
RID

Optional

 string

Windows user group RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

Note:The parameter must contain one of the NAME and RID.
DESCRIPTION

Optional

 string

Description.

Length:0~255
NAME

Optional

 string

Windows user group name.

The value is described as follows:

The value can neither include "/\[]:|<>+=;?*@, and control characters nor end with a period (.).

Length:1~256

Note:The parameter must contain one of the NAME and RID.
NEWNAME

Optional

 string

New name.

The value is described as follows:

The value can neither include "/\[]:|<>+=;?*@, and control characters nor end with a period (.).

Length:1~256
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

NAME

Mandatory

 string

Windows user group name.

RID

Mandatory

 string

Windows user group RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

DESCRIPTION

Mandatory

 string

Description.

GROUPTYPE

Mandatory

 enum

User group type.

The value is described as follows:

0: common user group

1: built-in user group

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Modifying a Windows user group by user group name.

    Request: PUT/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP{
    "NAME": "test",
    "DESCRIPTION": "111"
}Response: {
    "data": {      
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

  • Modifying a Windows user group by user group RID.

    Request: PUT/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP{
    "RID": "1000",
    "DESCRIPTION": "111"
}Response: {
    "data": {    
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Deleting a Windows User Group

Function

This interface is used to delete a Windows user group.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Optional

 string

Windows user group name.

The value is described as follows:

The value can neither include "/[]:|<>+=;?*@, and control characters nor end with a period (.).

Length:1~256

Note:The parameter must contain one of the NAME and RID.
RID

Optional

 string

Windows user group RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

Note:The parameter must contain one of the NAME and RID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a Windows user group by name.

    Request: DELETE/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP?NAME=testgroup
Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

  • Deleting a Windows user group by RID.

    Request: DELETE/deviceManager/rest/210235843910E6000009/WINDOWS_GROUP?RID=1000
Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of Windows Users

Function

This interface is used to query the number of Windows users.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter NAME is supported.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried Windows users.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying the number of Windows users.

    Request: GET/deviceManager/rest/210235843910E6000009/WINDOWS_USER/count
Response: {
    "data": {
        "COUNT": "1"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Creating a Windows User

Function

This interface is used to create a Windows user.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Windows user name.

The value is described as follows:

The name contains a maximum of 20 case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_), and cannot contain spaces, control character, or any of the following special characters: "/\[]:|<>+=;?*@,, and the minimum length of the name is controlled by security policies,and the last character cannot be a period (.).

Length:1~20
RID

Optional

 string

Windows user RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.
DESCRIPTION

Optional

 string

Description.

Length:0~255
PASSWORD

Mandatory

 string

Password.

The value is described as follows:

The password complexity is controlled by security policies.

Length:6~32

Note:

The password:

1. Contains 6 to 32 characters.

2. "Normal": The password contains at least any two types of special characters, uppercase letters, lowercase letters, and digits.

3. "High": The password must contain special characters, and at least any two types of uppercase letters, lowercase letters, and digits.

4. Cannot be the same as the user name or mirror writing of the user name.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.
STATUSENABLE

Optional

 bool

User status.

The value is described as follows:

true: enables the user.

false: locks the user.

Default:true

Result

Parameter

Mandatory/Conditional

Type

Description

NAME

Mandatory

Windows user name.

RID

Mandatory

Windows user RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

DESCRIPTION

Conditional

Description.

vstoreId

Conditional

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

STATUSENABLE

Mandatory

User status.

The value is described as follows:

true: enabled

false: locked

PASSWORDVALIDPERIOD

Mandatory

Remaining password validity period.

The value is described as follows:

The value ranges from 0 to 999. FFFFFFFF(4294967295) indicates disabled.

Example

  • Creating a Windows user.

    Request: POST/deviceManager/rest/210235843910E6000009/WINDOWS_USER{
    "NAME": "test",
    "PASSWORD": "test@123",
    "DESCRIPTION": ""
}
Response: {
    "data": {
        "DESCRIPTION": "",
        "RID": "100000",
        "NAME": "test",
        "PASSWORDVALIDPERIOD": "175",
        "STATUSENABLE": "true",
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying a Windows User

Function

This interface is used to modify a Windows user.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
RID

Optional

 string

Windows user RID.

The value is described as follows:

The value ranges from 1000 to 4,294,967,295.

Note:The parameter must contain one of the NAME and RID.
NAME

Optional

 string

Windows user name.

The value is described as follows:

The name contains a maximum of 20 case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_), and cannot contain spaces, control characters, or any of the following special characters: "/\[]:|<>+=;?*@,,and the last character cannot be a period (.).

Length:1~20

Note:The parameter must contain one of the NAME and RID.
DESCRIPTION

Optional

 string

Description.

Length:0~255
PASSWORD

Optional

 string

Password.

The value is described as follows:

The password:

1. Contains 6 to 32 characters.

2. normal, containing any two of special characters, uppercase letters, lowercase letters, and digits.

3. high, containing special characters and any two of uppercase letters, lowercase letters, and digits.

4. Cannot be the same as the user name or mirror writing of the user name.

Length:6-32
STATUSENABLE

Optional

 bool

User status.

The value is described as follows:

true: enables the user.

false: locks the user.
NEWNAME

Optional

 string

Name.

The value is described as follows:

The name contains a maximum of 20 case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_), and cannot contain spaces, control characters, or any of the following special characters: "/\[]:|<>+=;?*@,.

Length:1~20
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Modifying a Windows user by NAME.

    Request: PUT/deviceManager/rest/210235843910E6000009/WINDOWS_USER{
    “NAME”: "test",
    "DESCRIPTION": ""
}
Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

  • Modifying a Windows user by RID.

    Request: PUT/deviceManager/rest/210235843910E6000009/WINDOWS_USER{
    “RID”: "1000",
    "DESCRIPTION": ""
}
Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying Security Policies of Windows Users

Function

This interface is used to modify security policies of Windows users.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
USERMINLENGTH

Optional

 uint32

Minimum length of a user name.

Length:1-20
PASSWORDMINLENGTH

Optional

 uint32

Minimum length of a password.

Length:6-32
PASSWORDMAXLENGTH

Optional

 uint32

Maximum length of a password.

Length:6-32
PWDCOMPLEX

Optional

 uint32

Password strength.

The value is described as follows:

0: normal, containing any two of special characters, uppercase letters, lowercase letters, and digits.

1: high, containing special characters and any two of uppercase letters, lowercase letters, and digits.

Length:0-1
REDUPLICATECHARCOUNT

Optional

 uint32

Maximum number of consecutive same characters.

Length:0-9

Note:Maximum number of consecutive same characters in a password (0 indicates no restriction).
PWDINCORRECTTIMES

Optional

 uint32

Maximum number of incorrect password attempts.

Length:0-9

Note:0 indicates no restriction.
PWDVALIDPERIOD

Optional

 uint32

Password validity period of a man-machine user.

Unit:days

Length:0-999

Note:Validity periods are required for passwords and 0 indicates that passwords are permanently valid.
INACTIVEUSERLOCKTIME

Optional

 uint32

Idle lock interval.

The value is described as follows:

0: disabled

Unit:days

Length:0-999
USERMODIFYPWDVALIDPERIOD

Optional

 uint32

Password change interval.

The value is described as follows:

0: disabled

Unit:minutes

Length:0-9999
vstoreId

Optional

 string

vStore ID.
SIDPREFIX

Optional

 string

SID prefix of the windows user.

The value is described as follows:

The value can contain uppercase letters, lowercase letters, digits, and hyphens (-).

Length:5-256

Result

N/A

Example

  • Modifying the minimum length of a user name.

    Request: PUT/deviceManager/rest/210235843710E7000007/WINDOWS_USER_SECURITY_POLICY{
    “vstoreId”: "1""USERMINLENGTH": "5"
}
Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying User Mapping Configuration of a vStore

Function

This interface is used to modify user mapping configuration of a vStore.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
IDMUUSERMAPPINGDN

Optional

 string

IDMU search DN.

Length:0-255
IDMUUSERMAPPINGDNTIMEOUT

Optional

 uint32

IDMU search timeout duration.

The value is described as follows:

The range is from 5 to 120.

Unit:seconds
IDMUWINOBJECTCLASS

Optional

 string

objectclass used by the Windows user searched by the IDMU.

The value is described as follows:

The value is a string containing 1 to 255 characters.

Length:1-255
IDMUUNIXOBJECTCLASS

Optional

 string

objectclass used by the UNIX user searched by the IDMU.

The value is described as follows:

The value is a string containing 1 to 255 characters.

Length:1-255
USERMAPPINGPROVIDER

Optional

 enum

Mapping type.

The value is described as follows:

0: user mapping not supported

1: mapping rules set in local

2: mapping rules set in IDMU

3: mapping rules set in IDMU and local, IDMU preferentially

4: mapping rules set in local and IDMU, local preferentially
DEFAULTWINDOWSUSER

Optional

 string

Default Windows user.

Length:1-256
DEFAULTUNIXUSER

Optional

 string

Default UNIX user.

Length:1-256
SAMEUSERSWITCH

Optional

 enum

Switch of a mapping between users with the same name.

If the user names are the same, the mapping exists by default.

The value is described as follows:

0: off

1: on
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Modifying user mapping configuration of a vStore.

    Request: PUT /deviceManager/rest/210235843910E6000009/identitymappingconfig
{
    "IDMUUSERMAPPINGDN": "name=aaa",
    "USERMAPPINGPROVIDER": "4"
}

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

Interface for Batch Querying User Mappings

Function

This interface is used to batch query user mappings.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Parameters FROMIDENTITY and TOIDENTITY 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 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.
sortby

Optional

 string

Sorting condition. Sorting by the following is supported: FROMIDENTITY, TOIDENTITY, MAPPINGTYPE, and RULEPRIORITY.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

User mapping ID.

FROMIDENTITY

Mandatory

 string

Source user.

MAPPINGTYPE

Mandatory

 string(enum)

Mapping type.

The value is described as follows:

0: Windows to Unix

1: Unix to Windows

RULEPRIORITY

Mandatory

 uint32

Priority.

TOIDENTITY

Mandatory

 string

Target user.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in vStore scenarios.

Example

  • Batch querying user mappings.

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

Response:
{
    "data": [
        {
            "FROMIDENTITY": "user1",
            "ID": "9",
            "MAPPINGTYPE": "0",
            "RULEPRIORITY": "10",
            "TOIDENTITY": "user2",
            "vstoreId": "0",
            "vstoreName": "System_vStore"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Count of User Mappings

Function

This interface is used to query the count of user mappings.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Parameters FROMIDENTITY and TOIDENTITY are supported.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

COUNT

Mandatory

 string(uint32)

Number of queried user mappings.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in vStore scenarios.

vstoreId

Conditional

 string

vStore ID

Note:This field must be returned in vStore scenarios.

Example

  • Querying the count of user mappings.

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

Response: 
{
    "data": {
        "COUNT": "4",
        "vstoreId": "0",
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying User Mapping Configuration of a vStore

Function

This interface is used to query user mapping configuration of a vStore.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

IDMUUSERMAPPINGDN

Mandatory

 string

IDMU search DN.

IDMUUSERMAPPINGDNTIMEOUT

Mandatory

 string(uint32)

IDMU search timeout duration.

Unit:seconds

IDMUWINOBJECTCLASS

Mandatory

 string

objectclass used by the Windows user searched by the IDMU.

The value is described as follows:

The value is a string containing 1 to 255 characters.

IDMUUNIXOBJECTCLASS

Mandatory

 string

objectclass used by the UNIX user searched by the IDMU.

The value is described as follows:

The value is a string containing 1 to 255 characters.

USERMAPPINGPROVIDER

Mandatory

 string(enum)

Mapping type.

The value is described as follows:

0: user mapping not supported

1: mapping rules set in local

2: mapping rules set in IDMU

3: mapping rules set in IDMU and local, IDMU preferentially

4: mapping rules set in local and IDMU, local preferentially

DEFAULTWINDOWSUSER

Mandatory

 string

Default Windows user.

DEFAULTUNIXUSER

Mandatory

 string

Default UNIX user.

SAMEUSERSWITCH

Mandatory

 string(enum)

Switch of a mapping between users with the same name.

The value is described as follows:

0: off

1: on

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in vStore scenarios.

Example

  • Querying user mapping configuration of a vStore.

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

Response: 
{
    "data": {
        "IDMUUSERMAPPINGDN": "",
        "IDMUUSERMAPPINGDNTIMEOUT": "15",
        "USERMAPPINGPROVIDER": "0",
        "IDMUWINOBJECTCLASS": "ad",
        "IDMUUNIXOBJECTCLASS": "rt",
        "DEFAULTWINDOWSUSER": "admin",
        "DEFAULTUNIXUSER": "root",
        "SAMEUSERSWITCH": "on",
        "vstoreId": "0",
        "vstoreName":  "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Testing Whether the Target User Exists

Function

This interface is used to test whether the target user exists.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
MAPPINGTYPE

Mandatory

 enum

Mapping type.

The value is described as follows:

0: Windows to Unix

1: Unix to Windows
TOIDENTITY

Mandatory

 string

Target user.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

TOIDENTITYEXIST

Mandatory

 string(bool)

Whether the target user exists.

The value is described as follows:

true: exist

false: not exist

Example

  • Testing whether the target user exists.

    Request: GET /deviceManager/rest/210235843910E6000009/toidentity_test?MAPPINGTYPE=0&TOIDENTITY=user1

Response: 
{
    "data": [{
        "TOIDENTITYEXIST": "false"
    }],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of UNIX User Groups

Function

This interface is used to query the number of UNIX user groups.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter name is supported.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

count

Mandatory

 string(uint32)

Number of queried local user groups.

Example

  • Querying the number of UNIX user groups.

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

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

Interface for Deleting a UNIX User Group

Function

This interface is used to delete a UNIX user group.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

Name of the UNIX user group.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a UNIX user group.

    Request: DELETE/deviceManager/rest/210235843910E6000009/UNIX_GROUP?name=mlgroup1

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

Interface for Batch Querying UNIX User Group Information

Function

This interface is used to batch query basic information about UNIX user groups.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by NAME is supported.
range

Conditional

 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 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

id

Mandatory

 string

User group ID.

name

Mandatory

 string

Name.

description

Mandatory

 string

Description.

group_type

Mandatory

 string(enum)

User group type.

The value is described as follows:

1: default

2: created by an administrator

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Batch querying basic information about UNIX user groups.

    Request: GET/deviceManager/rest/210235843910E6000009/UNIX_GROUP?range=[0-100]

Response: {
    "data": [
        {
            "description": "",
            "group_type": "1",
            "id": "99997",
            "name": "Backup Operators",
            "vstoreId": "0",
            "vstoreName": "System_vStore"
        },
        {
            "description": "the antivirus group",
            "group_type": "1",
            "id": "99998",
            "name": "AntivirusGroup",
            "vstoreId": "0",
            "vstoreName": "System_vStore"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying UNIX User Information

Function

This interface is used to query basic information about a UNIX user.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

Name of the UNIX user.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

id

Mandatory

 string

Object ID.

name

Mandatory

 string

Name.

description

Mandatory

 string

Description.

primary_group_id

Mandatory

 string

ID of the primary group to which a user belongs.

primary_group_name

Mandatory

 string

Name of the primary group to which a user belongs.

group_names

Mandatory

 string(array)

List of temporary groups to which a user belongs.

The value is described as follows:

A maximum of 31 temporary groups are supported.

user_type

Mandatory

 string(enum)

User type.

The value is described as follows:

1: default

2: created by an administrator

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying basic information about a UNIX user.

    Request: GET/deviceManager/rest/210235843910E6000009/UNIX_USER?name=malei

Response: {
    "data": {
        "description": "",
        "group_names": "",
        "id": "100000",
        "name": "malei",
        "primary_group_id": "100000",
        "primary_group_name": "default_group",
        "user_type": "2"
        "vstoreId": "0"
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying a UNIX User

Function

This interface is used to modify a UNIX user.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

Name of the UNIX user.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64
description

Optional

 string

Description.

The value is described as follows:

The value contains 0 to 255 characters.

Length:0~255
primary_group_id

Optional

 uint32

ID of the primary group to which a user belongs.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

Note:Either primary_group_id or primary_group_name must be specified. If both of them are specified, only primary_group_id takes effect.
primary_group_name

Optional

 string

Name of the primary group to which a user belongs.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64

Note:Either primary_group_id or primary_group_name must be specified. If both of them are specified, only primary_group_id takes effect.
id

Optional

 uint32

ID of the UNIX user.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Modifying a UNIX user.

    Request: PUT/deviceManager/rest/210235843910E6000009/UNIX_USER{
    "name": "mluser1",
    "description": ""
}Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying the Number of UNIX Users

Function

This interface is used to query the number of UNIX users.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter NAME is supported.
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

count

Mandatory

 string(uint32)

Number of queried UNIX users.

Example

  • Querying the number of UNIX users.

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

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

Interface for Creating a UNIX User

Function

This interface is used to create a UNIX user.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

Name.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64
description

Optional

 string

Description.

The value is described as follows:

The value contains 0 to 255 characters.

Length:0~255
primary_group_id

Conditional

 string

ID of the primary group to which a user belongs.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

Note:Either primary_group_id or primary_group_name must be specified. If both of them are specified, only primary_group_id takes effect.
primary_group_name

Conditional

 string

Name of the primary group to which a user belongs.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64

Note:Either primary_group_id or primary_group_name must be specified. If both of them are specified, only primary_group_id takes effect.
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.
id

Optional

 string

ID of the UNIX user.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

Result

N/A

Example

  • Creating a UNIX user.

    Request: POST /deviceManager/rest/210235843910E6000009/UNIX_USER
{
    "name": "test6",
    "primary_group_id": "100000",
    "primary_group_name": "default_group",
    "description": ""
}

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

Interface for Deleting a UNIX User

Function

This interface is used to delete a local user.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

User name.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Deleting a UNIX user.

    Request: DELETE /deviceManager/rest/210235843910E6000009/UNIX_USER?name=unixuser1

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

Interface for Batch Querying UNIX User Information

Function

This interface is used to batch query basic information about UNIX users.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The parameter NAME is supported.
range

Optional

 string

Search 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 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

id

Mandatory

 string

User ID.

name

Mandatory

 string

Name.

description

Mandatory

 string

Description.

primary_group_name

Mandatory

 string

Name of the primary group to which a user belongs.

user_type

Mandatory

 string(enum)

User type.

The value is described as follows:

1: default

2: created by an administrator

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Batch querying basic information about UNIX users.

    Request: GET /deviceManager/rest/210235843910E6000009/UNIX_USER?range=[0-100]

Response: 
{
    "data": [
        {
            "description": "",
            "id": "100000",
            "name": "tangfuwang",
             "primary_group_name": "default_group",
            "user_type": "2"
            "vstoreId": "0"
            "vstoreName": "System_vStore"
        },
        {
            "description": "",
            "id": "100001",
            "name": "TFW123456",
            "primary_group_name": "Backup Operators",
            "user_type": "2"
            "vstoreId": "0"
            "vstoreName": "System_vStore"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Creating a UNIX User Group

Function

This interface is used to create a UNIX user group.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

Name of the UNIX user group.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64
description

Optional

 string

Description.

The value is described as follows:

The value contains 0 to 255 characters.

Length:0~255
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.
id

Optional

 string

ID of the UNIX user group.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.

Result

N/A

Example

  • Creating a UNIX user group.

    Request: POST /deviceManager/rest/210235843910E6000009/UNIX_GROUP
{
    "description": "xzczc",
    "name": "test00000"
}

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

Interface for Modifying UNIX User Group Information

Function

This interface is used to modify basic information about a UNIX user group.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

Name of the UNIX user group.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).

Length:1~64
id

Optional

 string

ID of the UNIX user group.

The value is described as follows:

The value ranges from 0 to 4,294,967,295.
description

Optional

 string

Description.

The value is described as follows:

The value contains 0 to 255 characters.

Length:0~255
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Modifying basic information about a local user group.

    Request: PUT/deviceManager/rest/210235843910E6000009/UNIX_GROUP{
    "name": "mlgroup1",
    "description": "111"
}Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying UNIX User Group Information

Function

This interface is used to query basic information about a UNIX user group.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
name

Mandatory

 string

User group name.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

name

Mandatory

 string

Name.

description

Mandatory

 string

Description.

group_type

Mandatory

 string(enum)

User group type.

The value is described as follows:

1: default

2: created by an administrator

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

id

Mandatory

 string

User group ID.

Example

  • Querying basic information about a local user group.

    Request: GET/deviceManager/rest/210235843910E6000009/UNIX_GROUP?name=default_group

Response: {
    "data": {
        "description": "",
        "group_type": "1",
        "id": "100000",
        "name": "default_group",
        "vstoreId": "0"
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Removing a UNIX User from a UNIX User Group

Function

This interface is used to remove a UNIX user from the user group.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
user_name

Mandatory

 string

Name of the UNIX user.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
group_name

Mandatory

 string

Name of the UNIX user group.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Removing a UNIX user from the user group.

    Request: DELETE/deviceManager/rest/210235843910E6000009/UNIX_USER_GROUP_MAP?user_name=unixuser1&group_name=unixgroup1

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

Interface for Adding a UNIX User to a UNIX User Group

Function

This interface is used to add a UNIX user to a UNIX user group.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
user_name

Mandatory

 string

Name of the UNIX user.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
group_name

Mandatory

 string

Name of the UNIX user group.

The value is described as follows:

The value contains 1 to 64 characters, including case-sensitive letters, digits, hyphens (-), periods (.), and underscores (_). The name cannot start with a hyphen (-).
vstoreId

Conditional

 string

vStore ID.

Default:0

Note:This field must be delivered in multi-vStore scenarios.

Result

N/A

Example

  • Adding a UNIX user to a UNIX user group.

    Request: DELETE/deviceManager/rest/210235843910E6000009/UNIX_USER_GROUP_MAP{
    "user_name": "unixuser1",
    "group_name": "unixgroup1"
}
}Response: {
"data": {
    
},
"error": {
    "code": 0,
    "description": "0"
}
}

Interface for Querying a User Mapping

Function

This interface is used to query a user mapping.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

User mapping ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

User mapping ID.

FROMIDENTITY

Mandatory

 string

Source user.

MAPPINGTYPE

Mandatory

 string(enum)

Mapping type.

The value is described as follows:

0: Windows to Unix

1: Unix to Windows

RULEPRIORITY

Mandatory

 string(uint32)

Priority.

TOIDENTITY

Mandatory

 string

Target user.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in vStore scenarios.

Example

  • Querying a user mapping.

    Request: GET /deviceManager/rest/210235843910E6000009/identitymapping/9

Response: 
{
    "data": {
        "FROMIDENTITY": "user1",
        "ID": "9",
        "MAPPINGTYPE": "0",
        "RULEPRIORITY": "10",
        "TOIDENTITY": "user2",
        "vstoreId": "0",
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Creating a User Mapping

Function

This interface is used to create a user mapping.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
MAPPINGTYPE

Mandatory

 enum

Mapping type.

The value is described as follows:

0: Windows to Unix

1: Unix to Windows
FROMIDENTITY

Mandatory

 string

Source user.

The value is described as follows:

The value cannot contain consecutive asterisks (*), end with a period (.), and contain the following characters: "/][><+:;,?|=@.

Length:1~256
TOIDENTITY

Mandatory

 string

Target user.

The value is described as follows:

The value can neither end with a period (.) nor contain the following characters: "/][><+:;,?*|=@.

Length:1~256
RULEPRIORITY

Optional

 uint32

Priority.

The value is described as follows:

1 to 32.

Default:10
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

User mapping ID.

FROMIDENTITY

Mandatory

 string

Source user.

MAPPINGTYPE

Mandatory

 string(enum)

Mapping type.

The value is described as follows:

0: Windows to Unix

1: Unix to Windows

RULEPRIORITY

Mandatory

 uint32

Priority.

TOIDENTITY

Mandatory

 string

Target user.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in vStore scenarios.

Example

  • Creating a user mapping.

    Request: POST /deviceManager/rest/210235843910E6000009/identitymapping
{
    "MAPPINGTYPE": "0",
    "FROMIDENTITY": "user1",
    "TOIDENTITY": "user2",
    "RULEPRIORITY": 10
}

Response: 
{
    "data": {
        "FROMIDENTITY": "user1",
        "ID": "9",
        "MAPPINGTYPE": "0",
        "RULEPRIORITY": "10",
        "TOIDENTITY": "user2",
        "vstoreId": "0",
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Clearing User Mapping Configuration of a vStore

Function

This interface is used to clear user mapping configuration of a vStore.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Clearing user mapping configuration of a vStore.

    Request: DELETE /deviceManager/rest/210235843910E6000009/identitymappingconfig
{

}

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

Interface for Modifying a User Mapping

Function

This interface is used to modify a user mapping.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

User mapping ID.
MAPPINGTYPE

Optional

 enum

Mapping type.

The value is described as follows:

0: Windows to Unix

1: Unix to Windows
FROMIDENTITY

Optional

 string

Source user.

The value is described as follows:

The value cannot contain consecutive asterisks (*), end with a period (.), and contain the following characters: "/][><+:;,?|=@.

Length:1~256
TOIDENTITY

Optional

 string

Target user.

The value is described as follows:

The value can neither end with a period (.) nor contain the following characters: "/][><+:;,?*|=@.

Length:1~256
RULEPRIORITY

Optional

 uint32

Priority.

The value is described as follows:

1 to 32.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Modifying a user mapping.

    Request: PUT/deviceManager/rest/210235843910E6000009/identitymapping/0
{
    "RULEPRIORITY": 3
}

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

Interface for Deleting a User Mapping

Function

This interface is used to delete a user mapping.

URL

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

Access Method

DELETE

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

User mapping ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in vStore scenarios.

Result

N/A

Example

  • Deleting a user mapping.

    Request: DELETE /deviceManager/rest/210235843910E6000009/identitymapping/0

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

Interface for Querying CIFS Share User (Group) Information

Function

This interface is used to query information about a CIFS share user (user group).

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

Object ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

ID.

NAME

Mandatory

 string

Name of a user or user group.

PARENTID

Mandatory

 string

CIFS share ID.

DOMAINTYPE

Mandatory

 string(uint32)

Domain type.

The value is described as follows:

0: AD domain user or user group.

1: LDAP domain user or user group.

2: local user or user group.

3: NIS domain user or user group.

PERMISSION

Mandatory

 string(uint32)

Permission.

The value is described as follows:

0: read

1: full control

2: forbidden

5: read/write

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Querying information about a CIFS share user (user group).

    Request: GET/deviceManager/rest/210235843910E6000009/CIFS_SHARE_AUTH_CLIENT/4294967297Response: {
    "data": {
        "DOMAINTYPE": "2",
        "ID": "4294967297",
        "NAME": "tangfuwang",
        "PARENTID": "1",
        "PERMISSION": "0",
        "vstoreId": "0",
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Batch Querying CIFS Share User (Group) Information

Function

This interface is used to batch query information about CIFS share users (user groups).

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

The query by PARENTID and NAME is supported.
range

Conditional

 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:If "filter" is delivered, "range" is mandatory. A maximum of 10000 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

ID.

NAME

Mandatory

 string

Name of a user or user group.

PARENTID

Mandatory

 string

CIFS share ID.

DOMAINTYPE

Mandatory

 string(uint32)

Domain type.

The value is described as follows:

0: AD domain user or user group.

1: LDAP domain user or user group.

2: local user or user group.

3: NIS domain user or user group.

PERMISSION

Mandatory

 string(enum)

Permission.

The value is described as follows:

0: read

1: full control

2: forbidden

5: read/write

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

Example

  • Batch querying information about CIFS share users (user groups).

    Request: GET/deviceManager/rest/210235843910E6000009/CIFS_SHARE_AUTH_CLIENT?filter=PARENTID: : 1&range=[
    0-100
]Response: {
    "data": [
        {
            "ID": "8589934594",
            "NAME": "tangfuwang",
            "PARENTID": "2",
            "DOMAINTYPE": "2",
            "PERMISSION": "1",
            "vstoreId": "0",
            "vstoreName": "System_vStore"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Querying CIFS Share Information

Function

This interface is used to query basic information about CIFS shares.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

CIFS share ID.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

CIFS share ID.

NAME

Mandatory

 string

Name.

DESCRIPTION

Mandatory

 string

Description.

SHAREPATH

Mandatory

 string

Share path.

subType

Mandatory

 string(uint32)

Share object subtype.

The value is described as follows:

0: normal

1: homedir

2: all

ABEENABLE

Mandatory

 string(bool)

After this function is enabled, users can only access folders for which the users have access permission.

Note:This field is not supported temporarily.

FSID

Mandatory

 string

File system ID.

ENABLEOPLOCK

Mandatory

 string(bool)

Indicates whether oplock is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLENOTIFY

Mandatory

 string(bool)

Indicates whether the Notify function is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLECA

Mandatory

 string(bool)

Indicates whether failover is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLEIPCONTROL

Mandatory

 string(bool)

Whether to enable the IP address access control feature.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

OFFLINEFILEMODE

Mandatory

 string(enum)

Offline cache mode.

The value is described as follows:

0: none

1: manual

2: documents

3: programs

Note:This field is not supported temporarily.

AUDITITEMS

Mandatory

 array

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

13: get xattr

14: set xattr

APPLYDEFAULTACL

Mandatory

 string(bool)

Whether to enable the default ACL.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLEFILEEXTENSIONFILTER

Mandatory

 string(bool)

Whether to enable the file name extension filtering feature.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLESHOWPREVIOUSVERSIONS

Mandatory

 string(bool)

Whether the function of showing previous versions is enabled.

The value is described as follows:

true: enabled

false: disabled

ENABLESHOWSNAPSHOT

Mandatory

 string(bool)

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

enableBrowse

Mandatory

 string(bool)

Whether to allow Windows clients to browse the share.

The value is described as follows:

true: enabled

false: disabled

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

DTREEID

Mandatory

 string

Dtree ID.

leaseEnable

Mandatory

 string(bool)

Lease lock switch, which allows the client to lock a file with a lease key. The server can revoke the lock. Lease locks are supported with the SMB 2.1 protocol and later.

The value is described as follows:

true: enabled

false: disabled

Example

  • Querying basic information about CIFS shares.

    Request: GET/deviceManager/rest/210235843910E6000009/CIFSHARE/1Response: {
    "data": {
        "DESCRIPTION": "",
        "FSID": "5",
        "ID": "1",
        "AUDITITEMS": "[0]",
        "DTREEID:1@0",
        "enableBrowse": "true",
        "subType": "0",
        "NAME": "llt",
        "SHAREPATH": "/FileSystem0050001/",
        "ENABLESHOWPREVIOUSVERSIONS": "true",
        "ENABLESHOWSNAPSHOT": "true",
        "leaseEnable": true,
        "vstoreId": "0",
        "vstoreName": "System_vStore"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Batch Querying CIFS Share Information

Function

This interface is used to batch query basic information about CIFS shares.

URL

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

Access Method

GET

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
filter

Optional

 string

Query criteria.

The value is described as follows:

Query by NAME, DESCRIPTION, subType, DTREEID, and FSID is 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 100 results can be returned.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

CIFS share ID.

NAME

Mandatory

 string

Name.

subType

Mandatory

 string(uint32)

Share object subtype.

The value is described as follows:

0: normal

1: homedir

2: all

DESCRIPTION

Mandatory

 string

Description.

SHAREPATH

Mandatory

 string

Share path.

ABEENABLE

Mandatory

 string(bool)

After this function is enabled, users can only access folders for which the users have access permission.

Note:This field is not supported temporarily.

FSID

Mandatory

 string

File system ID.

ENABLEOPLOCK

Mandatory

 string(bool)

Indicates whether oplock is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLENOTIFY

Mandatory

 string(bool)

Indicates whether the Notify function is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLECA

Mandatory

 string(bool)

Indicates whether failover is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLEIPCONTROL

Mandatory

 string(bool)

Whether to enable the IP address access control feature.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

OFFLINEFILEMODE

Mandatory

 string(enum)

Offline cache mode.

The value is described as follows:

0: none

1: manual

2: documents

3: programs

Note:This field is not supported temporarily.

AUDITITEMS

Mandatory

 array

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

13: get xattr

14: set xattr

APPLYDEFAULTACL

Mandatory

 string(bool)

Whether to enable the default ACL.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLEFILEEXTENSIONFILTER

Mandatory

 string(bool)

Whether to enable the file name extension filtering feature.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

ENABLESHOWPREVIOUSVERSIONS

Mandatory

 string(bool)

Whether the function of showing previous versions is enabled.

The value is described as follows:

true: enabled

false: disabled

ENABLESHOWSNAPSHOT

Mandatory

 string(bool)

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

enableBrowse

Mandatory

 string(bool)

Whether to allow Windows clients to browse the share.

The value is described as follows:

true: enabled

false: disabled

DTREEID

Mandatory

 string

Dtree ID.

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

leaseEnable

Mandatory

 string(bool)

Lease lock switch, which allows the client to lock a file with a lease key. The server can revoke the lock. Lease locks are supported with the SMB 2.1 protocol and later.

The value is described as follows:

true: enabled

false: disabled

Example

  • Batch querying basic information about CIFS shares.

    Request: GET/deviceManager/rest/210235843910E6000009/CIFSHARE?filter=NAME: t&range=[
    0-100
]Response: {
    "data": [
        {
            "ID": "1",
            "NAME": "share",
            "DESCRIPTION": "",
            "subType": "0",
            "SHAREPATH": "/fs0/",
            "FSID": "1",
            "AUDITITEMS": "[0]",
            "ENABLESHOWPREVIOUSVERSIONS": "false",
            "ENABLESHOWSNAPSHOT": "false",
            "enableBrowse": "true",
            "leaseEnable": true,
            "DTREEID": "1@0",
            "vstoreId": "0",
            "vstoreName": "System_vStore"
        }
    ],
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Creating a CIFS Share

Function

This interface is used to create a CIFS share.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
NAME

Mandatory

 string

Name.

The value is described as follows:

The value cannot include special characters including " / \ [ ] : | < > + ; , ? * =, and cannot be the name reserved by the system such as ipc$, autohome, ~, and print$.

Length:1~80
subType

Optional

 uint32

Share object subtype.

The value is described as follows:

0: normal

1: homedir

2: all

Default:0: normal
DESCRIPTION

Optional

 string

Description.

Length:0~255
SHAREPATH

Mandatory

 string

Share path.

The value is described as follows:

/file system name/quota tree name.

Length:2-1024
ABEENABLE

Optional

 bool

After this function is enabled, users can only access folders for which the users have access permission.

The value is described as follows:

true: enabled

false: disabled

Default:false: disabled

Note:This field is not supported temporarily.
ENABLEOPLOCK

Optional

 bool

Indicates whether oplock is enabled.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled

Note:This field is not supported temporarily.
ENABLENOTIFY

Optional

 bool

Indicates whether the Notify function is enabled.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled

Note:This field is not supported temporarily.
ENABLECA

Optional

 bool

Indicates whether failover is enabled.

The value is described as follows:

true: enabled

false: disabled

Default:false: disabled

Note:This field is not supported temporarily.
FSID

Optional

 string

File system ID.
OFFLINEFILEMODE

Optional

 enum

Offline cache mode.

The value is described as follows:

0: none

1: manual

2: documents

3: programs

Default:1: manual

Note:This field is not supported temporarily.
ENABLEIPCONTROL

Optional

 bool

Whether to enable the IP address access control feature.

The value is described as follows:

true: enabled

false: disabled

Default:false: disabled

Note:This field is not supported temporarily.
AUDITITEMS

Optional

 array

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

13: get xattr

14: set xattr

Default:0: none
APPLYDEFAULTACL

Optional

 bool

Whether to enable the default ACL.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled

Note:This field is not supported temporarily.
ENABLEFILEEXTENSIONFILTER

Optional

 bool

Whether to enable the file name extension filtering feature.

The value is described as follows:

true: enabled

false: disabled

Default:false: disabled

Note:This field is not supported temporarily.
ENABLESHOWPREVIOUSVERSIONS

Optional

 bool

Whether the function of showing previous versions is enabled.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled
ENABLESHOWSNAPSHOT

Optional

 bool

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.
DTREEID

Optional

 string

Dtree ID.

Length:1-20
leaseEnable

Optional

 bool

Lease lock switch, which allows the client to lock a file with a lease key. The server can revoke the lock. Lease locks are supported with the SMB 2.1 protocol and later.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

CIFS share ID.

NAME

Mandatory

 string

Name.

DESCRIPTION

Conditional

 string

Description.

SHAREPATH

Mandatory

 string

Share path.

ABEENABLE

Conditional

 string(bool)

After this function is enabled, users can only access folders for which the users have access permission.

FSID

Conditional

 string

File system ID.

ENABLEOPLOCK

Conditional

 string(bool)

Indicates whether oplock is enabled.

The value is described as follows:

true: enabled

false: disabled

ENABLENOTIFY

Conditional

 string(bool)

Indicates whether the Notify function is enabled.

The value is described as follows:

true: enabled

false: disabled

ENABLECA

Conditional

 string(bool)

Indicates whether failover is enabled.

The value is described as follows:

true: enabled

false: disabled

ENABLEIPCONTROL

Conditional

 string(bool)

Whether to enable the IP address access control feature.

The value is described as follows:

true: enabled

false: disabled

OFFLINEFILEMODE

Conditional

 string(enum)

Offline cache mode.

The value is described as follows:

0: none

1: manual

2: documents

3: programs

AUDITITEMS

Conditional

 string(array)

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

13: get xattr

14: set xattr

APPLYDEFAULTACL

Conditional

 string(bool)

Whether to enable the default ACL.

The value is described as follows:

true: enabled

false: disabled

ENABLEFILEEXTENSIONFILTER

Conditional

 string(bool)

Whether to enable the file name extension filtering feature.

The value is described as follows:

true: enabled

false: disabled

ENABLESHOWPREVIOUSVERSIONS

Conditional

 string(bool)

Whether the function of showing previous versions is enabled.

The value is described as follows:

true: enabled

false: disabled

ENABLESHOWSNAPSHOT

Conditional

 string(bool)

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

vstoreId

Conditional

 string

vStore ID.

Note:This field must be returned in multi-vStore scenarios.

vstoreName

Conditional

 string

vStore name.

Note:This field must be returned in multi-vStore scenarios.

DTREEID

Mandatory

 string

Dtree ID.

leaseEnable

Mandatory

 string(bool)

Lease lock switch, which allows the client to lock a file with a lease key, and the server can revoke the lock. Lease locks are supported with the SMB 2.1 protocol and later.

The value is described as follows:

true: enabled

false: disabled

Example

  • Creating a CIFS share.

    Request: POST/deviceManager/rest/210235843910E6000009/CIFSHARE{
    "NAME": "G1",
    "SHAREPATH": "/FileSystem010/",
    "DESCRIPTION": "1",
    "FSID": "5",
    "AUDITITEMS": [
        0
    ],
    "ENABLESHOWPREVIOUSVERSIONS": true,
    "ENABLESHOWSNAPSHOT": true,
    "leaseEnable": true
}Response: {
    "data": {
        "AUDITITEMS": "[0]",
        "DESCRIPTION": "1",
        "FSID": "5",
        "ID": "1",
        "vstoreId": "0",
        "NAME": "G1",
        "SHAREPATH": "/FileSystem010/",
        "ENABLESHOWPREVIOUSVERSIONS": "true",
        "ENABLESHOWSNAPSHOT": "true",
        "leaseEnable": true,
        "DTREEID": "1@0"
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying CIFS Share Information

Function

This interface is used to modify a CIFS share.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

CIFS share ID.
DESCRIPTION

Optional

 string

Description.

Length:0~255
ABEENABLE

Optional

 bool

After this function is enabled, users can only access folders for which the users have access permission.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
ENABLEOPLOCK

Optional

 bool

Indicates whether oplock is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
ENABLENOTIFY

Optional

 bool

Indicates whether the Notify function is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
ENABLECA

Optional

 bool

Indicates whether failover is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
OFFLINEFILEMODE

Optional

 enum

Offline cache mode.

The value is described as follows:

0: none

1: manual

2: documents

3: programs

Note:This field is not supported temporarily.
ENABLEIPCONTROL

Optional

 bool

Whether to enable the IP address access control feature.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
AUDITITEMS

Optional

 array

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: get security

10: set security

11: get attr

12: set attr

13: get xattr

14: set xattr
APPLYDEFAULTACL

Optional

 bool

Whether to enable the default ACL.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
ENABLEFILEEXTENSIONFILTER

Optional

 bool

Whether to enable the file name extension filtering feature.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.
ENABLESHOWPREVIOUSVERSIONS

Optional

 bool

Whether the function of showing previous versions is enabled.

The value is described as follows:

true: enabled

false: disabled
ENABLESHOWSNAPSHOT

Optional

 bool

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.
leaseEnable

Optional

 bool

Lease lock switch, which allows the client to lock a file with a lease key. The server can revoke the lock. Lease locks are supported with the SMB 2.1 protocol and later.

The value is described as follows:

true: enabled

false: disabled

Result

N/A

Example

  • Modifying a CIFS share.

    Request: PUT/deviceManager/rest/210235843910E6000009/CIFSHARE/1{
    "DESCRIPTION": "",
    "AUDITITEMS": [
        0
    ],
    "ENABLESHOWPREVIOUSVERSIONS": "true",
    "ENABLESHOWSNAPSHOT": "true",
    "leaseEnable": "true"
}Response: {
    "data": {
        
    },
    "error": {
        "code": 0,
        "description": "0"
    }
}

Interface for Modifying NFS Share Information

Function

This interface is used to modify an NFS share.

HighRisk

You are about to change the character code of an NFS share. This operation may cause garbled display or service interruption after switching the language.

Suggestion: Confirm that you want to perform this operation based on the service type.

URL

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

Access Method

PUT

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
ID

Mandatory

 string

NFS share ID.
DESCRIPTION

Optional

 string

Description.

Length:0~255
LOCKPOLICY

Optional

 enum

NFS lock policy.

The value is described as follows:

0: mandatory locking

1: advisory locking

Note:This field is not supported temporarily.
CHARACTERENCODING

Optional

 enum

Character coding used by the current share.

The value is described as follows:

0: UTF-8

11: ZH

12: GBK

13: EUC-TW

14: BIG5

21: EUC-JP

22: JIS

23: S-JIS

30: DE

31: PT

32: ES

33: FR

34: IT

40: KO
AUDITITEMS

Optional

 array

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: obtain security properties

10: obtain security properties

11: obtain properties

12: set properties

Note:This field is not supported temporarily.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.
ENABLESHOWSNAPSHOT

Optional

 bool

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

Note:This field is not supported temporarily.

Result

N/A

Example

  • Modifying an NFS share.

    Request: PUT /deviceManager/rest/210235843910E6000009/NFSHARE/1
{
    "DESCRIPTION": "adsf"
}

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

Interface for Creating an NFS Share

Function

This interface is used to create an NFS share.

HighRisk

You are about to enable the audit log function when creating an NFS share. This operation may cause NFS service performance to decrease.

Suggestion: Confirm that you want to perform this operation based on the service type.

URL

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

Access Method

POST

Parameters

Parameter

Mandatory/Optional/Conditional

Type

Description
DESCRIPTION

Optional

 string

Description.

Length:0~255
NAME

Optional

 string

Share alias.

The value is described as follows:

The value must start with a slash (/). Except the first slash, the value contains 1 to 255 characters, only including letters, digits, spaces, and special characters (!\"#&%$'()*+-,.:;<=>?@[]^_`{|}~).

Length:1-255

Note:This field is not supported temporarily.
SHAREPATH

Mandatory

 string

Share path.

Length:2~1024
FSID

Optional

 string

File system ID.
LOCKPOLICY

Optional

 enum

NFS lock policy.

The value is described as follows:

0: mandatory locking

1: advisory locking

Default:0: mandatory locking

Note:This field is not supported temporarily.
CHARACTERENCODING

Optional

 enum

Character coding used by the current share.

The value is described as follows:

0: UTF-8

11: ZH

12: GBK

13: EUC-TW

14: BIG5

21: EUC-JP

22: JIS

23: S-JIS

30: DE

31: PT

32: ES

33: FR

34: IT

40: KO

Default:0: UTF-8
AUDITITEMS

Optional

 array

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: obtain security properties

10: set security properties

11: obtain properties

12: set properties

Default:0

Note:This field is not supported temporarily.
ENABLESHOWSNAPSHOT

Optional

 bool

Whether the function of showing the .snapshot folder is enabled.

The value is described as follows:

true: enabled

false: disabled

Default:true: enabled

Note:This field is not supported temporarily.
vstoreId

Conditional

 string

vStore ID.

Note:This field must be delivered in multi-vStore scenarios.
DTREEID

Optional

 string

Result

Parameter

Mandatory/Conditional

Type

Description

ID

Mandatory

 string

NFS share ID.

DESCRIPTION

Mandatory

 string

Description.

NAME

Mandatory

 string

Share alias.

Note:This field is not supported temporarily.

SHAREPATH

Mandatory

 string

Share path.

FSID

Mandatory

 string

File system ID.

CHARACTERENCODING

Mandatory

 string(enum)

Character coding used by the current share.

LOCKPOLICY

Mandatory

 string(enum)

NFS lock policy.

The value is described as follows:

0: mandatory locking

1: advisory locking

Note:This field is not supported temporarily.

TYPE

Mandatory

 enum

Type number of the managed object.

The value is described as follows:

16401: NFS share

AUDITITEMS

Mandatory

 string(array)

List of events that support auditing.

The value is described as follows:

0: none

1: all

2: open

3: create

4: read

5: write

6: close

7: delete

8: rename

9: obtain security properties

10: set security properties

11: obtain properties

12: set properties

Note:This field is not supported temporarily.

vstoreId