Namespace:Get Namespace

Search (SHIFT+S)




New in this release

Get Namespace

GET /object/namespaces/namespace/{id}

Gets the details for the given namespace.

idNamespace 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
<user_mapping>     0-* Elements
<domain> A single-valued attribute indicating the user's IDP domain String Valid Values:
  •  Examples: "emc.com" or "netapp.com"
<attributes>
<attribute>     0-* Elements
<key> Lookup string for this key-value pair String
<value> Lookup result for this key-value pair String 0-* Elements
</attribute>      
</attributes>
<groups>
<group> String 0-* Elements
</groups>
</user_mapping>      
<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:
  •  urn:storageos:resource-type:UUID:
<link> Hyperlink to the details for this resource
<creation_time> Timestamp that shows when this resource was created in ECS DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<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:
  •  true
  •  false
<global> Indicates whether the resource is global. Boolean Valid Values:
  •  true
  •  false
<remote> Indicates whether the resource is remote. Boolean Valid Values:
  •  true
  •  false
<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:
  •  true
  •  false
</namespace>

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>
    <tags/>
    <allowed_vpools_list>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</allowed_vpools_list>
    <namespace_admins>wuser1@sanity.local</namespace_admins>
    <default_data_services_vpool>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</default_data_services_vpool>
</namespace>
Notes: