检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录:API错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment
对API的修改是否需要重新发布? API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。 父主题: 服务集成
开发场景 场景说明 ROMA Connect的服务集成主要涉及以下几个开发场景: API调用认证开发:业务系统在调用服务集成APIC开放的API时,若API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 APP认证(签名认证):
创建应用配置 功能介绍 创建应用配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic/instances/{instance_id
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调试 您可以在
查询插件列表 功能介绍 查询一组符合条件的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
创建API分组 概述 API分组是同一类业务API的集合,API开发者以API分组为单位,管理分组内的所有API。每个API都要归属到某个API分组下,在创建API前应提前创建API分组。 前提条件 每个API分组都要归属到某个集成应用下,在创建API分组前您需要有可用的集成应用,
导入导出API 概述 ROMA Connect支持通过文件的方式导入导出API。 导入API:支持导入YAML和JSON格式API定义文件,且文件内容应满足Swagger 2.0规范。 导出API:支持导出YAML和JSON格式API定义文件。 前提条件 导入API前,您需要在导入的
配置API授权(可选) 概述 仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 若API开启了简易认证,可直接使用集成应用中配置的AppCode进行简易安全认证,无需使用Key
查看API调用日志 概述 ROMA Connect提供了API的可视化分析和统计能力,支持查看API的调用日志。 Site实例中不支持API分析。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊
删除应用配置 功能介绍 删除应用配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/instances/{instance_id
解除绑定API的插件 功能介绍 解除绑定在API上的插件 解绑及时生效 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic
查询分组详情 功能介绍 查询指定分组的详细信息。 调试 您可以在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/instances
修改变量 功能介绍 修改环境变量。环境变量引用位置为API的后端服务地址时,修改对应环境变量会将使用该变量的所有API重新发布。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instances