Consulta da lista de segredos
Função
Esta API é usada para consultar todos os segredos criados pelo usuário atual no projeto atual.
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
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | ID do projeto |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
limit | Não | String | Número de resultados retornados em cada página Valor padrão: 50 |
marker | Não | String | ID do recurso da consulta de paginação. Se o parâmetro for deixado em branco, apenas os recursos na primeira página serão consultados. |
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 |
|---|---|---|
secrets | Array of Secret objects | Lista de segredo |
page_info | PageInfo object | Informações de paginação |
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. |
Parâmetro | Tipo | Descrição |
|---|---|---|
next_marker | String | Endereço da próxima página (ID de recurso inicial da próxima página) em uma consulta. Se este parâmetro não for especificado, a página seguinte estará vazia. |
previous_marker | String | Endereço da página anterior (ID de recurso final da página anterior) em uma consulta. |
current_count | Integer | Número de registros retornados na página atual |
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.
{
"secrets" : [ {
"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
} ],
"page_info" : {
"next_marker" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"previous_marker" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"current_count" : 1
}
} 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.
