CreateKeyPair_轻量应用服务器_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

阿里云 SSH 密钥对是一种安全便捷的登录认证方式,用于在 SSH 协议中进行身份验证和加密通信。由公钥和私钥组成,仅支持 Linux 实例,满足您对更高安全性、便利性的业务需求。

  • 仅支持 Linux 系统的轻量应用服务器设置密钥对登录的方式。
  • 一个阿里云账号在一个地域下最多可以创建 10 个密钥对。
  • 控制台仅支持创建 RSA 2048 位密钥对。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
swas-open:CreateKeyPair
Create
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

指定的轻量数据库实例所属的地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    ListRegions
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性

示例值:123e4567-e89b-12d3-a456-426655440000
KeyPairNamestring

密钥对名称。长度为 2~64 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://或 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

示例值:KeyPairName参考取值来源:
    ImportKeyPair
    ListKeyPairs
    CreateInstanceKeyPair
    DescribeInstanceKeyPair

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:20758A-585D-4A41-A9B2-28DA8F4F****
KeyPairNamestring

密钥对名称。长度为 2~64 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://或 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

示例值:KeyPairName
PrivateKeyBodystring

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

示例值:MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
KeyPairNameAlreadyExist
The keyPair name already exist.诊断

变更历史

暂无变更历史

相关示例