Dell Technologies ECS REST API

Search (SHIFT+S)




Get Base URL

GET /object/baseurl/{id}

Gets details for the specified Base URL.

idBase URL identifier for the Base URL that needs to be retrieved

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Response Body

Base URL object details for the specified Base URL Id.

Field Description Type Notes
base_url
baseurl Base URL String
namespace_in_host Flag indicating whether namespace is a part of the host Boolean
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
  •  Unix timestamp
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
internal Indicated whether the resource is an internal resource Boolean Valid Values:
  •  true
  •  false

Examples

Request
GET https://192.168.0.0:4443/object/baseurl/urn:storageos:ObjectBaseUrl:89116eb1-bc3d-4b35-96b0-5929edd3b194: 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"?>
<base_url>
   <baseurl>emc.com</baseurl>
   <namespace_in_host>true</namespace_in_host>
   <name>TestBaseURL</name>
   <id>urn:storageos:ObjectBaseUrl:89116eb1-bc3d-4b35-96b0-5929edd3b194:</id>
   <inactive>false</inactive>
   <link href="/object/baseurl/urn:storageos:ObjectBaseUrl:89116eb1-bc3d-4b35-96b0-5929edd3b194:" rel="self/>
   <tags/>
</base_url>