REST API - GET Storage Policy Copy Details

This operation returns the details of a storage policy copy.

Request

Syntax

GET <webservice>/V2/StoragePolicy/{storagePolicyId}/Copy/{copyId} HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>

where <webservice> is the root path that routes the API requests to the Web Server.

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

Request Parameters

Name	Description	Required
storagePolicyId	The system-generated ID of the storage policy.	Yes
copyId	The system-generated ID of the storage policy copy.	Yes

Request Headers

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

Response

Response Parameters

Parameter	Description	Element
storagePolicyName	The name of the storage policy.	storagePolicy
storagePolicyId	The system-generated ID of the storage policy.	storagePolicy
copyId	The system-generated ID of the storage policy copy.	StoragePolicyCopy
copyName	The name of the storage policy copy.	StoragePolicyCopy
mediaAgentId	The system-generated ID of the MediaAgent that is associated with the storage policy copy.	mediaAgent
mediaAgentName	The name of the MediaAgent that is associated with the storage policy copy.	mediaAgent
libraryId	The system-generated ID of the library that is associated with the storage policy copy.	library
libraryName	The name of the library that is associated with the storage policy copy.	library
errorCode	The possible error codes. Valid values are: 0, a successful completion. 2, a failure. a specific error code.	error
errorMessage	The description of the error code. Not all error codes have an error message.	error

Examples

Sample Request

GET <webservice>/V2/StoragePolicy/10/Copy/1016 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' ?>
<App_GetStoragePolicyCopyResp>
    <copy copyPrecedence="3" copyType="1" active="1" isMirrorCopy="0" isSnapCopy="0" isDefault="0" throttleNetworkBandWidthMBHR="0">
        <StoragePolicyCopy copyId="1016" copyName="Copy1"/>
        <sourceCopy copyId="136" copyName="Primary"/>
        <startTime time="19800"/>
        <mediaAgent mediaAgentId="3" mediaAgentName="MA1"/>
        <retentionRules retainBackupDataForDays="12" retainBackupDataForCycles="12" retainArchiverDataForDays="-1" jobs="0">
            <retentionFlags>
                <dirtyExtendedRetention>1</dirtyExtendedRetention>
                <enableDataAging>1</enableDataAging>
            </retentionFlags>
        </retentionRules>
        <copyFlags>
            <multiplexSourceStreams>1</multiplexSourceStreams>
            <combineStreams>1</combineStreams>
            <roundRobbinDataPath>1</roundRobbinDataPath>
            <autoAddDataPaths>1</autoAddDataPaths>
            <storeKeyOnMedia>1</storeKeyOnMedia>
            <auxCopyReencryptData>1</auxCopyReencryptData>
        </copyFlags>
        <extendedFlags>
            <chunkLevelAuxCopy>1</chunkLevelAuxCopy>
        </extendedFlags>
        <dedupeFlags/>
        <library libraryId="13320" libraryName="new_auto"/>
        <drivePool drivePoolId="13728" drivePoolName="DrivePool(AUTOV11MA)13728"/>
        <spareMediaGroup spareMediaGroupId="0" spareMediaGroupName=""/>
        <storagePool storagePoolId="0" storagePoolName=""/>
    </copy>
    <error errorCode="0" errorMessage=""/>
</App_GetStoragePolicyCopyResp>