更新时间:2026-10-27 GMT+08:00

API概览

本文介绍MaaS支持的API,分别为模型API(文本生成)和管控面API(自定义接入点、MaaS调用统计等)。

文本生成

表1 文本生成API列表

API

说明

MaaS标准API V2接口

介绍Chat API的调用规范,对输入输出参数进行了详细说明及展示了调用示例。

OpenAI兼容接口

通过兼容 OpenAI 格式的Chat API 调用模型,对输入输出参数进行了详细说明及展示了调用示例。

Anthropic兼容接口

通过兼容 Anthropic 格式的 Chat API 调用模型,对输入输出参数进行了详细说明及展示了调用示例。

MaaS标准API V1接口

介绍Chat API的调用规范(适用部分旧模型),对输入输出参数进行了详细说明及展示了调用示例。该接口不再演进,建议优先使用MaaS标准API V2接口。

自定义接入点

表2 自定义接入点

API

说明

创建自定义接入点

用于创建独立的调用入口,允许用户设置限流规则,并基于自定义接入点名称实现费用的精准统计,帮助用户高效管理推理服务资源,优化使用成本。

编辑自定义接入点

用于编辑指定接入点的流控、内容安全护栏开关、接入点名称、接入点描述。

查询自定义接入点

用于查询用户接入点列表。

删除自定义接入点

用于根据传入的custom_endpoint_id,删除指定的接入点。

启用/停用自定义接入点

用于根据传入的project_id和custom_endpoint_id,启用或停用接入点。

查询AI开发平台ModelArts-在线服务

API

说明

获取区域信息

用于获取AI开发平台ModelArts-在线服务的Region信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时,获取请求中的region参数。

获取工作空间信息

用于获取AI开发平台ModelArts-在线服务的WorkSpace信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时,查询infer_service_id。

获取推理服务信息

用于获取AI开发平台ModelArts-在线服务的WorkSpace信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时,获取推理服务信息。

获取最新内容安全护栏免责声明

用于获取MaaS-在线推理的内容安全护栏免责声明。当创建自定义接入点的“moderation”参数选择“false”时,必须签订最新版本的免责声明。

MaaS调用统计

API

说明

获取汇总统计

用于查询在线推理服务调用的汇总数据,包括:总调用次数、总调用失败次数、总调用Tokens数、输入Tokens数、输出总Tokens数等。仅保存30天内的统计数据。

获取服务统计信息列表

用于获取用户已开通的预置服务、已创建的自定义接入点两种类型服务,并展示每个服务的调用次数、调用失败率、调用总Tokens数、输入Tokens数、输出Tokens数、端到端时延等指标信息。仅保存30天内的统计数据。

获取服务指标时间分布统计信息

用于获取服务的指标明细数据。查看该服务的调用次数、调用失败率、调用tokens量、输入Tokens大小、输出Tokens大小、端到端时延、TPM、RPM、QPS、平均生成时长等指标时间变化趋势。仅保存30天内的统计数据。

获取服务错误明细列表

用于获取服务的错误明细数据,查看调用失败的相关信息,如错误码、发生次数、错误信息等。仅保存30天内的统计数据。

获取服务列表

用于获取服务ID对应的服务名称。

查询IP列表

用于获取IP地址。

查询资源监控指标详情

用于查询MaaS在线推理模块我的服务类型资源监控指标信息。仅保存30天内的统计数据。

查询服务版本调用数据

用于查询服务的所有版本及其相应的监控指标数据。仅保存30天内的统计数据。

获取不同模型类型支持的指标列表

用于获取服务模型类型对应支持的指标列表。

获取服务错误码时间分布统计信息

用于展现服务的错误码统计时间分布信息。仅保存30天内的统计数据。

API Key鉴权管理

表3 API Key鉴权管理

API

说明

创建API Key

创建接口是API Key全生命周期管理的起点,旨在为开发者或业务系统生成专属的身份访问凭证。

更新API Key

用于更新API Key指定ID、描述信息、是否允许所有IP访问、API Key的IP白名单等信息。

删除API Key

用于根据传入的key_id,删除指定的API key。

查询API Key列表

用于查询API Key列表。