GenerateAssetOperationToken - Bastionhost - Alibaba Cloud Documentation Center

Applies for an O\&M token.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GenerateAssetOperationToken		All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host for which you want to apply an O&M token. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
AssetType	string	Yes	The type of the asset for which you want to apply for an O&M token. Valid values: Host Database	Host
AssetId	string	Yes	The ID of the asset for which you want to apply for an O&M token.	11
AssetAccountId	string	No	The ID of the account whose assets the O&M token takes effect. Note You must specify at least one of the following parameters: AssetAccountId and AssetAccountName. If you specify both parameters, AssetAccountId takes precedence.	2
AssetAccountName	string	No	The name of the host account. If you use a custom account, enter a real account name. Note When both AssetAccountId and AssetAccountName are specified, AssetAccountId takes precedence.	root
AssetAccountPassword	string	No	The Base64-encoded password. This parameter is required if you want to apply for an O&M token for a custom account.	dGVzdHBhc3N3b3Jk
AssetAccountProtocolName	string	No	The name of the protocol. Valid values: SSH RDP Oracle PostgreSQL MySQL SQLServer	SSH

Response parameters

Parameter	Type	Description	Example
	object
AssetOperationToken	object	The data returned.
CountLeft	long	The remaining number of times that you can use the O&M token.	1
ExpireTime	long	The time when the O&M token expires. The value is a UNIX timestamp.	1709110797
HasCountLimit	boolean	Indicates whether the number of times that you can use the O&M token is limited.	true
MaxRenewCount	long	The maximum number of renewals. A value of 0 indicates that renewal is not supported.	10
RenewCount	string	The number of times the O&M token is renewed.	1
Token	string	The O&M token that you apply for.	NmYyMmEzNmMwYzljNGY******
TokenId	string	The ID of the O&M token.	1
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Sample success responses

JSONformat

{
  "AssetOperationToken": {
    "CountLeft": 1,
    "ExpireTime": 1709110797,
    "HasCountLimit": true,
    "MaxRenewCount": 10,
    "RenewCount": "1",
    "Token": "NmYyMmEzNmMwYzljNGY******",
    "TokenId": "1"
  },
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

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.

For a list of error codes, visit the Service error codes.