Web Search

Spectra BlackPearl Converged Storage System

About This Guide

Intended Audience

Related Information

Online Forum

Typographical Conventions

Common Request Header Elements

Using this Command Reference

Amazon S3 Operations

Amazon S3 Bucket Operations

Create Bucket (Put Bucket)

Delete Bucket

Get Bucket (List Objects)

Get Buckets (Get Service)

Head Bucket

Amazon S3 Object Operations

Delete Object

Delete Multiple Objects

Get Object

Head Object

Put Object

Amazon S3 Multipart Object Operations

Abort Multipart Upload

Complete Multipart Upload

Initiate Multipart Upload

List Multipart Upload Parts

List Multipart Uploads

Upload Part

Spectra S3 Bucket, Object, and Job Operations

Spectra S3 Bucket Operations

Create Bucket - Spectra S3

Delete Bucket - Spectra S3

Get Bucket - Spectra S3

Get Buckets - Spectra S3

Modify Bucket - Spectra S3

Spectra S3 Object Operations

Delete Folder Recursively

Get Object - Spectra S3

Get Objects - Spectra S3

Get Physical Placement

Verify Physical Placement

Job Operations

Spectra S3 Bulk Operations Overview

Close Aggregating Job Request

Get Job Chunk Information

Get Job Chunks Ready for Processing

Verify That It Is Safe to Create a PUT Job

Access Control Operations

Access Control List Operations

Create Bucket ACL for a Group

Create Bucket ACL for a User

Create Data Policy ACL for a Group

Create Data Policy ACL for a User

Create Global Bucket ACL for a Group

Create Global Bucket ACL for a User

Create Global Data Policy ACL for a Group

Create Global Data Policy ACL for a User

Delete Bucket ACL

Delete Data Policy ACL

Add Group as Group Member

Add User as Group Member

Verify Group Membership

Regenerate Secret Key

Advanced Bucket Management Operations

Data Policy Operations

Create Data Persistence Rule

Create Data Policy

Create Amazon S3 Data Replication Rule

Create Azure Data Replication Rule

Create DS3 Data Replication Rule

Delete Data Persistence Rule

Delete Data Policy

Delete Amazon S3 Data Replication Rule

Delete Azure Data Replication Rule

Delete DS3 Data Replication Rule

Get Data Persistence Rule

Get Data Persistence Rules

Get Data Policies

Get Data Policy

Get Amazon S3 Data Replication Rule

Get Amazon S3 Data Replication Rules

Get Azure Data Replication Rule

Get Azure Data Replication Rules

Get DS3 Data Replication Rule

Get DS3 Data Replication Rules

Modify Data Persistence Rule

Modify Data Policy

Modify Amazon S3 Data Replication Rule

Modify Azure Data Replication Rule

Modify DS3 Data Replication Rule

Replication Target Operations

Force Target Environment Refresh

Create Amazon S3 Target Bucket Name

Create Amazon S3 Target Read Preference

Delete Amazon S3 Target

Delete Amazon S3 Target Bucket Name

Delete Amazon S3 Target Failure

Delete Amazon S3 Target Read Preference

Get Amazon S3 Target

Get Amazon S3 Target Bucket Names

Get Amazon S3 Target Failures

Get Amazon S3 Target Read Preference

Get Amazon S3 Target Read Preferences

Get Amazon S3 Targets

Get Blobs on Amazon S3 Target

Import Amazon S3 Target

Modify All Amazon S3 Targets

Modify Amazon S3 Target

Verify Amazon S3 Target

Create Azure Target Bucket Name

Create Azure Target Read Preference

Delete Azure Target

Delete Azure Target Bucket Name

Delete Azure Target Failure

Delete Azure Target Read Preference

Get Azure Target

Get Azure Target Bucket Names

Get Azure Target Failures

Get Azure Target Read Preference

Get Azure Target Read Preferences

Get Azure Targets

Get Blobs on Azure Target

Import Azure Target

Modify All Azure Targets

Modify Azure Target

Verify Azure Target

Create DS3 Target Read Preference

Delete DS3 Target

Delete DS3 Target Failure

Delete DS3 Target Read Preference

Get DS3 Target

Get DS3 Target Data Policies

Get DS3 Target Failures

Get DS3 Target Read Preference

Get DS3 Target Read Preferences

Get DS3 Targets

Get Blobs on DS3 Target

Modify All DS3 Targets

Modify DS3 Target

Pair Back Registered DS3 Target

Verify DS3 Target

Storage Domain Operations

Convert a Storage Domain to a BlackPearl Target

Create Pool Storage Domain Member

Create Storage Domain

Create Tape Storage Domain Member

Delete Storage Domain

Delete Storage Domain Failure

Delete Storage Domain Member

Get Storage Domain

Get Storage Domain Failures

Get Storage Domain Member

Get Storage Domain Members

Get Storage Domains

Modify Storage Domain

Modify Storage Domain Member

Cancel Import of Pool

Cancel Import of Pools

Cancel Verify Pool

Cancel Verify On All Pools

Compact Pool

Compact Pools

Create Pool Partition

Deallocate Pool

Delete Permanently Lost Pool

Delete Pool Failure

Delete Pool Partition

Force Pool Environment Refresh

Format Foreign Pool

Format Foreign Pools

Get Object Parts on Pool

