VMware Cloud Director API - ContainerType

ContainerType

Type:

ContainerType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Container for query result sets.

Since:

Schema:

common.xsd

Media type(s):

application/vnd.vmware.vcloud.query.records+xml
application/vnd.vmware.vcloud.query.idrecords+xml
application/vnd.vmware.vcloud.query.records+json
application/vnd.vmware.vcloud.query.idrecords+json
application/vnd.vmware.vcloud.query.references+xml
application/vnd.vmware.vcloud.query.references+json

Extends:

ResourceType

XML Representation:

Attributes

Attribute	Type	Required	Modifiable	Description
href	anyURI	No	always	The URI of the entity.
type	string	No	always	The MIME type of the entity.
name	string	No	none	Query name that generated this result set.
page	int	No	none	Page of the result set that this container holds. The first page is page number 1.
pageSize	int	No	none	Page size, as a number of records or references.
total	long	No	none	Total number of records or references in the container.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Link	LinkType	No	none			A reference to an entity or operation associated with this object.
VCloudExtension	VCloudExtensionType	No	always			An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /admin/extension/datastores/query	Get a list of all datastores by using REST API General QueryHandler.	1.5
read	GET /admin/extension/externalNetworkReferences/query	Get list of external networks by using REST API general QueryHandler.	1.5	35.0
read	GET /admin/extension/hostReferences/query	Get list of hosts by using REST API general QueryHAndler; This is read only list of host references and is not bound to specific states.	1.5
read	GET /admin/extension/networkPoolReferences/query	Get list of network pools by using REST API general QueryHandler.	1.5	35.0
read	GET /admin/extension/orgNetworks/query	Get list of Organization Networks for the system by using REST API general QueryHandler.	1.5	35.0
read	GET /admin/extension/orgVdcs/query	Get list of all Organization Vdcs in the system by using REST API general QueryHandler.	1.5
read	GET /admin/extension/providerVdcReferences/query	Get list of provider vDCs by using REST API general QueryHandler.	5.1
read	GET /admin/extension/resourcePool/{id}/vmList	List all VMs using this resource pool.	5.1
read	GET /admin/extension/service/apidefinition/{id}/files	Returns all file descriptors for the API definition.	5.1
read	GET /admin/extension/service/query	Return the System Administrator representation of all extension services registered with the system.
read	GET /admin/extension/service/resourceclass/{id}/resourceclassactions	List registered resource class actions for extension service.
read	GET /admin/extension/service/resourceclass/{id}/serviceresources	List registered service resources for extension service.
read	GET /admin/extension/service/resourceclassaction/{id}/aclrules	List registered resource class ACL rule for extension service.
read	GET /admin/extension/service/{id}/apidefinitions	Returns the API definitions registered by this service.	5.1
read	GET /admin/extension/service/{id}/apifilters	Returns the API filters registered by this service.	5.1
read	GET /admin/extension/service/{id}/links	Returns the links registered by this service.	5.1
read	GET /admin/extension/service/{id}/resourceclasses	List registered resource classes for extension service.
read	GET /admin/extension/strandedItems/query	Get list of all stranded items in the system by using REST API general QueryHandler.	1.5
read	GET /admin/extension/vapps/query	Get list of all vApps in the system by using REST API general QueryHandler.	1.5
read	GET /admin/extension/vimServerReferences/query	Get list of vSphere servers by using REST API general QueryHandler; This is read only list of vim servers and is not bound to specific states.	1.5
read	GET /admin/extension/vmGroup/name/{groupName}/vmsList	Get all VMs from all clusters in given VM group.
read	GET /admin/extension/vmGroup/{groupId}/vmsList	Enumerate the properties of the specified VM group	27.0
read	GET /admin/groups/query	Retrieves a list of groups for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5	38.1
read	GET /admin/org/{orgId}/roles/query	Retrieves a list of roles in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5	33.0
read	GET /admin/orgs/query	Retrieves a list of organizations by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5	38.1
read	GET /admin/rights/query	Retrieves a list of rights in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5	33.0
read	GET /admin/roles/query	Retrieves a list of roles in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5	33.0
read	GET /admin/strandedUsers/query	Retrieves a list of stranded users by using REST API general QueryHandler.	1.5
read	GET /admin/users/query	Retrieves a list of users for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5	38.0
read	GET /admin/vdc/{id}/edgeGateways	List all gateways for this Org vDC.	5.1
read	GET /admin/vdc/{id}/networks	List all networks for this Org vDC.	5.1	35.0
read	GET /admin/vdcs/query	Retrieves a list of vdcs in the organization; If filter is provided it will be applied to the corresponding result set.	1.5
read	GET /apidefinition/{id}/files	Returns all file descriptors for the API definition.	5.1
read	GET /apidefinitions	Return all API definitions.
read	GET /catalogs/query	Retrieves a list of Catalogs by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5
read	GET /disks/query	Retrieves a disk list by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5
read	GET /files	Return all API definition file descriptors.
read	GET /mediaList/query	Retrieves a media list by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5
read	GET /service	Return all extension services registered with the system.
read	GET /service/{id}/apidefinitions	Return all Extension Service API Definitions.
read	GET /vAppTemplates/query	Retrieves a list of vAppTemplates using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5
read	GET /vApps/query	Retrieves a list of vApps by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5
read	GET /vms/query	Retrieves a list of VMs in lease by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.	1.5
action	POST /admin/vdc/{id}/edgeGateways	Create an edge gateway.	5.1
action	POST /admin/vdc/{id}/networks	Create an Org vDC network.	5.1	35.0