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 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 pruebas, y v1.2 en el entorno de desarrollo. APIG proporciona gestión del entorno, lo que le permite acceder a APIG en diferentes escenarios con un costo mínimo.
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 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. |
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á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 |
Hora 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. |
Solicitudes de ejemplo
{ "name" : "DEV", "remark" : "Development environment" }
Ejemplo de respuestas
Código de estado: 201
Created
{ "create_time" : "2020-07-31T06:41:43.511347628Z", "name" : "DEV", "remark" : "Development environment", "env_id" : "7a1ad0c350844ee69479b47df9a881cb" }
Código de estado: 400
Bad Request
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" }
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: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.