VMware vFabric Data Director 2.0 User guide

Brand: VMware

Model: vFabric Data Director 2.0

Category: Development software

Type: User guide

VMware vFabric vFabric Data Director 2.0 is a powerful tool that enables organizations to manage and protect their data assets, ensuring high availability and security. With its advanced features, it offers a comprehensive solution for data management, providing organizations with the ability to:

Manage data resources: Efficiently allocate and manage data resources, including storage pools, compute resources, and network connectivity, to optimize performance and utilization.
Protect data: Implement robust data protection strategies, including backup, replication, and recovery, to safeguard data from loss or corruption due to hardware failures, software errors, or human mistakes.

Manage data resources: Efficiently allocate and manage data resources, including storage pools, compute resources, and network connectivity, to optimize performance and utilization.
Protect data: Implement robust data protection strategies, including backup, replication, and recovery, to safeguard data from loss or corruption due to hardware failures, software errors, or human mistakes.

VMware vFabric Data Director API

Programming Guide

vFabric Data Director 2.0

This document supports the version of each product listed and

supports all subsequent versions until the document is replaced

by a new edition. To check for more recent editions of this

document, see http://www.vmware.com/support/pubs.

EN-000873-00

VMware vFabric Data Director API Programming Guide

2 VMware, Inc.

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

[email protected]

property laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks

and names mentioned herein may be trademarks of their respective companies.

VMware, Inc.

3401 Hillview Ave.

Palo Alto, CA 94304

www.vmware.com

Contents

vFabric Data Director API Programming Guide 5

About the Data Director API 7

REST API Versioning 7

Client Workflow Overview 7

Understanding Resources and DB Groups 9

Understanding Call Dependencies 10

Working with Enumeration Types 11

Making a Call 13

Data Director REST Requests 13

API REST Response Codes 15

Hello vFabric Data Director: a Simplified RESTful Workflow 17

Creating a System Resource Bundle 17

Converting a Base DBVM to a Base DB Template 18

Creating a Resource Bundle 19

Creating an Organization 20

Assigning a Resource Bundle to an Organization 20

Enabling a Base DB Template 21

Creating a DB Group 21

Creating a Database 22

Managing a Database 25

Ingesting a Database 29

Refreshing a Database or Catalog 31

Cloning a Database 33

Safeguarding Data 35

Backing Up Data 35

Restoring Data 35

Index 37

VMware, Inc. 3

VMware vFabric Data Director API Programming Guide

4 VMware, Inc.

vFabric Data Director API

Programming Guide 1

The vFabric Data Director API Programming Guide provides information about version 2.0 of the Data Director

API.

VMware provides many different APIs and SDKs for applications and goals. This guide provides information

about the vFabric Data Director API for developers who are interested in creating RESTful clients for

Data Director.

Revision History

The VMware vFabric Data Director API Programming Guide is revised with each release of the product or when

necessary. A revised version can contain minor or major changes.

Table 1-1. Revision History

Revision Date Description

20Mar2012 API Version 1.1

10Jul2012 API Version 2.0

Intended Audience

This guide is intended for software developers who are building Data Director applications, including

interactive clients of Data Director. This guide discusses common database terminology, VMware's vFabric

Data Director product, VMware's Virtual Machine technology, and web technologies such as XML, HTTP, and

REST.

Related Publications

The Data Director Administration Guide contains information about many of the objects and operations referred

to in this guide. Most users of the Data Director REST API will find the information in those documents valuable

when developing client applications. To access the current versions of these and other VMware books, go to

http://www.vmware.com/support/pubs.

VMware, Inc.

VMware vFabric Data Director API Programming Guide

6 VMware, Inc.

About the Data Director API 2

The Data Director API provides support for developers who are building interactive clients of

vFabric Data Director using a RESTful application development style.

The Data Director API calls communicate over HTTP, exchanging representations of Data Director objects.

