• Bucket

Create Bucket

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

Required Roles

Requires one of the following roles:

• SYSTEM_ADMIN

• NAMESPACE_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

• A qualifying storage pool must exist corresponding to the replication group for bucket

• Only authenticated users can create buckets

• Bucket name should be less than 255 characters

• Bucket name should contain only alphanumeric, '.','-' and '_'.

Request Payload

<object_bucket_create>
   <blockSize></blockSize>
   <notificationSize></notificationSize>
   <name></name>
   <vpool></vpool>
   <filesystem_enabled></filesystem_enabled>
   <head_type></head_type>
   <namespace></namespace>
   <TagSet>
      <Tag>
         <Key></Key>
         <Value></Value>
      </Tag>
   </TagSet>
   <is_encryption_enabled></is_encryption_enabled>
   <default_group_file_read_permission></default_group_file_read_permission>
   <default_group_file_write_permission></default_group_file_write_permission>
   <default_group_file_execute_permission></default_group_file_execute_permission>
   <default_group_dir_read_permission></default_group_dir_read_permission>
   <default_group_dir_write_permission></default_group_dir_write_permission>
   <default_group_dir_execute_permission></default_group_dir_execute_permission>
   <default_group></default_group>
   <autocommit_period></autocommit_period>
   <retention></retention>
   <is_stale_allowed></is_stale_allowed>
   <is_object_lock_with_ado_allowed></is_object_lock_with_ado_allowed>
   <is_tso_read_only></is_tso_read_only>
   <search_metadata>
      <metadata>
         <type></type>
         <name></name>
         <datatype></datatype>
      </metadata>
   </search_metadata>
   <metadata_tokens></metadata_tokens>
   <owner></owner>
   <min_max_governor>
      <enforce_retention></enforce_retention>
      <minimum_fixed_retention></minimum_fixed_retention>
      <maximum_fixed_retention></maximum_fixed_retention>
      <minimum_variable_retention></minimum_variable_retention>
      <maximum_variable_retention></maximum_variable_retention>
   </min_max_governor>
   <audited_delete_expiration></audited_delete_expiration>
   <is_object_lock_enabled></is_object_lock_enabled>
   <storage_policy></storage_policy>
   <blockSizeInCount></blockSizeInCount>
   <notificationSizeInCount></notificationSizeInCount>
   <copy_policy>
      <days_after_last_write></days_after_last_write>
      <minimum_size></minimum_size>
      <external_endpoint></external_endpoint>
      <target_bucket></target_bucket>
      <target_access_key></target_access_key>
      <target_secret_key></target_secret_key>
      <target_account></target_account>
      <target_role></target_role>
      <tag_filter></tag_filter>
      <policy_type></policy_type>
      <backup_read_target></backup_read_target>
      <sse_s3_enabled></sse_s3_enabled>
      <detailed_log_enabled></detailed_log_enabled>
      <detailed_log_errors_only></detailed_log_errors_only>
      <detailed_log_bucket></detailed_log_bucket>
      <detailed_log_prefix></detailed_log_prefix>
      <external_certs></external_certs>
   </copy_policy>
   <enableAdvancedMetadataSearch></enableAdvancedMetadataSearch>
   <advancedMetadataSearchTargetName></advancedMetadataSearchTargetName>
   <advancedMetadataSearchTargetStream></advancedMetadataSearchTargetStream>
</object_bucket_create>

{
  "blockSize": "",
  "notificationSize": "",
  "name": "",
  "vpool": "",
  "filesystem_enabled": "",
  "head_type": "",
  "namespace": "",
  "TagSet": [
    {
      "Key": "",
      "Value": ""
    }
  ],
  "is_encryption_enabled": "",
  "default_group_file_read_permission": "",
  "default_group_file_write_permission": "",
  "default_group_file_execute_permission": "",
  "default_group_dir_read_permission": "",
  "default_group_dir_write_permission": "",
  "default_group_dir_execute_permission": "",
  "default_group": "",
  "autocommit_period": "",
  "retention": "",
  "is_stale_allowed": "",
  "is_object_lock_with_ado_allowed": "",
  "is_tso_read_only": "",
  "search_metadata": [
    {
      "type": "",
      "name": "",
      "datatype": ""
    }
  ],
  "metadata_tokens": "",
  "owner": "",
  "min_max_governor": {
    "enforce_retention": "",
    "minimum_fixed_retention": "",
    "maximum_fixed_retention": "",
    "minimum_variable_retention": "",
    "maximum_variable_retention": ""
  },
  "audited_delete_expiration": "",
  "is_object_lock_enabled": "",
  "storage_policy": "",
  "blockSizeInCount": "",
  "notificationSizeInCount": "",
  "copy_policy": {
    "days_after_last_write": "",
    "minimum_size": "",
    "external_endpoint": "",
    "target_bucket": "",
    "target_access_key": "",
    "target_secret_key": "",
    "target_account": "",
    "target_role": "",
    "tag_filter": "",
    "policy_type": "",
    "backup_read_target": "",
    "sse_s3_enabled": "",
    "detailed_log_enabled": "",
    "detailed_log_errors_only": "",
    "detailed_log_bucket": "",
    "detailed_log_prefix": "",
    "external_certs": ""
  },
  "enableAdvancedMetadataSearch": "",
  "advancedMetadataSearchTargetName": "",
  "advancedMetadataSearchTargetStream": ""
}

Response Body

Indicating success or failure of the bucket create operation

Examples

POST https://192.168.0.0:4443/object/bucket

HTTP/1.1
Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
<object_bucket_create>
   <name>bucket3</name>
   <vpool></vpool>
   <filesystem_enabled>false</filesystem_enabled>
   <head_type>s3</head_type>
   <namespace>s3</namespace>
   <is_stale_allowed>false</is_stale_allowed>
   <retention>3</retention>
   <compliance_enabled>false</compliance_enabled>
   <search_metadata>
      <metadata>
         <name>x-amz-meta-custom-type</name>
         <datatype>integer</datatype>
      </metadata>
   </search_metadata>
</object_bucket_create>

HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_bucket>
    <id>s3.bucket3</id>
    <inactive>false</inactive>
    <name>bucket3</name>
    <tags/>
    <search_metadata>
        <type>User</type>
        <metadata>
           <name>x-amz-meta-custom</name>
           <datatype>integer</datatype>
        </metadata>
    </search_metadata>
</object_bucket>

POST https://192.168.0.0:4443/object/bucket.json

HTTP/1.1
Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
{
    "name": "bucket5",
    "filesystem_enabled": "false",
    "head_type": "s3",
    "namespace": "s3",
    "is_stale_allowed": "false",
    "retention": "3"
    "compliance_enabled": "false",
    "search_metadata":{
       "metadata":[
          {
             "datatype":"integer",
             "name":"x-amz-meta-custom"
          }
       ]
    }
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "name": "bucket5",
    "id": "s3.bucket5",
    "inactive": false,
    "global": null,
    "remote": null,
    "vdc": null,
    "tags": [],
    "search_metadata":{
      "metadata":[
         {
            "type": "User",
            "datatype":"integer",
            "name":"x-amz-meta-custom"
         }
      ]
    }
}

curl -H $token -H "Content-Type: application/xml" -X POST https://$nodeIp:4443/object/bucket

HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_bucket>
    <id>s3.bucket3</id>
    <inactive>false</inactive>
    <name>bucket3</name>
    <tags/>
    <search_metadata>
        <type>User</type>
        <metadata>
           <name>x-amz-meta-custom</name>
           <datatype>integer</datatype>
        </metadata>
    </search_metadata>
</object_bucket>