All Products
Search

This Product

    Bastionhost:GenerateAssetOperationToken

    Document Center

    Bastionhost:GenerateAssetOperationToken

    Last Updated:May 25, 2026

    Call this operation to request O&M tokens for bastions or databases, which allows you to manage assets.

    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:GenerateAssetOperationToken

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the bastion host instance.

    Note

    You can call the DescribeInstances operation to query the ID.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the bastion host instance.

    Note

    For more information about region IDs, see Regions and zones.

    cn-hangzhou
    AssetType

    string

    Yes

    The type of the asset for which you want to generate an O&M token. Valid values:

    • Host

    • Database

    Host
    AssetId

    string

    Yes

    The ID of the asset.

    11
    AssetAccountId

    string

    No

    The ID of the asset account.

    Note

    You must specify at least one of AssetAccountId and AssetAccountName. If you specify both parameters, AssetAccountId is used.

    2
    AssetAccountName

    string

    No

    The name of the asset account. If this parameter specifies a custom account, you must enter the actual account name.

    Note

    If you specify both AssetAccountId and AssetAccountName, AssetAccountId is used.

    root
    AssetAccountPassword

    string

    No

    The password that is encoded in Base64. This parameter is required if you want to generate an O&M token for a custom account.

    dGVzdHBhc3N3b3Jk
    AssetAccountProtocolName

    string

    No

    The protocol that is used to connect to the asset. Valid values:

    • SSH

    • RDP

    • Oracle

    • PostgreSQL

    • MySQL

    • SQLServer

    Note

    This parameter is required if you want to generate an O&M token for a custom account.

    SSH
    OperationMode

    string

    No

    The O&M mode. Valid values:

    • WebToken: generates an O&M token.

    • Sso: logs on to the client.

    Note

    This parameter is supported only by bastion hosts of V3.2.44 or later. If you do not specify this parameter, WebToken is used.

    Sso
    LoginAttribute

    string

    No

    The logon attribute. This parameter is required if you set OperationMode to Sso and use a custom Oracle account. Valid values:

    • SERVICENAME

    • SID

    Note

    This parameter is supported only by bastion hosts of V3.2.44 or later.

    SID
    DatabaseSchema

    string

    No

    The name of the database. This parameter is required for a custom account if you set OperationMode to Sso and AssetAccountProtocolName to PostgreSQL or Oracle.

    Note

    This parameter is supported only by bastion hosts of V3.2.44 or later.

    orcl
    SsoClient

    string

    No

    The type of the client that you want to use for O&M on a Linux asset. This parameter is required if you set OperationMode to Sso and the asset protocol to SSH. Valid values:

    • ssh: opens a client that supports the SSH protocol to perform O&M with SSH permissions.

    • sftp: opens a client that supports the SFTP protocol to perform O&M with SFTP permissions.

    Note

    This parameter is supported only by bastion hosts of V3.2.44 or later.

    ssh
    OperationNote

    string

    No

    The remarks for the logon. This parameter is required if your administrator enables logon remarks in the control policy.

    comment

    Response elements

    Element

    Type

    Description

    Example

    object

    AssetOperationToken

    object

    The asset operation token.

    CountLeft

    integer

    The number of remaining uses for the token.

    1
    ExpireTime

    integer

    The expiration time of the token. This value is a UNIX timestamp.

    1709110797
    HasCountLimit

    boolean

    Indicates whether the token has a use limit.

    true
    MaxRenewCount

    integer

    The maximum number of times the token can be renewed. A value of 0 indicates that the token cannot be renewed.

    10
    RenewCount

    integer

    The number of times the token has been renewed.

    1
    Token

    string

    The O&M token that is requested.

    NmYyMmEzNmMwYzljNGY******
    TokenId

    string

    The ID of the O&M token.

    1
    SsoUrl

    string

    The single sign-on (SSO) URL.

    sso://eyJOT0RFX0NPTU1PTiI6eyJNb2R******
    RequestId

    string

    The ID of the request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    Examples

    Success response

    JSON format

    {
  "AssetOperationToken": {
    "CountLeft": 1,
    "ExpireTime": 1709110797,
    "HasCountLimit": true,
    "MaxRenewCount": 10,
    "RenewCount": 1,
    "Token": "NmYyMmEzNmMwYzljNGY******",
    "TokenId": "1",
    "SsoUrl": "sso://eyJOT0RFX0NPTU1PTiI6eyJNb2R******"
  },
  "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.