通过注册方式，将大模型的服务注册到服务平台统一管理，可统计不同应用对模型的调用量，并可对模型API进行限流、监控和查看调用日志。本文为您介绍如何基于模型创建API。
步骤一：选择生成API的方式
在Dataphin首页的顶部菜单栏，选择服务 > API开发。
在左上角选择服务项目，单击左侧导航栏的API服务。在API页面，单击+新建API按钮。
在新建API对话框中，选择模型API。
步骤二：配置模型API的参数信息
在新建API页面配置参数。
参数
描述
基础信息配置
API名称
填写API的名称。命名规则如下：
只能包含中文、字母、数字或下划线（_）。
长度为4~42个字符。
以字母开头。
全局唯一。
模型
填写模型的名称，不超过256个字符。
协议类型
选择API的接口协议，支持OpenAI兼容和DashScope。
请求方式
默认为GET，不可修改。
GET：请求服务器获取指定的某个资源。
API分组
选择当前项目下配置的API分组，如需创建，请参见创建服务分组。
描述
填写对API的简单描述。128个字符以内。
协议
数据生成API的接口协议，支持HTTP、HTTPS协议。
HTTP：即超文本传输协议HTTP（HyperText Transfer Protocol），是应用最为广泛的网络协议。
HTTPS：若网关配置为阿里公有云API网关（专享实例或共享实例）时，支持选中HTTPS协议，请确保独立域名的SSL证书有效，避免无法正常调用。请通过选择平台管理网络配置，在网络配置页面，进行SSL证书配置。
调用模式
用于客户端和服务器之间的通信，以获取或处理数据。支持选择同步调用和异步调用，默认为同步调用。
同步调用：客户端发送请求后，必须等服务器返回结果后才能继续执行其他请求，针对复杂查询语句，响应时间较长且在等待过程中会占用服务器连接数，造成服务器压力。适用于实时性要求高、处理时间短的场景。
异步调用：客户端发送请求后，无需等待服务器响应，可继续执行其他请求，服务器处理完成后再通知客户端，在批量获取数据时，可降低数据库查询结果的重复率，用数据服务API进行数据获取。适用于处理时间长、实时性要求不高的场景，如批量处理等。
执行超时时间
当调用模式为异步调用时支持配置。用于监控SQL执行的时长。默认为60秒，支持设置的时间范围为1到7200秒（2小时）的正整数。
超时时间
用于监控API调用的最大时长。当调用模式为同步调用时，默认为30秒，支持设置的时间范围为3到60秒的正整数；当调用模式为异步调用时，默认为600秒，支持设置的时间范围为3到7200秒（2小时）的正整数。
调用API过程中如果超过了设定的超时时间，则调用API时会报错，便于您及时发现并处理调用API的异常情况。关于异常情况的查看，详情请参见查看及管理运维监控API。
版本号
请填写API的版本号，每份配置信息会有所属版本号，以便于和上个版本信息对比。64个字符以内。该API下版本号唯一。
返回类型
默认JSON。
后端服务配置
模式
支持Basic或Dev_Prod两种模式。
Basic模式下开发时、提交及发布线上均读取生产库。
Dev-Prod模式下开发及提交读取开发库，发布线上读取生产库。
请求方式
用于配置转发调用后端服务的请求方法，仅支持POST。
POST：若请求方法选择POST，则请求参数支持选择BODY。
API数据源
请选择注册API的数据源，如需创建，请参见创建API数据源。
服务超时
于监控转发调用后端服务的时长。调用后端服务过程中如果超过了设定的服务超时时间，则调用API时会由于后端服务调用超时报错，便于您及时发现并处理调用API的异常情况。异常情况查看，详情请参见查看及管理运维监控API。
服务path
根据协议类型和模型类型决定服务的路径，当协议类型为OpenAI兼容，模型类型支持对话和自定义；当协议类型DashScope，模型类型支持对话、图像生成和自定义。选择不同的模型类型，系统为您展示对应的服务路径。
例如：API数据源的URL地址为：
http://dashscope.aliyuncs.com:*****/api/example，服务Path为：/compatible-mode/v1/chat/completions，则后端服务的完整URL为：http://dashscope.aliyuncs.com:*****/api/example/compatible-mode/v1/chat/completions。当选择自定义服务路径时，路径需以正斜线（/）开头，且字符个数不超过128个。
请求参数
参数名称
对外开放的参数，即用户访问API时直接使用的参数，128个字符以内。
参数位置
支持选择Headers、Parameters、Body。
Headers：在解析请求参数时会添加到参数的头部位置。
Parameters：在解析请求参数时会拼接数据源的URL。
Body：在解析请求参数时如果有多个参数，则会封装成一个Body。
参数类型
当参数位置为Body时，支持选择参数类型为Array(int)、Array(string)和Object。
当参数位置为其他时，参数类型包括DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL，需选择参数名对应的绑定字段的参数类型。
默认值
后端服务调用时，若无传值，则以默认值传入。支持输入不超过1000个字符，若参数类型为STRING，无字符输入限制。
示例
填写请求参数值的示例，便于开发者理解。支持输入不超过1000个字符。
描述
填写对请求参数的简单描述。支持输入不超过1000个字符。
是否必填
必填参数，若在调用API时不传参数值，则API调用失败。
测试
您可通过测试判断大模型返回的响应内容是否符合预期。
请求参数配置完成后，单击测试按钮，在测试请求发送对话框中，根据请求参数输入试运行值，单击开始测试按钮，系统将请求参数进行封装，发送请求体给大模型，并返回响应内容。
返回参数
参数名称
对外开放的参数，API返回时最终展示给用户的参数名称，128个字符以内。
参数类型
返回参数类型包括DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL、Array(int)、Array(string)11种，需选择参数名对应的绑定字段的参数类型。
示例
填写返回参数值的示例，便于开发者理解。支持输入不超过1000个字符。
描述
填写对返回参数的简单描述。支持输入不超过1000个字符。
返回参数取值路径
仅支持JSON格式，当返回数据多层嵌套，需要配置对应的返回参数路径。可单击查看配置说明， 参照示例配置返回参数的取值路径，或直接输入关键字搜索匹配路径。
单击提交，即可完成API的创建。