您可以通过该接口申请主机或数据库运维令牌,并通过运维令牌运维资产。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-bastionhost:GenerateAssetOperationToken | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 指定要申请运维令牌操作所在堡垒机的实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 堡垒机的地域 ID。 说明
地域 ID 和地域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
AssetType | string | 是 | 指定要申请令牌的资产类型。取值:
| Host |
AssetId | string | 是 | 需要申请运维令牌的资产 ID。 | 11 |
AssetAccountId | string | 否 | 申请运维令牌的资产账户 ID。 说明
AssetAccountId 和 AssetAccountName 需要至少指定一个,当同时指定时,优先使用 AssetAccountId。
| 2 |
AssetAccountName | string | 否 | 主机账号名,当为自定义账号时,填写真实账户名。 说明
当 AssetAccountId 和 AssetAccountName 同时指定时,优先使用 AssetAccountId。
| root |
AssetAccountPassword | string | 否 | base64 后的密码。当为自定义账号申请运维令牌时必填。 | dGVzdHBhc3N3b3Jk |
AssetAccountProtocolName | string | 否 | 协议名称。取值:
| SSH |
OperationMode | string | 否 | 运维登录方式。取值:
说明
仅支持 V3.2.44 及以上版本使用,为空时默认取值为 WebToken。
| Sso |
LoginAttribute | string | 否 | 登录属性,当 OperationMode 为 Sso 且账户为 Oracle 类型自定义账户时必须指定,取值:
说明
仅支持 V3.2.44 及以上版本使用。
| SID |
DatabaseSchema | string | 否 | 数据库名。当 OperationMode 为 Sso 且 AssetAccountProtocolName 为 PostgreSQL 或 Oracle,且为自定义账户时,DatabaseSchema 为必填。 说明
仅支持 V3.2.44 及以上版本使用。
| orcl |
SsoClient | string | 否 | linux 资产运维需打开的本地客户端类型。当 OperationMode 为 Sso 且资产协议为 SSH 时必传。取值:
说明
仅支持 V3.2.44 及以上版本使用。
| ssh |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-05 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |