All Products
Search

This Product

    Bastionhost:GenerateAssetOperationToken

    Document Center

    Bastionhost:GenerateAssetOperationToken

    Last Updated:Oct 09, 2026

    Applies for a host or database O&M token to perform O&M operations on 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 instance ID of the Bastionhost instance for which you want to apply for an O&M token.

    Note

    You can invoke the DescribeInstances operation to obtain the value of this parameter.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the Bastionhost instance.

    Note

    For more information about the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou
    AssetType

    string

    Yes

    The Asset Type for which you want to apply for a token. Valid values:

    • Host: host

    • Database: 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 asset account for which you want to apply for an O&M token.

    Note

    You must specify at least one of AssetAccountId and AssetAccountName. If both are specified, AssetAccountId takes precedence.

    2
    AssetAccountName

    string

    No

    The name of the host account. If the account is a custom account, specify the actual account name.

    Note

    If both AssetAccountId and AssetAccountName are specified, AssetAccountId takes precedence.

    root
    AssetAccountPassword

    string

    No

    The Base64-encoded password. This parameter is required when you 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

    Note

    This parameter is required when you apply for an O&M token for a custom account.

    SSH
    OperationMode

    string

    No

    The O&M logon method. Valid values:

    • WebToken: obtain an O&M token

    • Sso: log on by using a local client

    Note

    This parameter is supported only in Bastionhost V3.2.44 and later. If this parameter is left empty, the default value WebToken is used.

    Valid values:

    • Sso :

      Log on by using a local client.

    • WebToken :

      Obtain an O&M token.

    Sso
    LoginAttribute

    string

    No

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

    • SERVICENAME

    • SID

    Note

    This parameter is supported only in Bastionhost V3.2.44 and later.

    Valid values:

    • SERVICENAME :

      Service name.

    • SID :

      SID

    SID
    DatabaseSchema

    string

    No

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

    Note

    This parameter is supported only in Bastionhost V3.2.44 and later.

    orcl
    SsoClient

    string

    No

    The type of the local client to be opened for O&M operations on Linux assets. This parameter is required when OperationMode is set to Sso and the asset protocol is SSH. Valid values:

    • ssh: open an SSH client to perform O&M operations with SSH permissions

    • sftp: open an SFTP client to perform O&M operations with SFTP permissions

    Note

    This parameter is supported only in Bastionhost V3.2.44 and later.

    Valid values:

    • ssh :

      SSH client.

    • sftp :

      SFTP client.

    ssh
    OperationNote

    string

    No

    The logon note. This parameter is required when the administrator enables the logon note feature in the control policy.

    comment

    Response elements

    Element

    Type

    Description

    Example

    object

    AssetOperationToken

    object

    The response data.

    CountLeft

    integer

    The remaining number of times the O&M token can be used.

    1
    ExpireTime

    integer

    The expiration time of the O&M token. The value is a UNIX timestamp.

    1709110797
    HasCountLimit

    boolean

    Indicates whether the number of uses is limited.

    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 requested O&M token.

    NmYyMmEzNmMwYzljNGY******
    TokenId

    string

    The ID of the O&M token.

    1
    SsoUrl

    string

    The single sign-on 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.