导入已有密钥对--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

导入已有密钥对

最近更新时间：2024.07.08 16:21:02首次发布时间：2022.02.25 18:58:32

本接口用于导入已存在的密钥对。

使用说明

使用限制：
目前仅支持 ssh-rsa 格式。
注意事项：
导入密钥对后，系统为您保管公钥部分，您需要自行妥善保存密钥对的私钥部分。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=ImportSSHKey&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ImportSSHKey	公共参数。该参数表示接口名称。取值：ImportSSHKey。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
key_pair_name	String	是	mykeys	密钥对名称。
public_key	String	是	ssh-rsa AAAAB3NzaC1y****	公钥内容。

返回参数

参数	类型	示例值	描述
key_pair	SSHKeyPair	请参见返回示例	密钥对信息。

请求示例

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 请求失败。关于错误码的更多信息，参见错误码。