REST API - PUT Storage Policy

This operation updates a storage policy. To create a storage policy using an XML file, see REST API - POST Storage Policy.

Request

Syntax

XML

PUT webservice/V2/StoragePolicy/storagePolicyId HTTP/1.1 Host: host name Accept: application/xml Authtoken: authentication token <XML_updateSP.xml>

JSON

PUT webservice/V2/StoragePolicy/storagePolicyId HTTP/1.1 Host: host name Accept: application/json Authtoken: authentication token <XML_updateSP.json>

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

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
errorCode	The possible error codes. Valid values are: 0, a successful completion. 1, a failure. a specific error code.	error

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, a successful completion.
1, a failure.
a specific error code.

error

Examples

Sample Request

This request updates a storage policy.

XML

PUT webservice/V2/StoragePolicy/10 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
<App_UpdateStoragePolicyReq>
    <numberOfStreams/>
    <description/>
    <auxCopyAlertDays>2</auxCopyAlertDays>
    <auxCopyAlertGB>2</auxCopyAlertGB>
    <forceNextBkpToFull>0</forceNextBkpToFull>
    <newStoragePolicyName>SP2</>
    <StoragePolicy>
        <storagePolicyName/>
    </StoragePolicy>
    <flag>
        <randomizeStream>2</randomizeStream>
        <enableAuxCopyAlert>2</enableAuxCopyAlert>
        <storagePolicyLevelMediaPassword>2</storagePolicyLevelMediaPassword>
        <hideStoragePolicy>2</hideStoragePolicy>
        <cacheResourceReservationForJobs>2</cacheResourceReservationForJobs>
        <distributeDataEvenlyAmongStreams>2</distributeDataEvenlyAmongStreams>
    </flag>
    <sidbBlockSizeKB/>
</App_UpdateStoragePolicyReq>

JSON

PUT webservice/V2/StoragePolicy/10 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
{"auxCopyAlertDays":2,"description":"","newStoragePolicyName":"SP2","numberOfStreams":12,"forceNextBkpToFull":false,"auxCopyAlertGB":2,"flag":{"enableAuxCopyAlert":2,"distributeDataEvenlyAmongStreams":2,"cacheResourceReservationForJobs":2,"storagePolicyLevelMediaPassword":2,"hideStoragePolicy":2,"randomizeStream":2},"StoragePolicy":{"storagePolicyName":""}}

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0"/>

JSON

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0"/>