Ticket

CreateTicket

Creates a ticket. For example,

CreateTicket name=cloud_Ticket requests='[{"requestName": "create vm","apiName": "org.zstack.header.vm.APICreateVmInstanceMsg","executeTimes":1,"apiBody": {"name": "vm name","instanceOfferingUuid": "46466abc6c8931fdaab7a8df43e4f175","imageUuid": "43e997234af63863b28a5e9987e1d122","l3NetworkUuids": ["ddd66c7ba30598cdc7ab835e04f96"],"hostUuid":"3c84aa23e55f42758485db459202bdc3"}}]' flowCollectionUuid=1c4db59a73b63f968889764bcb2bae9d accountSystemType=iam2 accountSystemContext='{"projectUuid": "28c9a199e3e842d28c9805eb89be56cb","virtualIDUuid": "1c255722caf34cb888b57d11a744248c"}'

Parameters

Name	Description	Optional	Starting Version
name	The resource name.		3.0.0
description	The detailed description of the resource.	Yes	3.0.0
requests			3.0.0
flowCollectionUuid		Yes	3.0.0
accountSystemType			3.0.0
accountSystemContext			3.0.0
resourceUuid		Yes	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

UpdateTicketRequest

Updates a ticket request. For example,

UpdateTicketRequest uuid=b86c9016b4f24953a9edefb53ca0678c requests=requests='[{"requestName": "create vm","apiName": "org.zstack.header.vm.APICreateVmInstanceMsg","executeTimes":1,"apiBody": {"name": "vm name","instanceOfferingUuid": "46466abc6c8931fdaab7a8df43e4f175","imageUuid": "43e997234af63863b28a5e9987e1d122","l3NetworkUuids": ["ddd66c7ba30598cdc7ab835e04f96"],"hostUuid":"3c84aa23e55f42758485db459202bdc3"}}]'

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		3.0.0
requests			3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

ChangeTicketStatus

Changes the status of a ticket. For example,

ChangeTicketStatus uuid= statusEvent=open comment=this is the comment for change status operation

Parameters

Name	Description	Optional	Valid Value	Starting Version
uuid	The resource UUID.			3.0.0
statusEvent			open approve cancel reject reopen	3.0.0
comment	The comment.	Yes		3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.0.0
timeout		Yes

QueryTicket

Queries a ticket. For example,

QueryTicket name=test Ticket

Primitive Fields of Query

See Ticket Inventory.

QueryArchiveTicket

Queries an archived ticket. For example,

QueryArchiveTicket name=cloud

QueryTicketHistory

Queries a ticket history. For example,

QueryTicketHistory name=ZSatck

CreateIAM2TickFlowCollection

Creates a ticket process. For example,

CreateIAM2TickFlowCollection name=cloud  projectUuid=1c4db59a73b63f968889764bcb2bae9d

Parameters

Name	Description	Optional	Starting Version
flows		Yes	3.0.0
name	The resource name.		3.0.0
description	The detailed description of the resource.	Yes	3.0.0
isDefault		Yes	3.0.0
resourceUuid		Yes	3.0.0
projectUuid			3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

DeleteTicketFlowCollection

Deletes a ticket process. For example,

DeleteTicketFlowCollection uuid=657b0e4c4b21394db32f1c7c1066efa9

Parameters

Name	Description	Optional	Starting Version
uuid			3.0.0
deleteMode		Yes	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

UpdateIAM2TicketFlowCollection

Updates a ticket process. For example,

UpdateIAM2TicketFlowCollection uuid=b86c9016b4f24953a9edefb53ca0678c name=cloud-1

Parameters

Name	Description	Optional	Starting Version
flows		Yes	3.0.0
uuid	The resource UUID.		3.0.0
name	The resource name.	Yes	3.0.0
description	The detailed description of the resource.	Yes	3.0.0
isDefault		Yes	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

QueryTicketFlowCollection

Queries a ticket process. For example,

QueryTicketFlowCollection name=cloud

Primitive Fields of Query

See Ticket Flow Collection Inventory.

Nested and Expanded Fields of Query

Field	Inventory	Description	Starting Version
flow	Flow Inventory	A flow in a ticket process.	2.4.0
flows	Flow Inventory	Multiple flows in a ticket process.	2.4.0

ChangeTicketFlowCollectionState

Changes the state of a ticket process. For example,

ChangeTicketFlowCollectionState uuid=b86c9016b4f24953a9edefb53ca0678c stateEvent=enable

Parameters

Name	Description	Optional	Valid Value	Starting Version
uuid	The resource UUID.			3.0.0
stateEvent			enable disable	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.0.0
timeout		Yes

QueryTicketFlow

Queries a flow in a ticket process. For example,

QueryTicketFlow name=Flow-1

Primitive Fields of Query

See Ticket Flow Inventory.

Nested and Expanded Fields of Query

Field	Inventory	Description	Starting Version
collection	Collection Inventory	The flow collection.	3.0.0

AddIAM2TicketFlow

Adds a custom approval flow. For example,

AddIAM2TicketFlow approverUuid=2b1b555f19531df9a94ce42c8959fa9 name=Flow-1 collectionUuid=82b6111a0d7f47bd955f385f959b1eb7

Parameters

Name	Description	Optional	Starting Version
approverUuid			3.0.0
approverTitle		Yes	3.0.0
name	The resource name.		3.0.0
description	The detailed description of the resource.	Yes	3.0.0
collectionUuid			3.0.0
parentFlowUuid		Yes	3.0.0
resourceUuid		Yes	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

UpdateIAM2TicketFlow

Updates a custom approval flow. For example,

UpdateIAM2TicketFlow uuid=b86c9016b4f24953a9edefb53ca0678c name=cloud-1

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		3.0.0
name	The resource name.	Yes	3.0.0
description	The detailed description of the resource.	Yes	3.0.0
approverUuid		Yes	3.0.0
approverTitle		Yes	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

DeleteIAM2TicketFlow

Deletes a custom approval flow. For example,

DeleteIAM2TicketFlow uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		3.0.0
deleteMode		Yes	3.0.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.0.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.0.0
timeout		Yes

AddTicketTypesToTicketFlowCollection

Adds a ticket type to a ticket process. For example,

AddTicketTypesToTicketFlowCollection ticketFlowCollectionUuid=3b933e9aaf2d49b9a3dcf0c92867790f ticketTypeUuids=ef064ef45fb446d381db7b7d5f71695c

Parameters

Name	Description	Optional	Starting Version
ticketFlowCollectionUuid	The ticket process UUID.		3.6.0
ticketTypeUuids	The ticket type UUID.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

RemoveTicketTypesFromTicketFlowCollection

Removes a ticket type from a ticket process. For example,

RemoveTicketTypesFromTicketFlowCollection ticketFlowCollectionUuid=3b933e9aaf2d49b9a3dcf0c92867790f ticketTypeUuids=ef064ef45fb446d381db7b7d5f71695c

Parameters

Name	Description	Optional	Starting Version
ticketFlowCollectionUuid	The ticket process UUID.		3.6.0
ticketTypeUuids	The ticket type UUID.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

QueryTicketType

Queries a ticket type. For example,

QueryTicketType uuid=3b933e9aaf2d49b9a3dcf0c92867790f

Primitive Fields of Query

See Ticket Type Inventory.

PreviousProject NextSSO