检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加简易认证凭据 若API开启了简易认证,可直接使用凭据中配置的AppCode进行简易安全认证,无需使用Key和Secret进行认证。 约束与限制 仅安全认证方式为“APP认证”的API支持简易认证。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台
插件管理 创建插件 修改插件 删除插件 查询插件列表 查询插件详情 插件绑定API API绑定插件 解除绑定插件的API 解除绑定API的插件 查询插件下绑定的API 查询API下绑定的插件 查询可绑定当前插件的API 查询可绑定当前API的插件 父主题: 服务集成API
API管理 创建API 修改API 删除API 发布或下线API 查询API详情 查询API列表 批量发布或下线API 调试API 切换API版本 查看版本详情 根据版本编号下线API 查询API历史版本列表 查询API运行时定义 校验API定义 父主题: 服务集成API
部署在VPC下的应用是否可以调用API? 默认部署在VPC下的应用可以调用API。如果域名解析失败,则参考怎样切换内网DNS,在当前终端节点上配置DNS服务器。配置完成后,部署在VPC下的应用可以调用API。 父主题: 服务集成
API绑定流控策略 绑定流控策略 解除API与流控策略的绑定关系 查看流控策略绑定的API列表 查看流控策略未绑定的API列表 查看API绑定的流控策略列表 批量解绑流控策略 父主题: 服务集成API
创建插件 功能介绍 创建插件信息。 插件不允许重名 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 约束与限制 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 如果API在选择的环境中已发布,再次发布将覆盖原来已发布的API。 前提条件 系统已提供了默认发布环境
绑定域名 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。 您也可以使用系统分配的默认子域名访问
添加后端实例 功能介绍 为指定的VPC通道添加后端实例 若指定地址的后端实例已存在,则更新对应后端实例信息。若请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK
创建ACL策略 功能介绍 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:前端API的Swagger扩展定义”章节。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,
查看实例约束信息 功能介绍 查看实例约束信息 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{
发布API 概述 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建发布环境
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击
配置自定义认证 创建前端自定义认证 创建后端自定义认证 父主题: 服务集成指导(旧版界面)
发布函数API 在函数后端创建后,您需要发布函数后端,生成函数API并发布到环境上,才可供其他用户调用。 前提条件 每个API都要归属到某个API分组下,在发布函数API前您需要有可用的API分组,否则请提前创建API分组。 如果需要使用自定义认证方式进行API的安全认证,请提前创建前端自定义认证
定时调用API 通过在ROMA Connect中创建API定时任务,可以实现定时自动调用API的功能。 前提条件 添加到定时任务中的API必须已发布,否则请先发布API。 添加到定时任务中的API必须为“APP认证”或“无认证”的安全认证方式。 ROMA Connect的实例配置参数
附录:API错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment
监控信息查询 API指标统计值查询-最近一段时间 查询API指标统计值 父主题: 服务集成API
VPC通道管理 创建VPC通道 修改VPC通道 删除VPC通道 查看VPC通道详情 查询VPC通道列表 添加后端实例 查看后端实例列表 修改后端实例 删除后端实例 批量修改后端服务器状态可用 批量修改后端服务器状态不可用 修改VPC通道健康检查 添加VPC通道后端服务器组 查询VPC