Execution permission
Storage Administrator (Provisioning)
Request line
POST base-URL/v1/objects/parity-groups/object-ID/actions/format/invoke
Request message
- Object ID
-
Specify the parityGroupId value obtained by getting information about the parity group.
Attribute
Type
Description
parityGroupId
string
(Required) Parity group number
Specify concatenated parity groups in the same way as the above.
If the concatenated parity groups are 1-3-1, 1-3-2, or 1-3-3, specify as follows:
"parityGroupId": "1-3"
Response message
- Body
-
A job object is returned. For details, see the section explaining job objects. This API function does not display the affectedResources attribute. Formatting is performed when the state attribute of the job object is Succeeded. To check whether the formatting of each volume is complete, use the following URL. For parity-group-number, specify the parity group number that was specified for the object ID.
GET base-URL/v1/objects/ldevs?parityGroupId=parity-group-number
If the status of each volume in the specified parity group is normal (NML), formatting is complete.
Action template
None.
Status codes
For details on the status codes of the request for this operation, see the description of HTTP status codes.
Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/parity-groups/1-7/actions/format/invoke -d ""