Getting a list of resource groups

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
The following request gets information about resource groups registered in the storage system. You can also use a query parameter to get information about only certain resources of interest.
Important:

Pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/resource-groups

Request message

Object ID

None.

Query parameters

To filter execution results:

Parameter

Type

Filter condition

lockStatus

string

(Optional) Lock status of the resource group
  • Locked: Gets information about the locked resource groups

  • Unlocked: Gets information about the unlocked resource groups

To get information about only certain types of resources in resource groups:

If you try to get information for a large number of resource groups, processing might take a long time. You can reduce the request processing time by using the following query parameter to get information about only certain resources of interest.

Parameter

Type

Filter condition

attributes

string

(Optional) Type of resource for which information is to be obtained

Information will be obtained about only resources corresponding to the specified attributes.

To specify multiple attributes, separate the attributes by using commas.

You can use this parameter in combination with the lockStatus parameter.

This parameter cannot be specified at the same time as the detailInfoType parameter.

  • ldevIds: LDEV numbers

  • parityGroupIds: Parity group numbers

  • externalParityGroupIds: External parity group numbers

  • portIds: Port numbers

  • hostGroupIds: Object IDs of host groups or iSCSI targets

  • nvmSubsystemIds: NVM subsystem numbers

    This value can be specified if the storage system is VSP 5000 series, VSP E1090, or VSP E1090H.

If this parameter is omitted, information will be obtained about all of the attributes listed above, excluding the NVM subsystem number.

Information about attributes other than those listed above will be obtained regardless of the specification of this parameter.

When getting information with NVM subsystem information added

Parameter

Type

Description

detailInfoType

string

(Optional) NVM subsystem information

You can use this parameter in combination with the lockStatus parameter.

This parameter cannot be specified at the same time as the attributes parameter.

  • nvmSubsystemIds

    Adds NVM subsystem information to all the information related to the resource group.

    This value can be specified if the storage system is VSP 5000 series, VSP E1090, or VSP E1090H.

Note:

Specify either of the following query parameters when getting NVM subsystem storage information and the storage system is VSP 5000 series, VSP E1090, or VSP E1090H.

  • To get only information related to NVM subsystems, specify nvmSubsystemIds in attributes.
  • To get all information including NVM subsystem information, specify nvmSubsystemIds in detailInfoType.

The following are examples of how to specify these query parameters in various situations.

To get the LDEV numbers of locked resource groups:
?lockStatus=Locked&attributes=ldevIds
To get the port numbers, and the object IDs of host groups or iSCSI targets for all resource groups:
?attributes=portIds,hostGroupIds
Body

None.

Response message

Body

The following is an example of output when a request is run to get information about all types of resource groups:

{
  "data": [
    {
      "resourceGroupId": 4,
      "resourceGroupName": "devResourceGroup",
      "lockStatus": "Locked",
      "lockOwner": "devUser",
      "lockHost": "host01",
      "virtualStorageId": 0,
      "ldevIds": [
        12,
        13
      ],
      "parityGroupIds": [
        "1-1",
        "1-2"
      ],
      "externalParityGroupIds": [
        "1-5",
        "1-6"
      ],
      "portIds": [
        "CL1-A",
        "CL1-B"
      ],
      "hostGroupIds": [
        "CL1-A,4",
        "CL1-A,5",
        "CL1-A,6"
      ],
      "nvmSubsystemIds": [
        3,
        4
      ]
    },
    {
      "resourceGroupId": 5,
      "resourceGroupName": "sales_group_resource",
      "lockStatus": "Unlocked",
      "virtualStorageId": 0,
      "ldevIds": [
        32,
        33
      ],
      "parityGroupIds": [
        "2-1",
        "2-2"
      ],
      "externalParityGroupIds": [
        "1-7",
        "1-8"
      ],
      "portIds": [
        "CL3-A"
      ],
      "hostGroupIds": [
        "CL3-A,1",
        "CL3-A,2"
      ],
      "nvmSubsystemIds": [
        7,
        8
      ]
    }
  ]
}
The following is an example of output when a request is run with the attributes query parameter specified, to get only information about port numbers and the object IDs of host groups or iSCSI targets:
{
  "data": [
    {
      "resourceGroupId": 4,
      "resourceGroupName": "devResourceGroup",
      "lockStatus": "Locked",
      "lockOwner": "devUser",
      "lockHost": "host01",
      "virtualStorageId": 0,
      "portIds": [
        "CL1-A",
        "CL1-B"
      ],
      "hostGroupIds": [
        "CL1-A,4",
        "CL1-A,5",
        "CL1-A,6"
      ]
    },
    {
      "resourceGroupId": 5,
      "resourceGroupName": "sales_group_resource",
      "lockStatus": "Unlocked",
      "virtualStorageId": 0,
      "portIds": [
        "CL3-A"
      ],
      "hostGroupIds": [
        "CL3-A,1",
        "CL3-A,2"
      ]
    }
  ]
}

Attribute

Type

Description

resourceGroupName

string

Resource group name

resourceGroupId

int

Resource group ID

lockStatus

string

Lock status of the resource group

  • Locked: The resource group is locked.
  • Unlocked: The resource group is unlocked.

selfLock

boolean

Whether the session specified in the Authorization header locked the resource group

  • true: The specified session locked the resource group
  • false: Another session locked the resource group

This attribute is output if the resource group is locked by a session that was generated by the same user who runs the API.

lockOwner

string

User ID that locked the resource group

This attribute is not output if the resource group is unlocked.

lockHost

string

IP address or name of the host that locked the resource group

If the resource group has been locked by the REST API, IP address or the host name of the SVP or GUM is output.

This attribute is output only when the resource group is locked.

lockSessionId

int

Session ID that locked the resource group

This attribute is output only when the resource group is locked and when a user who belongs to the Administrator user group (built-in user group) runs the API.

virtualStorageId

int

ID of the virtual storage machine that corresponds to the resource group

ldevIds

int[]

LDEV number

parityGroupIds

string[]

Parity group number

externalParityGroupIds

string[]

External parity group number

portIds

string[]

Port number

hostGroupIds

string[]

Object ID of the host group or iSCSI target

nvmSubsystemIds

int[]

NVM subsystem number

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/resource-groups