检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
绑定域名 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。 您也可以使用系统分配的默认子域名访问
创建应用配置 功能介绍 创建应用配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic/instances/{instance_id
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调试 您可以在
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息和API请求参数信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
查询插件列表 功能介绍 查询一组符合条件的API网关插件详情。 支持分页 支持根据插件类型查询 支持根据插件可见范围查询 支持根据插件编码查询 支持根据名称模糊查询 支持根据集成应用编号查询 支持根据集成应用名称查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权
查询标签列表 功能介绍 查询标签列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{instance_id
查看ACL策略详情 功能介绍 查询指定ACL策略的详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances
修改后端实例 功能介绍 更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。若未指定修改的云服务器组,则进行全量覆盖。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例
开发场景 场景说明 ROMA Connect的服务集成主要涉及以下几个开发场景: API调用认证开发:业务系统在调用服务集成APIC开放的API时,若API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 APP认证(签名认证):
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“重试次数
创建负载通道(可选) ROMA Connect通过创建负载通道,可访问指定服务器中已部署的后端服务,并实现后端服务访问的负载均衡功能。ROMA Connect的负载通道可直接访问同一VPC内的弹性云服务器(ECS),也可以通过IP访问其他VPC内的ECS和私有服务器。 例如,VPC
配置调用授权(可选) 使用APP认证方式的API,需要配置调用授权,把API授权给指定凭据。用户调用API时,使用凭据的Key和Secret进行安全认证。 API所属集成应用无需授权,可直接作为凭据用于API调用。 约束与限制 API的安全认证方式为“APP认证”。 前提条件 API
接入数据源 概述 在创建数据API之前,您需要先接入数据源,确保可以正常从数据源读取数据。根据数据源类型的不同,数据源的接入配置有所差异。 前提条件 在接入数据源前,请确保ROMA Connect实例与您的数据源所在网络互通。 若ROMA Connect实例与数据源在相同VPC内时
调用开放的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 若您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 如果两个API的所属分组、请求方法和请求路径都相同,则调用API时
查看应用配置详情 功能介绍 查看应用配置详情 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{
查看证书详情 功能介绍 查看证书详情 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/certificates/{certificate_id
修改流控策略 功能介绍 修改指定流控策略的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instances
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。其中,签名密钥就是API安全保护机制的一种。租户创建一个签名密钥,并将签名密钥与API进行绑定,则服务集成在请求这个API