检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
校验API分组名称是否存在 功能介绍 校验API分组名称是否存在。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic
查询API指标统计值 功能介绍 查询某个实例下的API统计信息。 接口约束 调用超时或返回“request statistics error”报错时,请切换其他mode或缩短统计时长。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
修改后端API 功能介绍 在某个实例中更新后端API的参数。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/in
获取服务API版本列表 功能介绍 获取服务API版本列表,无需认证。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET / 请求参数 无 响应参数 状态码: 200
参数类型 描述 api_id 否 String 后端API编号 api_type 否 String API类型 data:数据API function:函数API scripts 否 Array of LdApiScript objects API脚本信息列表 表4 LdApiScript
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“
Connect对API请求进行安全认证。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 华为IAM认证:表示由IAM对API请求进行安全认证。用户调用API时,使用Token或AK/SK进行API请求的安全认证。 自定义认证:表示使用自定义的函数API对API请求进行安全认证。 无认证:表示API请求不需要认证。
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 URI POST /v1/{project_id}/apic/instances/{instance_id}/apis/publish 表1 路径参数 参数 是否必选 参数类型 描述
SL证书。 其他业务系统调用API 向API提供方获取API的调用信息。 获取API的请求信息。 API提供方可在ROMA Connect控制台选择“服务集成 APIC > API列表”,在列表中单击API的名称进入API运行页面,在页面中可获取API的请求方法和URL,在“前端配置”页签下,可获取API的请求参数。
是否支持自定义流控值。 是 {"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"} api_limits API全局默认流控值。注意:如果配置过小会导致业务持续被流控,请根据业务谨慎修改。 200 次/秒 1-1000000
String 后端API返回类型 缺省值:json api_signature_id String 后端API为签名认证时绑定的签名密钥编号 最小长度:1 最大长度:64 roma_app_id String 后端API归属的集成应用编号 更新后端API时,status=4为后端API的已部
在页面中单击策略的名称,进入策略详情页面。 在“绑定的API列表”页签下选择要绑定API的环境,然后单击“绑定API”。 在绑定API弹窗中,勾选要绑定策略的API。 您可以通过指定API分组和API名称,筛选所需API。 单击“确定”,完成API与流控策略的绑定。 为应用绑定流控策略 如果
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}
在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多 > 下线”。 在下线API弹窗中,选择要下线API的环境,完成后单击“确定”。 父主题: API管理
部署的环境编号 api_id String 部署的前端API编号 deploy_time String 部署时间 api_definition LdApiInfo object 自定义后端API详情 表5 LdApiInfo 参数 参数类型 描述 name String 后端API名称。
Connect实例的“服务集成 APIC > API列表”中查看并编辑该发布的API。 支持的动作 接收API调用 配置参数 参数 说明 API名称 填写API的名称,根据规划自定义。该名称会在对应ROMA Connect实例的“服务集成 APIC > API列表”中展示。 安全认证 选择安全认证方式,当前支持以下方式
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
部署的前端API分组编号 env_id String 部署的环境编号 api_id String 部署的前端API编号 deploy_time String 部署时间 api_definition LdApiInfo object 自定义后端API详情 表5 LdApiInfo 参数
查询插件下绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 绑定关系列表中返回的API在对应的环境中可能已经下线 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Expl