11. tag – Tagging

Virtual machine tagging functionality.

11.1. Resources

11.1.1. Tag

class tag.Tag

This resource represents a method in which to create a new set of tags for a specific VM.

Resource URI::

/rest/hosting/vm/<UUID>/tag/

PUT(tag)

Create a new set of tags for a virtual machine by submitting an HTTP PUT request. The tag parameter is a comma-separated list of tag names. The UUID in the resource URI should be the UUID of the target virtual machine.

Note

This resource requires create permission on the elastic_hosting extension module.

Parameter:tag – The comma-separated list of tags to create. Return type:tag.RepTag

See also

vm

11.1.2. TagName

class tag.TagName

This resource represents a specific tag for a target virtual machine referenced by tag name.

Resource URI::

/rest/hosting/vm/<UUID>/tag/<NAME>/

DELETE()

Delete the specified tag from the target virtual machine. The NAME in the resource URI should be the name of the tag to delete. The UUID in the resource URI should be the UUID of the target virtual machine.

Note

This resource requires create permission on the elastic_hosting extension module.

Return type:tag.RepTagList

See also

vm

11.1.3. TagList

class tag.TagList

This class represents a list of tags. Repending on the resource URI, this can either be a list of all VM tags, or a list of tags belonging to a particular virtual machine.

Resource URI::

/rest/hosting/vm/tag/list/
/rest/hosting/vm/<UUID>/tag/list/

GET()

Retrieve a list of virtual machine tags.

Note

This resource requires read permission on the elastic_hosting extension module.

Return type:tag.RepTagList

11.2. Representations

11.2.1. RepTag

class tag.RepTag

This is a representation of a set of tags that have just been created.

errno

This attribute represents the general error number generated by the resource.

message

This attribute represents the general message generated by the resource.

tags

This attribute represents the list of tags that have been created.

Representation:

{"errno":response.errno,
 "message":response.message,
 "tags": [tag1, tag2]}

11.2.2. RepTagList

class tag.RepTagList

This is a representation of a set of tags.

errno

This attribute represents the general error number generated by the resource.

message

This attribute represents the general message generated by the resource.

tags

This attribute represents the list of tag name strings.

Representation:

{"errno":response.errno,
 "message":response.message,
 "tags": [tag1, tag2]}