Modify Pool Partition

Modify Pools

Verify Pool

Verify Pools

Tape Library and Component Operations

Cancel Eject of Tape

Cancel Eject of Tapes

Cancel Format of Tape

Cancel Format of Tapes

Cancel Import of Foreign Tape

Cancel Import of Foreign Tapes

Cancel Online of Tape

Cancel Online of Tapes

Cancel Verify of Tape

Cancel Verify of Tapes

Clean Tape Drive

Create Tape Density Directive

Delete Permanently Lost Tape

Delete Tape Density Directive

Delete Tape Drive

Delete Tape Failure

Delete Tape Partition

Delete Tape Partition Failure

Eject Tape

Eject Tapes

Eject Storage Domain

Eject Storage Domain Blobs

Force Tape Environment Refresh

Format Tape

Format Tapes

Get Physical Placement for Object Parts on Tape

Get Tape

Get Tape Density Directive

Get Tape Density Directives

Get Tape Partition Failures

Get Tape Partitions

Get Tapes

Import All BlackPearl Foreign Tapes

Import All LTFS Foreign Tapes

Import BlackPearl Foreign Tape

Import LTFS Foreign Tape

Modify Tape Partition

Modify Tape Partitions

Notification Operations

Create Amazon S3 Target Failure Notification Registration

Create Azure Target Failure Notification Registration

Create DS3 Target Failure Notification Registration

Create Job Completed Notification Registration

Create Job Created Notification Registration

Create Job Creation Failed Notification Registration

Create Object Cached Notification Registration

Create Object Lost Notification Registration

Create Object Persisted Notification Registration

Create Pool Failure Notification Registration

Create Storage Domain Failure Notification Registration

Create System Failure Notification Registration

Create Tape Failure Notification Registration

Create Tape Partition Failure Notification Registration

Delete Amazon S3 Target Failure Notification Registration

Delete Azure Target Failure Notification Registration

Delete DS3 Target Failure Notification Registration

Delete Job Completed Notification Registration

Delete Job Created Notification Registration

Delete Job Creation Failed Notification Registration

Delete Object Cached Notification Registration

Delete Object Lost Notification Registration

Delete Object Persisted Notification Registration

Delete Pool Failure Notification Registration

Delete Storage Domain Failure Notification Registration

Delete System Failure Notification Registration

Delete Tape Failure Notification Registration

Delete Tape Partition Failure Notification Registration

Get Amazon S3 Target Failure Notification Registration

Get Amazon S3 Target Failure Notification Registrations

Get Azure Target Failure Notification Registration

Get Azure Target Failure Notification Registrations

Get DS3 Target Failure Notification Registration

Get DS3 Target Failure Notification Registrations

Get Job Completed Notification Registration

Get Job Completed Notification Registrations

Get Job Created Notification Registration

Get Job Created Notification Registrations

Get Job Creation Failed Notification Registration

Get Job Creation Failed Notification Registrations

Get Object Cached Notification Registration

Get Object Cached Notification Registrations

Get Object Lost Notification Registration

Get Object Lost Notification Registrations

Get Object Persisted Notification Registration

Get Object Persisted Notification Registrations

Get Pool Failure Notification Registration

Get Pool Failure Notification Registrations

Get Storage Domain Failure Notification Registration

Get Storage Domain Failure Notification Registrations

Get System Failure Notification Registration

Get System Failure Notification Registrations

Get Tape Failure Notification Registration

Get Tape Failure Notification Registrations

Get Tape Partition Failure Notification Registration

Get Tape Partition Failure Notification Registrations

Miscellaneous Operations

Cache Operations

Force Full Cache Reclaim

Get Cache Filesystem

Get Cache Filesystems

Get Cache State

Modify Cache Filesystem

Capacity Operations

Get Bucket Capacity Summary

Get Storage Domain Capacity Summary

Get System Capacity Summary

Data Planner Operations

Get Data Path Backend

Get Data Planner Blob Store Tasks

Modify Data Path Backend

Degradation Operations

Clear Suspect Object Part in Storage Pool

Clear Suspect Object Part on Tape

Clear Suspect Object Part on an Amazon S3 Target

Clear Suspect Object Part on an Azure Target

Clear Suspect Object Part on a DS3 Target

Get Degraded Object Parts

Get Degraded Buckets

Get Degraded Data Persistence Rules

Get Degraded Amazon S3 Replication Rules

Get Degraded Azure Replication Rules

Get Degraded DS3 Replication Rules

Get Suspect Object Parts in Storage Pools

Get Suspect Object Parts on Tape Media

Get Suspect Object Parts on Amazon S3 Targets

Get Suspect Object Parts on Azure Targets

Get Suspect Object Parts on DS3 Targets

Get Suspect Buckets

Get Suspect Objects

Get Suspect Objects with Full Details

Mark Suspect Object Part in a Storage Pool as Degraded

Mark Suspect Object Part on Tape as Degraded

Mark Suspect Object Part on an Amazon S3 Target as Degraded

Mark Suspect Object Part on an Azure Target as Degraded

Mark Suspect Object Part on a DS3 Target as Degraded

System Operations

Force Feature Key Validation

Get Feature Keys

Get Formal API Contract

Get General System Information

Get Request Handlers

Get System Failures

Reset Instance Identifier

Verify System Health