VMware Cloud Director API - ResourceClassAction

VMware Cloud Director API - ResourceClassAction

ResourceClassActionType

Element:
ResourceClassAction
Type:
ResourceClassActionType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Defines the HTTP methods allowed on a URL pattern associated with an extension service resource class.
Since:
5.1
Schema:
services.xsd
Media type(s):
application/vnd.vmware.admin.resourceClassAction+xml
application/vnd.vmware.admin.resourceClassAction+json
Extends:
EntityType
XML Representation:
<ResourceClassAction xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5: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">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </vcloud_v1.5:Error>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <vcloud_v1.5:VcTaskList>
                <vcloud_v1.5: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"/>
            </vcloud_v1.5:VcTaskList>
            <vcloud_v1.5:Result>
                <ResultContent> ... </ResultContent>
                <vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </vcloud_v1.5:Result>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <HttpMethod> xs:string </HttpMethod>
    <UrlPattern> xs:string </UrlPattern>
    <AclRules>
        <AclRule href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks>
                <vcloud_v1.5: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">
                    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string" model="xs:string"/>
                    <Description> xs:string </Description>
                    <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
                    <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                            vendorSpecificErrorCode="xs:string">
                        <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
                    </vcloud_v1.5:Error>
                    <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                    <Details> xs:string </Details>
                    <vcloud_v1.5:VcTaskList>
                        <vcloud_v1.5: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"/>
                    </vcloud_v1.5:VcTaskList>
                    <vcloud_v1.5:Result>
                        <ResultContent> ... </ResultContent>
                        <vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    </vcloud_v1.5:Result>
                </vcloud_v1.5:Task>
            </vcloud_v1.5:Tasks>
            <ServiceResourceAccess>
                <Access> xs:string </Access>
                <vcloud_v1.5:Entity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </ServiceResourceAccess>
            <OrganizationAccess>
                <Access> xs:string </Access>
                <vcloud_v1.5:Entity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </OrganizationAccess>
            <PrincipalAccess>
                <Access> xs:string </Access>
                <vcloud_v1.5:Entity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </PrincipalAccess>
        </AclRule>
    </AclRules>
</ResourceClassAction>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.1 The URI of the entity.
type string No always 5.1 The MIME type of the entity.
id string No none 5.1 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 5.1 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
AclRules AclRulesType No always 5.1 Container for values used to create ACL rules for an extension service resource class action.
Description string No always 5.1 Optional description.
HttpMethod string Yes none 5.1 HTTP method, one of: GET, PUT, POST, DELETE.
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
Tasks TasksInProgressType No none 5.1 A list of queued, running, or recently completed tasks associated with this entity.
UrlPattern string Yes none 5.1 The relative URL of the resource as a named regular expression where (?&ltid>) matches the resource identifier. For example:
/backup/restore
/backup/restore/(?&ltid>[-,a-g,0-9]*)
Must be <=1024 characters.
VCloudExtension VCloudExtensionType No always 5.1 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
create POST /admin/extension/service/resourceclass/{id}/resourceclassactions Registers resource class action for extension service.
read GET /admin/extension/service/resourceclassaction/{id} Retrieve (GET) resource class action info
delete DELETE /admin/extension/service/resourceclassaction/{id} Deletes (DELETE) resource class action