This operation returns the details of a storage policy.
Request
Syntax
GET <webservice>/V2/StoragePolicy/{storagePolicyId}?propertyLevel={propertyLevel} 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 storage policy ID for the storage policy. If the storage policy ID is not known, use the GET Storage Policy API to retrieve it. |
Yes |
propertyLevel |
The amount of information to return for the storage policy. Valid values are:
|
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 |
errorCode |
The possible error codes. Valid values are:
|
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?propertyLevel=10 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<App_GetStoragePoliciesResp> <policies timeZoneType="0" description="" type="1" searchEngineName="saivmidcprodcertlocAnalyticsServer" searchEngineId="1" numberOfStreams="50" sidbBlockSizeKB="128" auxCopyAlertGB="0" numberOfCopies="5" auxCopyAlertDays="0" smReplicationProtocolType="0"> <flag distributeDataEvenlyAmongStreams="1" blockLevelDedup="1" randomizeStream="1" /> <logStoragePolicy storagePolicyName="" storagePolicyId="0" /> <copies copyType="1" isDefault="1" isSnapCopy="0" isMirrorCopy="0" copyPrecedence="1"> <storagePool storagePoolName="" storagePoolId="0" /> <retentionRules retainBackupDataForCycles="1" retainBackupDataForDays="30" /> <StoragePolicyCopy copyId="252" copyName="Primary" /> <library libraryName="ReassocTestLib" libraryId="24" /> <mediaAgent mediaAgentId="2" mediaAgentName="saivm" /> </copies> <copies copyType="2" isDefault="0" isSnapCopy="0" isMirrorCopy="0" copyPrecedence="2"> <storagePool storagePoolName="" storagePoolId="0" /> <retentionRules retainBackupDataForCycles="1" retainBackupDataForDays="30" /> <StoragePolicyCopy copyId="261" copyName="Copy-2" /> <library libraryName="ReassocTestLib" libraryId="24" /> <mediaAgent mediaAgentId="2" mediaAgentName="saivm" /> </copies> <incrementalStoragePolicy storagePolicyName="" storagePolicyId="0" /> <storagePolicy storagePolicyName="SRSP2" storagePolicyId="165" /> </policies> <error errorMessage="" errorCode="0" />
</App_GetStoragePoliciesResp>