Skip to main content

GetStorageAssociatedCopies​

Select

SaaS
Customer Managed

Get associated copies and plan which are utilizing this storage.

Path Parameters
  • storagePoolId int32 required

    Id of the storage pool whose associated copies have to be fetched

Responses

Success

Schema
  • copies object[]

    List of copies associated with given storage pool

  • copy object
  • id int32
  • name string
  • plan object
  • id int32
  • name string
  • planType string

    Possible values: [Server, Laptop, FSIBMiVTL, ExchangeJournal, ExchangeUser, Office365, DataClassification, Archiver, CDM, ObjectStore, DLO, Database, Snap, FSServer, VSAServer, Dynamics365, RiskAnalysis, ThreatIndicator]

  • storagePolicy object
  • id int32
  • name string
  • isSnapCopy boolean

    Is this a snap copy?

  • copyType

    Possible values: [SYNCHRONOUS, SELECTIVE, PRIMARY]

  • backupsToCopy string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • retentionPeriodDays int32

    Retention period in days

  • useExtendedRetentionRules boolean

    Tells if extended retention rules are used

  • extendedRetentionRules object

    If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.

  • firstExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • secondExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • thirdExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

GET /v4/storage/:storagepoolid/associatedcopies

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
storagePoolId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Storage/:storagePoolId/associatedCopies' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'