Getting information about a specific resource group

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify the value of resourceGroupId that was obtained by the processing to get information about resource groups.

Attribute	Type	Description
resourceGroupId	int	(Required) Resource group ID Specify a decimal (base 10) number in the range from 0 to 1023.

Query parameters

Parameter	Type	Description
detailInfoType	string	(Optional) NVM subsystem information 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.

Body

None.

Response message

Body

{
  "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"
  ]
}

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 resource group was locked by the session specified in the Authorization header true: The specified session locked the resource group. false: Another session locked the resource group. This attribute is output when the resource group is locked by a session that was generated by the same user who runs the API.
lockOwner	string	User ID of the user who locked the resource group This attribute is output only when the resource group is locked.
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 of the session that locked the resource group This attribute is output only when the resource group is locked and the API was run by one of the following users: the user who belongs to the Administrator user group (built-in user group).
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/4