Consulta de detalles de variables
Función
Esta API se utiliza para consultar los detalles de una variable de entorno.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
|
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
|
env_variable_id |
Sí |
String |
ID de variable de entorno. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando 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ámetros de respuesta
Código de estado: 200
|
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 permiten 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: 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. |
Solicitudes de ejemplo
Ninguna
Ejemplo de respuestas
Código de estado: 200
OK
{
"variable_value" : "192.168.1.5",
"env_id" : "7a1ad0c350844ee69479b47df9a881cb",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"id" : "25054838a624400bbf2267cf5b3a3f70",
"variable_name" : "address"
}
Código de estado: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
Not Found
{
"error_code" : "APIG.3011",
"error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70"
}
Código de estado: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.