These representations are encoded as XML elements or JSON objects. depending on the format of your request.

You use HTTP GET requests to retrieve the current representation of an object, HTTP POST and PUT requests

to create or update an object, and HTTP DELETE requests to delete an object.

This chapter includes the following topics:

“REST API Versioning,” on page 7

“Client Workflow Overview,” on page 7

“Understanding Resources and DB Groups,” on page 9

“Understanding Call Dependencies,” on page 10

“Working with Enumeration Types,” on page 11

REST API Versioning

The vFabric Data Director REST API supports versioning through HTTP Accept/Content-Type headers.

As an example, if you want to use the version 2.0 APIs, append the vFabric Data Director version prefix to the

standard media type in the request Accept header.

Accept: application/vnd.vmware.vfdd-v2.0+json

The response will include a versioned Content-Type response header.

Content-Type: application/vnd.vmware.vfdd-v2.0+json

If you don't include a version prefix in the Accept header, then the latest version content is returned.

Client Workflow Overview

vFabric Data Director API clients implement a RESTful workflow, making HTTP requests to the server and

retrieving the information they need from the server’s responses.

About RESTful Workflows

REST, an acronym for Representational State Transfer, describes an architectural style characteristic of

programs that rely on the inherent properties of hypermedia to create and modify the state of an object whose

serialized representation is accessible as a URL.

VMware, Inc.

If a URL of such an object is known to a client, the client can use an HTTP GET request to retrieve the

representation of the object. In the Data Director API, this representation is an XML document or a JSON object.

In a RESTful workflow, representations of object state are passed back and forth between a client and a service

with the explicit assumption that neither party need know anything about an object other than what is

presented in a single request or response. The URLs at which these documents are available often persist

beyond the lifetime of the request or response that includes them.

Data Director REST API Workflows

Application programs written to a REST API use HTTP requests that are often executed by a script or other

higher-level language to make remote procedure calls that create, retrieve, update, or delete objects that the

API defines. In the Data Director REST API, these objects are defined by a collection of XML schemas. The

operations themselves are HTTP requests, and so are generic to all HTTP clients.

To write a RESTful client, you must understand only the HTTP protocol, the semantics of either XML or JSON,

and an HTTP client, such as Wget. To use the Data Director API effectively with your client code, become

familiar with the following:

The set of objects that the API supports and what they represent. For example, what is a database group

and how does it relate to an organization?

How the API represents these objects. For example, what does the request or response body for an Org

look like? What do the individual elements and attributes represent?

How the client refers to an object on which it wants to operate. For example, where are the links to objects

in a database group? How does a client obtain and use them?

You can find this information in the Data Director API XML schemas. The XML elements, attributes, and

composition rules are defined in the XML schemas and represent the data structures of Data Director objects.

You can find this same information for both XML and JSON formats, as they are associated with the API calls,

by opening the VMware vFabric Data Director Call Reference (rest-api2.0.html) file and clicking on the respective

XML and JSON links.

Your client code can read an object by making an HTTP GET request to the object’s URL. Your client code can

create or modify an object with an HTTP POST or PUT request that includes a new or changed XML or JSON

body for the object. Your client code can delete an object with an HTTP DELETE request.

RESTful Workflow Patterns

All RESTful workflows follow a common pattern.

1 Make an HTTP request, typically GET, PUT, POST, or DELETE. The target of this request is the path to

the Data Director API, or a URL obtained from the response to a previous request. For example, a GET

request to an organization URL returns Data Director objects that the organization contains.

2 Examine the response, which always includes an HTTP response code and usually includes a body. In the

Data Director API, a response body is an XML or JSON representation of an object, including elements

and attributes that represent object properties, links that implement operations on the object or provide

references to contained or containing objects and, if the object is being created or modified, an embedded

task object that tracks the progress of the creation or modification. The response also includes an HTTP

response code, which indicates whether the request succeeded or failed, and might be accompanied by a

