全部产品
Search

搜索本产品

    运维安全中心（堡垒机）：GenerateAssetOperationToken - 申请运维令牌

    文档中心

    运维安全中心（堡垒机）：GenerateAssetOperationToken - 申请运维令牌

    更新时间：Dec 16, 2024

    您可以通过该接口申请主机或数据库运维令牌，并通过运维令牌运维资产。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-bastionhost:GenerateAssetOperationTokencreate
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    指定要申请运维令牌操作所在堡垒机的实例 ID。

    说明 您可以调用 DescribeInstances 接口获取该参数。
    		bastionhost-cn-st220aw****
    RegionIdstring否

    堡垒机的地域 ID。

    说明 地域 ID 和地域名称的对应关系，请参见地域和可用区。
    		cn-hangzhou
    AssetTypestring是

    指定要申请令牌的资产类型。取值：

    • Host：主机。
    • Database：数据库。
    		Host
    AssetIdstring是

    需要申请运维令牌的资产 ID。

    		11
    AssetAccountIdstring否

    申请运维令牌的资产账户 ID。

    说明 AssetAccountId 和 AssetAccountName 需要至少指定一个，当同时指定时，优先使用 AssetAccountId。
    		2
    AssetAccountNamestring否

    主机账号名，当为自定义账号时，填写真实账户名。

    说明 当 AssetAccountId 和 AssetAccountName 同时指定时，优先使用 AssetAccountId。
    		root
    AssetAccountPasswordstring否

    base64 后的密码。当为自定义账号申请运维令牌时必填。

    		dGVzdHBhc3N3b3Jk
    AssetAccountProtocolNamestring否

    协议名称。取值：

    • SSH
    • RDP
    • Oracle
    • PostgreSQL
    • MySQL
    • SQLServer
    		SSH
    OperationModestring否

    运维登录方式。取值：

    • WebToken：获取运维令牌。
    • Sso：本地客户端登录。
    说明 仅支持 V3.2.44 及以上版本使用，为空时默认取值为 WebToken。
    		Sso
    LoginAttributestring否

    登录属性，当 OperationMode 为 Sso 且账户为 Oracle 类型自定义账户时必须指定，取值：

    • SERVICENAME
    • SID
    说明 仅支持 V3.2.44 及以上版本使用。
    		SID
    DatabaseSchemastring否

    数据库名。当 OperationMode 为 Sso 且 AssetAccountProtocolName 为 PostgreSQL 或 Oracle，且为自定义账户时，DatabaseSchema 为必填。

    说明 仅支持 V3.2.44 及以上版本使用。
    		orcl
    SsoClientstring否

    linux 资产运维需打开的本地客户端类型。当 OperationMode 为 Sso 且资产协议为 SSH 时必传。取值：

    • ssh：打开 SSH 协议客户端，以 SSH 权限进行运维。
    • sftp：打开 SFTP 协议客户端，以 SFTP 权限进行运维。
    说明 仅支持 V3.2.44 及以上版本使用。
    		ssh

    返回参数

    名称类型描述示例值
    object
    AssetOperationTokenobject

    响应数据。

    CountLeftlong

    运维令牌剩余可使用的次数。

    		1
    ExpireTimelong

    运维令牌过期时间。时间戳格式。

    		1709110797
    HasCountLimitboolean

    是否有使用次数限制.

    		true
    MaxRenewCountlong

    最大续期次数，0 表示不可续期。

    		10
    RenewCountlong

    已经续期的次数。

    		1
    Tokenstring

    申请的运维令牌。

    		NmYyMmEzNmMwYzljNGY******
    TokenIdstring

    运维令牌 ID。

    		1
    SsoUrlstring

    单点登录链接。

    		sso://eyJOT0RFX0NPTU1PTiI6eyJNb2R******
    RequestIdstring

    阿里云为该请求生成的唯一标识符。

    		EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameterThe argument is invalid.参数错误
    500InternalErrorAn unknown error occurred.未知错误

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-11-05OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情