Joyent CloudAPI

This is the reference documentation for the CloudAPI that is part of Joyent's SmartDataCenter 7.0 product. This guide provides descriptions of the APIs available, as well as supporting information such as how to use the SDK(s), command line interface (CLI), and where to find more information.

For more information about this product visit Joyent SmartDataCenter.

This document refers to SmartDataCenter 7.0. For information on 6.5 version of this API see CloudAPI 6.5 Documentation

Conventions

Any content formatted like this is a command-line example that you can run from a shell:

sdc-listmachines

All other examples and information are formatted like this:

GET /my/machines HTTP/1.1

Introduction to CloudAPI

What is CloudAPI?

CloudAPI is the API you use to interact with the SmartDataCenter product. Using CloudAPI, you can:

How do I access CloudAPI?

CloudAPI is available as a REST API, and you can access it using:

If you don't want to write any code, use the CloudAPI CLI. The CLI lets you use command line tools to perform every action available in the SDK and in the REST API.

Getting Started

The CloudAPI command line interface (CLI) requires Node.js and npm to run.

You can get Node.js from nodejs.org as source code and as precompiled packages for Windows and Macintosh.

Given the required Node.js version should be greater or equal than v0.8.14, npm will be included with the Node.js distribution.

Once you've installed Node.js and npm, install the CloudAPI CLI like this:

npm install smartdc -g

You will also want to install jsontool, a tool that makes it easier to work with JSON-formatted output. You can install it like this:

npm install jsontool -g

In both cases the -g switch installs the tools globally, usually in /usr/local/bin, so that you can use them easily from the command line.

Generate an SSH key

The CloudAPI CLI does not allow you to use HTTP Basic Authentication, as it is a weak security mechanism. Additionally, to interact with provisioned machines, you need an SSH key to login.

If you haven't already generated an SSH key (required to use both SSH and HTTP Signing), run the following command:

ssh-keygen -b 2048 -t rsa

This will prompt you with a place to save the key. You should probably just accept the defaults, as many programs (SSH and SDC CLI) will first look for a file called ~/.ssh/id_rsa.

Set Up your CLI

You need to know the following information in order to interact with CloudAPI:

You can quickly get your key fingerprint by running:

    ssh-keygen -l -f ~/.ssh/id_rsa.pub | awk '{print $2}' | tr -d '\n'

where you obviously replace ~/.ssh/id_rsa.pub with the path to your the public key you wan to use for signing requests.

Working with the CLI

For a complete list of CloudAPI CLI commands available see Appendix D: CloudAPI CLI Commands.

To get help on command, use the --help flag. For example:

sdc-listdatacenters --help
sdc-listdatacenters [--account string] [--debug boolean] [--help boolean]
[--keyId string] [--url url]

You can set environment variables for the following flags so that you don't have to type them for each request:

CLI FlagDescriptionEnvironment Variable
--account
-a
Login name (account)SDC_ACCOUNT
--keyId
-k
Fingerprint of the key to use for signingSDC_KEY_ID
--url
-u
URL of the CloudAPI endpointSDC_URL

Note that you can use the short form of flags as well. For instance, you can use the -a or the --account flag.

Provision a new SmartMachine

To provision a new SmartMachine with the default settings, you first need to get the id for the image you want to use as the base for your machine.

You can get the list of available images using the sdc-listimages command. See the ListImages section below for a detailed explanation of this command.

Then, to provision the new SmartMachine the you can simply run:

sdc-createmachine -n getting-started -e 3390ca7c-f2e7-11e1-8818-c36e0b12e58b

You can use the -n flag to name your machine. If you do not specify a name, SmartDataCenter will generate a name for you. You can retrieve the status of your SmartMachine like:

sdc-listmachines -n getting-started -e 3390ca7c-f2e7-11e1-8818-c36e0b12e58b

[
  {
    "id": "0b97c186-05a5-4113-b05f-3e597e3cf038",
    "name": getting-started",
    "owner": demo",
    "type": "smartmachine",
    "state": "running",
    "dataset": "standard-1.0.7",
    "ips": [],
    "memory": 128,
    "disk": 5120,
    "metadata": {},
    "created": "2011-06-27T19:52:40+00:00",
    "updated": "2011-06-27T20:08:55+00:00"
  }
]