URL that points to a location from which you can retrieve additional information.

These operations can repeat, in this order, for as long as necessary.

VMware vFabric Data Director API Programming Guide

8 VMware, Inc.

Understanding Resources and DB Groups

The Data Director API allows you to perform resource management and access control functions. This section

gives you an overview of the available resources and their management operations.

The Data Director API allows you to extend the functionality of the Data Director Client by performing Create,

Read, Update, and Delete operations against Data Director organizations, users, roles, database groups,

databases, and resource bundles.

In this release of the API, a resource bundle includes one resource pool (cpu/memory), one database storage

pool, and one backup storage pool. The following figure represents a default resource pool.

A resource bundle is assigned to or revoked from an organization. The following figure shows the relationship

between organizations and resource bundles.

A database group under an organization needs resources to create or backup databases. When creating or

backing up a database, the consumed resources come from the parent database group.

The following figure shows the relationship between an organization, a resource bundle, and a database group.

The available resources for a database group are in the resource bundle of the parent organization.

Chapter 2 About the Data Director API

VMware, Inc. 9

Understanding Call Dependencies

Because the Data Director API allows you to manipulate objects and access control, some calls have prerequisite

actions. For example, you cannot register a user for an organization before you have created the user.

The following outline gives you an idea of how the calls are related to or dependent on each other.

1 Read qualified resource pools

a Read datastores of a selected resource pool

b Read networks of a selected resource pool

1 Create a resource bundle

2 Create an organization

a Assign the resource bundle to the organization

3 Read available network configurations of the resource bundle

a Create a database group

b Read available resource templates of the organization

c Read available base DB templates of the resource bundle assigned to this database group

d Read available backup templates of the organization

1 Create a database

a Delete a database

2 Delete a database group

4 Revoke the resource bundle from the organization

5 Delete the organization

6 Delete the resource bundle

2 Create a user

a Register/approve/reject a user for an organization

b Create a role for an organization

1 Grant updated permissions to a user in an organization/dbgroup/database

2 Grant updated permissions to a role in an organization/dbgroup/database

3 Grant a role to a user

a Revoke a role from a user

b Revoke permissions from a role

4 Delete a role

5 Unregister a user from an organization

c Disable a user

1 Delete a user

VMware vFabric Data Director API Programming Guide

10 VMware, Inc.

Working with Enumeration Types

The vFabric Data Director REST API includes some String parameters that are enumeration types. This section

lists most of the enumeration types and the allowed values for each.

Please refer to the VMware vFabric Data Director Call Reference (rest-api2.0.html)for more detailed information

when making REST API calls.

Table 2-1. Enumeration Types

Enumeration Type Values Used In

entityType SYSTEM, ORGANIZATION,

DB_GROUP, DB_SERVER,

RESOURCE_TEMPLATE

BACKUP_TEMPLATE,

RESOURCE_BUNDLE

api/privilege/entityType

status PENDING, RUNNING, REVERTING,

SUCCESS, FAILED, CANCELLED,

ERROR_WAIT

TaskRead

shareLevel/

cpuShareLevel/memShareLevel

HIGH, NORMAL, LOW, CUSTOM DbgroupRead, ResourcePoolRead

priority Automatic, Low, Normal, High DatabaseCreate/resourceSetting/re

sourceConfig

DatabaseUpdate/resourceSetting/r

esourceConfig,

ResourceTemplateRead/resourceC

onfig

type Integer, Boolean, String, Real, Enum All

action-

AfterStorage-

Exhausted

Suspend, DeleteOldest DatabaseCreate/backupSetting/bac

kupConfig,

DatabaseUpdate/backupSetting/ba

ckupConfig,

BackupTemplateRead/backupCon

fig

allocType DHCP, IP_POOL ResourceBundle-

Create/networkSetting/ipAllocTyp

ResourceBundleUpdate/networkS

etting/ipAllocTypes

