本接口用于导入已存在的密钥对。
使用限制:
目前仅支持 ssh-rsa 格式。
注意事项:
导入密钥对后,系统为您保管公钥部分,您需要自行妥善保存密钥对的私钥部分。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ImportSSHKey | 接口名称。当前 API 的名称为 ImportSSHKey。 |
Version | String | 是 | 2021-04-30 | 接口版本。当前 API 的版本为 2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
project | String | 否 | default | 密钥对所属项目。 |
key_pair_name | String | 是 | mykeys | 密钥对名称。 |
public_key | String | 是 | ssh-rsa AAAAB3NzaC1y**** | 公钥内容。 |
Tags | Object[] | 否 | - | 标签。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结果。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
key_pair | Object | - | 密钥对信息。 |
POST https://veenedge.volcengineapi.com/?Action=ImportSSHKey&Version=2021-04-30 &<其他公共参数> { "key_pair_name": "mykeys", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCwMkr****===" }
{ "ResponseMetadata": { "RequestId": "20240417172506E088655F0DC70267****", "Action": "ImportSSHKey", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "key_pair": { "key_pair_identity": "sshkey-v8gzvhvtpsv****" } } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。