api 接口规范

查看更多 →

信公众号客服）移动端APP客服语音呼叫中心环信机器人的全媒体接入具备以下特点：高扩展性：除了以上已支持的渠道外，环信机器人提供标准的API接口规范，可任意扩展和适配新的接入方式。高吞吐量，高并发能力，水平扩展，动态扩容。核心功能各个模块职责明确界限清晰，保证整个系统高可用：智能单

查看更多 →

系。 智慧学校按照科学规划、标准统一、资源整合、应用驱动、特色创新的原则推进建设。要依据国家公共资源服务体系及上级教育云开放平台开发API接口规范等标准，以统一身份认证、统一数据汇聚、统一资源管理、统一桌面呈现为基础，充分利用各级各类资源，实现资源的优化重组，发挥校内应用互联、校

查看更多 →

创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计

查看更多 →

在左侧导航栏单击“API设计”。 根据下表相关任务，了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器

查看更多 →

查看更多 →

Open Service Broker API规范说明 Service Broker接入通过自定义来源的形式进行业务呈现，接入方需按照以下的接口规范提供接口。 认证凭据（必需) 服务目录（必需) 服务实例创建 服务绑定 服务实例信息 服务绑定信息 服务实例最新操作信息 服务绑定最新操作信息

查看更多 →

05:43 创建API 调用API 02:28 调用API 为API设置流量控制 02:11 为API设置流量控制 创建API 05:43 创建API 调用API 02:28 调用API 为API设置流量控制 02:11 为API设置流量控制 帮助文档 开发者工具 API网关 SDK

查看更多 →

选择待导出API所在的部署环境。 API 默认导出API服务在所选择环境下的所有API。如果只需要导出个别API，可单击“自定义导出API”，勾选需要导出的API。 API定义范围 选择导出的API服务文件中，API定义字段的类型范围。 基础定义：包括API前端请求定义和响应定义，不包括后端服务定义。其中A

查看更多 →

CONSUMER 调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 MARKET模式，接口调用者必须是API购买者或拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String

查看更多 →

roma_app_name String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo

查看更多 →

roma_app_name String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo

查看更多 →

查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/

查看更多 →

DEVELOPER 调试尚未发布的API定义 CONSUMER 调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 path 是 String API的请求路径，需以"/"开头，最大长度1024

查看更多 →

CONSUMER 调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 MARKET模式，接口调用者必须是API购买者或拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String

查看更多 →

注册API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务

查看更多 →

说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String

查看更多 →

注册API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。

查看更多 →

调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 MARKET模式，接口调用者必须是API购买者或拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 path 是 String API的请求路径，需以"/"开头，最大长度1024

查看更多 →

roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo

查看更多 →

API设计配置 ROMA API提供了API设计文件规范性检查，帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段，您按照Swagger规范性设计API的同时，也可额外自定义扩展字段。

查看更多 →

注册API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。

查看更多 →

查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/

查看更多 →

修改API 功能介绍 修改指定API的信息，包括后端服务信息。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v1/{project_id}/apic/i

查看更多 →

查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/

查看更多 →

调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 MARKET模式，接口调用者必须是API购买者或拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 path 是 String API的请求路径，需以"/"开头，最大长度1024

查看更多 →

查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义，分别代表如下含义： 临时定义：API在编辑中的定义，表示用户最后一次编辑后的API的状态 运行时定义：API在发布到某个环

查看更多 →

roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo

查看更多 →

API概览 MRS提供的符合RESTful API的设计规范的接口，如表1和表2所示。如何选择不同版本的接口请参见API版本选择建议。 MRS 版本演进过程中逐步废弃部分接口，具体请参见表3。 表1 V2接口 接口 功能 API URI 集群管理接口 创建集群 POST /v2/

查看更多 →

说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String

查看更多 →

roma_app_name String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo

查看更多 →

查询API详情 功能介绍 查看指定的API的详细信息。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/apic/insta

查看更多 →

创建API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了ROMA Connect如何去访问

查看更多 →

创建API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了ROMA Connect如何去访问

查看更多 →

导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范，API网关自定义扩展字段请参考《API网关开发指南》的“导入导出API：扩展定义”章节。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自

查看更多 →

导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范，API网关自定义扩展字段请参考《API网关开发指南》的“导入导出API：扩展定义”章节。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK

查看更多 →

API概览 CSS提供的接口为符合RESTful API设计规范的自研接口。通过CSS的自研接口，您可以使用CSS的如表1所示的功能。 表1 接口说明 类型 说明 集群管理接口 可以通过接口创建集群、扩容集群、查看集群详情、获取实例规格列表等。 词库管理接口 云搜索服务提供自定义

查看更多 →

API概览 医疗智能体平台所提供的API，均符合RESTful API设计规范，如表1所示。 临床研究和药物设计所提供的API，均符合RESTful API设计规范，如表2、表3所示。 表1 医疗智能体平台API 类型 API 说明 项目管理 项目管理 项目创建、获取项目详情、删除项目等相关操作API。

查看更多 →