Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Data Encryption Workshop/ Referencia de la API/ APIs/ API de gestión de secreto/ Gestión del ciclo de vida/ Consulta de la lista de secreto

Actualización más reciente 2022-11-03 GMT+08:00

Ver PDF

Consulta de la lista de secreto

Función

Esta API se utiliza para consultar todos los secretos creados por el usuario actual en el proyecto actual.

Restricciones

La información devuelta a través de esta API es los metadatos del secreto y no contiene el valor de secreto.

URI

GET /v1/{project_id}/secrets

**Tabla 1** Parámetros de URI
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
limit	No	String	Número de resultados devueltos en cada página Valor predeterminado: 50
marker	No	String	ID de recurso de la consulta de paginación. Si el parámetro se deja en blanco, solo se consultan los recursos de la primera página.

Parámetro de solicitud

**Tabla 3** Parámetro de header de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta).

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
secrets	Array of Secret objects	Lista de secretos
page_info	PageInfo object	Información de Paginación

**Tabla 5** Secret
Parámetro	Tipo	Descripción
id	String	ID de secreto
name	String	Nombre de secreto
state	String	Estado de secreto. Su valor puede ser: ENABLED DISABLED PENDING_DELETE FROZEN
kms_key_id	String	ID del KMS CMK utilizado para cifrar valores secretos
description	String	Descripción de un secreto
create_time	Long	Tiempo de creación de secreto. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970).
update_time	Long	Hora en la que un secreto fue actualizado por última vez. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970).
scheduled_delete_time	Long	Hora en la que se eliminará un secreto según lo programado. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). Si un secreto no está en estado de Pending deletion, el valor de este parámetro es null.

**Tabla 6** PageInfo
Parámetro	Tipo	Descripción
next_marker	String	Dirección de la página siguiente (ID de recurso inicial de la página siguiente) en una consulta. Si no se especifica este parámetro, la página siguiente estará vacía.
previous_marker	String	Dirección de la página anterior (ID de recurso final de la página anterior) en una consulta.
current_count	Integer	Número de registros devueltos en la página actual

Código de estado: 400

**Tabla 7** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error
error_msg	String	Descripción del error

Solicitud de ejemplo

Ninguno

Ejemplo de respuesta

Código de estado: 200

La solicitud se ha realizado correctamente.

{
  "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
  }
}