修改主机账户信息,支持修改主机账户的名称、密码和私钥信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-bastionhost:ModifyHostAccount | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 指定要修改的主机账户所在堡垒机的实例 ID。 说明
可通过调用 DescribeInstances 接口获取堡垒机实例 ID。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 指定要查询的主机账户所在堡垒机的区域 ID。 说明
地域 ID 和地域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
HostAccountId | string | 是 | 指定要修改的主机账户 ID。 说明
您可以调用 ListHostAccounts 接口获取该参数。
| 1 |
HostAccountName | string | 否 | 指定修改后的主机账户名称,最多支持 128 字符。 | abc |
Password | string | 否 | 指定修改后的主机账户密码。 | 123456 |
PrivateKey | string | 否 | 指定修改后的主机账户私钥,私钥为使用 Base64 编码后的字符串。 说明
主机账户协议为 SSH 时,该参数生效。主机账户协议为 RDP 时,无需配置该参数。您可以调用 GetHostAccount 接口查询主机账户使用的协议。支持同时为主机账户配置密码和私钥。在连接资产时,堡垒机会优先使用私钥进行连接。
| -----BEGIN RSA PRIVATE KEY----- ...... -----END RSA PRIVATE KEY----- |
PassPhrase | string | 否 | 指定修改后的主机账户的私钥口令。 说明
主机账户协议为 SSH 时,该参数生效。主机账户协议为 RDP 时,无需配置该参数。
| 123456 |
HostShareKeyId | string | 否 | 主机共享密钥 ID。 说明
此 ID 可通过调用 ListHostShareKeys 接口获取。
| 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
404 | HostAccountNotFound | The host account is not found. | 主机账号不存在 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。