extended-RetentionFrequency OneDay, OneWeek, OneMonth,

ThreeMonths, OneYear

DatabaseCreate/backupSetting/bac

kupConfig,

DatabaseUpdate/backupSetting/ba

ckupConfig,

BackupTemplateRead/backupCon

fig

extended-

RetentionPeriod

OneWeek, TwoWeeks, OneMonth,

SixMonths, OneYear, Forever

DatabaseCreate/backupSetting/bac

kupConfig,

DatabaseUpdate/backupSetting/ba

ckupConfig,

BackupTemplateRead/backupCon

fig

Chapter 2 About the Data Director API

VMware, Inc. 11

Table 2-1. Enumeration Types (Continued)

Enumeration Type Values Used In

snapShotFrequency Never, FourHours, EightHours,

TwelveHours, TwentyHours

DatabaseCreate/backupSetting/bac

kupConfig

DatabaseUpdate/backupSetting/ba

ckupConfig

BackupTemplateRead/backupCon

fig

snapShot-

RetentionType

Hour, Copy DatabaseCreate/backupSetting/bac

kupConfig

DatabaseUpdate/backupSetting/ba

ckupConfig

BackupTemplateRead/backupCon

fig

snapShot-

RetentionPeriod

FourHours, EightHours,

TwelveHours, TwentyFourHours,

FortyEightHours

DatabaseCreate/backupSetting/bac

kupConfig

DatabaseUpdate/backupSetting/ba

ckupConfig

BackupTemplateRead/backupCon

fig

externalFrequency Never, TwelveHours, OneDay,

OneWeek, OneMonth

DatabaseCreate/backupSetting/bac

kupConfig

DatabaseUpdate/backupSetting/ba

ckupConfig

BackupTemplateRead/backupCon

fig

externalStartTimeEx Sunday, Monday, Tuesday,

Wednesday, Thursday, Friday,

Saturday, Beginning, Middle, End

DatabaseCreate/backupSetting/bac

kupConfig

DatabaseUpdate/backupSetting/ba

ckupConfig

BackupTemplateRead/backupCon

fig

external-

Retention

OneDay, OneWeek, TwoWeeks,

OneMonth, SixMonths, OneYear

DatabaseCreate/backupSetting/bac

kupConfig

DatabaseUpdate/backupSetting/ba

ckupConfig,

BackupTemplateRead/backupCon

fig

VMware vFabric Data Director API Programming Guide

12 VMware, Inc.

Making a Call 3

This section discusses the Data Director REST API requests and responses and gives you some examples.

This chapter includes the following topics:

“Data Director REST Requests,” on page 13

“API REST Response Codes,” on page 15

Data Director REST Requests

To retrieve object data, you can make HTTP requests to the Data Director API. The server returns the requested

data as XML or JSON values in response to POST, GET, PUT, or DELETE requests and the format you specify

in the HTTP header.

Creating a Request

As with most REST APIs, you perform the following steps to implement each call.

1. Create a string for the HTTP request that consists of the following format [HTTP verb][url] + [headers] +

(optional for some calls) or [Request Body].

2. Authentication. REST APIs accept HTTP Basic authentication on each request, encoded with an existing Data

Director username/password credential.

3. Use your programming language to encode the XML or JSON request body, if needed.

4. Use your language's network library (or higher level HTTP library) to send the request to your Data Director

http server.

5. Read the response using your programming language.

6. Use your programming language to parse the XML or JSON data within the response.

7. Use the data in your applications.

HTTP/REST Verbs

Each of the HTTP/REST verbs maps to one of the well-known database operations: Create, Retrieve, Update,

and Delete (CRUD); or the SQL statements: INSERT, SELECT, UPDATE, and DELETE.

Table 3-1. CRUD Operations Summary

HTTP/REST Operation SQL Statement Operation Summary

POST Create INSERT Creates a new object.

GET Retrieve SELECT Retrieves the representation of an

existing object.

