Base URL:Create Base URL

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Create Base URL

POST /object/baseurl

Creates a Base URL with the given details.

Required Roles

SYSTEM_ADMIN

Request Payload

<object_base_url_create>
   <name></name>
   <base_url></base_url>
   <is_namespace_in_host></is_namespace_in_host>
</object_base_url_create>

{
  "name": "",
  "base_url": "",
  "is_namespace_in_host": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
object_base_url_create
name	Name for this Base-URL	String
base_url	Base URL to be used	String
is_namespace_in_host	Set true if namespace is in host, false otherwise	Boolean	Valid Values: true false

Response Body

Newly created base url details.

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

POST https://192.168.0.0:4443/object/baseurl HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<?xml version="1.0" encoding="UTF-8"?>
<object_base_url_create>
   <name>TestBaseURL</name>
   <base_url>emc.com</base_url>
   <is_namespace_in_host>true</is_namespace_in_host>
</object_base_url_create>

Response

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

<?xml version="1.0" encoding="UTF-8"?>
<base_url>
   <baseurl>emc.com</baseurl>
   <id>urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:</id>
   <inactive>false</inactive>
   <link href="/object/baseurl/urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:"
      rel="self"/>
   <name>TestBaseURL</name>
   <namespace_in_host>true</namespace_in_host>
   <tags/>
</base_url>

Request

POST https://192.168.0.0:4443/object/baseurl.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
	"is_namespace_in_host": "true", 
	"name": "TestBaseURL", 
	"base_url": "emc.com"
}

Response

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

{
	"name":"TestBaseURL",
	"id":"urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:",
	"link":{
			"rel":"self",
			"href":"/object/baseurl/urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:"
			},
			"inactive":false,
			"tags":[],
			"baseurl":"emc.com",
			"namespace_in_host":true
}

Request

cat body.txt

<?xml version="1.0" encoding="UTF-8"?>
<object_base_url_create>
   <name>TestBaseURL</name>
   <base_url>emc.com</base_url>
   <is_namespace_in_host>true</is_namespace_in_host>
</object_base_url_create>

curl -H $token -H "Content-Type: application/xml" -X POST --data @body.txt https://$nodeIp:4443/object/baseurl

Response

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

<?xml version="1.0" encoding="UTF-8"?>
<base_url>
   <baseurl>emc.com</baseurl>
   <id>urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:</id>
   <inactive>false</inactive>
   <link href="/object/baseurl/urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:"
      rel="self"/>
   <name>TestBaseURL</name>
   <namespace_in_host>true</namespace_in_host>
   <tags/>
</base_url>