POST v1/bunits/{bunitId}/consumers/{consumerId}/orainbucket
Add a bucket to a consumption unit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit of the bucket | integer |
Required |
consumerId |
The ID of the consumption unit of the bucket | integer |
Required |
Body Parameters
The bucket to create
ORainBucket| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
Name |
string |
None. |
Magazines |
List of magazines the bucket redides on |
Collection of ORainMagazine |
None. |
ORainId |
Unique ORain ID |
string |
None. |
BurnMode |
ORainBurnMode |
None. |
|
BurnType |
ORainBurnType |
None. |
|
BurnCron |
string |
None. |
|
CleanType |
ORainCleanType |
None. |
|
CleanCron |
string |
None. |
|
RaidType |
ORainRaidType |
None. |
|
DiscType |
ORainDiscType |
None. |
|
MinBurnCapacityGB |
decimal number |
None. |
|
AllowLogicalDiscAdjustment |
boolean |
None. |
|
RetainDiscAfterMigration |
boolean |
None. |
|
DelayedArchivingDays |
integer |
None. |
|
EnableDelayedArchive |
boolean |
None. |
|
VersioningState |
Indicates whether S3 Versioning is Disabled, Enabled or Suspended. Once it is enabled, it cannot be disabled, but suspended - which effectively disables it for new objects, but keeps existing object versions. Thus, following transitions are allowed: Disabled > Enabled > Suspended > Enabled. |
VersioningState |
None. |
ObjectCount |
Number of Objects |
integer |
None. |
ObjectsSizeBytes |
Total Size of Objects |
integer |
None. |
Preset |
ORainBucketPreset |
None. |
|
DeleteProcess |
DeleteProcess |
None. |
|
Users |
Collection of ORainUser |
None. |
|
Server |
ORainServer |
None. |
|
Consumer |
Consumer |
None. |
|
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The created bucket
ORainBucket| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
Name |
string |
None. |
Magazines |
List of magazines the bucket redides on |
Collection of ORainMagazine |
None. |
ORainId |
Unique ORain ID |
string |
None. |
BurnMode |
ORainBurnMode |
None. |
|
BurnType |
ORainBurnType |
None. |
|
BurnCron |
string |
None. |
|
CleanType |
ORainCleanType |
None. |
|
CleanCron |
string |
None. |
|
RaidType |
ORainRaidType |
None. |
|
DiscType |
ORainDiscType |
None. |
|
MinBurnCapacityGB |
decimal number |
None. |
|
AllowLogicalDiscAdjustment |
boolean |
None. |
|
RetainDiscAfterMigration |
boolean |
None. |
|
DelayedArchivingDays |
integer |
None. |
|
EnableDelayedArchive |
boolean |
None. |
|
VersioningState |
Indicates whether S3 Versioning is Disabled, Enabled or Suspended. Once it is enabled, it cannot be disabled, but suspended - which effectively disables it for new objects, but keeps existing object versions. Thus, following transitions are allowed: Disabled > Enabled > Suspended > Enabled. |
VersioningState |
None. |
ObjectCount |
Number of Objects |
integer |
None. |
ObjectsSizeBytes |
Total Size of Objects |
integer |
None. |
Preset |
ORainBucketPreset |
None. |
|
DeleteProcess |
DeleteProcess |
None. |
|
Users |
Collection of ORainUser |
None. |
|
Server |
ORainServer |
None. |
|
Consumer |
Consumer |
None. |
|
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.