VMware, Inc. 13

Table 3-1. CRUD Operations Summary (Continued)

HTTP/REST Operation SQL Statement Operation Summary

PUT Update UPDATE Modifies an existing object.

DELETE Delete DELETE Deletes an existing object.

Hostname

The hostname is the network name of the computer running Data Director.

Path

The path is the path to the Data Director API package on your computer or network.

Headers

The Data Director API supports standard HTTP Accept headers as follows:

Content-type: The value of the context-type header is application/xml or application/json, depending on which

request format you use. The content-type header must be used with PUT/POST requests that include a request

body.

Accepts: The value of the Accepts header is application/xml or application/json, depending on which return

format you require. The Accepts header must be used with GET requests that expect a response body in return.

Authorization: HTTP basic authentication (RFC 2617).

Location: Requests that create an object (including all asynchronous requests, which create a task object), return

the created object's URL via this header.

Request Body

The request body includes the parameters of your API call. The parameter options for each call in the vFabric

Data Director API are listed in the VMware vFabric Data Director Call Reference (rest-api2.0.html).

You can retrieve live examples of data object representations in your choice of encoding from a live Data

Director API server by browsing the namespace under http://.../datadirector/api/dataformat.

An example of the XML and JSON elements for the request body of the RoleCreate call is shown below.

XML:

<name>sample</name>

<description>sample</description>

</RoleCreate>

JSON:

{

"name" : "sample",

"description" : "sample",

"orgId" : 1,

"active" : true

}

See Chapter 4 of this guide for more examples of call requests.

VMware vFabric Data Director API Programming Guide

14 VMware, Inc.

Requesting a List

Use the GET verb with any of the ‘Enumerate’ calls (collection URLs). This will return a list of URLs that contain

the names of the objects in a collection. Use the GET verb again with each of the URLs to retrieve the data for

a specific object. All collection URLs support encoding as application/xml, application/json, or text/plain media

types.

API REST Response Codes

All responses include an HTTP status code and, unless the status code is 204 (No Content), a Content-Type

header. Response content depends on the request. Some responses include a document body, some include

only a URL, and some are empty.

The code sections that follow are examples of Data Director API responses.

Sample response for OrgCreate:

Status: 201

Server: Apache-Coyote/1.1

Location: https://example.aurora.com \

/datadirector/api/org/187

Content-Length: 0

Date: Wed, 07 Mar 2012 03:40:07 GMT

Sample response for OrgRead

Status: 200

Server: Apache-Coyote/1.1

Cache-Control: private

Expires: Thu, 01 Jan 1970 00:00:00 UT

Content-Type: application/json

Transfer-Encoding: chunked

Date: Wed, 07 Mar 2012 03:40:07 GMT

{'status':'NORMAL','description':

'Org created by test harness','id':

243,'name':'Test org'}

Sample response for OrgUpdate:

Status: 204

Server: Apache-Coyote/1.1

Cache-Control: private

Expires: Thu, 01 Jan 1970 00:00:00 UTC

Date: Wed, 07 Mar 2012 03:40:07 GMT

Sample response for OrgDelete:

Status: 202

Server: Apache-Coyote/1.1

Cache-Control: private

Expires: Thu, 01 Jan 1970 00:00:00 UTC

Location: https://example.aurora.com \

/datadirector/api/task/43

Content-Length: 0

Date: Wed, 07 Mar 2012 03:40:07 GMT

Chapter 3 Making a Call

VMware, Inc. 15

Synchronous vs. Asynchronous Responses

When you receive a "202 Accepted" status and a URL, this is an asynchronous response and you must poll to

find out the results of the call. Use GET followed by the URL to retrieve the results of an asynchronous response.

Status Codes

The Data Director API returns a subset of HTTP status codes in the response.

Table 3-2. HTTP Status Codes that the Data Director API Returns

Status Code Status Description

200 OK The request is valid and was completed. The response

includes a document body.

