接口说明¶
MindIE Motor提供推理业务接口、管理接口、监控接口、观测接口和内部接口。
业务接口¶
MindIE Motor提供下列推理业务接口:
- OpenAI Chat Completion 接口:
/v1/chat/completions - OpenAI Completion 接口:
/v1/completions - Anthropic Messages 接口:
/v1/messages - Anthropic Count Tokens 接口:
/v1/messages/count_tokens - 模型列表查询接口:
/v1/models
业务接口的IP/端口与配置¶
推理业务接口IP
- 使用Kubernetes部署时,推理业务接口IP使用主机IP或者域名。
- 在Kubernetes集群内,推理业务接口IP使用
Coordinator服务的IP。 - 取值来自于
user_config.json配置文件中的coordinator_api_host配置项。 - 当配置文件中无此配置项时,则使用
Coordinator服务部署的环境变量POD_IP。 - 当环境变量
POD_IP也不存在或为空时,使用默认值127.0.0.1。
推理业务接口端口
- 使用Kubernetes部署时,推理业务接口端口使用
yaml文件中mindie-motor-coordinator-infer元数据定义的nodePort,默认值为31015。 - 当使用CRD模式部署时,
yaml文件参考examples/deployer/yaml_template/infer_service_template.yaml; - 当使用Multi模式部署时,
yaml文件参考examples/deployer/yaml_template/coordinator_template.yaml。 - 在Kubernetes集群内,推理业务接口端口使用
user_config.json配置文件中coordinator_api_infer_port定义的端口。 - 当配置文件中无此配置项时,使用默认端口
1025。
管理接口¶
MindIE Motor提供下列管理接口:
说明
管理接口仅限Kubernetes集群内使用,不提供给集群外使用。
管理接口的IP/端口与配置¶
管理接口IP
- 在Kubernetes集群内,管理接口IP,使用
Coordinator服务的IP。 - 取值来自于
user_config.json配置文件中的coordinator_api_host配置项。 - 当配置文件中无此配置项时,则使用
Coordinator服务部署的环境变量POD_IP。 - 当环境变量
POD_IP也不存在或为空时,使用默认值127.0.0.1。
管理接口端口
- 在Kubernetes集群内,管理接口端口使用
user_config.json配置文件中coordinator_api_mgmt_port定义的端口。 - 当配置文件中无此配置项时,使用默认接口端口
1026。
监控接口¶
MindIE Motor提供下列监控接口:
监控接口的IP/端口与配置¶
监控接口IP
- 使用Kubernetes部署时,监控接口IP使用主机IP或者域名。
- 在Kubernetes集群内,监控接口IP,使用
Coordinator服务的IP。 - 取值来自于
user_config.json配置文件中的coordinator_api_host配置项。 - 当配置文件中无此配置项时,则使用
Coordinator服务部署的环境变量POD_IP。 - 当环境变量
POD_IP也不存在或为空时,使用默认值127.0.0.1。
监控接口端口
- 使用Kubernetes部署时,监控接口端口使用
yaml文件中mindie-motor-coordinator-obs元数据定义的nodePort,默认值为31017。 - 当使用CRD模式部署时,
yaml文件参考examples/deployer/yaml_template/infer_service_template.yaml; - 当使用Multi模式部署时,
yaml文件参考examples/deployer/yaml_template/coordinator_template.yaml。 - 在Kubernetes集群内,监控接口端口使用
user_config.json配置文件中coordinator_obs_port定义的端口。 - 当配置文件中无此配置项时,使用默认端口
1027。
观测接口¶
MindIE Motor提供下列观测接口:
- 模型服务清单查询接口:
/observability/inventory - 监控指标查询接口:
/observability/metrics - 告警查询接口:
/observability/alarms - 对接 CCAE 前端平台
观测接口的IP/端口与配置¶
观测接口IP
- 使用Kubernetes部署时,观测接口IP使用主机IP或者域名。
- 在Kubernetes集群内,观测接口IP,使用
Controller服务的IP。 - 取值来自于
user_config.json配置文件中的controller_api_host配置项。 - 当配置文件中无此配置项时,则使用
Controller服务部署的环境变量POD_IP。 - 当环境变量
POD_IP也不存在或为空时,使用默认值127.0.0.1。
观测接口端口
- 使用Kubernetes部署时,观测接口端口使用
yaml文件中mindie-motor-observability元数据定义的nodePort,默认值为31027。 - 当使用CRD模式部署时,
yaml文件参考examples/deployer/yaml_template/infer_service_template.yaml; - 当使用Multi模式部署时,
yaml文件参考examples/deployer/yaml_template/controller_template.yaml。 - 在Kubernetes集群内,观测接口端口使用
user_config.json配置文件中observability_api_port定义的端口。 - 当配置文件中无此配置项时,使用默认端口
1027。
内部接口¶
EngineServer提供下列内部接口:
- Engine Server 快照接口,包括:
- 设备侧快照保存接口:
/suspend - 设备解锁接口:
/device_unlock - 设备侧快照恢复接口:
/resume - MetaServer转发接口:
/v1/metaserver
说明
Engine Server 内部接口挂载在 Engine Server 推理面,不在 Coordinator 推理接口上提供服务。
内部接口的IP/端口¶
- 内部接口IP:Engine Server 所在节点的 IP 或
engine_server --host绑定的地址。 - 内部接口端口:
engine_server --port指定的端口。
安全、认证与限流¶
- 安全协议:
infer_tls_config.tls_enable/mgmt_tls_config.tls_enable为true时,推理/管理接口端口使用https - 请求头:
- 必选:
Content-Type: application/json - 可选:API Key
- 对
/v1/completions、/v1/chat/completions、/v1/messages、/v1/messages/count_tokens生效 - Header 名称:
api_key_config.header_name(默认Authorization) - 前缀:
api_key_config.key_prefix(默认Bearer)
- 对
- 限流(可选):
rate_limit_config.enable_rate_limit=true时启用,超限返回429