華為云計(jì)算 云知識(shí) 創(chuàng)建和導(dǎo)入SSH密鑰NovaCreateKeypair
創(chuàng)建和導(dǎo)入SSH密鑰NovaCreateKeypair

 

功能介紹

創(chuàng)建SSH密鑰,或把公鑰導(dǎo)入系統(tǒng),生成密鑰對(duì)。

創(chuàng)建SSH密鑰成功后,請把響應(yīng)數(shù)據(jù)中的私鑰內(nèi)容保存到本地文件,用戶使用該私鑰登錄 云服務(wù)器 。為保證云服務(wù)器安全,私鑰數(shù)據(jù)只能讀取一次,請妥善保管。

密鑰對(duì)創(chuàng)建后默認(rèn)是屬于創(chuàng)建用戶的,如果是子帳號(hào)創(chuàng)建的密鑰,包括主帳號(hào)在內(nèi)的其他用戶無法查看不屬于本用戶的密鑰對(duì)。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

POST /v2.1/{project_id}/os-keypairs

參數(shù)說明請參見表1。
表1 參數(shù)說明

參數(shù)

是否必選

描述

project_id

項(xiàng)目ID。

獲取方法請參見獲取項(xiàng)目ID。

請求消息

請求參數(shù)如表2所示。

創(chuàng)建SSH密鑰時(shí),只需要提交SSH密鑰的name屬性。導(dǎo)入SSH密鑰時(shí),才需要提交public_key屬性。

表2 請求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

keypair

Object

創(chuàng)建或?qū)氲腟SH密鑰信息,詳情請參見表3。

表3 keypair字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

public_key

String

導(dǎo)入的公鑰信息。

建議導(dǎo)入的公鑰長度不大于1024字節(jié)。

說明:

長度超過1024字節(jié)會(huì)導(dǎo)致云服務(wù)器注入該密鑰失敗。

type

String

密鑰類型,值為“ssh”“x509”

微版本2.2及以上版本支持。

name

String

密鑰名稱。

新創(chuàng)建的密鑰名稱不能和已有密鑰名稱相同。

user_id

String

密鑰的用戶ID。

微版本2.10及以上版本支持。

響應(yīng)消息

響應(yīng)參數(shù)如表4所示。
表4 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

keypair

Object

SSH密鑰信息,詳情請參見表5。

表5 keypair字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

參數(shù)類型

描述

fingerprint

String

密鑰對(duì)應(yīng)指紋信息。

name

String

密鑰名稱。

public_key

String

密鑰對(duì)應(yīng)publicKey信息。

private_key

String

密鑰對(duì)應(yīng)privateKey信息。

  • 創(chuàng)建SSH密鑰時(shí),響應(yīng)中包括private_key的信息。
  • 導(dǎo)入SSH密鑰時(shí),響應(yīng)中不包括private_key的信息。

user_id

String

密鑰所屬用戶ID。

type

String

密鑰類型,值為“ssh”“x509”。

微版本2.2及以上版本支持。

請求示例

  • 導(dǎo)入SSH密鑰。
  • 創(chuàng)建SSH密鑰。
    POST https://{endpoint}/v2.1/{project_id}/os-keypairs
    
    {
        "keypair": {
            "name": "demo"
        }
    }

響應(yīng)示例

查看>>


返回值

請參考通用請求返回值。