Specifying an object ID

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
An object ID is an ID that is used to uniquely identify a resource. An object ID is used when specifying a specific resource in a URL.

You can use the following two methods to specify an object ID:

  • (Recommended) Run the GET operation to obtain the object ID from the execution result.

    Example: When specifying the object ID of an LDEV

    If the object type is ldevs, because the object ID of the LDEV is unique in the storage system, use the object ID obtained by running the GET operation without changing the ID. If the object ID of the LDEV is 100, specify as follows:

    ldevs/100
  • Generate an object ID by using the character string that connects multiple attribute values with commas.

    Example: When specifying the object ID of a host group

    If the object type is host-groups, the object ID of the host group can be generated by connecting, with a comma, the attribute value of the port and the attribute value of the host group that belongs to the port. If the attribute value representing the port is CL1-A, and the attribute value representing the host group which belongs to the port is 200, specify as follows:

    host-groups/CL1-A,200

To generate an object ID by connecting multiple attribute values with commas, the attribute value must be encoded in accordance with the RFC3986 on the REST API client. After all attribute values are encoded, specify the character string that connects multiple attribute values with commas to be the object ID. Typical symbols which need encoding are shown below.

Pre-Encode

Post-Encode

! (exclamation mark)

%21

# (number sign)

%23

$ (dollar sign)

%24

% (percent)

%25

& (ampersand)

%26

' (single quotation mark)

%27

( (left parenthesis)

%28

) (right parenthesis)

%29

* (asterisk)

%2A

+ (plus sign)

%2B

, (comma)

%2C

: (colon)

%3A

; (semicolon)

%3B

= (equal sign)

%3D

? (question mark)

%3F

@ (at sign)

%40

[ (left square bracket)

%5B

] (right square bracket)

%5D

Here is an example of specifying the object ID of the ShadowImage pair from the following attribute values:

"copyGroupName": "localCopyGroup1"

"pvolDeviceGroupName": "localCopyGroup1P_"

"svolDeviceGroupName": "localCopyGroup1S_"

"copyPairName": "pair_1P,1S"

In this example, the comma in copyPairName is encoded to %2C, and then the values are connected with commas. The resulting object ID is as follows.

localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair_1P%2C1S
Note:
  • If the object ID is obtained by performing the GET operation, the REST API server returns an encoded value. To use the object ID obtained by performing the GET operation in a request of another operation, use the object ID without decoding it.
  • If you want to create a new object or change an attribute, we recommend that you do not specify values that contain the reserved characters listed above.