创建密钥对--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

创建密钥对

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

本接口用于创建密钥对。

使用说明

除了调用 GenerateSSHKey 创建密钥对之外，您还可以使用第三方工具创建密钥对，然后使用 ImportSSHKey 接口进行上传。
系统会为您保管密钥的公钥部分，并返回未加密的 PEM 编码的 PKCS#8 格式私钥。您需要自行妥善保管私钥部分。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
key_pair_name	String	是	new-key	密钥对名称，命名规则如下：允许5~20个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。

参数

类型

是否必选

示例值

描述

key_pair_name

String

是

new-key

密钥对名称，命名规则如下：

允许5~20个字符。
支持中文、大写字母、小写字母、数字。
支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=GenerateSSHKey&Version=2021-04-30
&<其他公共参数>
{
  "key_pair_name":"My_keypair"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230525205151CFFD5D80B4A17C18****",
        "Action": "GenerateSSHKey",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "key_pair": {
            "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAn4rGQyVYKcjDi+BML+2DzoHSwdC****HbGckrg32/OH\n-----END RSA PRIVATE KEY-----\n",
            "key_pair_identity": "sshkey-rdgpt4p9v7m****"
        }
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。