SoftLayer Network Storage::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Network_Storage service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Error Handling

Overview

getObject retrieves the SoftLayer_Network_Storage object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage service.

To retrieve the ID for StorageLayer volumes, use the associated methods for the SoftLayer_Network_Storage service.

User Access

Users wishing to execute getObject service must have the Manage NAS permission assigned to their account.

Return Type

getObject returns the SoftLayer_Network_Storage data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Network_StorageInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Network_StorageObjectMask

Error Handling

getObject throws the following exceptions:

• SoftLayer_Exception_ObjectNotFound

Throw the error "Unable to find object with id of {id}." if the given initialization parameter has an invalid id field.

• SoftLayer_Exception_AccessDenied

Throw the error "Access Denied." if the given initialization parameter id field is not the account id of the user making the API call.