Creación de un entorno
Función
Los proveedores de API pueden publicar una API en diferentes entornos, como los entornos de desarrollo, pruebas y producción.
La información de la API, como la versión, la dirección de solicitud e incluso el mensaje de solicitud, varía según el entorno en el que se publica una API. Por ejemplo, v1.0 de una API se publica en el entorno de producción, v1.1 en el entorno de prueba y v1.2 en el entorno de desarrollo.
APIG proporciona gestión del entorno, lo que le permite acceder a APIG en diferentes escenarios a un costo mínimo.
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}/envs
|
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 |
|---|---|---|---|
|
name |
Sí |
String |
Nombre del entorno, que puede contener letras, dígitos y guiones bajos (_) y debe comenzar con una letra. Mínimo: 3 Máximo: 64 |
|
remark |
No |
String |
Descripción. Máximo: 255 |
Parámetros de respuesta
Código de estado: 201
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
create_time |
String |
Tiempo de creación. |
|
name |
String |
Nombre del entorno. |
|
remark |
String |
Descripción. |
|
id |
String |
ID 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: 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 un entorno
{
"name" : "DEV",
"remark" : "Development environment"
}
Ejemplo de respuestas
Código de estado: 201
Creado
{
"create_time" : "2020-07-31T06:41:43.511347628Z",
"name" : "DEV",
"remark" : "Development environment",
"id" : "7a1ad0c350844ee69479b47df9a881cb"
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:name. 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: 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 |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.
