Consulta de um segredo
Função
Essa API é usada para consultar um segredo.
Restrições
As informações retornadas por meio dessa API são os metadados do segredo e não contêm o valor do segredo.
URI
GET /v1/{project_id}/secrets/{secret_name}
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto |
secret_name |
Sim |
String |
Nome 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 |
---|---|---|
secret |
Secret object |
Segredo |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do segredo |
name |
String |
Nome de segredo |
state |
String |
Status de segredo. Seu valor pode ser: ENABLED DISABLED PENDING_DELETE FROZEN |
kms_key_id |
String |
ID da CMK do KMS usado para criptografar valores do segredo |
description |
String |
Descrição de um segredo |
create_time |
Long |
Tempo de criação do 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). |
update_time |
Long |
Hora em que um segredo foi atualizado pela última vez. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). |
scheduled_delete_time |
Long |
Hora em que um segredo será excluído conforme programado. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). Se um segredo não estiver no estado Pending deletion, o valor deste parâmetro é null. |
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.
{ "secret" : { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "name" : "test", "state" : "ENABLED", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "description" : "description", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000 } }
Código de status
Código de status |
Descrição |
---|---|
200 |
O pedido foi bem-sucedido. |
400 |
Resposta de erro |
Código de erro
Para obter detalhes, consulte Códigos de erro.