Creación de una variable
Función
La publicación de una API en diferentes entornos puede implicar varias variables, como la dirección de despliegue del servicio de API y la versión de solicitud.
Puede 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 dirección variable es 192.168.1.5 en el entorno RELEASE, la URL real de la API será https://192.168.1.5:8080 después de la publicación.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/env-variables
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
variable_value |
Sí |
String |
El valor de la variable puede contener de 1 a 255 caracteres. Solo se permiten letras, dígitos y caracteres especiales (_-/.:). |
|
env_id |
Sí |
String |
ID de entorno. Mínimo: 1 Máximo: 65 |
|
group_id |
Sí |
String |
ID de grupo de API. Mínimo: 1 Máximo: 65 |
|
variable_name |
Sí |
String |
Nombre de variable, que puede contener de 3 a 32 caracteres, comenzando por una letra. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_). El nombre de la variable es equivalente a "#Name#" en las definiciones de la 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. |
Parámetros de respuesta
Código de estado: 201
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
variable_value |
String |
El valor de la variable puede contener de 1 a 255 caracteres. Solo se permiten letras, dígitos y caracteres especiales (_-/.:). |
|
env_id |
String |
ID de entorno. Mínimo: 1 Máximo: 65 |
|
group_id |
String |
ID de grupo de API. Mínimo: 1 Máximo: 65 |
|
variable_name |
String |
Nombre de variable, que puede contener de 3 a 32 caracteres, comenzando por una letra. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_). El nombre de la variable es equivalente a "#Name#" en las definiciones de la 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. |
|
id |
String |
ID de variable de entorno. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 404
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Creación de una variable de entorno
{
"variable_name" : "address",
"variable_value" : "192.168.1.5",
"env_id" : "7a1ad0c350844ee69479b47df9a881cb",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600"
}
Ejemplo de respuestas
Código de estado: 201
Creado
{
"variable_value" : "192.168.1.5",
"env_id" : "7a1ad0c350844ee69479b47df9a881cb",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"id" : "25054838a624400bbf2267cf5b3a3f70",
"variable_name" : "address"
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3003",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
201 |
Creado |
|
400 |
Error en la solicitud |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
404 |
No se ha encontrado |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.
