Consulta de una lista de variables de entorno
Función
Esta API se utiliza para consultar la lista de todas las variables de entorno bajo un grupo de API.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
GET |
/v1.0/apigw/env-variables[?page_size, page_no, env_id, group_id, variable_name] |
- Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
- Las condiciones de consulta incluyen: env_id, group_id, variable_name, page_size y page_no.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
env_id |
No |
String |
ID de entorno |
group_id |
Yes |
String |
ID de grupo de API |
variable_name |
No |
String |
Nombre de la variable |
page_size |
No |
Integer |
Número de registros mostrados en cada página. El valor predeterminado es 20. |
page_no |
No |
Integer |
Número de página. El valor predeterminado es 1. |
precise_search |
No |
String |
Nombre del parámetro (variable_name) para la coincidencia exacta |
Solicitud
N/A
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
variables |
Dictionary |
Lista de variables de entorno |
total |
Integer |
Número de variables de entorno que coinciden con las condiciones de consulta |
size |
Integer |
Longitud de la lista de variables de entorno devueltas |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de variable de entorno |
env_id |
String |
ID de entorno |
group_id |
String |
ID de grupo de API |
variable_name |
String |
Nombre de la variable |
variable_value |
String |
Valor variable |
Ejemplo de respuesta:
{ "total": 2, "size": 2, "variables": [{ "id": "09ab8135-7224-40b9-bf5d-107f2a09d409", "env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb", "group_id": "73c58022-f20d-495a-a188-85d718647f09", "variable_name": "port", "variable_value": "8080" }, { "id": "104185e5-3e8f-4c63-a7e5-ef4117bf870c", "env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb", "group_id": "73c58022-f20d-495a-a188-85d718647f09", "variable_name": "address", "variable_value": "192.168.1.5" }] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |