Consulta da versão e o valor do segredo
Função
Essa API é usada para consultar as informações sobre uma versão de segredo especificada e o valor de segredo de texto não criptografado na versão. Somente as credenciais no estado Enabled podem ser consultadas. O valor da última versão de segredo pode ser obtido via /v1/{project_id}/secrets/{secret_id}/versions/latest.
URI
GET /v1/{project_id}/secrets/{secret_name}/versions/{version_id}
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto |
|
secret_name |
Sim |
String |
Nome de segredo |
|
version_id |
Sim |
String |
ID da versão de segredo |
Parâmetro 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âmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
version |
Version object |
Versão de segredo |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
version_metadata |
VersionMetadata object |
Status de uma versão de segredo |
|
secret_binary |
String |
Texto não criptografado de um segredo binário no formato Base64. O CSMS o criptografa e o armazena na versão inicial do segredo. Tipo: objeto de dados binários no formato Base64 |
|
secret_string |
String |
Texto não criptografado de um segredo binário em formato de texto. O CSMS o criptografa e o armazena na versão inicial do 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
Nenhum
Exemplo de resposta
Código de status: 200
O pedido foi bem-sucedido.
{
"version" : {
"version_metadata" : {
"id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
"create_time" : 1581507580000,
"secret_name" : "secret-name-demo",
"version_stages" : [ "pending", "used" ]
},
"secret_binary" : "secret_binary",
"secret_string" : "secret_string"
}
}
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.