创建轻量应用服务器密钥对。
接口说明
阿里云 SSH 密钥对是一种安全便捷的登录认证方式,用于在 SSH 协议中进行身份验证和加密通信。由公钥和私钥组成,仅支持 Linux 实例,满足您对更高安全性、便利性的业务需求。
- 仅支持 Linux 系统的轻量应用服务器设置密钥对登录的方式。
- 一个阿里云账号在一个地域下最多可以创建 10 个密钥对。
- 控制台仅支持创建 RSA 2048 位密钥对。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
swas-open:CreateKeyPair | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 指定的轻量数据库实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。 | cn-hangzhou |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
KeyPairName | string | 是 | 密钥对名称。长度为 2~64 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://或 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 | KeyPairName |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
"KeyPairName": "KeyPairName",
"PrivateKeyBody": "MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | KeyPairNameAlreadyExist | The keyPair name already exist. |
访问错误中心查看更多错误码。