Getting information about external parity groups

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-parity-groups

Request message

Object ID

None.

Query parameters

With each request, you can obtain information about a maximum of 200 external parity groups. To obtain information about additional external parity groups, run the API request multiple times by using a combination of the count and startIndex parameters. By specifying the count parameter, you can also filter the external parity group information you require.

Parameter	Type	Filter Condition
startIndex	int	(Optional) Specify the index number of the external parity group from which to start obtaining information. Use a value in the range from 0 through 65535.
count	int	(Optional) Specify the number of external parity groups for which information is obtained. Use a value in the range from 1 through 200. If this parameter is omitted, 200 is assumed.

Body

None.

Response message

Body

{
  "data": [
    {
      "id": "1-500",
      "status": "Normal",
      "externalPathGroupId": 500,
      "externalPath": [
        {
          "portId": "CL5-A",
          "portProtocol": "FC",
          "externalPortWwn": "50060e8012000c60",
          "lun": 1754,
          "status": "Normal"
        }
      ],
      "index": 2073
    },
    {
      "id": "9-1200",
      "status": "Normal",
      "externalPathGroupId": 1200,
      "externalPath": [
        {
          "portId": "CL1-B",
          "portProtocol": "iSCSI",
          "externalPortIpAddress": "10.1.2.122",
          "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d011",
          "externalTcpPortNumber": 3260,
          "lun": 1200,
          "virtualPortNumber": 1,
          "status": "Normal"
        }
      ],
      "index": 2274
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute	Type	Description
id	string	External parity group ID
status	string	Status of the external parity group Normal: Normal Checking: Currently checking the status of the external path Cache Destaging: Currently writing data from the cache to the volume Disconnect: External paths are not connected Blockade: External paths are blocked Warning: A problem has occurred related to one or more external paths Unknown: Unknown
externalPathGroupId	int	External path group ID
externalPath	object[]	Information about each external path in the external parity group appears. portId (string) ID of the external connection port portProtocol (string) Protocol of the port FC iSCSI externalPortWwn (string) WWN of the port of the externally connected storage system If an iSCSI port is specified, this attribute will not appear. externalPortIpAddress (string) IP address of the port of the externally connected storage system This attribute is output in IPv4 or IPv6 format. If an FC port is specified, this attribute will not appear. externalPortIscsiName (string) Name of the iSCSI target for the port of the externally connected storage system If an FC port is specified, this attribute will not appear. externalTcpPortNumber (int) TCP port number of the port of the externally connected storage system If an FC port is specified, this attribute will not appear. virtualPortNumber (int) Virtual port number of the external connection port This attribute will not appear in the following cases: If an FC port is specified If an iSCSI port is specified and the use of virtual ports is disabled lun (int) LUN assigned to the port of the externally connected storage system If Unknown is displayed for the status of the external path, this attribute will not appear. status (string) Status of the external path Normal: Normal Disconnect: Not connected Temporary Blockade: The port is blocked (temporarily blocked) Blockade: Blocked Unknown: Unknown
index	int	Index number of the external parity group

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-parity-groups