Generate a Docker Compose file to install an AI Gateway instance
GET /api/ai_gateway_groups/{ai_gateway_group_id}/deployment/docker-compose
GET /api/ai_gateway_groups/{ai_gateway_group_id}/deployment/docker-composeInteractive request editor loads with JavaScript.
In: header
Path Parameters
AI Gateway group ID.
1 <= lengthQuery Parameters
The IP address of the control plane.
1 <= lengthThe validity period of the certificate in days.
1 <= value <= 109503650Docker image.
1 <= lengthThe HTTP port of the gateway.
9080The name of the docker compose container and service.
1 <= length"api7-ee-3-gateway"Additional docker run arguments.
Response Body
text/plain
application/json
curl -X GET "$API_BASE_URL/api/ai_gateway_groups/abc1234567890/deployment/docker-compose?image=api7%2Fapi7-ee-3-gateway&extra_args%5B%5D=a%3Db&extra_args%5B%5D=c%3Dd"Successfully generated the Docker Compose configuration for AI Gateway installation.
"services:\n ai-gateway:\n image: api7/aisix:latest\n container_name: ai-gateway\n restart: always\n ports:\n - \"3000:3000\"\n environment:\n API7_CONTROL_PLANE_ENDPOINTS: '[\"https://10.0.0.1:31344\"]'\n"Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
{
"value": {},
"error_msg": "error message"
}Complete operation details and schema variants
GET /api/ai_gateway_groups/{ai_gateway_group_id}/deployment/docker-compose
Generate a Docker Compose file to install an AI Gateway instance
IAM Action: ai_gateway:GetAIGatewayGroup, Resource: arn:api7:ai_gateway:aigatewaygroup/%s
Generates a Docker Compose configuration that starts an AISIX AI Gateway instance connected to the specified AI Gateway group.
Parameters
ai_gateway_group_id(path, string, required): AI Gateway group ID.dp_manager_address(query, string, optional):validity_period(query, integer, optional):image(query, string, optional): Docker image.http_port(query, integer, optional): The HTTP port of the gateway.name(query, string, optional): The name of the docker compose container and service.extra_args[](query, array, optional): Additional docker run arguments.
Responses
200: Successfully generated the Docker Compose configuration for AI Gateway installation.400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.value(object, optional): The specific resource.error_msg(string, optional): The error message.
cURL
curl -X GET '$API_BASE_URL/api/ai_gateway_groups/{ai_gateway_group_id}/deployment/docker-compose'