Creates a bucket in which users can create objects. The bucket is created in a storage pool associated with the specified replication group.
Current user will become the bucket owner.
If namespace to this bucket creation does not exist, user's namespace is used
For non SYSTEM_ADMIN user, namespace should be current user's namespace
Field | Description | Type | Notes |
<object_bucket_create> | |||
<blockSize> | Block size in GB. Cannot be less than 1GB or use decimal values. Can be set to -1 to indicate quota value not defined. | Long | |
<notificationSize> | Notification size in GB. Cannot be less than 1GB or use decimal values. Can be set to -1 to indicate quota value not defined. | Long | |
<name> | Bucket name | String | |
<vpool> | Replication group identifier | URI | |
<filesystem_enabled> | flag indicating whether file-system is enabled for this bucket | Boolean | |
<head_type> | HeadType indicates the object head type that is allowed to access the bucket. If the bucket has FS-Enabled, then the FS heads are implicitly allowed to access this bucket | String | |
<namespace> | Namespace associated with the user/tenant that is allowed to access the bucket | String | |
<TagSet> | Tags - list of tags set for the Bucket | ||
<Tag> |
0-* Elements |
||
<Key> | The key of a tag | String | |
<Value> | The value of a tag | String | |
</Tag> | |||
</TagSet> | |||
<is_encryption_enabled> | tag to enable encryption for the bucket | Boolean | |
<default_group_file_read_permission> | Flag indicating the Read permission for default group | Boolean | |
<default_group_file_write_permission> | Flag indicating the file write permission for default group | Boolean | |
<default_group_file_execute_permission> | Flag indicating the file execute permission for default group | Boolean | |
<default_group_dir_read_permission> | Flag indicating the directory read permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects | Boolean | |
<default_group_dir_write_permission> | Flag indicating the directory write permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects | Boolean | |
<default_group_dir_execute_permission> | Flag indicating the directory execute permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects | Boolean | |
<default_group> | Default group for Filesystem-enabled buckets | String | |
<autocommit_period> | Default autocommit period in seconds | Long | |
<retention> | Default retention period in seconds | Long | |
<is_stale_allowed> | tag to allow stale data in bucket | Boolean | |
<is_object_lock_with_ado_allowed> | Boolean | ||
<is_tso_read_only> | Boolean | ||
<search_metadata> | Searchable tags assigned to objects created within the bucket. | ||
<metadata> |
0-* Elements |
||
<type> | The meta key type. | String | |
<name> | The meta key name. | String | |
<datatype> | The meta key data type. | String | |
</metadata> | |||
</search_metadata> | |||
<metadata_tokens> | metadata search: whether to treat metadata value as array of values (true) or single value (false) | Boolean | |
<owner> | Bucket owner | String | |
<min_max_governor> | |||
<enforce_retention> | Boolean | ||
<minimum_fixed_retention> | Long | ||
<maximum_fixed_retention> | Long | ||
<minimum_variable_retention> | Long | ||
<maximum_variable_retention> | Long | ||
</min_max_governor> | |||
<audited_delete_expiration> | Audit delete expiration time in seconds | Long | |
<is_object_lock_enabled> | Boolean | ||
<storage_policy> | String | ||
<blockSizeInCount> | Long | ||
<notificationSizeInCount> | Long | ||
<copy_policy> | |||
<days_after_last_write> | Long | ||
<minimum_size> | Long | ||
<external_endpoint> | URI | ||
<target_bucket> | String | ||
<target_access_key> | String | ||
<target_secret_key> | String | ||
<target_account> | String | ||
<target_role> | String | ||
<tag_filter> | String | ||
<policy_type> | |||
<backup_read_target> | Boolean | ||
<sse_s3_enabled> | Boolean | ||
<detailed_log_enabled> | Boolean | ||
<detailed_log_errors_only> | Boolean | ||
<detailed_log_bucket> | String | ||
<detailed_log_prefix> | String | ||
<external_certs> | String | ||
</copy_policy> | |||
<enableAdvancedMetadataSearch> | Boolean | ||
<advancedMetadataSearchTargetName> | String | ||
<advancedMetadataSearchTargetStream> | String | ||
</object_bucket_create> |
Field | Description | Type | Notes |
<object_bucket> | |||
<error_message> | Message returned by the server indicating the reason for create bucket failure (if any) | String | |
<TagSet> | Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search. | ||
<Tag> |
0-* Elements |
||
<Key> | The key of a tag | String | |
<Value> | The value of a tag | String | |
</Tag> | |||
</TagSet> | |||
<metaData> | |||
<metadata> |
0-* Elements |
||
<type> | The meta key type. | String | |
<name> | The meta key name. | String | |
<datatype> | The meta key data type. | String | |
</metadata> | |||
<isEnabled> | Getter for the enabled flag. | Boolean | |
<mdTokens> | Getter for the mdTokens flag. | Boolean | |
<maxKeys> | Getter for maxKeys. | Integer | |
</metaData> | |||
<advancedMetadataSearchEnabled> | Boolean | ||
<advancedMetadataSearchTargetName> | String | ||
<advancedMetadataSearchTargetStream> | String | ||
<name> | Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier. | String | |
<id> | Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time. | URI |
Valid Values:
|
<link> | Hyperlink to the details for this resource | ||
<creation_time> | Timestamp that shows when this resource was created in ECS | DateTime |
Valid Values:
|
<inactive> | Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. | Boolean |
Valid Values:
|
<global> | Indicates whether the resource is global. | Boolean |
Valid Values:
|
<remote> | Indicates whether the resource is remote. | Boolean |
Valid Values:
|
<vdc> | |||
<id> | ECS Id of the related object | URI | |
<link> | Hyperlink to the related object | ||
</vdc> | |||
<internal> | Indicated whether the resource is an internal resource | Boolean |
Valid Values:
|
</object_bucket> |