Crear e importar un par de claves SSH
Función
Esta API se utiliza para crear e importar un par de claves SSH.
URI
POST /v3/{project_id}/keypairs
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. El token se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta). |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
keypair |
Sí |
CreateKeypairAction object |
Parámetro en el cuerpo de la solicitud para crear un par de claves. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
name |
Sí |
String |
Nombre del par de claves SSH.
|
|
type |
No |
String |
Tipo de par de claves SSH. |
|
public_key |
No |
String |
Cadena de la clave pública importada. |
|
scope |
No |
String |
Nivel de inquilino o nivel de usuario. |
|
user_id |
No |
String |
Usuario al que pertenece un par de claves SSH. |
|
key_protection |
No |
KeyProtection object |
Alojamiento de claves privadas y protección para el par de claves SSH. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
private_key |
No |
String |
Clave privada del par de claves SSH importadas. |
|
encryption |
No |
Encryption object |
Cómo se cifra y se almacena una clave privada. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
type |
No |
String |
Opciones de valor:
|
|
kms_key_name |
No |
String |
Nombre de una clave KMS.
|
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
keypair |
CreateKeypairResp object |
Detalles del par de claves SSH. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
name |
String |
Nombre del par de claves SSH. |
|
type |
String |
Tipo de par de claves SSH. |
|
public_key |
String |
Información de clave pública sobre un par de claves SSH. |
|
private_key |
String |
Información de clave privada sobre un par de claves SSH.
|
|
fingerprint |
String |
Información de huellas dactilares sobre un par de claves SSH. |
|
user_id |
String |
Usuario al que pertenece un par de claves SSH. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Solicitudes de ejemplo
{
"keypair" : {
"name" : "demo2"
}
}
Ejemplo de respuestas
Código de estado: 200
OK.
{
"keypair" : {
"name" : "demo",
"type" : "ssh",
"public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...",
"private_key" : "-----BEGIN RSA PRIVATE KEY-----...",
"fingerprint" : "49:ef:73:2b:9b:7f:2e:0c:58:d3:e3:42:8e:28:04:3b",
"user_id" : "e4f380899b1248918f3d37098dc63746"
}
}
Código de estado: 400
Se ha producido un error.
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK. |
|
400 |
Error occurred. |
Códigos de error
Consulte Códigos de error.