Criação de uma versão de segredo
Função
Essa API é usada para criar uma nova versão de um segredo para criptografar e manter o novo valor do segredo. Por padrão, a versão de segredo mais recente no estado SYSCURRENT. A versão anterior está no estado SYSPREVIOUS. Você pode configurar o VersionStage para substituir as configurações padrão.
Restrições
- O console do CSMS usa apenas o campo secret_string. Para adicionar um segredo binário ao campo secret_binary, é necessário usar um SDK ou uma API.
- Um segredo pode ter até 20 versões.
- Você só pode adicionar versões aos segredos ativados.
- As versões de segredos são numeradas v1, v2, v3 e assim por diante, com base em seu tempo de criação.
URI
POST /v1/{project_id}/secrets/{secret_name}/versions
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto |
|
secret_name |
Sim |
String |
Nome de segredo |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Ele pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho da resposta). |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
secret_binary |
Não |
String |
Valor de um novo segredo. Ele será criptografado e armazenado na versão inicial do segredo. Tipo: objeto de dados binários no formato Base64 Restrições: você deve configurar um e somente um de secret_binary e secret_string. O tamanho máximo é de 32 KB. |
|
secret_string |
Não |
String |
Valor de um novo segredo. Ele será criptografado e armazenado na versão inicial do segredo. Restrições: você deve configurar um e somente um de secret_binary e secret_string. O tamanho máximo é de 32 KB. |
|
version_stages |
Não |
Array of strings |
Status de uma nova versão de segredo. Se este parâmetro não for especificado, a versão padrão SYSCURRENT será usada. Restrição: a matriz pode conter de 1 a 12 itens. O comprimento do estágio é de 1 a 64 bytes. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
version_metadata |
VersionMetadata object |
Status de uma versão de segredo. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID de uma versão de segredo. Um segredo não pode ter IDs de versão duplicadas. |
|
create_time |
Long |
Tempo de criação da versão de segredo. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). |
|
kms_key_id |
String |
ID da CMK do KMS usado para criptografar valores do segredo. |
|
secret_name |
String |
Nome de segredo |
|
version_stages |
Array of strings |
Status de uma versão de segredo. Uma tag de status pode ser usada para apenas uma versão de cada segredo. Por exemplo, se você adicionar a tag de status usada pela versão A à versão B, a tag será movida da versão A para a versão B. Se o parâmetro version_stage não for especificado, o status da versão mais recente será SYSCURRENT por padrão. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro |
|
error_msg |
String |
Descrição do erro |
Exemplo de solicitação
{
"secret_string" : "secret_string"
}
Exemplo de resposta
Código de status: 200
O pedido foi bem-sucedido.
{
"version_metadata" : {
"id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
"create_time" : 1581507580000,
"secret_name" : "secret-name-demo",
"version_stages" : [ "pending", "used" ]
}
}
Código de status
|
Código de status |
Descrição |
|---|---|
|
200 |
O pedido foi bem-sucedido. |
|
400 |
Erro na solicitação. |
Código de erro
Para obter detalhes, consulte Códigos de erro.