SSH密钥
概览
SSH密钥：SSH密钥是一种安全的云主机登录认证方式，由一个公钥和一个私钥组成。仅Linux云主机支持通过SSH密钥登录。
功能特点
SSH密钥具有以下功能特点：
- 安全性：SSH密钥登录采用非对称加密方式，能有效降低暴力破解风险。
- 便捷性：SSH密钥登录时无需输入密码，登录端配置私钥后，可快捷登录目标云主机。
- 使用限制：SSH密钥登录仅适用于Linux云主机root用户。
快速使用流程
用户可参考以下步骤快速使用SSH密钥：
- 生成SSH密钥对，并妥善保管自动下载的私钥。
- 将SSH公钥绑定到目标云主机。
- 将SSH私钥上传到登录端，并执行
ssh -i ${private_key.pem} ${UserName}@${IpAddress}登录目标云主机。
Note: 登录命令中，${private_key.pem}指私钥文件路径，${UserName}指登录用户名，${IpAddress}指目标云主机的IP地址，例如：
ssh -i private_key.pem root@172.20.20.194清单
SSH密钥清单(SshKeyPair Inventory)
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 请参见资源属性 | 4.7.21 | ||
| name | 请参见资源属性 | 4.7.21 | ||
| description | 请参见资源属性 | 是 | 4.7.21 | |
| groupBy | 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type | 是 | 4.7.21 | |
| SystemTag | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| tagUuid | 标签UUID | 是 | 4.7.21 | |
| userTag | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| publicKey | 4.7.21 | |||
| createDate | 请参见资源属性 | 是 | 4.7.21 | |
| lastOpDate | 请参见资源属性 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
示例
{
"inventories": [
{
"createDate": "Sep 25, 2023 1:29:04 PM",
"lastOpDate": "Sep 25, 2023 1:29:04 PM",
"name": "miyao",
"publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCfn8GoxuWrqBixsiySD6oqka1W2XsE9RrP4auc0qK9SeKfKsZ+gPa8iXUu1kG7
LqGhp26TgriaYSKJpnWeV3VU0OgUYOv6RVF9YGCXiUfQd6EyN/qjR+KbF6A4HV0J6JBhmy/7YWv45zNsC92pLFubInhjvE2WqWeWYAg+laUir/a4wh6eKDZR1wgtDX
KUJ3CZCfCDXgaO0ML1QYSBihzJeP9b06ttyzwF7XqHYjDYulmjX0JUnIb3p5M4erT0rNN+w5hHdg1i1LfzIRtNqcK91DJ06rKUNzcgmyJuL7HOxxgpNo5fGXaqY4QA
GdRyoR7MTpChLpBN94TuyEV8f7sN ",
"uuid": "86f08f4c06c84b3898829d73a47cb009"
}
],
"success": true
}操作（Operations）
生成SSH密钥(GenerateSshKeyPair)
管理员可以使用GenerateSshKeyPair生成SSH密钥。例如：
GenerateSshKeyPair name=ssh-key-pair参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 资源名称 | 4.7.21 | ||
| description | 资源的详细描述 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
上传SSH密钥(CreateSshKeyPair)
管理员可以使用CreateSshKeyPair上传SSH密钥。例如：
CreateSshKeyPair name=ssh-key-pair publicKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNMQriGc2KPLlKROR4kg9nAgzHv0Wa8wBNcOkqhH50Pfshv4f6r+y3e4mHW6pcyiw65Vv6qUrgnvhBzkBrWaOwXMVwnVj3SAWoop9k2yhRMYOW9cC5JReNPH3I1GvlSmGwXt3h2PW1O3o+pvWpvQM7tw+vWydhX5otvj9yXaepfRSrQV4iMWBvHnDMlgY1MpWQzYx7W9OZp0uT2tBTAzhK47o2Vx81Z8ImHNFk0OkFSTBo4NFQlu4LPDRBnpuWwh/tfy2BelsvoBYZ6CgXaky0cEtC1nfn9X4aQXXlbo5UKh9vS/Xj4J8UL+EKBJ0bMA36WzaaIeX/KuYXVVt1Al5参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 资源名称 | 4.7.21 | ||
| publicKey | 资源名称 | 4.7.21 | ||
| description | 资源的详细描述 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
删除SSH密钥(DeleteSshKeyPair)
管理员可以使用DeleteSshKeyPair删除SSH密钥。例如：
DeleteSshKeyPair uuid=86f08f4c06c84b3898829d73a47cb009参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 4.7.21 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
查询SSH密钥(QuerySshKeyPair)
管理员可以使用QuerySshKeyPair查询SSH密钥。例如：
QuerySshKeyPair uuid=86f08f4c06c84b3898829d73a47cb009原生域查询（Primitive Fields of Query）
请参见 查询SSH密钥。
更新SSH密钥(UpdateSshKeyPair)
管理员可以使用UpdateSshKeyPair更新SSH密钥。例如：
UpdateSshKeyPair uuid=cbd93a2598fc424aa4f890ec3fb670d5
参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源的UUID，唯一标示该资源 | 4.7.21 | ||
| name | 资源名称 | 是 | 4.7.21 | |
| description | 资源的详细描述 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
云主机挂载密钥对(AttachSshKeyPairToVmInstance)
管理员可以使用AttachSshKeyPairToVmInstance将SSH密钥挂载到云主机。例如：
AttachSshKeyPairToVmInstance vmInstanceUuid=e6251b82663b4ad5a5501f02dcfc60ab sshKeyPairUuid=cbd93a2598fc424aa4f890ec3fb670d5
参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| vmInstanceUuid | 云主机UUID | 4.7.21 | ||
| sshKeyPairUuid | url | 4.7.21 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
云主机卸载密钥对(DetachSshKeyPairFromVmInstance)
管理员可以使用DetachSshKeyPairToVmInstance从云主机卸载SSH密钥。例如：
DetachSshKeyPairToVmInstance vmInstanceUuid=e6251b82663b4ad5a5501f02dcfc60ab sshKeyPairUuid=cbd93a2598fc424aa4f890ec3fb670d5参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| vmInstanceUuid | 云主机UUID | 4.7.21 | ||
| sshKeyPairUuid | url | 4.7.21 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 |
标签（Tags）
用户可以使用resourceType=VolumeSnapshotVO创建快照组用户标签。
例如：
CreateUserTag resourceType=VolumeSnapshotVO tag=golden-ResourceStack
resourceUuid=27260a1dfa93453087d67c69dc78805c