Once the state is "running", you can login to your new machine (assuming it's a Unix-based machine), with the following:

ssh-add
$ ssh -A admin@10.88.88.50

Those two commands set up your SSH Agent (which has some magical properties, such as the ability for the CLI to work on your SmartMachine without keys), and logs you in as the admin user on that machine. Note that the admin user has password-less sudo capabilities, so you may want to set up some less priviledged users. The SSH keys on your account will allow you to login as any OS user on a SmartMachine.

Now that we've done some basics with a SmartMachine, let's introduce a few concepts in case you want to be cooler than the defaults.

Images

By default, you can use SmartOS images. Your SmartDataCenter cloud may have other images available, such as Linux or Windows images. The list of available images can be obtained with:

sdc-listimages

Main difference with datasets is that images will not provide an URN, but just an unique id which must be used to identify our image of choice.

Packages

You can list packages available in your cloud with:

sdc-listpackages

Packages are the SmartDataCenter name for the "size" of your machine. Packages are provided so that you do not need to select individual settings, such as memory or disk. To provision a new SmartMachine with more memory, for example, try:

sdc-createmachine -e 3390ca7c-f2e7-11e1-8818-c36e0b12e58b -n big-one -p regular_1024

Please, note the previous example assumes the package regular_1024 exists in the SmartDataCenter setup you are interacting with. That may or not be the case, given packages may change from one setup to a different one. Just make sure you try the previous example with either an existing package name or package id from those ones you obtained using sdc-listpackages.

Managing SSH keys

For machines of type smartmachine, you can manage the SSH keys that allow login to the OS from Cloud API (Virtual Machines are static, and whatever keys are in your account at machine creation time are used). To rotate keys, for example, run:

sdc-createkey -n my_other_rsa_key ~/.ssh/my_other_rsa_key.pub

The -n option sets the name of the key. If you don't provide one, Cloud API sets it to the name of the file. In this case my_other_rsa_key.pub.

To use the new key, you will need to update the environment variables:

export SDC_KEY_ID=my_other_rsa_key

At this point you could delete your other key from the system; see Cleaning Up for a quick example.

Creating Analytics

Now that you've got a SmartMachine up and running, and you logged in and did whatever it is you thought was awesome, let's create an instrumentation to monitor performance. Analytics are one of the most powerful features of SmartDataCenter, so for more information, be sure to read Appendix B: Cloud Analytics on Analytics in this document. Anyway, let's instrument something!

To get started for now, let's create an instrumentation on our network bytes:

sdc-createinstrumentation -m nic -s vnic_bytes

Great, now ssh back into your machine, and do something silly like:

wget joyent.com
$ ping -I 1 joyent.com

Now, go ahead and run:

sdc-getinstrumentation -v 1

Where 1 is the id you got back from sdc-createinstrumentation. You should be able to run this a few times and see the changes. This is just a starting point, for a full discssion of analytics, be sure to read Appendix B: Cloud Analytics.

Cleaning up

After going through the Getting Started section, you should now have at least one SSH key, one machine and one instrumentation. The rest of the commands assume you have jsontool installed.

Deleting Instrumentations

Before cleaning up your machines, let's get rid of the instrumentation we created:

sdc-deleteinstrumentation 1

Deleting Machines

Machines need to be shutdown before you can delete them, so let's do some fancy shell work to do that:

sdc-listmachines -n getting-started | json 0.id | xargs sdc-stopmachine

Now, go ahead and check the state a few times until it's stopped. Then go ahead and run sdc-deletemachine.

sdc-listmachines -n getting-started | json 0.state
$ sdc-listmachines -n getting-started | json 0.id | xargs sdc-deletemachine

Deleting keys

Finally, you probably have two SSH keys uploaded to SmartDataCenter after going through the guide, so go ahead and delete the one we setup:

sdc-deletekey id_rsa

API Introduction

CloudAPI is available as an HTTP standard REST API. You can work with the REST API by either talking directly to it via tooling you already know about (such as curl, et al), or by using the CloudAPI SDK from Joyent. The CloudAPI SDK is available as an npm module, which you can install with:

npm install smartdc

The rest of this document will show all APIs in terms of both the raw HTTP specification, the SDK API, and the CLI command.

Issuing Requests

All HTTP calls to CloudAPI must be made over SSL/TLS, and requests must carry at least two headers (in addition to standard HTTP headers): Authorization and X-Api-Version header. The details are explained below. In addition to these headers, any requests requiring content must be sent in an acceptable scheme to CloudAPI. Details are also below.

Content-Type

For requests requiring content, you can send parameters encoded with application/json, application/x-www-form-urlencoded or multipart/form-data. Joyent recommends application/json. The value of the Accept header determines the encoding of content returned in responses. CloudAPI supports application/json response encodings only.

For exmaple, all of the following are valid calls:

Query String (on the uri):

POST /my/keys?name=rsa&key=... HTTP/1.1
Host: joyent.com
Authorization: ...
Content-Length: 0

Form encoded in the body:

POST /my/keys HTTP/1.1
Host: joyent.com
Authorization: ...
Content-Type: application/x-www-form-urlencoded
Content-Length: 123

name=rsa&key=...

JSON in the body:

POST /my/keys HTTP/1.1
Host: joyent.com
Authorization: ...
Content-Type: application/json
Content-Length: 123

{"name":"rsa","key":"..."}

Authorization

All API calls to the CloudAPI require an Authorization header, which supports multiple "schemes". Currently CloudAPI supports only one Authentication mechanism due to PCI compliance restrictions:

In order to leverage HTTP Signature Authentication, only RSA signing mechanisms are supported, and your keyId must be equal to the path returned from a ListKeys API call. For example, if your SmartDataCenter login is demo, and you've uploaded an RSA SSH key with the name foo, an Authorization header would look like:

Authorization: Signature keyId=/demo/keys/foo,algorithm="rsa-sha256" ${Base64($Date)}

The default value to sign for CloudAPI requests is simply the value of the HTTP Date header. For more informaton on the Date header value, see RFC 2616. All requests to CloudAPI using the Signature authentication scheme must send a Date header. Note that clock skew will be enforced to 300s (positive or negative) of the value sent.

Full support for HTTP Signature Authentication scheme is in the CloudAPI SDK; additionally, a reference implementation for node.js is available in the NPM http-signature, which you can install with:

npm install http-signature@0.9.11

Api-Version

The CloudAPI is strongly versioned, and all requests must specify a version of the API. The Api-Version header is expected to carry a semver string that the client wants to use, with the additional twist that your client can specify ranges of versions to support, as you can with NPM. For details on how to specify ranges, check node-semver. A couple examples:

X-Api-Version: ~7.0
X-Api-Version: >=7.0.0

Joyent recommends you set the Api-Version header to ~7.0; each service release of SmartDataCenter will increment the patch version; any major releases of SmartDataCenter will increment either the minor or major version.

Using cURL with CloudAPI

Since cURL is commonly used to script requests to web services, here's a simple function you can use to wrap cURL to communicate with CloudAPI:

function cloudapi() {
  local now=`date -u "+%a, %d %h %Y %H:%M:%S GMT"` ;
  local signature=`echo ${now} | tr -d '\n' | openssl dgst -sha256 -sign ~/.ssh/id_rsa | openssl enc -e -a | tr -d '\n'` ;

  curl -is -H "Accept: application/json" -H "api-version: ~7.0" -H "Date: ${now}" -H "Authorization: Signature keyId=\"/demo/keys/id_rsa\",algorithm=\"rsa-sha256\" ${signature}" --url https://api.example.com$@ ;
  echo "";
}

With that function, you could just do:

cloudapi /my/machines

CloudAPI HTTP Responses

As indicated above, CloudAPI returns all response objects as application/json encoded HTTP bodies. In addition to the content object, all response have the following headers:

HeaderDescription
DateWhen the response was sent (RFC 1123 format)
Api-VersionThe exact version of the CloudAPI server you talked to
Request-IdA unique id for this request; you should log this
Response-TimeHow long the server took to process your request (ms)

Note that for backwards compatibility with ~6.5 version, the headers X-Api-Version, X-Request-Id and X-Response-Time are also provided with exactly the same values than their counterparts without the X- prefix. These X- prefixed headers will be unsupported and removed when we remove support for version 6.5 of Cloud API.

If there is content, you can expect:

HeaderDescription
Content-LengthHow much content, in bytes
Content-TypeFormatting of the response (almost always application/json)
Content-MD5An MD5 checksum of the response; you should check this

HTTP Status Codes

Your client should check for each of the following status codes from any API request:

ResponseCodeDescription
400Bad RequestInvalid HTTP Request
401UnauthorizedEither no Authorization header was sent, or invalid credentials were used
403ForbiddenNo permissions to the specified resource
404Not FoundSomething you requested was not found
405Method Not AllowedMethod not supported for the given resource
406Not AcceptableTry sending a different Accept header
409ConflictMost likely invalid or missing parameters
413Request Entity Too LargeYou sent too much data
415Unsupported Media TypeYou encoded your request in a format we don't understand
420Slow DownYou're sending too many requests
449Retry WithInvalid Version header; try with a different X-Api-Version string
503Service UnavailableEither there's no capacity in this datacenter, or we're in a maintenance window

Error Responses

In the event of an error, CloudAPI will return a standard error response object of the scheme:

{
  "code": "CODE",
  "message": "human readable string"
}

Where the code element is one of:

CodeDescription
BadRequestYou sent bad HTTP
InternalErrorSomething was wrong on our end
InvalidArgumentYou sent bad arguments or a bad value for an argument
InvalidCredentialsTry authenticating correctly
InvalidHeaderYou sent a bad HTTP header
InvalidVersionYou sent a bad X-Api-Version string
MissingParameterYou didn't send a required parameter
NotAuthorizedYou don't have access to the requested resource
RequestThrottledYou got throttled
RequestTooLargeYou sent too much request data
RequestMovedHTTP Redirect
ResourceNotFoundWhat you asked for wasn't found
UnknownErrorSomething completely unexpected happened.

Clients are expected to check HTTP status code first, and if in the 4xx range, they can leverage the codes above.

Account

You can obtain your account details and update them through Cloud API, with the notable exception of login - modifications of login are not permitted at all - and password. Any password modification should happen through SDC Portal.

GetAccount (GET /:login)

Retrieves your account details

Inputs

Returns

Account object:

FieldTypeDescription
idStringUnique id for you
loginStringYour login name
emailStringEmail address
companyNameString...
firstNameString...
lastNameString...
addressString...
postalCodeString...
cityString...
stateString...
countryString...
phoneString...

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-getaccount

Example Request

GET /login HTTP/1.1
authorization: Signature keyId="..."
accept: application/json
accept-version: ~7.0
host: api.example.com

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 316
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
content-md5: F7ACwRAC1+7//jajYKbvYw==
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 29be67c0-7d0c-11e2-8048-5195b6159808
response-time: 164
x-request-id: 29be67c0-7d0c-11e2-8048-5195b6159808
x-api-version: 7.0.0
x-response-time: 164

{
  "id": "cc71f8bb-f310-4746-8e36-afd7c6dd2895",
  "login": "login",
  "email": "login@example.com",
  "companyName": "Example",
  "firstName": "Name",
  "lastName": "Surname",
  "postalCode": "4967",
  "address": [
    "liltingly, Inc.",
    "6165 pyrophyllite Street"
  ],
  "city": "benzoylation concoctive",
  "state": "SP",
  "country": "BAT",
  "phone": "+1 891 657 5818"
}

UpdateAccount (POST /:login)

Update your account details with the given parameters

Inputs

FieldTypeDescription
emailStringEmail address
companyNameString...
firstNameString...
lastNameString...
addressString...
postalCodeString...
cityString...
stateString...
countryString...
phoneString...

Returns

Account object:

FieldTypeDescription
idStringUnique id for you
loginStringYour login name
emailStringEmail address
companyNameString...
firstNameString...
lastNameString...
addressString...
postalCodeString...
cityString...
stateString...
countryString...
phoneString...

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-updateaccount --postal-code=12345 --phone='1 (234) 567 890'

Example Request

POST /login HTTP/1.1
authorization: Signature keyId="...
accept: application/json
content-type: application/json
accept-version: ~7.0
content-length: 48
content-md5: 6kCHdE651hsI9N82TUkU/g==
host: api.example.com
connection: keep-alive

postal-code=12345&phone=1%20(234)%20567%20890

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 317
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
content-md5: dRwQeA63/aCqc43sGyyheg==
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: be62e5b0-7d0f-11e2-918f-912e9d0235c1
response-time: 326
x-request-id: be62e5b0-7d0f-11e2-918f-912e9d0235c1
x-api-version: 7.0.0
x-response-time: 326

{
  "id": "cc71f8bb-f310-4746-8e36-afd7c6dd2895",
  "login": "login",
  "email": "login@example.com",
  "companyName": "Example",
  "firstName": "Name",
  "lastName": "Surname",
  "postalCode": "12345",
  "address": [
    "liltingly, Inc.",
    "6165 pyrophyllite Street"
  ],
  "city": "benzoylation concoctive",
  "state": "SP",
  "country": "BAT",
  "phone": "1 (234) 567 890"
}

Keys

Keys are the means by which you operate on your SSH/signing keys. Currently CloudAPI supports uploads of public keys in the OpenSSH format.

Note that while it's possible to provide a name attribute for an SSH key in order to use it as an human friendly alias, this attribute presence is completely optional.

When it's not given, the ssh key fingerprint will be used instead to fill also the name attribute, appart of the always present fingerprint atribute.

On the following routes, the parameter placeholder :key can be replaced either with key's name or fingerprint.

It's strongly recommended to use fingerprint when possible, since name attribute hasn't got - neither will have - uniqueness restrictions.

ListKeys (GET /:login/keys)

Lists all public keys we have on record for the specified account.

Inputs

Returns

An array of key objects. Keys are:

FieldTypeDescription
nameStringName for this key
fingerprintStringKey fingerprint
keyStringOpenSSH formatted public key

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-listkeys

Example Request

GET /my/keys HTTP/1.1
Host: api.example.com
Authorization: ...
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:05:42 GMT
X-API-Version: 7.0.0
X-RequestId: 9E962AAA-E5F6-487F-8339-45FABA3CF5BD
X-Response-Time: 66
Content-Type: application/json
Content-Length: 503
Content-MD5: RHiVkkX0AZHOjijYqJFRNg==

[
  {
    "name": "rsa",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0A5Pf5Cq...",
    "fingerprint": "59:a4:..."
  }
]

GetKey (GET /:login/keys/:key)

Retrieves an individual key record.

Inputs

Returns

FieldTypeDescription
nameStringName for this key
fingerprintStringKey fingerprint
keyStringOpenSSH formatted public key

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-getkey rsa

Example Request

GET /my/keys/rsa HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-API-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, DELETE
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: BE3559EE-713B-43EB-8DEB-6EE93F441C23
X-Response-Time: 78
Content-Type: application/json
Content-Length: 501
Content-MD5: O5KO1sbXxLHk1KHxN6U+Fw==

{
  "name": "rsa",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0A5Pf5Cq...",
  "fingerprint": "59:a4:61:..."
}

CreateKey (POST /:login/keys)

Uploads a new OpenSSH key to SmartDataCenter for use in SSH and HTTP signing.

Inputs

FieldTypeDescription
nameStringName for this key (optional)
keyStringOpenSSH formatted public key

Returns

FieldTypeDescription
nameStringName for this key
fingerprintStringKey fingerprint
keyStringOpenSSH formatted public key

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
InvalidArgumentIf name or key is invalid (usually key)
MissingParameterIf you didn't send a key
ResourceNotFoundIf :login does not exist

CLI Command

sdc-createkey -n id_rsa ~/.ssh/id_rsa.pub

Example Request

POST /my/keys HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 455
Content-Type: application/json
X-Api-Version: ~7.0

{
  "name": "id_rsa",
  "key": "ssh-rsa AAA...",
  "fingerprint": "59:a4:..."
}

Example Response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: BE3559EE-713B-43EB-8DEB-6EE93F441C23
X-Response-Time: 78
Content-Type: application/json
Content-Length: 501
Content-MD5: O5KO1sbXxLHk1KHxN6U+Fw==

{
  "name": "rsa",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0A5Pf5Cq...",
  "fingerprint": "59:a4:..."
}

DeleteKey (DELETE /:login/keys/:key)

Deletes an SSH key by name or fingerprint.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or there isn't a key with either the name or fingerprint given as :key value

CLI Command

sdc-deletekey id_rsa

Example Request

DELETE /my/keys/id_rsa HTTP/1.1
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0
Content-Length: 0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, DELETE
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: 4655EA0A-C4CB-4486-8AA9-8C8C9A0B71B1
X-Response-Time: 65
Content-Length: 0

Datacenters

ListDatacenters (GET /:login/datacenters)

Provides a list of all datacenters this cloud is aware of.

Inputs

Returns

An object where the keys are the datacenter name, and the value is the URL.

FieldTypeDescription
$datacenternameUrllocation of the datacenter

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-listdatacenters

Example Request

GET /my/datacenters HTTP/1.1
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0
Content-Length: 0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Connection: close
x-api-version: 7.0.0
Date: Mon, 06 Jun 2011 18:45:21 GMT
Server: SmartDataCenter
x-request-id: 75812321-5887-45ae-b0d4-6e562cb463b5
x-response-time: 0
Content-Type: application/json
Content-Length: 28
Content-MD5: nvk5mzwiEmQEfWbQCcBauQ==

{
  "joyent": "https://api.example.com"
}

GetDatacenter (GET /:login/datacenters/:name)

Gets an individual datacenter by name. Returns an HTTP redirect to your client, which you can ignore if you really want, as the datacenter url is in the Location header.

Inputs

Returns

An object formatted like an Error Response; check the Location header for the URL itself.

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or :name does not exist

CLI Command

Example Request

GET /my/datacenters/joyent HTTP/1.1
Authorization: Basic ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 302 Moved Temporarily
Location: https://api.example.com
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Connection: close
x-api-version: 7.0.0
Date: Mon, 06 Jun 2011 18:47:01 GMT
Server: SmartDataCenter
x-request-id: e7b35c46-c36d-4e02-8cde-6fdf2695af15
x-response-time: 178
Content-Type: application/json
Content-Length: 875
Content-MD5: FV3cglJSamXOETia0jOZ5g==


{
  "code": "ResourceMoved",
  "message": joyent is at https://api.example.com"
}

Images

An image contains the software packages that will be available on newly provisioned machines. In the case of virtual machines, the dataset also includes the operating system.

ListImages (GET /:login/images)

Provides a list of images available in this datacenter.

Inputs

The following optional query parameters are available to filter the list of images:

nameStringThe "friendly" name for this image
osStringThe underlying operating system for this image
versionStringThe version for this image
publicBoolean(New in 7.1.) Filter public/private images, e.g. ?public=true, ?public=false
stateString(New in 7.1.) Filter on image state. By default only active images are shown. Use ?state=all to list all images.
ownerString(New in 7.1.) Filter on the owner UUID.
typeString(New in 7.1.) Filter on the image type, e.g. ?type=smartmachine.

Returns

An array of images. Image objects include the following fields:

idStringa unique identifier for this image
nameStringThe "friendly name for this image
osStringThe underlying operating system for this image
versionStringThe version for this image
typeStringWhether this is a smartmachine or virtualmachine dataset
requirementsObjectContains a grouping of various minimum requirements for provisioning a machine with this image. For example 'password' indicates that a password must be provided.
homepageString(New in 7.0.) The URL for a web page including detailed information for this image
published_atString (ISO-8859)(New in 7.0.) The time this image has been made publicly available.
publicBoolean(New in 7.1.) Indicates if this image is publicly available.
stateString(New in 7.1.) The current state of the image. One of 'active', 'unactivated', 'disabled', 'creating', 'failed'.
tagsObject(New in 7.1.) An object of key/value pairs that allows clients to categorize images by any given criteria.
eulaString(New in 7.1.) URL of the End User License Agreement (EULA) for the image.
aclArray(New in 7.1.) Access Control List. An array of account UUIDs given access to a private image. The field is only relevant to private images.
errorObject(New in 7.1.) If state=="failed", resulting from CreateImageFromMachine failiure, then there may be an error object of the form {"code": "<string error code>", "message": "<string desc>"}
error.codeString(New in 7.1.) A CamelCase string code for this error, e.g. "PrepareImageDidNotRun". See GetImage docs for a table of error.code values.
error.messageString(New in 7.1.) A short description of the image creation failure.

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-listimages

Example Request

GET /my/images HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: FD6F87E7-5EA5-4B55-97D9-DEE29259731D
X-Response-Time: 257
Content-Type: application/json
Content-Length: 402
Content-MD5: y7YOeXG98DYchC96s46yRw==

[
  {
    "name": "nodejs",
    "version": "1.1.3",
    "os": "smartos",
    "id": "7456f2b0-67ac-11e0-b5ec-832e6cf079d5",
    "default": true,
    "type": "smartmachine",
    "published_at": "2011-04-15T22:04:12+00:00"
  },
  {
    "name": "smartos",
    "version": "1.3.12",
    "os": "smartos",
    "id": "febaa412-6417-11e0-bc56-535d219f2590",
    "default": false,
    "type": "smartmachine",
    "published_at": "2011-04-11T08:45:00+00:00"
  }
]

GetImage (GET /:login/images/:id)

Gets an individual image by id.

Inputs

None

Returns

idStringa unique identifier for this image
nameStringThe "friendly name for this image
osStringThe underlying operating system for this image
versionStringThe version for this image
typeStringWhether this is a smartmachine or virtualmachine dataset
requirementsObjectContains a grouping of various minimum requirements for provisioning a machine with this image. For example 'password' indicates that a password must be provided.
homepageString(New in 7.0.) The URL for a web page including detailed information for this image
published_atString (ISO-8859)(New in 7.0.) The time this image has been made publicly available.
ownerString(New in 7.1.) The UUID of the user who owns this image.
publicBoolean(New in 7.1.) Indicates if this image is publicly available.
stateString(New in 7.1.) The current state of the image. One of 'active', 'unactivated', 'disabled', 'creating', 'failed'.
tagsObject(New in 7.1.) An object of key/value pairs that allows clients to categorize images by any given criteria.
eulaString(New in 7.1.) URL of the End User License Agreement (EULA) for the image.
aclArray(New in 7.1.) Access Control List. An array of account UUIDs given access to a private image. The field is only relevant to private images.
errorObject(New in 7.1.) If state=="failed", resulting from CreateImageFromMachine failiure, then there may be an error object of the form {"code": "<string error code>", "message": "<string desc>"}
error.codeString(New in 7.1.) A CamelCase string code for this error, e.g. "PrepareImageDidNotRun".
error.messageString(New in 7.1.) A short description of the image creation failure.

Possible error.code values:

error.codeDetails
PrepareImageDidNotRunThis typically means that the target KVM machine (e.g. Linux) has old guest tools that pre-date the image creation feature. Guest tools can be upgraded with installers at https://download.joyent.com/pub/guest-tools/. Other possibilities are: a boot time greater than the 5 minute timeout or a bug or crash in the image preparation script.
VmHasNoOriginOrigin image data could not be found for the machine. Typically this is for a machine migrated before image creation support was added.
NotSupportedIndicates an error due to functionality that isn't currently supported. One example is that custom image creation of a VM based on a custom image isn't currently supported.
InternalErrorA catch-all error for unexpected or internal errors.

Errors

For all possible errors, see CloudAPI HTTP Responses.

CLI Command

sdc-getimage e42f8c84-bbea-11e2-b920-078fab2aab1f

Example Request

GET /my/images/e42f8c84-bbea-11e2-b920-078fab2aab1f HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 340
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
Access-Control-Allow-Methods: GET, HEAD, POST
Access-Control-Expose-Headers: Api-Version, Request-Id, Response-Time
Connection: Keep-Alive
Content-MD5: Q4ibyY8+ckGrTqyr/sbYLw==
Date: Thu, 08 Aug 2013 06:02:49 GMT
Server: Joyent SmartDataCenter 7.0.0
Api-Version: 7.0.0
Request-Id: 27431d80-fff0-11e2-b61a-f51841e5d1bd
Response-Time: 491
X-Request-Id: 27431d80-fff0-11e2-b61a-f51841e5d1bd
X-Api-Version: 7.0.0
X-Response-Time: 491

{
  "id": "e42f8c84-bbea-11e2-b920-078fab2aab1f",
  "name": "fedora",
  "version": "2.4.2",
  "os": "linux",
  "type": "virtualmachine",
  "requirements": {},
  "description": "Fedora 18 64-bit image with just essential...",
  "published_at": "2013-05-17T18:18:36.472Z",
  "public": true
  "state": "active",
}

DeleteImage (DELETE /:login/images/:id)

(Beta. Custom image management is currently in beta.)

Delete an image. One must be the owner of the image to delete it.

Inputs

None

Returns

Responds with HTTP 204 'No Content'.

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the image specified does not exist

CLI Command

sdc-deleteimage 0c428eb9-7f03-4bb0-ac9f-c0718945d604

Example Request

DELETE /my/images/e42f8c84-bbea-11e2-b920-078fab2aab1f HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
Access-Control-Allow-Methods: GET, HEAD, DELETE
Access-Control-Expose-Headers: Api-Version, Request-Id, Response-Time
Connection: Keep-Alive
Date: Sat, 10 Aug 2013 00:43:33 GMT
Server: Joyent SmartDataCenter 7.0.0
Api-Version: 7.0.0
Request-Id: e23eeef0-0155-11e3-8fd4-39aa5371c390
Response-Time: 244
X-Request-Id: e23eeef0-0155-11e3-8fd4-39aa5371c390
X-Api-Version: 7.0.0
X-Response-Time: 244

ExportImage (POST /:login/images/:id?action=export)

(Beta. Custom image management is currently in beta.)

Exports an image to the specified Manta path. One must be the owner of the image and the correspondent Manta path prefix in order to export it. Both the image manifest and the image file will be exported and their filenames will default to the following format when the specified manta path is a directory:

<manta_path>/NAME-VER.imgmanifest
<manta_path>/NAME-VER.zfs.FILE-EXT

Where NAME is the image name and VER is the image version. FILE-EXT is the file extension of the image file. As an example, exporting a foo-1.0.0 image to /user/stor/cloudapi would result in the following files being exported:

/user/stor/cloudapi/foo-1.0.0.imgmanifest
/user/stor/cloudapi/foo-1.0.0.zfs.gz

In contrast, if the basename of the given prefix is not a directory, then "MANTA_PATH.imgmanifest" and "MANTA_PATH.zfs[.EXT]" are created. As an example, the following shows how to export foo-1.0.0 with a custom name:

/my/images/<uuid>?action=export&manta_path=/user/stor/my-image

/user/stor/my-image.imgmanifest
/user/stor/my-image.zfs.gz

Inputs

manta_pathStringThe Manta path prefix to use when exporting the image.

Returns

A Manta location response object. It provides the properties that allow the cloudapi user to retrieve the image file and manifest from Manta: manta_url, image_path, manifest_path.

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the image specified does not exist

CLI Command

sdc-exportimage 0c428eb9-7f03-4bb0-ac9f-c0718945d604 manta_path=/user/stor/my-image

Example Request

POST /my/images/e42f8c84-bbea-11e2-b920-078fab2aab1f?action=export&manta_path=/user/stor/my-image HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 150
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
Access-Control-Allow-Methods: GET, HEAD, POST, DELETE
Access-Control-Expose-Headers: Api-Version, Request-Id, Response-Time
Connection: Keep-Alive
Content-MD5: qSUhN+dwdJKEFlcyrUdBiw==
Date: Tue, 03 Sep 2013 23:21:05 GMT
Server: Joyent SmartDataCenter 7.1.0
Api-Version: 7.1.0
Request-Id: 8180ad80-14ef-11e3-a62d-89e8106c294e
Response-Time: 670
X-Request-Id: 8180ad80-14ef-11e3-a62d-89e8106c294e
X-Api-Version: 7.1.0
X-Response-Time: 670

{
  "manta_url": "https://us-east.manta.joyent.com",
  "image_path": "/user/stor/my-image.zfs.gz",
  "manifest_path": "/user/stor/my-image.imgmanifest"
}

CreateImageFromMachine (POST /:login/images)

(Beta. Custom image management is currently in beta.)

Create a new custom image from a machine. The typical process is:

  1. Customize a machine instance as you want it.
  2. Call this endpoint to create the new image.
  3. ... repeat from step 1 if more customizations are desired.
  4. Use the new image for provisioning via CreateMachine.

Inputs

All inputs except machine are image manifest fields as defined by the IMGAPI docs. Note that not all fields listed there can be specified here.

FieldTypeRequired?DefaultNotes
machineUUIDYes-The prepared and stopped machine UUID from which the image is to be created.
nameStringYes-The name of the custom image, e.g. "my-image". See the IMGAPI docs for details.
versionStringYes-The version of the custom image, e.g. "1.0.0". See the IMGAPI docs for details.
descriptionStringNo-The image description.
homepageStringNo-The image homepage.
eulaStringNo-The image eula.
aclStringNo-The image acl.
tagsStringNo-The image tags.

Returns

FieldTypeNotes
idStringa unique identifier for this image
nameStringThe "friendly name for this image
osStringThe underlying operating system for this image
versionStringThe version for this image
typeStringWhether this is a smartmachine or virtualmachine dataset
requirementsObjectContains a grouping of various minimum requirements for provisioning a machine with this image. For example 'password' indicates that a password must be provided.
homepageString(New in 7.0.) The URL for a web page including detailed information for this image
published_atString (ISO-8859)(New in 7.0.) The time this image has been made publicly available.
ownerString(New in 7.1.) The UUID of the user who owns this image.
publicBoolean(New in 7.1.) Indicates if this image is publicly available. Currently all custom images are private.
stateString(New in 7.1.) The current state of the image. The value returned here will be 'creating'.
tagsObject(New in 7.1.) An object of key/value pairs that allows clients to categorize images by any given criteria.
eulaString(New in 7.1.) URL of the End User License Agreement (EULA) for the image.
aclArray(New in 7.1.) Access Control List. An array of account UUIDs given access to a private image. The field is only relevant to private images.

Errors

For general errors, see CloudAPI HTTP Responses. Some typical and specific errors for this endpoint:

CodeHTTP StatusDescription
InsufficientServerVersionError422The machine given is running on a server that is too old.
NotAvailable501Typically this indicates that image creation is not supported for the OS of the given VM.

Example CLI Command

sdc-createimagefrommachine \
    --machine a44f2b9b-e7af-f548-b0ba-4d9270423f1a
    --name my-custom-image
    --imageVersion 1.0.0

Example HTTP Request

POST /my/images HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

{
  "machine": "a44f2b9b-e7af-f548-b0ba-4d9270423f1a",
  "name": "my-custom-image",
  "version": "1.0.0"
}

Example HTTP Response

HTTP/1.1 201 Created
x-joyent-jobid: 0b30ef20-d622-436a-9c30-7376ba7d904c
Location: /admin/images/b87616a2-7a49-4e02-a71d-2e0ce5a2f037
Content-Type: application/json
Content-Length: 125
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
Access-Control-Allow-Methods: GET, HEAD, POST
Access-Control-Expose-Headers: Api-Version, Request-Id, Response-Time
Connection: Keep-Alive
Content-MD5: 2sEZ45LmhRiretMPn5sqVA==
Date: Tue, 30 Jul 2013 19:59:25 GMT
Server: Joyent SmartDataCenter 7.0.0
Api-Version: 7.0.0
Request-Id: 88af23b0-f952-11e2-8f2c-fff0ec35f4ce
Response-Time: 160
X-Request-Id: 88af23b0-f952-11e2-8f2c-fff0ec35f4ce
X-Api-Version: 7.0.0
X-Response-Time: 160

{
    "id": "62306cd7-7b8a-c5dd-d44e-8491c83b9974",
    "name": "my-custom-image",
    "version": "1.2.3",
    "requirements": {},
    "owner": "47034e57-42d1-0342-b302-00db733e8c8a",
    "public": false,
    "state": "creating"
}

Packages

Packages are named collections of resources that are used to describe the ‘sizes’ of either a smart machine or a virtual machine. These resources include (but are not limited to) RAM, CPUs, CPU Caps, Lightweight Threads, Disk Space, Swap size, and Logical Networks.

ListPackages (GET /:login/packages)

Provides a list of packages available in this datacenter.

Inputs

nameStringThe "friendly" name for this package
memoryNumberHow much memory will by available (in Mb)
diskNumberHow much disk space will be available (in Gb)
swapNumberHow much swap memory will be available (in Mb)
versionStringThe version for this package
vcpusNumberNumber of VCPUS for this package
groupStringThe group this package belongs to

When any value is provided for one or more of the aforementioned inputs, the retrieved packages must match all of them.

Returns

An array of objects, of the form:

nameStringThe "friendly" name for this package
memoryNumberHow much memory will by available (in Mb)
diskNumberHow much disk space will be available (in Gb)
swapNumberHow much swap memory will be available (in Mb)
vcpusNumberNumber of VCPUS for this package
defaultBooleanWhether this is the default package in this datacenter
idStringUnique identifier for this package
versionStringThe version for this package
groupStringThe group this package belongs to
descriptionStringAn Human friendly description for this package

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-listpackages

Example Request

GET /my/packages HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: FD6F87E7-5EA5-4B55-97D9-DEE29259731D
X-Response-Time: 257
Content-Type: application/json
Content-Length: 402
Content-MD5: y7YOeXG98DYchC96s46yRw==

[
  {
    "name": "regular_128",
    "memory": 128,
    "disk": 5120,
    "swap": 256,
    "default": true
  },
  {
    "name": "regular_256",
    "memory": 256,
    "disk": 5120,
    "swap": 512,
    "default": false
  },
  {
    "name": "regular_512",
    "memory": 512,
    "disk": 10240,
    "swap": 1024,
    "default": false
  },
  {
    "name": "regular_1024",
    "memory": 1024,
    "disk": 15360,
    "swap": 2048,
    "default": false
  }
]

GetPackage (GET /:login/packages/:package)

Gets a package by name or id.

Inputs

Returns

nameStringThe "friendly name for this package
memoryNumberHow much memory will by available (in Mb)
diskNumberHow much disk space will be available (in Gb)
swapNumberHow much swap memory will be available (in Mb)
vcpusNumberNumber of VCPUS for this package
defaultBooleanWhether this is the default package in this datacenter
idStringUnique identifier for this package
versionStringThe version for this package
groupStringThe group this package belongs to
descriptionStringAn Human friendly description for this package

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the specified package does not exist

CLI Command

sdc-getpackage regular_128

Example Request

GET /my/packages/regular_128 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Server: SmartDataCenter
Connection: close
Date: Tue, 16 Oct 2012 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: F01F0DC1-12DE-4D9A-B92B-FB3A041E46B8
X-Response-Time: 120
Content-Type: application/json
Content-Length: 122
Content-MD5: aokYYCYw/EU8JwTD9F6PyA==

{
  "name": "regular_128",
  "memory": 128,
  "swap": 256,
  "disk": 5120,
  "default": true,
  "id": "5968a8a4-5bff-4c5e-8034-d79de962e7f6",
  "vcpus": 1,
  "version": "1.0.0"
}

Machines

ListMachines (GET /:login/machines)

Lists all machines we have on record for your account. If you have a large number of machines, you can filter using the input parameters listed below.

You can paginate this API by passing in offset, and limit. HTTP responses will contain the additional headers x-resource-count and x-query-limit. If x-resource-count is less than x-query-limit, you're done, otherwise call the API again with offset set to offset + limit.

Note that there is a HEAD /:login/machines form of this API so you can retrieve the number of machines.

Inputs

typeStringvirtualmachine or smartmachine
nameStringMachine name to find (will make your list size 1, or 0)
imageStringImage ID; returns machines provisioned with that image
stateStringThe current state of the machine
memoryNumberThe current size of the RAM deployed for the machine (Mb)
tombstoneNumberInclude machines destroyed in the last N minutes
limitNumberReturn N machines; default is 1000 (which is also the maximum allowable result set size)
offsetNumberGet the next $limit of machines starting at this point
tag.$nameStringAn arbitrary set of tags can be used to query on, assuming they are prefixed with "tag."
credentialsBooleanWhether to include the generated credentials for machines, if present. Defaults to false.

Also, if the special input tags=* is provided, any other input will be completely ignored and the response will return all the machines with any tag.

Returns

An array of machine objects, which contain:

idStringThe globally unique id for this machine
nameStringThe "friendly" name for this machine
typeStringWhether this is a smartmachine or virtualmachine
stateStringThe current state of this machine
datasetURNThe dataset urn this machine was provisioned with (note that for new images/datasets w/o an URN, this value will be the dataset id, i.e, same value than the image attribute)
memoryNumberThe amount of memory this machine has (Mb)
diskNumberThe amount of disk this machine has (Gb)
ipsArray[String]The IP addresses this machine has
metadataObject[String => String]Any "extra" metadata this machine has
createdDate (ISO8601)When this machine was created
updatedDate (ISO8601)When this machine was updated
packageStringThe name of the package used to create this machine.
imageStringThe image id this machine was provisioned with

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidArgumentIf one of the input parameters was invalid

CLI Command

Getting all machines:

sdc-listmachines

Getting all SmartMachines:

sdc-listmachines -y smartmachine

Getting all SmartMachines that are currently running:

sdc-listmachines -y smartmachine -s running

Getting all SmartMachines that are currently running and have 256 Mb of memory:

sdc-listmachines -y smartmachine -s running -m 256

Getting all SmartMachines that are currently running, with 256 Mb of memory tagged 'test':

sdc-listmachines -y smartmachine -s running -m 256 -t group=test

Getting all tagged machines:

sdc-listmachines -t \*

(Note depending on your shell you may need to escape the asterisk char. BASH for example, requires it escaped).

Basically, the CLI has sane parameters that let you filter on anything in the API, and you can combine them. run $ sdc-listmachines -h to see all the options.

Example Request

GET /my/machines HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: AECD793C-3368-45FA-ACD9-19AC394B8933
X-Response-Time: 315
x-resource-count: 2
x-query-limit: 25
Content-Type: application/json
Content-Length: 292
Content-MD5: kGRcBWkLgMT+IAjDM46rFg==

[
  {
    "id": "15080eca-3786-4bb8-a4d0-f43e1981cd72",
    "name": "getting-started",
    "type": "smartmachine",
    "state": "running",
    "dataset": "sdc:sdc:smartos:1.3.15",
    "image": "01b2c898-945f-11e1-a523-af1afbe22822",
    "memory": 256,
    "disk": 5120,
    "ips": [
      "10.88.88.50"
    ],
    "metadata": {},
    "created": "2011-06-03T00:02:31+00:00",
    "updated": "2011-06-03T00:02:31+00:00"
  }
]

GetMachine (GET /:login/machines/:id)

Gets the details for an individual machine.

Inputs

Returns

idStringThe globally unique id for this machine
nameStringThe "friendly" name for this machine
typeStringWhether this is a smartmachine or virtualmachine
stateStringThe current state of this machine
datasetURNThe dataset urn this machine was provisioned with (note that for new images/datasets w/o an URN, this value will be the dataset id, i.e, same value than the image attribute)
memoryNumberThe amount of memory this machine has (Mb)
diskNumberThe amount of disk this machine has (Gb)
ipsArray[String]The IP addresses this machine has
metadataObject[String => String]Any "extra" metadata this machine has
createdDate (ISO8601)When this machine was created
updatedDate (ISO8601)When this machine was updated
credentialsBooleanWhether to include the generated credentials for machines, if present. Defaults to false.
packageStringThe name of the package used to create this machine.
imageStringThe image id this machine was provisioned with

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

Getting the details for the machine whose id is 75cfe125-a5ce-49e8-82ac-09aa31ffdf26:

sdc-getmachine 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

GET /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Server: SmartDataCenter
Connection: close
Date: Tue, 28 Jun 2011 23:14:34 GMT
X-Api-Version: 7.0.0
X-RequestId: 4A8C4694-03C3-484D-80E0-ACBA9FEE6C7C
X-Response-Time: 174
Content-Type: application/json
Content-Length: 261
Content-MD5: oDccU7ZWZrOkdl/pGZ4oNA==

{
  "id": "75cfe125-a5ce-49e8-82ac-09aa31ffdf26",
  "name": "getting-started",
  "type": "smartmachine",
  "state": "running",
  "dataset": "sdc:sdc:smartos:1.3.15",
  "image": "01b2c898-945f-11e1-a523-af1afbe22822",
  "ips": [
    "10.88.88.51"
  ],
  "memory": 128,
  "disk": 5120,
  "metadata": {},
  "created": "2011-06-27T23:50:49+00:00",
  "updated": "2011-06-28T00:09:37+00:00"
}

CreateMachine (POST /:login/machines)

Allows you to provision a machine. Note that if you do not specify a package and/or dataset, you'll get the datacenter defaults for each. If you do not specify a name, CloudAPI will generate a random one for you. Your machine will initially be not available for login (SmartDataCenter must provision and boot it). You can poll GetMachine for status. When the state field is equal to running, you can log in.

NOTE:
CreateMachine no longer returns IP addresses as of SDC 7.0. To obtain the IP address of a newly-provisioned machine, poll ListMachines or GetMachine until the machine state is running or a failure.

With regards to login, if the machine is of type smartmachine, you can use any of the SSH keys managed under the keys section of CloudAPI to login, as any POSIX user on the OS. You can add/remove them over time, and the machine will automatically work with that set.

If the the machine is a virtualmachine, and of a UNIX-derived OS (e.g. Linux), you must have keys uploaded before provisioning; that entire set of keys will be written out to /root/.ssh/authorized_keys, and you can ssh in using one of those. Changing the keys over time under your account will not affect the running virtual machine in any way; those keys are statically written at provisioning-time only, and you will need to manually manage them.

If the image you create a machine from is set to generate passwords for you, the username/password pairs will be returned in the metadata response as a nested object, like:

"metadata": {
  "credentials": {
    "root": "s8v9kuht5e",
    "admin": "mf4bteqhpy"
  }
}

You cannot overwrite the credentials key in CloudAPI.

More generally, the metadata keys can be set either at machine creation time or after the fact. You must either pass in plain string values, or a JSON encoded string. On metadata retrieval, you will get back a "complex" JSON object.

Inputs

nameStringfriendly name for this machine; default is a randomly generated name
packageStringName of the package to use on provisioning; default is indicated in ListPackages
imageStringThe image UUID (the "id" field in ListImages)
networksArraydesired networks ids, obtained from ListNetworks
metadata.$nameStringAn arbitrary set of metadata key/value pairs can be set at provision time, but they must be prefixed with "metadata."
tag.$nameStringAn arbitrary set of tags can be set at provision time, but they must be prefixed with "tag."
firewall_enabledBoolean(Added in SDC 7.0.)Completely enable or disable firewall for this machine

Returns

idStringThe globally unique id for this machine
nameStringThe "friendly" name for this machine
typeStringWhether this is a smartmachine or virtualmachine
stateStringThe current state of this machine
datasetURNThe dataset urn this machine was provisioned with (note that for new images/datasets w/o an URN, this value will be the dataset id, i.e, same value than the image attribute)
memoryNumberThe amount of memory this machine has (Mb)
diskNumberThe amount of disk this machine has (Gb)
ipsArray[String]The IP addresses this machine has
metadataObject[String => String]Any "extra" metadata this machine has
createdDate (ISO8601)When this machine was created
updatedDate (ISO8601)When this machine was updated
firewall_enabledBooleanCompletely enable or disable firewall for this machine
packageStringThe name of the package used to create this machine.
imageStringThe image id this machine was provisioned with

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InsufficientCapacityThere isn't enough capacity in this datacenter
InvalidArgumentIf one of the input parameters was invalid

CLI Command

sdc-createmachine

Example Request

POST /my/machines HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 455
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

Example Response

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: Joyent
Connection: close
Date: Wed, 13 Apr 2011 23:12:39 GMT
X-Api-Version: 7.0.0
X-RequestId: 04BF964B-C285-4BDF-84B1-762B8FDCADB1
X-Response-Time: 470
Content-Type: application/json
Content-Length: 197
Content-MD5: yuUKkqnVw/ZtHXTTeoWVDQ==

{
  "id": "55a366ce-6c30-4f88-a36b-53638bd0cb62",
  "name": abcd1234",
  "type": "smartmachine",
  "state": "provisioning",
  "dataset": nodejs-1.1.4",
  "image": "01b2c898-945f-11e1-a523-af1afbe22822",
  "memory": 128,
  "disk": 5120,
  "ips": [],
  "metadata": {},
  "created": "2011-06-03T00:02:31+00:00",
  "updated": "2011-06-03T00:02:31+00:00",
}

User-script

The special value metadata.user-script can be specified to provide a custom script which will be executed by the machine right after creation. This script can also be specified using the command line option -s or --script, which should point to the absolute path to the file we want to upload to our machine.

StopMachine (POST /:login/machines/:id?action=stop)

Allows you to shut down a machine. POST to the machine name with an action of 'stop'.

You can poll on GetMachine until the state is stopped.

Inputs

actionStringUse the exact string stop.

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to be stopped
InvalidArgumentIf action was invalid
MissingParameterIf action wasn't sent

CLI Command

sdc-stopmachine 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=stop

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:35:25 GMT
X-Api-Version: 7.0.0
X-RequestId: F09F3674-2151-434B-9911-29DD188057F0
X-Response-Time: 115
Content-Length: 0

StartMachine (POST /:login/machines/:id?action=start)

Allows you to boot up a machine. POST to the machine name with an action of start.

You can poll on GetMachine until the state is running.

Inputs

actionStringUse the exact string start.

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to be started
InvalidArgumentIf action was invalid
MissingParameterIf action wasn't sent

CLI Command

sdc-startmachine 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=start

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:35:25 GMT
X-Api-Version: 7.0.0
X-RequestId: F09F3674-2151-434B-9911-29DD188057F0
X-Response-Time: 115
Content-Length: 0

RebootMachine (POST /:login/machines/:id?action=reboot)

Allows you to 'reboot' a machine. POST to the machine name with an action of reboot.

You can poll on GetMachine until the state is running.

Inputs

actionStringUse the exact string reboot.

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to be stopped
InvalidArgumentIf action was invalid
MissingParameterIf action wasn't sent

CLI Command

sdc-rebootmachine 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=reboot

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:35:25 GMT
X-Api-Version: 7.0.0
X-RequestId: F09F3674-2151-434B-9911-29DD188057F0
X-Response-Time: 115
Content-Length: 0

ResizeMachine (POST /:login/machines/:id?action=resize)

Allows you to resize a SmartMachine. POST to the machine id with an action of resize.

Virtual machines can also be resized but, only resizing virtual machines to a higher capacity package is supported.

You must additionally include a new package name, as you can only resize a machine to another package.

Inputs

actionStringUse the exact string resize
packageStringUse a package name returned from ListPackages

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to be resized
InvalidArgumentIf action was invalid or package wasn't a valid name
MissingParameterIf action wasn't sent or package wasn't sent

CLI Command

sdc-resizemachine -p regular_512 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=resize&package=regular_512

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
x-api-version: 7.0.0
Date: Sat, 11 Jun 2011 18:31:14 GMT
Server: SmartDataCenter
x-request-id: 3974ead1-0f1d-49ed-974c-1abfd13d6087
x-response-time: 161
Content-Length: 0

RenameMachine (POST /:login/machines/:id?action=rename)

Allows you to rename a machine. POST to the machine id with an action of rename. You must additionally include a new name for the machine.

Inputs

actionStringUse the exact string rename
nameStringThe new "friendly" name for this machine

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to be stopped
InvalidArgumentIf action was invalid or name wasn't a valid name
MissingParameterIf action wasn't sent or name wasn't sent

CLI Command

sdc-renamemachine -n new_friendly_name 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=rename&name=new_friendly_name

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
x-api-version: 7.0.0
Date: Sat, 11 Jun 2011 18:31:14 GMT
Server: SmartDataCenter
x-request-id: 3974ead1-0f1d-49ed-974c-1abfd13d6087
x-response-time: 161
Content-Length: 0

EnableMachineFirewall (POST /:login/machines/:id?action=enable_firewall)

Allows you to enable firewall for a machine.

Inputs

actionStringUse the exact string enable_firewall

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to enable firewall
InvalidArgumentIf action was invalid
MissingParameterIf action wasn't sent

CLI Command

sdc-enablemachinefirewall 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=enable_firewall

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
x-api-version: 7.0.0
Date: Sat, 11 Jun 2011 18:31:14 GMT
Server: SmartDataCenter
x-request-id: 3974ead1-0f1d-49ed-974c-1abfd13d6087
x-response-time: 161
Content-Length: 0

DisableMachineFirewall (POST /:login/machines/:id?action=disable_firewall)

Allows you to completelly disable firewall for a machine.

Inputs

actionStringUse the exact string disable_firewall

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to disable firewall
InvalidArgumentIf action was invalid
MissingParameterIf action wasn't sent

CLI Command

sdc-disablemachinefirewall 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

POST /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

action=disable_firewall

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
x-api-version: 7.0.0
Date: Sat, 11 Jun 2011 18:31:14 GMT
Server: SmartDataCenter
x-request-id: 3974ead1-0f1d-49ed-974c-1abfd13d6087
x-response-time: 161
Content-Length: 0

CreateMachineSnapshot (POST /:login/machines/:id/snapshots)

Allows you to take a snapshot of a machine. Note that snapshots are not usable with other machines; they are a point in time snapshot of "this" machine. Once you have one or more snapshots, you can boot the machine from a snapshot.

You can only take snapshots on machines that are of type 'smartmachine'.

You can poll on GetMachineSnapshot until the state is success.

Inputs

nameStringThe name to assign to the new snapshot.

Returns

nameStringThe name of this snapshot
stateStringThe current state of the snapshot

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist
InvalidArgumentIf name was invalid, or :id was not a smartmachine

CLI Command

sdc-createmachinesnapshot -n just-booted 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

POST /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/snapshots HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

name=just-booted

Example Response

HTTP/1.1 201 Created
Location: /mark/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/snapshots/just-booted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 116

{
  "name": "just-booted",
  "state": "queued",
  "created": "2011-07-05T17:19:26+00:00",
  "updated": "2011-07-05T17:19:26+00:00"
}

StartMachineFromSnapshot (POST /:login/machines/:id/snapshots/:name)

If a machine is in the 'stopped' state, you can choose to start the machine from the referenced snapshot.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login, :id or :name does not exist

CLI Command

sdc-startmachinefromsnapshot -n just-booted 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

POST /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/snapshots/just-booted HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 0
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

Example Response

HTTP/1.1 202 Accepted
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:26:56 GMT
Server: SmartDataCenter
X-Request-Id: af79d9cd-68c5-4002-95c6-af4c3ff0f1e4
X-Response-Time: 297
Content-Length: 0

ListMachineSnapshots (GET /:login/machines/:id/snapshots)

Lists all snapshots taken for a given machine. There are no filtration parameters for this API.

Inputs

Returns

An array of snapshots:

nameStringThe name of this snapshot
stateStringThe current state of the snapshot

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login, :id or :name does not exist

CLI Command

sdc-listmachinesnapshots 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

GET /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/snapshots HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 0
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 06a57272-9238-4276-951b-4123fbfdb948
X-Response-Time: 66
Content-Type: application/json
Content-MD5: UYdtqgRjRZVikfCM5Uf4XQ==
Content-Length: 119

[
  {
    "name": "just-booted",
    "state": "queued",
    "created": "2011-07-05T17:19:26+00:00",
    "updated": "2011-07-05T17:19:26+00:00"
  }
]

GetMachineSnapshot (GET /:login/machines/:id/snapshots/:name)

Gets the state of the named snapshot.

Inputs

Returns

nameStringThe name of this snapshot
stateStringThe current state of the snapshot (poll until it's "created")

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login, :id or :name does not exist

CLI Command

sdc-getmachinesnapshot -n just-booted 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

GET /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/snapshots/just-booted HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 0
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:26:56 GMT
Server: SmartDataCenter
X-Request-Id: af79d9cd-68c5-4002-95c6-af4c3ff0f1e4
X-Response-Time: 297
Content-Type: application/json
Content-MD5: VoPeS9cac4YMBIs8gUkd/A==
Content-Length: 117

{
  "name": "just-booted",
  "state": "queued",
  "created": "2011-07-05T17:19:26+00:00",
  "updated": "2011-07-05T17:19:26+00:00"
}

DeleteMachineSnapshot (DELETE /:login/machines/:id/snapshots/:name)

Deletes the specified snapshot of a machine.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login, :id or :name does not exist

CLI Command

sdc-deletemachinesnapshot -m 5e42cd1e-34bb-402f-8796-bf5a2cae47db just-booted

Example Request

DELETE /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/snapshots/just-booted HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 0
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:26:56 GMT
Server: SmartDataCenter
X-Request-Id: af79d9cd-68c5-4002-95c6-af4c3ff0f1e4
X-Response-Time: 297
Content-Length: 0

UpdateMachineMetadata (POST /:login/machines/:id/metadata)

Allows you to update the metadata for a given machine. Note that updating the metadata via CloudAPI will result in the metadata being updated in the running instance.

The semantics of this call are sublty different that the AddMachineTags call, in that any metadata keys passed in here are created if they do not exist, and overwritten if they do.

Inputs

FieldTypeDescription
$keyStringYou can assign any number of metadata keys in this call; the string can be either a plain string, or a JSON encoded string, which will be converted to a "proper" JSON object.

Returns

Returns the current set of tags.

FieldTypeDescription
$keyObjectYour value

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

./sdc-updatemachinemetadata -m foo=bar -m group=test cf055959-d776-482e-bd71-ca510a04bdd7

Example Request

POST /my/machines/cf055959-d776-482e-bd71-ca510a04bdd7/metadata HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

foo=bar&group=test

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 116

{
  "foo": "bar",
  "group": "test"
}

GetMachineMetadata (GET /:login/machines/:id/metadata)

Returns the complete set of metadata associated with this machine.

Inputs

FieldTypeDescription
credentialsBooleanWhether or not to return machine credentials. Defaults to false.

Returns

Returns the current metadata object

FieldTypeDescription
$nameObjectYour value

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

sdc-getmachinemetadata cf055959-d776-482e-bd71-ca510a04bdd7

Example Request

GET /my/machines/cf055959-d776-482e-bd71-ca510a04bdd7/metadata?credentials=true HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 116

{
  "foo": "bar",
  "group": "test",
  "credentials": {
    "root": "s8v9kuht5e",
    "admin": "mf4bteqhpy"
  }
}

DeleteMachineMetadata (DELETE /:login/machines/:id/metadata/:key)

Deletes a single metadata key from this machine.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

sdc-deletemachinemetadata -m foo cf055959-d776-482e-bd71-ca510a04bdd7

Example Request

DELETE /my/machines/cf055959-d776-482e-bd71-ca510a04bdd7/metadata/foo HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 0

DeleteAllMachineMetadata (DELETE /:login/machines/:id/metadata)

Deletes all metadata keys from this machine.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

sdc-deletemachinemetadata -m "*" cf055959-d776-482e-bd71-ca510a04bdd7

Note that if you're running in a Unix-like environment, you need to quote the wildcard to keep the shell from matching files in the current directory.

Example Request

DELETE /my/machines/cf055959-d776-482e-bd71-ca510a04bdd7/metadata HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 0

AddMachineTags (POST /:login/machines/:id/tags)

Allows you to add additional tags, other than those set at provisioning time. This API lets you append new tags, not overwrite existing tags.

This call allows you to send any number of parameters; all of these will be converted into tags on the machine that can be used for searching later.

Inputs

FieldTypeDescription
$tagNameStringYou can assign any number of tags in this call

Returns

Returns the current set of tags.

FieldTypeDescription
$tagNameStringYour value

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

sdc-addmachinetags -t foo=bar -t group=test 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

POST /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/tags HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

foo=bar&group=test

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 116

{
  "foo": "bar",
  "group": "test"
}

ReplaceMachineTags (PUT /:login/machines/:id/tags)

Allows you to replace all machine tags. This API lets you overwrite existing tags, not append to existing tags.

This call allows you to send any number of parameters; all of these will be converted into tags on the machine that can be used for searching later.

Inputs

FieldTypeDescription
$tagNameStringYou can assign any number of tags in this call

Returns

Returns the current set of tags.

FieldTypeDescription
$tagNameStringYour value

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

sdc-replacemachinetags -t foo=bar -t group=test 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

PUT /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/tags HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
Content-Length: 12
Content-Type: application/x-www-form-urlencoded
X-Api-Version: ~7.0

foo=bar&group=test

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2012 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 116

{
  "foo": "bar",
  "group": "test"
}

ListMachineTags (GET /:login/machines/:id/tags)

Returns the complete set of tags associated with this machine.

Inputs

Returns

Returns the current set of tags.

FieldTypeDescription
$tagNameStringYour value

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or the machine :id does not exist

CLI Command

sdc-listmachinetags 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

GET /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/tags HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: application/json
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 116

{
  "foo": "bar",
  "group": "test"
}

GetMachineTag (GET /:login/machines/:id/tags/:tag)

Returns the value for a single tag on this machine. Note that this API is "special", as it returns content in text/plain; this also means you must set the Accept header to text/plain.

Inputs

Returns

Returns the value of :tag in plain text.

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login, :id or :tag does not exist

CLI Command

sdc-getmachinetag -t foo 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

GET /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/tags/foo HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: text/plain
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 Ok
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Type: text/plain
Content-MD5: qKVbfrhXVqh7Oni6Pub9Pw==
Content-Length: 3

bar

DeleteMachineTag (DELETE /:login/machines/:id/tags/:tag)

Deletes a single tag from this machine.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login, :id or :tag does not exist

CLI Command

sdc-deletemachinetag -t foo 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Example Request

DELETE /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/tags/foo HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: text/plain
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Length: 0

DeleteMachineTags (DELETE /:login/machines/:id/tags)

Deletes all tags from this machine.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login or :id does not exist

CLI Command

sdc-deletemachinetag -t "*" 5e42cd1e-34bb-402f-8796-bf5a2cae47db

Note that if you're running in a Unix-like environment, you need to quote the wildcard to keep the shell from matching files in the current directory.

Example Request

DELETE /my/machines/5e42cd1e-34bb-402f-8796-bf5a2cae47db/tags HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: text/plain
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Connection: close
X-Api-Version: 7.0.0
Date: Tue, 05 Jul 2011 17:19:26 GMT
Server: SmartDataCenter
X-Request-Id: 4bcf467e-4b88-4ab4-b7ab-65fad7464de9
X-Response-Time: 754
Content-Length: 0

DeleteMachine (DELETE /:login/machines/:id)

Allows you to completely destroy a machine. Machine must be in the stopped state first.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidStateThe machine is in an invalid state to be deleted

CLI Command

sdc-deletemachine 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

DELETE /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:38:03 GMT
X-Api-Version: 7.0.0
X-RequestId: 762C3F37-8ACA-4A49-AF10-84CEC8137B1D
X-Response-Time: 72
Content-Length: 0

MachineAudit (GET /:login/machines/:id/audit)

Provides a list of machine's accomplished actions, (sorted from latest to older one).

Inputs

Returns

actionStringThe name of the action
parametersObjectThe original set of parameters sent when the action was requested
timeDate (ISO8601)When the action finished
successStringEither "yes" or "no", depending on the action successfulness
callerObjectAccount requesting the action

Depending on the account requesting the action, caller can have the following members:

typeStringAuthentication type for the action request. One of "basic", "operator", "signature" or "token"
userStringWhen the authentication type is "basic", this member will be present and include user login
ipStringThe IP addresses this from which the action was requested. Not present if type is "operator"
keyIdStringWhen authentication type is either "signature" or "token", SSH key identifier

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or :machine does not exist

CLI Command

sdc-getmachineaudit 75cfe125-a5ce-49e8-82ac-09aa31ffdf26

Example Request

GET /my/machines/75cfe125-a5ce-49e8-82ac-09aa31ffdf26/audit HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 191
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
content-md5: GRmOq/dAdKZJ4wVpEelRrQ==
date: Fri, 22 Feb 2013 15:19:37 GMT
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 453aee00-7d03-11e2-8048-5195b6159808
response-time: 34
x-request-id: 453aee00-7d03-11e2-8048-5195b6159808
x-api-version: 7.0.0
x-response-time: 34

[{
    "success": "yes",
    "time": "2013-02-22T15:19:32.522Z",
    "action": "provision",
    "caller": {
      "type": "signature",
      "ip": "127.0.0.1",
      "keyId": "/:login/keys/:fingerprint"
    }
  }, ...]

Analytics

It is strongly recommended that before you read the API documentation for Analytics, you first read through Appendix B: Cloud Analytics. Most supporting documentation and explanation of types and interactions are described there.

DescribeAnalytics (GET /:login/analytics)

Supports retrieving the "schema" for instrumentations that can be created using the analytics endpoint.

Inputs

Returns

A large object that reflects the analytics available to you. Each of the items listed below is actually an object; the "keys" in each are what can be used. For example, in 'modules', you'll get something like:

{
  "modules": {
    "cpu": { "label": "CPU" },
    "memory": { "label": "Memory" },
    ...
  },
  "fields": {
    "hostname": {
      "label": "server hostname",
      "type": "string"
    },
    "runtime": {
      "label": "time on CPU",
      "type": "time"
    },
    "zonename": {
      "label": "zone name",
      "type": "string"
    }
  },
  "types": {
    "string": {
      "arity": "discrete",
      "unit": ""
    },
    "size": {
      "arity": "numeric",
      "unit": "bytes",
      "abbr": "B",
      "base": 2,
    },
    "time": {
      "arity": "numeric",
      "unit": "seconds",
      "abbr": "s",
      "base": 10,
      "power": -9,
    }
  },
  "metrics": [ {
    "module": "cpu",
    "stat": "thread_executions",
    "label": "thread executions",
    "interval": "interval",
    "fields": [ "hostname", "zonename", "runtime" ],
    "unit": "operations"
  }, {
    "module": "memory",
    "stat": "rss",
    "label": "resident set size",
    "interval": "point",
    "fields": [ "hostname", "zonename" ],
    "type": "size"
  } ],
  "transformations": {
    "geolocate": {
      "label": "geolocate IP addresses",
      "fields": [ "raddr" ]
    },
    "reversedns": {
      "label": "reverse dns IP addresses lookup",
      "fields": [ "raddr" ]
    }
  }
}

You can use cpu, memory as module parameters to the other APIs.

FieldType
modulesObject
fieldsObject
typesObject
typesObject
metricsObject
transformationsObject

Each of these objects is discussed below:

Modules

Each metric is identified by both a module and stat name. Modules exist as namespaces to organize metrics. Module configuration looks like this:

"modules": {
  "cpu": {
    "label": "CPU" },
    "memory": { "label": "Memory" },
    ...
  }

Each module has a name (its key in the "modules" structure) and an object with a single field called label which is its human-readable label.

Metrics

Metrics describe quantities which can be measured by the system. Data is not collected for metrics unless an instrumentation has been configured for it.

"metrics": [ {
  "module": "cpu",
  "stat": "thread_executions",
  "label": "thread executions",
  "interval": "interval",
  "fields": [ "hostname", "zonename", "runtime" ],
  "unit": "operations"
}, {
  "module": "memory",
  "stat": "rss",
  "label": "resident set size",
  "interval": "point",
  "fields": [ "hostname", "zonename" ],
  "type": "size"
} ]

Each metric has the following properties:

FieldTypeDescription
moduleStringWith stat, a unique metric identifier
statStringWith module, a unique metric identifier
labelStringA human-readable metric description
intervalStringeither "interval" or "point", indicating whether the value of this metric covers activity over an interval of time or a snapshot of state at a particular point* in time
fieldsArraya list of fields to be used for predicates and decompositions
typeStringtype or unit used to display labels for values of this metric

Fields

Fields represent metadata by which data points can be filtered or decomposed.

"fields": {
  "pid": {
    "label": "process identifier",
    "type": "string"
  },
  "execname": {
    "label": "application name",
    "type": "string"
  },
  "psargs": {
    "label": "process arguments",
    "type": "string"
  },
  ...

Each field has the following properties:

FieldTypeDescription
labelStringhuman-readable description of the field
typeStringtype of the field, which determines how to label it as well as whether the field is numeric or discrete

Fields are either numeric or discrete based on the "arity" of their type.

Numeric fields
Discrete fields

Note that some fields look like numbers but are used by software as identifiers and so are actually discrete fields. Examples include process identifiers, which are numbers but for which it doesn't generally make sense to compare using inequalities or decompose to get a numeric distribution.

Types

Types are used with both metrics and fields for two purposes: to hint to clients at how to best label values, and to distinguish between numeric and discrete quantities.

"types": {
  "string": {
    "arity": "discrete",
    "unit": ""
  },
  "size": {
    "arity": "numeric",
    "unit": "bytes",
    "abbr": "B",
    "base": 2,
  },
  "time": {
    "arity": "numeric",
    "unit": "seconds",
    "abbr": "s",
    "base": 10,
    "power": -9,
   }
 }

Each type has the following properties:

FieldTypeDescription
arityStringindicates whether values of this type are "discrete" (e.g., identifiers and other strings), or "numeric" (e.g., measurements)
unitStringbase unit for this type
abbrString(optional) abbreviation for this base unit for this type
baseNumberindicates that when labeled, this quantity is usually labeled with SI prefixes corresponding to powers of the specified base
powerNumberthis indicates that the raw values of this type are expressed in units corresponding to base raised to power

Transformations

Transformations are post-processing functions that can be applied to data when it's retrieved.

"transformations": {
  "geolocate": {
    "label": "geolocate IP addresses",
    "fields": [ "raddr" ]
  },
  "reversedns": {
    "label": "reverse dns IP addresses lookup",
    "fields": [ "raddr" ]
  }
}

Each transformation has the following properties:

FieldTypeDescription
labelStringHuman readable string
fieldsArraylist of field names that can be transformed

The above transformations transform values of the "raddr" (remote address) field of any metric to either an object with geolocation details or an array of reverse-DNS hostnames, respectively.

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI Command

sdc-describeanalytics

Example Request

GET /my/analytics HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:40:30 GMT
X-Api-Version: 7.0.0
X-RequestId: 83BB32FC-1F65-4FEB-871E-BABCD96D588D
X-Response-Time: 285
Content-Type: application/json
Content-Length: 2806
Content-MD5: M4mXJlxSgflBnhXPYYCp1g==

{
  "modules": {
    "cpu": {
      "label": "CPU"
    },
    "fs": {
      "label": "Filesystem"
    },
    "node": {
      "label": "Node.js 0.4.x"
    }
  },
  // ....
}

ListInstrumentations (GET /:login/analytics/instrumentations)

Retrieves all currently created instrumentations.

Inputs

Returns

An array of instrumentations:

FieldType
moduleString
statString
predicateString
decompositionArray
value-dimensionNumber
value-arityString
retention-timeNumber
granularityNumber
idle-maxNumber
transformationsArray
persist-dataBoolean
crtimeNumber
value-scopeString
idString
urisArray

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidArgumentIf input values were incorrect

CLI

sdc-listinstrumentations

Example Request

GET /my/analytics/instrumentations HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:49:40 GMT
X-Api-Version: 7.0.0
X-RequestId: 99839114-1B59-4733-AC64-A93144CA7D8B
X-Response-Time: 48
Content-Type: application/json
Content-Length: 1062
Content-MD5: 8dSboZrGVMsaRYWGFbq88A==


[
  {
    "module": "syscall",
    "stat": "syscalls",
    "predicate": {},
    "decomposition": [],
    "value-dimension": 1,
    "value-arity": "scalar",
    "enabled": true,
    "retention-time": 600,
    "idle-max": 3600,
    "transformations": {},
    "nsources": 1,
    "granularity": 1,
    "persist-data": false,
    "crtime": 1309457451143,
    "value-scope": "interval",
    "id": "42",
    "uris": [{
      "uri": "/admin/analytics/instrumentations/42/value/raw",
      "name": "value_raw"
    }]
  }
}

GetInstrumentation (GET /:login/analytics/instrumentations/:id)

Retrieves the configuration for an instrumentation.

Inputs

Returns

FieldType
moduleString
statString
predicateString
decompositionArray
value-dimensionNumber
value-arityString
retention-timeNumber
granularityNumber
idle-maxNumber
transformationsArray
persist-dataBoolean
crtimeNumber
value-scopeString
idString
urisArray

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidArgumentIf input values were incorrect

CLI

sdc-getinstrumentation 1

Example Request

GET /my/analytics/instrumentations/1 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Location: /my/analytics/instrumentations/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:53:29 GMT
X-Api-Version: 7.0.0
X-RequestId: E79B48A2-EC5B-475E-A473-1AF0053FCF4F
X-Response-Time: 60
Content-Type: application/json
Content-Length: 530
Content-MD5: kOuwnsK6U9yQY7MpN3lEvQ==

{
  "module": "syscall",
  "stat": "syscalls",
  "predicate": {},
  "decomposition": [],
  "value-dimension": 1,
  "value-arity": "scalar",
  "enabled": true,
  "retention-time": 600,
  "idle-max": 3600,
  "transformations": {},
  "nsources": 1,
  "granularity": 1,
  "persist-data": false,
  "crtime": 1309374801692,
  "value-scope": "interval",
  "id": "2",
  "uris": [
    {
      "uri": "/my/analytics/instrumentations/2/value/raw",
      "name": "value_raw"
    }
  ]
}

GetInstrumentationValue (GET /:login/analytics/instrumentations/:id/value/raw)

Retrieves the data associated to an instrumentation for a point(s) in time.

Inputs

Returns

FieldType
valueObject
transformationsObject
start_timeNumber
durationNumber

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidArgumentIf input values were incorrect

CLI

sdc-getinstrumentation -v 1

Example Request

GET /my/analytics/instrumentations/1/value/raw
Host: api.example.com
Authorization: ...
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:53:29 GMT
X-Api-Version: 7.0.0
X-RequestId: E79B48A2-EC5B-475E-A473-1AF0053FCF4F
X-Response-Time: 60
Content-Type: application/json
Content-Length: 530
Content-MD5: kOuwnsK6U9yQY7MpN3lEvQ==

{
  "value": [
    [ [ 17000, 17999 ], 12 ],
    [ [ 18000, 18999 ], 12 ],
    ...
  ],
  "transformations": {},
  "start_time": 1309383598,
  "duration": 1,
  "nsources": 1,
  "minreporting": 1,
  "requested_start_time": 1309383598,
  "requested_duration": 1,
  "requested_end_time": 1309383599
}

GetInstrumentationHeatmap (GET /:login/analytics/instrumentations/:id/value/heatmap/image)

Retrieves a particular instrumentation's heatmap.

Inputs

FieldTypeDescription
heightNumberheight of the image in pixels
widthNumberwidth of the image in pixels
yminNumberY-Axis value for the bottom of the image (default: 0)
ymaxNumberY-Axis value for the top of the image (default: auto)
nbucketsNumberNumber of buckets in the vertical dimension
selectedArrayArray of field values to highlight, isolate or exclude
isolateBooleanIf true, only draw selected values
excludeBooleanIf true, don't draw selected values at all
huesArrayArray of colors for highlighting selected field values
decompose_allBooleanhighlight all field values (possibly reusing hues)

Returns

FieldTypeDescription
bucket_timeNumbertime corresponding to the bucket (Unix seconds)
bucket_yminNumberMinimum y-axis value for the bucket
bucket_ymaxNumberMaximum y-axis value for the bucket
presentObjectif the instrumentation defines a discrete decomposition, this property's value is an object whose keys are values of that field and whose values are the number of data points in that bucket for that key
totalNumberThe total number of data points in the bucket

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidArgumentIf input values were incorrect

CLI

Example Request

GET /my/analytics/instrumentations/1/heatmap/image HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Connection: close
X-Api-Version: 7.0.0
Date: Wed, 29 Jun 2011 23:57:44 GMT
Server: SmartDataCenter
X-Request-Id: 3d511185-36b8-4699-9cdd-a67bf8be7a6d
X-Response-Time: 109
Content-Type: application/json
Content-MD5: r5tPNDLr1HQE1tsLNqPbvg==
Content-Length: 2052

{
  "nbuckets": 100,
  "width": 600,
  "height": 300,
  "ymin": 0,
  "ymax": 400000,
  "present": [],
  "transformations": {},
  "image": "iVBORw0KGgoAAA...",
  "start_time": 1309391804,
  "duration": 60,
  "nsources": 1,
  "minreporting": 1,
  "requested_start_time": 1309391804,
  "requested_duration": 60,
  "requested_end_time": 1309391864
  }

GetInstrumentationHeatmapDetails (GET /:login/analytics/instrumentations/:id/value/heatmap/details)

Allows you to retrieve the bucket details for a heatmap.

Inputs

Takes all the same parameters as GetInstrumentationHeatmap, and additionally:

FieldType
xNumber
yNumber

Returns

The returned value includes:

FieldType
bucket_timeNumber
bucket_yminNumber
bucket_ymaxNumber
presentObject
totalNumber

Errors

CLI

Example Request

Example Response

CreateInstrumentation (POST /:login/analytics/instrumentations)

Creates an instrumentation. Note you can clone an existing instrumentation by passing in the parameter clone, which should be a numeric id of an existing instrumentation.

Inputs

FieldTypeDescription
cloneNumberAn existing instrumentation
moduleStringThe CA module
statStringThe CA stat
predicateStringMust be a JSON string
decompositionStringAn array of arrays
granularityNumberdefault is 1: number of seconds between data points
retention-timeNumberHow long to keep this instrumentation data for
persist-dataBooleanWhether or not to store this for historical analysis
idle-maxNumbernumber of seconds after which if the instrumentation or its data has not been accessed via the API the service may delete the instrumentation and its data

Returns

FieldType
moduleString
statString
predicateString
decompositionArray
value-dimensionNumber
value-arityString
retention-timeNumber
granularityNumber
idle-maxNumber
transformationsArray
persist-dataBoolean
crtimeNumber
value-scopeString
idString
urisArray

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist
InvalidArgumentIf input values were incorrect
MissingParameterIf parameter values were missing

CLI

sdc-createinstrumentation -m syscall -s syscalls

Example Request

POST /my/analytics/instrumentations HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0
Content-Length: 12
Content-Type: application/x-www-form-urlencoded

module=syscall&stat=syscalls

Example Response

HTTP/1.1 201 Created
Location: https://api.example.com/my/analytics/instrumentations/2
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:43:24 GMT
X-Api-Version: 7.0.0
X-RequestId: F4238406-ED7D-4938-937B-4E3D0F93D924
X-Response-Time: 1508
Content-Type: application/json
Content-Length: 544
Content-MD5: CrcS3CTR5mwpOvJEx60s1g==

{
  "module": "syscall",
  "stat": "syscalls",
  "predicate": {},
  "decomposition": [],
  "value-dimension": 1,
  "value-arity": "scalar",
  "enabled": true,
  "retention-time": 600,
  "idle-max": 3600,
  "transformations": {},
  "nsources": 1,
  "granularity": 1,
  "persist-data": false,
  "crtime": 1309374801692,
  "value-scope": "interval",
  "id": "2",
  "uris": [
    {
      "uri": "/mark/analytics/instrumentations/2/value/raw",
      "name": "value_raw"
    }
  ]
}

DeleteInstrumentation (DELETE /:login/analytics/instrumentations/:id)

Destroys an instrumentation.

Inputs

Returns

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI

sdc-deleteinstrumentation 1

Example Request

DELETE /my/analytics/instrumentations/1 HTTP/1.1
Authorization: ...
Host: api.example.com
Accept: application/json
X-Api-Version: ~7.0

Example Response

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, DELETE
Server: SmartDataCenter
Connection: close
Date: Wed, 13 Apr 2011 23:56:29 GMT
X-Api-Version: 7.0.0
X-RequestId: E4DD448D-F491-4A88-9237-DAF6C4DC782C
X-Response-Time: 49
Content-Length: 0

FirewallRules

It's possible to manage Firewall Rules for your machines through Cloud API.

Firewall Rule Syntax

In general, the firewall rule is composed of the following pieces:

FROM <target a> TO <target b> <action> <protocol> <port>

where target can be one of wildcard, ip, subnet, tag or vm, action is either ALLOW or BLOCK, protocol will be one between tcp, udp and icmp, and port is a valid port number.

The following are examples of different possibilities for firewall rules syntax:

Allow incoming http traffic to a VM:

{
    "enabled": true,
    "rule": "FROM subnet 10.99.99.0/24 TO vm 0abeae82-c040-4080-ac60-b60d3e3890a7 ALLOW tcp port 80"
}

Block outgoing SMTP traffic from a VM to a subnet:

{
    "enabled": true,
    "rule": "FROM vm 0abeae82-c040-4080-ac60-b60d3e3890a7 TO subnet 10.99.99.0/24 BLOCK tcp port 25"
}

Allow an IP HTTP and HTTPS access to all VMs tagged www or testwww:

{
    "enabled": true,
    "rule": "FROM ip 10.99.99.7 TO (tag www OR tag testwww) ALLOW tcp (port 80 AND port 443)"
}

Allow syslog traffic from VMs tagged www to VMs taged mon:

{
    "enabled": true,
    "rule": "FROM tag www TO tag mon ALLOW udp port 514"
}

ListFirewallRules (GET /:login/fwrules)

List all the firewall rules we have on record for the specified account

Inputs

Returns

An array of firewall rule objects. Firewall Rules are:

FieldTypeDescription
idStringUnique identifier for this rule
enabledBooleanIndicates if the rule is or not enabled
ruleStringFirewall Rule text

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI

sdc-listfirewallrules

Example Request

GET /login/fwrules HTTP/1.1
authorization: Signature keyId="...
accept: application/json
accept-version: ~7.0
host: api.example.com
connection: keep-alive

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 158
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
content-md5: v6s92rl/nTS2Ts5CNDcgQw==
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 35147710-7f49-11e2-8585-bd5fc323c72c
response-time: 134
x-request-id: 35147710-7f49-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 134

[
  {
    "id": "38de17c4-39e8-48c7-a168-0f58083de860",
    "rule": "FROM vm 3d51f2d5-46f2-4da5-bb04-3238f2f64768 TO subnet 10.99.99.0/24 BLOCK tcp PORT 25",
    "enabled": true
  }
]

GetFirewallRule (GET /:login/fwrules/:id)

Retrieves an individual firewall rule record.

Inputs

Returns

FieldTypeDescription
idStringUnique identifier for this rule
enabledBooleanIndicates if the rule is or not enabled
ruleStringFirewall Rule text

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI

sdc-getfirewallrule fwruleid

Example Request

GET /login/fwrules/38de17c4-39e8-48c7-a168-0f58083de860 HTTP/1.1
authorization: Signature keyId="...
accept: application/json
accept-version: ~7.0
host: api.example.com

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 156
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: cf1c1340-7f49-11e2-8585-bd5fc323c72c
response-time: 203
x-request-id: cf1c1340-7f49-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 203

{
  "id": "38de17c4-39e8-48c7-a168-0f58083de860",
  "rule": "FROM vm 3d51f2d5-46f2-4da5-bb04-3238f2f64768 TO subnet 10.99.99.0/24 BLOCK tcp PORT 25",
  "enabled": true
}

CreateFirewallRule (POST /:login/fwrules)

Adds a new firewall rule for the specified account. Note that this rule will be added to all the account machines where it may be necessary.

Inputs

FieldTypeDescription
enabledBooleanIndicates if the rule is or not enabled (optional, false by default)
ruleStringFirewall Rule text (mandatory)

Returns

Firewall rule object.

FieldTypeDescription
idStringUnique identifier for this rule
enabledBooleanIndicates if the rule is or not enabled
ruleStringFirewall Rule text

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
InvalidArgumentIf rule is invalid
MissingParameterIf you didn't send a rule
ResourceNotFoundIf :login does not exist

CLI

sdc-createfirewallrule --rule='...' --enabled=true

Example Request

POST /login/fwrules HTTP/1.1
authorization: Signature keyId="...
accept: application/json
content-type: application/json
accept-version: ~7.0
content-length: 112
host: api.example.com

Example Response

HTTP/1.1 201 Created
content-type: application/json
content-length: 156
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 2c0a2a20-7f49-11e2-8585-bd5fc323c72c
response-time: 36
x-request-id: 2c0a2a20-7f49-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 36

{
  "id": "38de17c4-39e8-48c7-a168-0f58083de860",
  "rule": "FROM vm 3d51f2d5-46f2-4da5-bb04-3238f2f64768 TO subnet 10.99.99.0/24 BLOCK tcp PORT 25",
  "enabled": true
}

UpdateFirewallRule (POST /:login/fwrules/:id)

Updates the given rule record and, depending on rule contents, adds/removes/updates the rule from all the required account machines.

Inputs

FieldTypeDescription
ruleStringFirewall Rule text (mandatory)

Returns

Firewall rule object.

FieldTypeDescription
idStringUnique identifier for this rule
enabledBooleanIndicates if the rule is or not enabled
ruleStringFirewall Rule text

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
InvalidArgumentIf rule is invalid
MissingParameterIf you didn't send a rule
ResourceNotFoundIf :login does not exist or rule with :id does not exist

CLI

sdc-updatefirewallrule fwruleid

Example Request

POST /login/fwrules/38de17c4-39e8-48c7-a168-0f58083de860 HTTP/1.1
authorization: Signature keyId="...
accept: application/json
content-type: application/json
accept-version: ~7.0
content-length: 111
host: api.example.com

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 170
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 284907d0-7f67-11e2-8585-bd5fc323c72c
response-time: 225
x-request-id: 284907d0-7f67-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 225

{
  "id": "38de17c4-39e8-48c7-a168-0f58083de860",
  "rule": "FROM vm 3d51f2d5-46f2-4da5-bb04-3238f2f64768 TO subnet 10.99.99.0/24 BLOCK tcp (PORT 25 AND PORT 80)",
  "enabled": true
}

EnableFirewallRule (POST /:login/fwrules/:id/enable)

Enables the given firewall rule record if it is disabled.

Inputs

Returns

Firewall rule

FieldTypeDescription
idStringUnique identifier for this rule
enabledBooleanIndicates if the rule is or not enabled
ruleStringFirewall Rule text

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or rule with :id does not exist

CLI

sdc-enablefirewallrule fwruleid

Example Request

POST /login/fwrules/38de17c4-39e8-48c7-a168-0f58083de860/enable HTTP/1.1
authorization: Signature keyId="...
accept: application/json
content-type: application/json
accept-version: ~7.0
content-length: 2
host: api.example.com

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 170
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 1ebe23c0-7f68-11e2-8585-bd5fc323c72c
response-time: 232
x-request-id: 1ebe23c0-7f68-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 232

{
  "id": "38de17c4-39e8-48c7-a168-0f58083de860",
  "rule": "FROM vm 3d51f2d5-46f2-4da5-bb04-3238f2f64768 TO subnet 10.99.99.0/24 BLOCK tcp (PORT 25 AND PORT 80)",
  "enabled": true
}

DisableFirewallRule (POST /:login/fwrules/:id/disable)

Disables the given firewall rule record if it is enabled.

Inputs

Returns

Firewall rule

FieldTypeDescription
idStringUnique identifier for this rule
enabledBooleanIndicates if the rule is or not enabled
ruleStringFirewall Rule text

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or rule with :id does not exist

CLI

sdc-disablefirewallrule fwruleid

Example Request

POST /login/fwrules/38de17c4-39e8-48c7-a168-0f58083de860/disable HTTP/1.1
authorization: Signature keyId="...
accept: application/json
content-type: application/json
accept-version: ~7.0
content-length: 2
host: api.example.com

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 171
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
content-md5: E7I47cYr/F7S4J68NbK1AQ==
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 8a2d7490-7f67-11e2-8585-bd5fc323c72c
response-time: 234
x-request-id: 8a2d7490-7f67-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 234

{
  "id": "38de17c4-39e8-48c7-a168-0f58083de860",
  "rule": "FROM vm 3d51f2d5-46f2-4da5-bb04-3238f2f64768 TO subnet 10.99.99.0/24 BLOCK tcp (PORT 25 AND PORT 80)",
  "enabled": false
}

DeleteFirewallRule (DELETE /:login/fwrules/:id)

Removes the given firewall rule record from all the required account machines.

Inputs

Returns

An array of firewall rule objects. Firewall Rules are:

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist or rule with :id does not exist

CLI

sdc-deletefirewallrule fwruleid

Example Request

DELETE /login/fwrules/38de17c4-39e8-48c7-a168-0f58083de860 HTTP/1.1
authorization: Signature keyId="...
accept: application/json
accept-version: ~7.0
host: api.example.com

Example Response

HTTP/1.1 204 No Content
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 50a78b60-7f68-11e2-8585-bd5fc323c72c
response-time: 219
x-request-id: 50a78b60-7f68-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 219

ListMachineFirewallRules (GET /:login/machines/:machine/fwrules)

Exactly with the same input and output than List Firewall Rules but just for the rules affecting the given :machine.

ListFirewallRuleMachines (GET /:login/fwrules/:id/machines)

Will return the collection of machines affected by the firewall rule given by :id. The output will be exactly the same than for List Machines.

Networks

CloudAPI provides a way to get the details for public and customer especific networks.

ListNetworks (GET /:login/networks)

List all the networks which can be used by the given account

Inputs

Returns

An array of network objects. Networks are:

FieldTypeDescription
idStringUnique identifier for this network
nameStringThe network name
publicBooleanIs this a public or private (rfc1918) network
descriptionStringOptional description for this network, when name is not enough

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login does not exist

CLI

sdc-listnetworks

Example Request

GET /login/networks HTTP/1.1
authorization: Signature keyId="...
accept: application/json
accept-version: ~7.0
host: api.example.com
connection: keep-alive

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 158
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET, HEAD
access-control-expose-headers: Api-Version, Request-Id, Response-Time
connection: Keep-Alive
content-md5: v6s92rl/nTS2Ts5CNDcgQw==
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: 35147710-7f49-11e2-8585-bd5fc323c72c
response-time: 134
x-request-id: 35147710-7f49-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 134

[
  {
    "id": "daeb93a2-532e-4bd4-8788-b6b30f10ac17",
    "name": "external",
    "public": true
  }
]

GetNetwork (GET /:login/networks/:id)

Retrieves an individual network record.

Inputs

Returns

FieldTypeDescription
idStringUnique identifier for this network
nameStringThe network name
publicBooleanIs this a public or private (rfc1918) network
descriptionStringOptional description for this network, when name is not enough

Errors

For all possible errors, see CloudAPI HTTP Responses.

Error CodeDescription
ResourceNotFoundIf :login or the network with the given :id does not exist

CLI

sdc-getnetwork networkid

Example Request

GET /login/networks/daeb93a2-532e-4bd4-8788-b6b30f10ac17 HTTP/1.1
authorization: Signature keyId="...
accept: application/json
accept-version: ~7.0
host: api.example.com

Example Response

HTTP/1.1 200 OK
content-type: application/json
content-length: 156
access-control-allow-origin: *
access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, Api-Version, Response-Time
access-control-allow-methods: GET, HEAD
access-control-expose-headers: Api-Version, Request-Id, Response-Time
server: Joyent SmartDataCenter 7.0.0
api-version: 7.0.0
request-id: cf1c1340-7f49-11e2-8585-bd5fc323c72c
response-time: 203
x-request-id: cf1c1340-7f49-11e2-8585-bd5fc323c72c
x-api-version: 7.0.0
x-response-time: 203

{
  "id": "daeb93a2-532e-4bd4-8788-b6b30f10ac17",
  "name": "external",
  "public": true
}

Appendix A: Machine States

Machine State Diagram

The following is the state diagram for a machine:

          POST /my/machines
                     |
                     |
                     V
          +----------------+
          |  Provisioning  |
          +----------------+
                     |
                     |
                     V
          +----------------+
    +---->|     Running    |
    |     +----------------+
    |                |
    |                | action=stop
    |                V
    |     +----------------+
    |     |    Stopping    |
    |     +----------------+
    |                |
    | action=start   |
    |                V
    |     +----------------+
    +---- |     Stopped    |
          +----------------+
                     |
                     | DELETE
                     V
          +----------------+
          |  Deleted       |---+
          +----------------+   |
                               |
                              ---
                               -

At any point the state can also be offline, if there is a network/power event to the machine.

Since version 7.0 of this API, failed is used to signify a failed provision.

Polling machine state

As suggested in CreateMachine, you can poll a machine state to check when that machine provisioning has either successfully finished or failed. Consider the following code using node.js SDK:

var sdc = smartdc.createClient({ ... });

function checkMachineStatus(id, state, callback) {
    return sdc.getMachine(id, function (err, machine) {
        if (err) {
            if (err.statusCode && err.statusCode === 410 && state === 'deleted') {
                return callback(null, true);
            }
            return callback(err);
        }
        if ((machine.state === 'deleted' && state !== 'deleted') ||
            machine.state === 'failed') {
            return callback(new Error('Provisioning Job failed'));
        }
        return callback(null, (machine ? machine.state === state : false));
    }, true);
}

function waitForMachine(id, state, callback) {
    return checkMachineStatus(id, state, function (err, ready) {
        if (err) {
            return callback(err);
        }
        if (!ready) {
            return setTimeout(function () {
                waitForMachine(id, state, callback);
            }, (process.env.POLL_INTERVAL || 2500));
        }
        return callback(null);
    });
}

with this code, you can poll, for example, when a machine with a given uuid is running by just doing:

var machine = 'd19432ff-d921-4d6c-b5f9-6b0e4de6665c';
waitForMachine(machine, 'running', function (err) {
    if (err) {
        console.error('Exiting because machine provisioning failed');
        process.exit(1);
    }
    // ... do your stuff here, machine is running now ...
});

Polling machine audit

There are some cases where polling for machine state change will not work either because there will not be such change for the requested action, "rename" for example, or because there is a high risk of do not be able to "capture" the machine on the desired state, like during a "reboot" action.

On such cases, is more interesting to poll machine historical list of actions available through machine's Machine Audit, wait for the desired action to appear on that list, and check successfulness there. Taking our example from previous section, this is how we could check for a reboot:

function checkMachineAction(id, action, time, cb) {
    return sdc.getMachineAudit(id, function (err, actions) {
        if (err) {
            return cb(err);
        }

        var acts = actions.filter(function (a) {
            return (a.action === action && (new Date(a.time) > time));
        });

        if (acts.length === 0) {
            return cb(null, false);
        }

        var act = acts[0];
        if (act.success !== 'yes') {
            return cb(action + ' failed');
        }
        return cb(null, true);


    }, true);
}



function waitForAction(id, action, time, cb) {
    console.log('Waiting for machine \'%s\' %s to complete',
            id, action);

    return checkMachineAction(id, action, time, function (err, ready) {
        if (err) {
            return cb(err);
        }

        if (!ready) {
            return setTimeout(function () {
                waitForAction(id, action, time, cb);
            }, (process.env.POLL_INTERVAL || 2500));
        }
        return cb(null);
    });
}


waitForAction(machine, 'reboot', (new Date()), function (err) {
    if (err) {
        // .. something failed
    } else {
        // ...all good, reboot happened successfully and machine is running
    }
});

Appendix B: Cloud Analytics

Cloud Analytics (CA) provides deep observability for systems and applications in a SmartDataCenter cloud. The CA service enables you to dynamically instrument systems in the cloud to collect performance data that can be visualized in real-time (through the portal) or collected using the API and analyzed later by custom tools. This data can be collected and saved indefinitely for capacity planning and other historical analysis.

Building blocks: metrics, instrumentations, and fields

A metric is any quantity that can be instrumented using CA. For examples:

Each metric also defines which fields are available when data is collected. These fields can be used to filter or decompose data. For example, the Disk I/O operations metric provides fields "hostname" (for the current server's hostname) and "disk" (for the name of the disk actually performing an operation), which allows users to filter out data from a physical server or break out the number of operations by disk.

You can list the available metrics using the DescribeAnalytics API.

{
  "metrics": [
    {
      "module": "fs",
      "stat": "logical_ops",
      "label": "logical filesystem operations",
      "interval": "interval",
      "fields": ["pid","execname",...,"fstype","optype","latency"],
      "unit": "operations"
    }, ...  ], ...
}

The "module" and "stat" properties identify the metric.

When you want to actually gather data for a metric, you create an instrumentation. The instrumentation specifies:

Continuing the above example, if the system provides the metric "FS Operations" with fields "optype" and "latency", an example instrumentation might specify:

When we create an instrumentation, the system dynamically instruments the relevant software and starts gathering data. The data is made available immediately in real-time. To get the data for a particular point in time, you retrieve the value of the instrumentation for that time:

sdc-getinstrumentation -v 4
{
  "value": [
    [ [ 17000, 17999 ], 12 ],
    [ [ 18000, 18999 ], 12 ],
    ...
  ],
  "transformations": {},
  "start_time": 1309383598,
  "duration": 1,
  "nsources": 1,
  "minreporting": 1,
  "requested_start_time": 1309383598,
  "requested_duration": 1,
  "requested_end_time": 1309383599
}

To summarize: metrics define what data the system is capable of reporting. Fields enhance the raw numbers with additional metadata about each event that can be used for filtering and decomposition. Instrumentations specify which metrics to actually collect, what additional information to collect from each metric, and how to store that data. When you want to retrieve that data, you query the service for the value of the instrumentation.

Values and visualizations

We showed above how fields can be used to decompose results. Let's look at that in more detail. We'll continue using the "FS Operations" metric with fields "optype".

Scalar values

Suppose we create an instrumentation with no filter and no decomposition. Then the value of the instrumentation for a particular time interval might look something like this (omitting several unrelated properties):

{
  start_time: 1308789361,
  duration: 1,
  value: 573
}

In this case, start_time denotes the start of the time interval in Unix time, duration denotes the length of the interval, and value denotes the actual value, which is 573. This means that 573 FS operations completed on all systems in the cloud between times 1308789361 and 1308789362.

Discrete decompositions

Now suppose we create a new instrumentation with a decomposition by execname. Then the raw value might look something like this:

{
  start_time: 1308789361,
  duration: 1,
  value: {
    ls: 1,
    cat: 49,
    ...
  }
}

We call the decomposition by execname a discrete decomposition because the possible values of execname ("ls", "cat", ...) are not numbers.

Numeric decompositions

It's useful to decompose some metrics by numeric fields. For example, you might want to view FS operations decomposed by latency (how long the operation took). The result is a distribution, which groups nearby latencies into buckets and shows the number of disk I/O operations that fell into each bucket. The result looks like this:

{
  "start_time": 1308863061,
  "duration": 1,
  "value": [
    [ [ 53000, 53999 ], 4 ],
    [ [ 54000, 54999 ], 4 ],
    [ [ 55000, 55999 ], 7 ],
    ...
    [ [ 810000, 819999 ], 1 ]
  ]
}

That data indicates that at time 1308863061, the system completed:

This type of instrumentation is called a numeric decomposition.

Combining decompositions

It's possible to combine a single discrete and numeric decomposition to produce an object mapping discrete key to numeric distribution, whose value looks like this:

{
  "start_time": 1308863799,
  "duration": 1,
  "value": {
    "ls": [
      [ [ 110000, 119999 ], 1 ],
      [ [ 120000, 129999 ], 1 ],
      ...
      [ [ 420000, 429999 ], 1 ],
      [ [ 25000000, 25999999 ], 1 ]
    ]
  }
}

As we will see, this data allows clients to visualize the distribution of I/O latency and then highlight individual programs in the distribution (or whatever field you broke it down along).

Value-related properties

We can now explain several of the instrumentation properties shown previously:

The arity serves as a hint to visualization clients: scalars are typically rendered as line or bar graphs, discrete decompositions are rendered as stacked or separate line or bar graphs, and numeric decompositions are rendered as heatmaps.

Predicate Syntax

Predicates allow you to filter out data points based on the fields of a metric. For example, instead of looking at FS operations for your whole cloud, you may only care about operations with latency over 100ms, or on a particular machine.

Predicates are represented as JSON objects using an LISP-like syntax. The primary goal for predicate syntax is to be very easy to construct and parse automatically to enable people to build tools to work with them.

The following leaf predicates are available:

{ eq: [ fieldname, value ] }: equality (string or number, as appropriate). { ne: [ fieldname, value ] }: inequality (string or number, as appropriate). { le: [ fieldname, value ] }: less than or equal to (numbers only). { lt: [ fieldname, value ] }: less than (numbers only). { ge: [ fieldname, value ] }: greater than or equal to (numbers only). { gt: [ fieldname, value ] }: greater than (numbers only).

Additionally, the following compound predicates are available:

{ and: [ predicate, ... ] }: all of subpredicates must be true. { or: [ predicate, ... ] }: at least one of subpredicates must be true.

All of these can be combined to form complex filters for drilling down. For example, this predicate:

{
  and: {
    { eq: [ "execname", "mysqld" ] }
    { gt: [ "latency", 100000000 ] },
    { or: [
      { eq: [ "hostname", "host1" ] },
      { eq: [ "hostname", "host2" ] },
      { eq: [ "hostname", "host3" ] }
    ] },
  }
}

This predicate could be used with the "logical filesystem operations" metric to identify file operations performed by MySQL on machines "host1", "host2", or "host3" that took longer than 100ms.

Heatmaps

Up to this point we have been showing raw values, which are JSON representations of the data exactly as gathered by Cloud Analytics. However, the service may provide other representations of the same data. For numeric decompositions, the service provides several heatmap resources that generate heatmaps, like this one:

Like raw values, heatmap values are returned using JSON, but instead of specifying a value property, they specify an image property whose contents are a base64-encoded PNG image. For details, see the API reference. Using the API, it's possible to specify the size of the image, the colors used, which values of the discrete decomposition to select, and many other properties controlling the final result.

Heatmaps also provide a resource for getting the details of a particular heatmap bucket, which looks like this:

{
  "start_time": 1308865184,
  "duration": 60,
  "nbuckets": 100,
  "width": 600,
  "height": 300,
  "bucket_time": 1308865185,
  "bucket_ymin": 10000,
  "bucket_ymax": 19999,
  "present": {
    "ls": 5,
    "cat": 57
  },
  "total": 1,
}

This example indicates the following about the particular heatmap bucket we clicked on:

This level of detail is critical for understanding hot spots or other patterns in the heatmap.

Data granularity and data retention

By default, CA collects and saves data each second for 10 minutes. So if you create an instrumentation for FS operations, the service will save the per-second number of FS operations going back for the last 10 minutes. These parameters are configurable using the following instrumentation properties:

These values affect the space used by the instrumentation's data. For example, all things being equal, the following all store the same amount of data:

The system imposes limits on these properties so that each instrumentation's data cannot consume too much space. The limits are expressed internally as a number of data points, so you can adjust granularity and retention-time to match your needs. Typically, you'll be interested in either per-second data for live performance analysis or an array of different granularities and retention-times for historical usage patterns.

Data persistence

By default, data collected by the CA service is only cached in memory, not persisted on disk. As a result, transient failures of underlying CA service instances can result in loss of the collected data. For live performance analysis, this is likely not an issue, since the likelihood of a crash is low and the data can probably be collected again. For historical data being kept for days, weeks, or even months, it's necessary to persist data to disk. This can be specified by setting the persist-data instrumentation property to "true". In that case, CA will ensure that data is persisted at approximately the granularity interval of the instrumentation, but no more frequently than every few minutes. (For that reason, there's little value in persisting an instrumentation whose retention time is only a few minutes.)

Transformations

Transformations are post-processing functions that can be applied to data when it's retrieved. You do not need to specify transformations when you create an instrumentation; you need only specify them when you retrieve the value. Transformations map values of a discrete decomposition to something else. For example, a metric that reports HTTP operations decomposed by IP address supports a transformation that performs a reverse-DNS lookup on each IP address so that you can view the results by hostname instead. Another transformation maps IP addresses to geolocation data for displaying incoming requests on a world map.

Each supported transformation has a name, like "reversedns". When a transformation is requested for a value, the returned value includes a transformations object with keys corresponding to each transformation (e.g., "reversedns"). Each of these is an object mapping keys of the discrete decomposition to transformed values. For example:

{
  "value": {
    "8.12.47.107": 57
  },
  "transformations": {
    "reversedns": {
      "8.12.47.107": [ "joyent.com" ]
    }
  },
  "start_time": 1308863799,
  "duration": 1,
  "nsources": 1,
  "minreporting": 1,
  "requested_start_time": 1308863799,
  "requested_duration": 1,
  "requested_end_time": 1308863800
}

Transformations are always performed asynchronously and the results cached internally for future requests. So the first time you request a transformation like "reversedns", you may see no values transformed at all. As you retrieve the value again, the system will have completed the reverse-DNS lookup for addresses in the data and they will be included in the returned value.

Appendix C: HTTP Signature Authentication

In addition to HTTP Basic Authentication, CloudAPI supports a new mechanism for authenticating HTTP requests based on signing with your SSH private key. Specific examples of using this mechanism with SDC are given here. Reference the HTTP Signature Authentication specification by Joyent, Inc. for complete details.

A node.js library for HTTP Signature is available with:

npm install http-signature@0.9.11

CloudAPI Specific Parameters

The Signature authentication scheme is based on the model that the client must authenticate itself with a digital signature produced by the private key associated with an SSH key under your account (see /my/keys above). Currently only RSA signatures are supported. You generate a signature by signing the value of the HTTP Date header.

As an example, assuming that you have associated an RSA SSH key with your account, called 'rsa-1', the following request is what you would send for a ListMachines request:

GET /my/machines HTTP/1.1
Host: api.example.com
Date: Sat, 11 Jun 2011 23:56:29 GMT
Authorization: Signature keyId="/demo/keys/rsa-1",algorithm="rsa-sha256" <Base64(rsa(sha256($Date)))>
Accept: application/json
X-Api-Version: ~7.0

Where the signature is attached with the Base64(rsa(sha256(Sat, 11 Jun 2011 23:56:29 GMT))) output. Note that the keyId parameter cannot use the my shortcut, as in the HTTP resource paths. This is because CloudAPI must lookup your account to resolve the key, as with Basic authentication. In short, you MUST use the login name associated to your account to specify the keyId.

Sample Code

Sample code for generating the Authorization header (and Date header), now follows.

var crypto = require('crypto');
var fs = require('fs');
var https = require('https');



/**
 * Simply pads a number < 10 with a leading 0.
 *
 * @param {String} val a numeric string.
 * @return {String} a new value that may have a leading 0.
 */
function pad(val) {
  if (parseInt(val, 10) < 10)
    val = '0' + val;
  return val;
}


/**
 * Generates an RFC 1123 compliant Date String
 *
 * @return {String} RFC 1123 date string.
 */
function httpDate() {
  var now = new Date();
  var months = ['Jan',
                'Feb',
                'Mar',
                'Apr',
                'May',
                'Jun',
                'Jul',
                'Aug',
                'Sep',
                'Oct',
                'Nov',
                'Dec'];
  var days = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
  return days[now.getUTCDay()] + ', ' +
              pad(now.getUTCDate()) + ' ' +
              months[now.getUTCMonth()] + ' ' +
              now.getUTCFullYear() + ' ' +
              pad(now.getUTCHours()) + ':' +
              pad(now.getUTCMinutes()) + ':' +
              pad(now.getUTCSeconds()) +
              ' GMT';
}


///--- Mainline

// Read in an SSH key from the "usual" location.
var file = process.env.HOME + '/.ssh/id_rsa';
var key = fs.readFileSync(file, 'ascii');
if (!key)
  throw new Error(file + ' was not a valid RSA key');

var date = httpDate();
var signer = crypto.createSign('RSA-SHA256');
signer.update(date);
authz = 'Signature keyId="/mark/keys/rsa-1",algorithm="rsa-sha256" ' + signer.sign(key, 'base64');

var request = {
  host: 'api.example.com',
  path: '/my/machines',
  headers: {
    'x-api-version': '~7.0',
    'Date': date,
    'Authorization': authz
  }
};
https.get(request, function(res) {
  console.log('STATUS: ' + res.statusCode);
  console.log('HEADERS: ' + JSON.stringify(res.headers, null, 2));
  res.setEncoding('utf8');
  res.body = '';
  res.on('data', function(chunk) {
    res.body += chunk;
  });
  res.on('end', function() {
    console.log('BODY: ' + JSON.stringify(res.body, null, 2));
  });
}).end();

Appendix D: CloudAPI CLI Commands

CommandDescription
sdc-addmachinetagsAllows you to add additional tags, other than those set at provisioning time.
sdc-createinstrumentationCreates an instrumentation.
sdc-createkeyUploads a new OpenSSH key to SmartDataCenter.
sdc-createmachineAllows you to provision a machine.
sdc-createmachinesnapshotAllows you to take a snapshot of a machine.
sdc-deleteinstrumentationDestroys an instrumentation.
sdc-deletekeyDeletes an SSH key by name.
sdc-deletemachineAllows you to completely destroy a machine.
sdc-deletemachinemetadataDeletes a single metadata key from this machine.
sdc-deletemachinesnapshotDeletes the specified snapshot of a machine.
sdc-deletemachinetagDeletes a single tag from this machine.
sdc-describeanalyticsRetrieves the "schema" for instrumentations that can be created using the analytics endpoint.
sdc-getdatasetGets an individual dataset by id.
sdc-getimageGets an individual image by id.
sdc-getinstrumentationRetrieves the configuration for an instrumentation.
sdc-getkeyRetrieves an individual key record.
sdc-getmachineGets the details for an individual machine.
sdc-getmachinemetadataReturns the complete set of metadata associated with this machine.
sdc-getmachinesnapshotGets the state of the named snapshot.
sdc-getmachinetagReturns the value for a single tag on this machine.
sdc-getnetworkGets a network by the given id.
sdc-getpackageGets a package by name.
sdc-listdatacentersProvides a list of all datacenters this cloud is aware of.
sdc-listdatasetsProvides a list of datasets available in this datacenter.
sdc-listimagesProvides a list of images available in this datacenter.
sdc-listinstrumentationsRetrieves all currently created instrumentations.
sdc-listkeysLists all public keys we have on record for the specified account.
sdc-listmachinesLists all machines on record for an account.
sdc-listmachinesnapshotsLists all snapshots taken for a given machine.
sdc-listmachinetagsReturns the complete set of tags associated with this machine.
sdc-listnetworksProvides a list of networks available to the user in this datacenter.
sdc-listpackagesProvides a list of packages available in this datacenter.
sdc-rebootmachineAllows you to 'reboot' a machine.
sdc-resizemachineAllows you to resize a SmartMachine.
sdc-setupSets up an account on a datacenter for use with this CLI.
sdc-startmachineAllows you to boot up a machine
sdc-startmachinefromsnapshotStarts a stopped machine from the referenced snapshot.
sdc-stopmachineAllows you to shut down a machine.
sdc-updatemachinemetadataAllows you to update the metadata for a given machine.

Appendix E: SDC 7 Changelog

Cloud API and SmartDC CLI have been completely rewritten for SDC 7.0. Notably, required version of Node.js to run the CLI is now greater or equal than 0.8.14.

Most of the commands remain the same, taking exactly the same options and returning exactly the same JSON information in an attempt to preserve backwards compatibility between 6.5 and 7.0 API clients, and software built for 6.5.

There are, anyway, some important differences between SDC 7.0 and the previous version, where the main one is:

Appendix F: SDC 6.5 Support

Version 6.5 of the API will not be supported longer than a period of 6 months after the public release of SDC 7.0.

During this period, backwards compatibility will be granted in order to give 3rd party software built on top of the previous API version time enough to migrate to the new version.

Creative Commons License Joyent CloudAPI Documentation by Joyent, Inc. is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.