V11 SP8
Loading...

REST API - GET Storage Policy List for a MediaAgent

Description

This operation returns a list of storage policies associated with a MediaAgent.

Request

Syntax

GET <webservice>/StoragePolicyListAssociatedToMediaAgent?MediaAgent={MediaAgent} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name Description Required
MediaAgent The MediaAgent ID for the MediaAgent. If the MediaAgent ID is not known, use the GET MediaAgent API to retrieve it. Yes

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

XML

An .xml file is not needed.

Response

Response Parameters

Parameter Description Element
errorCode The possible error codes. error
isMADDBHost Indicates whether the MediaAgent is hosting the deduplication database or not.

Valid values:

  • 0, if the MediaAgent is not hosting the deduplication database
  • 1, if the MediaAgent is hosting the deduplication database
storagePolicyInformationAssociatedToMA
isMADefaultDataPathInCopy Indicates whether the MediaAgent is the default data path in the storage policy copy.

Valid values:

  • 0, if the MediaAgent is not the default data path in the storage policy copy
  • 1, if the MediaAgent is the default data path in the storage policy copy
storagePolicyInformationAssociatedToMA
isPrimaryCopy Indicates whether this storage policy copy is the primary copy or not.

Valid values:

  • 0, if the storage policy copy is not the primary copy
  • 1, if the storage policy copy is the primary copy
storagePolicyInformationAssociatedToMA
isProxyMAInCopy Indicates whether the MediaAgent is a NAS attached MediaAgent.

Valid values:

  • 0
  • 1
storagePolicyInformationAssociatedToMA
mediaAgentId The system-generated ID assigned to the MediaAgent. mediaAgent
_type_   storagePolicyAndCopy
copyId The system-generated ID assigned to the copy. storagePolicyAndCopy
copyName The name of the storage policy copy. storagePolicyAndCopy
storagePolicyId The system-generated ID assigned to the storage policy. storagePolicyAndCopy
storagePolicyName The name of the storage policy associated with the MediaAgent. storagePolicyAndCopy

Examples

Sample Request

GET <webservice>/StoragePolicyListAssociatedToMediaAgent?MediaAgent=2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GetStoragePoliciesForMediaAgentResp>
  <error errorCode="0"/>
  <storagePolicyInformationAssociatedToMA isMADDBHost="0" isMADefaultDataPathInCopy="1" isPrimaryCopy="1" isProxyMAInCopy="0">
    <mediaAgent mediaAgentId="2"/>
    <storagePolicyAndCopy _type_="18" copyId="7" copyName="Primary" storagePolicyId="8" storagePolicyName="spOS"/>
  </storagePolicyInformationAssociatedToMA>
  <storagePolicyInformationAssociatedToMA isMADDBHost="0" isMADefaultDataPathInCopy="1" isPrimaryCopy="1" isProxyMAInCopy="0">
    <mediaAgent mediaAgentId="2"/>
    <storagePolicyAndCopy _type_="18" copyId="2" copyName="Primary" storagePolicyId="3" storagePolicyName="SPvm5"/>
   </storagePolicyInformationAssociatedToMA>
</App_GetStoragePoliciesForMediaAgentResp>