Getting device info by ID

To get information about a backup device by its ID, use the GetAccountInfoById method.

Required Parameters

Parameter	Description	Type/Supported values
accountId	The ID of the backup device to get information for. This information can be found when running the GetAccountInfo call which uses the account name.	<int> Integer

Parameter

Description

Type/Supported values

accountId

The ID of the backup device to get information for.

This information can be found when running the GetAccountInfo call which uses the account name.

<int> Integer

Optional Parameters

Parameter	Description	Type/Supported values
homenodeInfo	A group of parameters related to the storage node	StorageNodeInfo, (has child parameters of its own, see the HomeNodeInfo child parameters table below)

HomeNodeInfo child parameters

Parameter	Description	Type/Supported values
Id	An ID to assign to the new device. It must not coincide with the ID of existing devices	<int> Integer
ActiveAccounts	Number of active devices associated to this storage node	<int> Integer
TotalAccounts	Total number of devices associated to this storage node	<int> Integer
LocationId	The location of the storage node. We recommend using the location of the customer that owns the node.	<int> Integer
CommonInfo	Common information regarding the Storage Node	StorageNodeCommonInfo (has child parameters of its own, see the StorageNodeCommonInfo child parameters table below)
StateInfo	State information regarding the Storage Node	StorageNodeStateInfo (has child parameters of its own, see the StorageNodeStateInfo child parameters table below)
ModeInfo	Mode information regarding the Storage Node	StorageNodeModeInfo (has child parameters of its own, see the StorageNodeModeInfo child parameters table below)

StorageNodeCommonInfo child parameters

Parameter	Description	Type/Supported values
StorageID	The ID number of the storage	<int> Integer
Name	The name of the storage node	OptionalNonEmptyString String
Family	The family of the storage node	OptionalNonEmptyString String
User	The username the storage node belongs to	OptionalNonEmptyString String
Password	The password of the storage node	OptionalNonEmptyString String
Host	The hostname of the storage	OptionalNonEmptyString String
Path	The path to the storage node	<std::string>
GatewayHost	The gateway host of the storage node	<std::string>
HttpGatwayHost	The HTTP gateway host of the storage node	<std::string>
CertificateInfo	Certificate information for the storage node	StorageNodeCertificateInfo (has child parameters of its own, see the StorageNodeCertificateInfo child parameters table below)

StorageNodeCertificateInfo child parameters

Parameter	Description	Type/Supported values
Certificate	The certificate for the storage node	<std::string>
StartDate	The start date of the certificate	<std::time_t> Integer in Unix format. For example, 1535673599 stands for August 30, 2018
EndDate	The expiry date of the certificate	<std::time_t> Integer in Unix format. For example, 1535673599 stands for August 30, 2018
CertificatePin	The certificate pin	<std::string>

StorageNodeStateInfo child parameters

Parameter	Description	Type/Supported values
State	The state of the storage node	storagenodestatetype::flagstype Undefined Online Full Migrated Decommissioned Count
UsedStorage	The used storage on the storage node	<std::int64_t> Integer (in megabytes)
TotalStorage	The total storage available on the storage node	<std::int64_t> Integer (in megabytes)
PrivilegedStorage	The privileged storage on the storage node	<std::int64_t> Integer (in megabytes)

StorageNodeCommonInfo child parameters

Parameter	Description	Type/Supported values
Mode	The mode of the storage node	storagenodemode::Enum Undefined Operable OutofService Count
Message	A note relative to the storage node mode	<std::string>

Parameter

Description

Type/Supported values

Mode

The mode of the storage node

storagenodemode::Enum

Undefined
Operable
OutofService
Count

Message

A note relative to the storage node mode

<std::string>

Sample Request

The below example covers creating a very basic device with the minimum information. Once created in the Management Console, this device can be edited as needed, or changes can be made using the ModifyAccount method.

{
    "id": "jsonrpc",
    "jsonrpc": "2.0",
    "visa": "{{visa}}",
    "method": "GetAccountInfoById",
    "params": {
      	"accountId": 72896
    }
}

Sample Response

{
    "id": "jsonrpc",
    "jsonrpc": "2.0",
    "result": {
	"homeNodeInfo": {
	    "ActiveAccounts": 1084,
	    "CommonInfo": {
		"CertificateInfo": {
		    "ValidationMethod": "OsTrustStore"
		},
		"Family": "WEBMOD",
		"GatewayHost": "",
		"Host": "hostname:port",
		"HttpGatewayHost": "hostname:port",
		"Name": "storageName",
		"Password": "*****",
		"Path": "",
		"StorageId": 1234567,
		"User": "*****"
	    },
	    "Id": 2345678,
	    "LocationId": 1,
	    "ModeInfo": {
		"Mode": "Operable"
	    },
	    "StateInfo": {
		"PrivilegedStorage": 0,
		"State": [
		    "Online"
		],
		"TotalStorage": 269320579,
		"UpdateTimestamp": 1666347496,
		"UsedStorage": 210196248
	    },
	    "TotalAccounts": 165
	},
	"result": {
	    "CreationTime": 1517402049,
	    "ExpirationTime": 1535673599,
	    "Id": 72896,
	    "LocationId": 1,
	    "Name": "test-device",
	    "NameAlias": null,
	    "OverrideVirtual": "Default",
	    "PartnerId": 33495,
	    "Password": "673487fcvg1",
	    "ProductId": 28382,
	    "RemovalTime": 0,
	    "StorageId": 0,
	    "StorageLocationId": 1,
	    "Token": "068a53c1-a64b-45c8-a87e-0000XX0000X0Xx0",
	    "Type": "BackupManager"
	}
    },
    "visa": "{{visa}}"
}