Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Empty Status Operations
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Fanout (Cloud DVR)
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Lock Configuration Operations
- S3 Bucket Object Lock Operations
- S3 Bucket Policy
- S3 Bucket Versioning
- S3 Bucket Versions
- S3 Data Node
- S3 Metadata Key List
- S3 Metadata Key System List
- S3 Metadata Search
- S3 Multi Object Delete
- S3 Object
- S3 Object ACL
- S3 Object Detailed Replication Status Operations
- S3 Object Init Uploads
- S3 Object Legal Hold Operations
- S3 Object Replication Info Operations
- S3 Object Retention Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- S3 Select Operations
- EMC Atmos
- OpenStack Swift
ECS API Changes
Modified since last release
Get Namespace
GET /object/namespaces/namespace/{id}
Gets the details for the given namespace.
| id | Namespace identifier for which details needs to be retrieved. |
Required Roles
Requires one of the following roles:
SYSTEM_ADMIN
SYSTEM_MONITOR
NAMESPACE_ADMIN
Response Body
Namespace details
| Field | Description | Type | Notes |
| namespace | |||
| default_data_services_vpool | Default replication group identifier for this tenant when creating buckets | URI | |
| allowed_vpools_list | List of replication group that are allowed access to namespace | URI |
0-* Elements |
| disallowed_vpools_list | List of replication group that are not allowed access to namespace | URI |
0-* Elements |
| namespace_admins | Comma separated list of namespace admins | String | |
| is_encryption_enabled | encryption status of the namesapce | String | |
| user_mapping |
0-* Elements |
||
| domain | A single-valued attribute indicating the user's IDP domain | String |
Valid Values:
|
| attributes | |||
| attribute |
0-* Elements |
||
| key | Lookup string for this key-value pair | String | |
| value | Lookup result for this key-value pair | String |
0-* Elements |
| groups | |||
| group | String |
0-* Elements |
|
| default_bucket_block_size | Default bucket quota size. | Long | |
| external_group_admins | List of groups from AD Server | String | |
| is_stale_allowed | Namespace isStaleAllowed flag | Boolean | |
| is_object_lock_with_ado_allowed | Optional
Defines the default behavior for allowing Object Lock with ADO on new buckets created in the namespace. Existing buckets are not affected by this flag. When true the is_object_lock_with_ado_allowed flag is applied to new buckets allowing them to enable Object Lock with ADO without having to explicitly enable the flag on the bucket. When false or omitted, buckets created in the namespace will not be allowed to enable OBJECT LOCK with writable ADO unless the is_object_lock_with_ado_allowed flag is explicitly enabled on the bucket. The flag only affects new buckets. Existing buckets must set the flag explicitly to allow Object Lock with ADO. Warning: Once the flag is enabled on a bucket it cannot be changed. Make sure you understand the risk of data loss before enabling this flag. See the Admin Guide for more information. |
Boolean |
Valid Values:
|
| is_compliance_enabled | Namespace isComplianceEnabled flag | Boolean | |
| notificationSize | Notification Size in GB. | Long | |
| blockSize | Blocksize in GB | Long | |
| notificationSizeInCount | Notification Size in Count. | Long | |
| blockSizeInCount | Blocksize in Count | Long | |
| retention_classes | |||
| retention_class |
0-* Elements |
||
| name | Name of the retention class | String | |
| period | Period of the retention class in seconds | Long | |
| default_audit_delete_expiration | Default bucket audit delete expiration | Long | |
| root_user_name | String | ||
| root_user_password | 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 | ||
| internal | Indicated whether the resource is an internal resource | Boolean |
Valid Values:
|
Examples
Request
GET https://192.168.0.0:4443/object/namespaces/namespace/s3 HTTP/1.1 Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<namespace>
<id>s3</id>
<inactive>false</inactive>
<link rel="self" href="/object/namespaces/namespace/s3"/>
<name>s3</name>
<default_bucket_block_size>-1</default_bucket_block_size>
<is_compliance_enabled>false</is_compliance_enabled>
<is_encryption_enabled>false</is_encryption_enabled>
<is_stale_allowed>false</is_stale_allowed>
<default_data_services_vpool>urn:storageos:ReplicationGroupInfo:4644a1d1-a299-4f37-b0de-84d637312665:global</default_data_services_vpool>
<blockSize>-1</blockSize>
<notificationSize>-1</notificationSize>
</namespace>