Resource ID

This section describes IDs that identify resources used in URIs, request bodies, and response bodies. Different resources have different specifications and verification methods for resource IDs.

The resource IDs used by the RESTful API are shown below.

Also see Sample Script for a script that uses the RESTful API to derive the ID from the name of a resource.

Resource type Type Format Confirmation method

Volume

Integer

RESTful API's own specification

  • GET /volume API's response

  • "Volume ID" shown using "show volumes -detail" of the ETERNUS CLI

Job

Integer

RESTful API's own specification

  • GET /job API's response

RAID Group

Integer

RAID Group number

  • GET /raidgroup API's response

  • "RAID Group" information in ETERNUS Web GUI

  • ETERNUS CLI "show raid-groups"

Thin Provisioning Pool

Integer

Thin Provisioning Pool number

  • GET /tpp API's response

  • "Thin Provisioning Pool" information in ETERNUS Web GUI

  • ETERNUS CLI "show thin-pro-pools"

Flexible Tier Pool

Integer

Flexible Tier Pool number

  • GET /ftrp API's response

  • "Flexible Tier Pool" information in ETERNUS Web GUI

  • ETERNUS CLI "show flexible-tier-pools"

Host

Integer

For FC Host, FC Host number

For iSCSI Host, iSCSI Host number + 65536

  • GET /host API's response

  • "Registered FC/FCoE Host List" or "Registered iSCSI Host List" information in ETERNUS Web GUI

  • ETERNUS CLI "show host-wwn-name" or "show host-iscsi-name"

Copy Session

Integer

Session ID (Copy Session)

  • GET /copysession API's response

  • "Advanced Copy" information in ETERNUS Web GUI

  • ETERNUS CLI "show advanced-copy-sessions"

CA Port

String

wxyz

w: CE number

x: CM number

y: CA number

z: CA Port number

  • GET /caport API's response

  • "Component" information in ETERNUS Web GUI

  • ETERNUS CLI "show fru-ce"

Drive

String

xxyy

xx:

  • For DE loaded drives. DE number

  • For CE loaded drives, the first x is the CE number and the next x is fixed at 0 (example: 10 for drives on CE#1).

yy: Slot number (hexadecimal)

Example) The ID of the drive in Slot#1 that is loaded in CE#1 is "1001"

Example) The ID of the drive in Slot#10 that is loaded in DE#11 is "110a"

  • GET /drive API's response

  • "Drives" information in ETERNUS Web GUI

  • ETERNUS CLI "show disks"

CE

String

CE number

  • GET /ce API's response

  • "Controller Enclosure" information in ETERNUS Web GUI

  • ETERNUS CLI "show fru-ce"

DE

String

DE number

  • GET /de API's response

  • "Drive Enclosure" information in ETERNUS Web GUI

  • ETERNUS CLI "show fru-de"