CreateOperationTicket - Bastionhost - Alibaba Cloud Documentation Center

If an administrator configures a control policy to require O&M approval, an O&M engineer must create an O&M ticket. The engineer can perform O&M tasks only after an administrator approves the ticket.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:CreateOperationTicket

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance. Note Call the DescribeInstances operation to obtain this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information about regions and zones, see Regions and zones.	cn-hangzhou
AssetId	string	Yes	The ID of the asset for which to request O&M. Note Call the ListOperationDatabases and ListOperationHosts operations to obtain this parameter.	2
ProtocolName	string	Yes	The name of the protocol for the O&M request. Valid values: SSH RDP MySQL PostgreSQL Oracle SQLServer	SSH
AssetAccountName	string	Yes	The logon name of the asset account for the O&M request.	root
IsOneTimeEffect	boolean	No	Specifies whether the ticket is valid for a single logon. Valid values: true: The ticket is valid for a single logon. false: The ticket is valid for multiple logons within the validity period.	false
EffectStartTime	integer	No	The start time of the validity period for the logon request. This value is a UNIX timestamp. Unit: seconds.	1685600242
EffectEndTime	integer	No	The end time of the validity period for the logon request. This value is a UNIX timestamp. Unit: seconds. Note The end time must be later than the start time.	1679393152
ApproveComment	string	Yes	The comments on the ticket.	Comment

Response elements

Element	Type	Description	Example
	object
OperationTicketId	string	The ID of the O&M ticket.	2
RequestId	string	The ID of the request.	0ECCC399-4D35-48A7-8379-5C6180E66235

Examples

Success response

JSON format

{
  "OperationTicketId": "2",
  "RequestId": "0ECCC399-4D35-48A7-8379-5C6180E66235"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.