201 Created The request is valid. The requested object was created and

can be found at the URL specified in the Location header.

202 Accepted The request is valid and a task was created to handle it. This

response is usually accompanied by a Location header with

a Task URI.

204 No Content The request is valid and was completed. The response does

not include a body.

400 Bad Request The request body is malformed, incomplete, or otherwise

invalid.

401 Unauthorized An authorization header was expected but not found.

403 Forbidden The requesting user does not have adequate privileges to

access one or more objects specified in the request.

404 Not Found One or more objects specified in the request could not be

found in the specified container.

409 Conflict The object state is not compatible with the requested

operation.

500 Internal Server Error The request was received but could not be completed

because of an internal error at the server.

VMware vFabric Data Director API Programming Guide

16 VMware, Inc.

Hello vFabric Data Director: a

Simplified RESTful Workflow 4

Data Director API clients communicate with Data Director over HTTP, exchanging XML or JSON

representations of Data Director API objects. This chapter presents a series of examples that represent a typical

Data Director REST API workflow.

These examples describe the tasks you need to perform before and after creating a database with the REST

API.

This chapter includes the following topics:

“Creating a System Resource Bundle,” on page 17

“Converting a Base DBVM to a Base DB Template,” on page 18

“Creating a Resource Bundle,” on page 19

“Creating an Organization,” on page 20

“Assigning a Resource Bundle to an Organization,” on page 20

“Enabling a Base DB Template,” on page 21

“Creating a DB Group,” on page 21

“Creating a Database,” on page 22

Creating a System Resource Bundle

Use this call to create a system resource bundle.

The call in this example uses an iterative process that is common in REST APIs, where you make a call to

retrieve data that you will need in the next call.

The first call retrieves data about the resource pools.

GET https://example.aurora.com\

/datadirector/api\

/resourcepools?forsysrb=true

From this first call, we learn that the refId of ExampleSysRP is ‘null:ResourcePool:resgroup-9680’, which we

use in the next two calls.

The second call retrieves data about the datastores.

GET https://example.aurora.com\

/datadirector/api/resourcepool\

/null:ResourcePool:resgroup-9680\

/datastores

VMware, Inc.

The third call retrieves network information.

GET https://example.aurora.com\

/datadirector/api/resourcepool\

/null:ResourcePool:resgroup-9680\

/networks

The final call in the sequence contains a 'payload' of data that you submit to a web service, with the information

that we retrieved with our previous queries. This 'payload' is often included as application code in an

application such as Python or JavaScript.

POST https://example.aurora.com\

/datadirector/api/sysresourcebundle

{

"networkRefId": "null:Network:network-1464",

"backupDataStoreRefId": "null:Datastore:datastore-3803",

"dataDataStoreRefId": "null:Datastore:datastore-3803",

"backupStorageSize": 0,

"dataStorageSize": 151200,

"resourcePoolRefId": "null:ResourcePool:resgroup-9680",

"ipAllocType": "DHCP"

}

The following is an example of the corresponding response.

202 Accepted

location: https://example.aurora.com\

/datadirector/api/task/55

Converting a Base DBVM to a Base DB Template

Use this call to convert a Base DBVM to a Base DB Template.

The call in this example uses an iterative process that is common in REST APIs, where you make a call to

retrieve data that you will need in the next call.

The first call retrieves the ID of the base DBVMs.

GET https://example.aurora.com\

/datadirector/api/basedbvms

From this call, we can see the data for the base dbvms. We decide to use the base DBVM where the ID is 2.

The final call in the sequence contains a 'payload' of data that you submit to a web service. This is often included

as application code in an application such as Python or JavaScript.

POST https://example.aurora.com\

/datadirector/api/basedbtemplates

{

"keepBaseDbvm": true,

"baseDbvmId": 2,

"name": "vpostgress_template"

}

The following is an example of the corresponding response.

202 Accepted

location: https://example.aurora.com\

