Creación de una variable de entorno
Función
La publicación de una API en diferentes entornos puede implicar varias variables de entorno, como la dirección de despliegue del servicio de API y la versión de solicitud.
Definir variables de entorno al crear una API. Cuando se invoca a la API, las variables de entorno se reemplazarán con los valores de variable para distinguir entornos.
Las variables de entorno se definen para un grupo de API y se aplican a todas las API del grupo.
- Los nombres de variables de entorno deben ser únicos para un grupo de API en el mismo entorno.
- Los nombres de las variables de entorno distinguen entre mayúsculas y minúsculas. Por ejemplo, ABC y abc son dos variables diferentes.
- Las API que usan variables de entorno no se pueden depurar.
- Debe incluir una variable de entorno en signos numéricos (#) para que pueda reemplazarse con el valor real del entorno en el que se publica la API. Por ejemplo, si la URL de una API es https://#address#:8080 y el valor de la variable address es 192.168.1.5 en el entorno RELEASE, la URL real de la API es https://192.168.1.5:8080 después de la publicación.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
| Método de solicitud | URI |
|---|---|
| POST | /v1.0/apigw/env-variables |
Solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| env_id | Sí | String | ID de entorno |
| group_id | Sí | String | ID de grupo de API |
| variable_name | Sí | String | Nombre de la variable El nombre de una variable consta de 3 a 32 caracteres, comenzando por una letra. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_). El nombre de la variable es equivalente a #Name# en una definición de API. Los caracteres entre los signos numéricos distinguen entre mayúsculas y minúsculas. El nombre de la variable se reemplazará por el valor de la variable después de la publicación de la API. |
| variable_value | Sí | String | Valor variable Un valor variable consta de 1 a 255 caracteres. Solo se permiten letras, dígitos y caracteres especiales (_-/.:). |
Ejemplo de solicitud:
{
"env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
"group_id": "73c58022-f20d-495a-a188-85d718647f09",
"variable_name": "address",
"variable_value": "192.168.1.5"
} Respuesta
| 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:
{
"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 |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |