Consulta de una instancia secreta
Función
- Esta API se utiliza para consultar una instancia secreta. Puede consultar un secreto por etiqueta.
URI
POST /{version_id}/{project_id}/csms/{resource_instances}/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
resource_instances |
Sí |
String |
Resource instance. Su valor es resource_instances. |
project_id |
Sí |
String |
ID del proyecto. |
version_id |
Sí |
String |
Versión de la API |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. El token se puede obtener llamando a la API de IAM. (El token es el valor de X-Subject-Token en el encabezado de respuesta.) |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
limit |
No |
String |
Número de registros en una consulta. Si action está establecida en count, no es necesario establecer este parámetro. Si action se establece en filter, el valor predeterminado de este parámetro es 10. El rango de valores es de 1 a 1000. |
offset |
No |
String |
Ubicación del índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro. Cuando se consultan datos de una página, el valor del cuerpo de la respuesta de la página anterior se transfiere a este parámetro. (Si action es count, no es necesario establecer este parámetro.) Si el valor de action es filter, el valor predeterminado es 0. El valor debe ser un número y no puede ser un número negativo. |
action |
No |
String |
Tipo de operación. Puede ser:
|
tags |
No |
Array of Tag objects |
Lista de etiquetas, incluidas las claves de etiqueta y los valores de etiqueta.
|
matches |
No |
Array of TagItem objects |
Campo de búsqueda.
|
sequence |
No |
String |
Número de serie de 36 bytes de un mensaje de solicitud. Ejemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
No |
String |
Clave. El valor contiene un máximo de 36 caracteres Unicode. El valor de key no puede estar vacío. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (\), ni signos iguales (=). |
values |
No |
Array of strings |
Conjunto de valores de etiqueta |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
No |
String |
Clave. El valor contiene un máximo de 36 caracteres Unicode. El valor de key no puede estar vacío. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (\), ni signos iguales (=). |
value |
No |
String |
Valor. Cada valor contiene un máximo de 43 caracteres Unicode y puede ser una cadena vacía. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (\), y signos iguales (=). |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
resources |
Array of ActionResources objects |
Lista de instancias de recurso. |
total_count |
Integer |
Número total de recursos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
resource_id |
String |
ID del recurso |
resource_detail |
Secret object |
Secreto |
resource_name |
String |
Nombre del recurso. Este parámetro es una cadena vacía por defecto. |
tags |
Array of TagItem objects |
Lista de etiquetas. Si no hay ninguna etiqueta en la lista, se devuelve un array vacío. |
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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Clave. El valor contiene un máximo de 36 caracteres Unicode. El valor de key no puede estar vacío. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (\), y signos iguales (=). |
value |
String |
Valor. Cada valor contiene un máximo de 43 caracteres Unicode y puede ser una cadena vacía. No puede contener caracteres ASCII (0-31), asteriscos (*), corchetes angulares (< y >), barras invertidas (\), y signos iguales (=). |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Código de estado: 502
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Código de estado: 504
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
ErrorDetail object |
- |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Información de error. |
Solicitud de ejemplo
Ninguno
Ejemplo de respuesta
Ninguno
Código de estado
Código de estado |
Descripción |
---|---|
200 |
La solicitud se ha realizado correctamente. |
400 |
Parámetros de solicitud no válidos. |
401 |
Se requiere nombre de usuario y contraseña para acceder a la página solicitada. |
403 |
Error de autenticación. |
404 |
La página solicitada no existe o no se encuentra. |
500 |
Error interno del servicio. |
502 |
Error al completar la solicitud. El servidor recibe una respuesta no válida del servidor ascendente. |
504 |
Se agotó el tiempo de espera de la puerta de enlace. |
Códigos de error
Consulte Códigos de error.