Criação e importação de um par de chaves SSH
Função
Essa API é usada para criar e importar um par de chaves SSH.
URI
POST /v3/{project_id}/keypairs
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta). |
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
keypair |
Sim |
CreateKeypairAction object |
Parâmetro no corpo da solicitação para criar um par de chaves. |
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
name |
Sim |
String |
Nome do par de chaves SSH.
|
|
type |
Não |
String |
Tipo de par de chaves SSH. |
|
public_key |
Não |
String |
Cadeia da chave pública importada. |
|
scope |
Não |
String |
Nível de locatário ou nível de usuário. |
|
user_id |
Não |
String |
Usuário ao qual pertence um par de chaves SSH. |
|
key_protection |
Não |
KeyProtection object |
Hospedagem de chave privada e proteção para o par de chaves SSH. |
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
private_key |
Não |
String |
Chave privada do par de chaves SSH importado. |
|
encryption |
Não |
Encryption object |
Como uma chave privada é criptografada e armazenada. |
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
type |
Não |
String |
Opções de valor:
|
|
kms_key_name |
Não |
String |
Nome de uma chave de KMS.
|
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
keypair |
CreateKeypairResp object |
Detalhes do par de chaves SSH. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
name |
String |
Nome do par de chaves SSH. |
|
type |
String |
Tipo de par de chaves SSH. |
|
public_key |
String |
Informações de chave pública sobre um par de chaves SSH. |
|
private_key |
String |
Informações de chave privada sobre um par de chaves SSH.
|
|
fingerprint |
String |
Informações de impressão digital sobre um par de chaves SSH. |
|
user_id |
String |
Usuário ao qual pertence um par de chaves SSH. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitações
{
"keypair" : {
"name" : "demo2"
}
}
Exemplo de respostas
Código de status: 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 status: 400
Ocorreu um erro.
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
OK. |
|
400 |
Ocorreu um erro. |
Códigos de erro
Consulte Códigos de erro.