/datadirector/api/task/56

VMware vFabric Data Director API Programming Guide

18 VMware, Inc.

Creating a Resource Bundle

Use this call to create a resource bundle.

The call in this example uses an iterative process that is common in REST APIs, where you make a call to

retrieve data that you will need in the next call.

The first call retrieves data about the resource pools.

GET https://example.aurora.com\

/datadirector/api\

/resourcepools?forsysrb=false

The second call retrieves network information.

GET https://example.aurora.com\

/datadirector/api/resourcepool\

/null:ResourcePool:resgroup-9680\

/networks

The third call retrieves information about the base DB template.

GET https://example.aurora.com\

/datadirector/api/basedbtemplates

From this response, we learn that the template ID is 5.

The final call in the sequence contains a 'payload' of data that you submit to a web service, using information

obtained from our previous calls. This is often included as application code in an application such as Python

or JavaScript.

POST https://example.aurora.com\

/datadirector/api/resourcebundles

{

"networkSetting": {

"instance": [{

"networkRefId": "null:Network:network-1464",

"ipAllocType": "DHCP"

}]

"dataDataStoreRefId": "null:Datastore:datastore-3803",

"name": "AuroraRB",

"minStorageAlpha": 1.0,

"dataStorageSize": 100000,

"backupDataStoreRefId": "null:Datastore:datastore-3803",

"baseDbTemplateId": {

"instance": [{

"templateId": 5

}]

"resourcePoolRefId": "null:ResourcePool:resgroup-9673",

"backupStorageSize": 100000

}

The following is an example of the corresponding response.

202 Accepted

location: https://example.aurora.com\

/datadirector/api/task/57

Chapter 4 Hello vFabric Data Director: a Simplified RESTful Workflow

VMware, Inc. 19

Creating an Organization

Use this call to create an organization.

The call in this example uses an iterative process that is common in REST APIs, where you make a call to

retrieve data that you will need in the next call.

The first call retrieves the adminId from the user information.

GET https://example.aurora.com\

/datadirector/api/users

From the response, we learn that the adminId = 1.

The final call contains a 'payload' of data that you submit to a web service. This is often included as application

code in an application such as Python or JavaScript.

This is the request.

POST https://example.aurora.com\

/datadirector/api/orgs

{

"adminId": 1,

"name": "AuroraOrg"

}

The following is an example of the corresponding response.

201 Created

location: https://example.aurora.com\

/datadirector/api/org/82

Assigning a Resource Bundle to an Organization

Use this call to assign a resource bundle to an organization.

The call in this example uses an iterative process that is common in REST APIs, where you make a call to

retrieve data that you will need in the next call.

The first call retrieves data about the resource bundles.

GET https://example.aurora.com\

/datadirector/api/resourcebundles

The response returns a list of resource bundles. We choose to use the resource bundle with an ID of 81.

The second call retrieves data about the organization.

GET https://example.aurora.com\

/datadirector/api/orgs

The response returns a list of organizations. We choose to use the organization with an ID of 82.

The final call in the sequence performs the assignment operation.

This is an example.

POST https://example.aurora.com\

/datadirector/api/resourcebundle\

/81?action=assign&org=82

Note that this request does not include a 'payload' component.

VMware vFabric Data Director API Programming Guide

20 VMware, Inc.

Page is loading ...

VMware vFabric Data Director 2.0 User guide

Brand: VMware

Model: vFabric Data Director 2.0

Category: Development software

Type: User guide

Manage data resources: Efficiently allocate and manage data resources, including storage pools, compute resources, and network connectivity, to optimize performance and utilization.
Protect data: Implement robust data protection strategies, including backup, replication, and recovery, to safeguard data from loss or corruption due to hardware failures, software errors, or human mistakes.

Download PDF

report

VMware vFabric Data Director 2.0 User guide

VMware vFabric Data Director 2.0 User guide

Related papers

Other documents