检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。环境上存在已发布的API时,该环境不能被删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API
开发说明 开发场景 开发规范 父主题: 服务集成开发指导
绑定域名 概述 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。
配置调用授权(可选) 使用APP认证方式的API,需要配置调用授权,把API授权给指定凭据。用户调用API时,使用凭据的Key和Secret进行安全认证。 API所属集成应用无需授权,可直接作为凭据用于API调用。 约束与限制 API的安全认证方式为“APP认证”。 前提条件 API已发布到环境,否则请先发布API。
查看API调用日志 ROMA Connect提供了API的可视化分析和统计能力,支持查看API的调用日志。 约束与限制 Site实例中不支持监控分析。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成
添加简易认证凭据 若API开启了简易认证,可直接使用凭据中配置的AppCode进行简易安全认证,无需使用Key和Secret进行认证。 约束与限制 仅安全认证方式为“APP认证”的API支持简易认证。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,原来已经绑定的同类型插件,会直接覆盖。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,服务集成会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
删除变量 功能介绍 删除指定的环境变量。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/instances
删除VPC通道 功能介绍 删除指定的VPC通道 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/instan
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“
自定义后端管理 下线自定义后端 导入导出自定义后端 添加自定义后端公共配置 附录:自定义后端的Swagger扩展定义 父主题: 服务集成指导(旧版界面)
配置调用授权(可选) 使用APP认证方式的API,需要配置调用授权,把API授权给指定凭据。用户调用API时,使用凭据的Key和Secret进行安全认证。 API所属集成应用无需授权,可直接作为凭据用于API调用。 约束与限制 API的安全认证方式为“APP认证”。 前提条件 API已发布到环境,否则请先发布API。
接入数据源 概述 在创建数据API之前,您需要先接入数据源,确保可以正常从数据源读取数据。根据数据源类型的不同,数据源的接入配置有所差异。 前提条件 在接入数据源前,请确保ROMA Connect实例与您的数据源所在网络互通。 若ROMA Connect实例与数据源在相同VPC内时,可直接访问数据源。
调用开放的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 若您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 如果两个API的所属分组、请求方法和请求路径都相同,则调用API
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{
使用插件 概述 ROMA Connect支持通过插件的方式,为API提供灵活的扩展能力。 前提条件 插件和API本身相互独立,只有为API绑定插件后,插件才对API生效。为API绑定插件时需指定发布环境,插件只对指定环境上的API生效。 同一个API在同一个环境中只能绑定一个相同类型的插件。
查看实例约束信息 功能介绍 查看实例约束信息 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/