CreateKeyPair - 创建一对SSH密钥对

调用CreateKeyPair创建一对SSH密钥对。

接口说明

边缘节点服务 ENS 会为您保管密钥的公钥部分,并返回未加密的 PEM 编码的 PKCS#8 格式私钥。您需要自行妥善保管私钥部分。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:CreateKeyPaircreate
*全部资源
*

请求参数

名称类型必填描述示例值
KeyPairNamestring

密钥对名称。命名规则如下所示:

  • 长度为 2~128 个英文或中文字符。

  • 必须以大小字母或中文开头,不能以http://https://开头。

  • 可以包含数字、半角冒号(:)、下划线(_)、或者连字符(-)。

TestKeyPairName

返回参数

名称类型描述示例值
object
KeyPairFingerPrintstring

密钥对的指纹。根据 RFC4716 定义的公钥指纹格式,采用 MD5 信息摘要算法。详情请参见 RFC4716

7880c1ad4687fdbf7a6da2131****
KeyPairIdstring

SSH 密钥对的 ID。

ssh-5lywanlkih1zo9yl8eg****
KeyPairNamestring

密钥对名称。

TestKeyPairName
PrivateKeyBodystring

密钥对的私钥。PEM 编码的 PKCS#8 格式的私钥部分。

-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQE****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "KeyPairFingerPrint": "7880c1ad4687fdbf7a6da2131****",
  "KeyPairId": "ssh-5lywanlkih1zo9yl8eg****",
  "KeyPairName": "TestKeyPairName",
  "PrivateKeyBody": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQE****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.接口调用出错。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情