SoftLayer Network Subnet IpAddress::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Network_Subnet_IpAddress 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_Subnet_IpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_IpAddress service. You can only retrieve the IP address whose subnet is associated with a vlan that is associated with the account that your portal user is assigned to.

User Access

Users wishing to execute getObject service must have the View Hardware permission assigned to their account.

Return Type

getObject returns the SoftLayer_Network_Subnet_IpAddress data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Network_Subnet_IpAddressInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Network_Subnet_IpAddressObjectMask

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.