VMware Cloud Director API - Media

VMware Cloud Director API - Media

MediaType

Element:

Media

Type:

MediaType

Namespace:

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

Description:

Represents a Media object.

Since:

0.9

Schema:

media.xsd

Media type(s):

application/vnd.vmware.vcloud.media+xml
application/vnd.vmware.vcloud.media+json

Extends:

ResourceEntityType

XML Representation:

<Media xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:int" imageType="xs:string" size="xs:long">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <Files>
        <File href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks>
                <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                        cancelRequested="xs:boolean">
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string" model="xs:string"/>
                    <Description> xs:string </Description>
                    <Tasks> TasksInProgressType </Tasks>
                    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                            vendorSpecificErrorCode="xs:string">
                        <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
                    </Error>
                    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                    <Details> xs:string </Details>
                    <VcTaskList>
                        <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                                errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                                virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
                    </VcTaskList>
                    <Result>
                        <ResultContent> ... </ResultContent>
                        <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    </Result>
                </Task>
            </Tasks>
        </File>
    </Files>
    <Owner href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Owner>
    <VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Media>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	0.9		The URI of the entity.
type	string	No	always	0.9		The MIME type of the entity.
id	string	No	none	0.9		The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey	string	No	create	5.1		Optional unique identifier to support idempotent semantics for create and delete operations.
name	string	Yes	always	0.9		The name of the entity.
status	int	No	none	0.9		Creation status of the resource entity.
imageType	string	Yes	create	0.9		Media image type. One of: iso, floppy
size	long	Yes	create	0.9		Size of the media file, in bytes.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	0.9		Optional description.
Files	FilesListType	No	none	0.9		Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
Link	LinkType	No	none	0.9		A reference to an entity or operation associated with this object.
Owner	OwnerType	No	none	0.9		Media owner.
Tasks	TasksInProgressType	No	none	0.9		A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension	VCloudExtensionType	No	always	0.9		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VdcStorageProfile	ReferenceType	No	always	5.1		A reference to a storage profile to be used for this object. The specified storage profile must exist in the organization vDC that contains the object. If not specified, the default storage profile for the vDC is used.

Operations

CRUD	Operation	Description	Since	Deprecated
create	POST /admin/extension/vimServer/{id}/importMedia	Import media from vCenter.	1.5
create	POST /vdc/{id}/action/cloneMedia	Create a copy of a media object.	0.9
read	GET /media/{id}	Retrieve a media object.	0.9
update	PUT /media/{id}	Update the name and description of a media object.	0.9
delete	DELETE /media/{id}	Delete a media object.	0.9