检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入API前,您需要在导入的API定义文件中补全API的Swagger扩展定义。 导入API前,请确保API和API分组的配额满足需求。 如果导入API时选择“生成新的分组”,则会使用API定义文件中的“info.title”字段值作为API分组名称。在导入API前,不能手动修改API定义文件中的“info.title”字段值。
String 在线的版本号 表7 BatchFailure 参数 参数类型 描述 api_id String 操作失败的API ID api_name String 操作失败的APi名称 error_code String 操作失败的错误码 error_msg String 操作失败的错误信息
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
$context.sourceIp:API调用者的源地址 $context.stage:API调用的部署环境 $context.apiName: API的名称 $context.apiId:API的ID $context.appName: API调用者的APP对象名称 $context
更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。 最小长度:2 最大长度:256 method String 后端API请求方法。 支持GET、PUT、POST、DELETE 更新后端API时,status=4为后端API的已部署状
校验API分组名称是否存在 功能介绍 校验API分组名称是否存在。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic
历史API 服务集成API(V1) 设备集成API(V1)
max_cpu_time 允许函数API中执行的CPU时间占用的最高时长。单位:毫秒。 60000 ms 1-1000000 ms max_memory 允许函数API中执行的内存大小。单位:字节。 256 M 1-9536 M livedata_env 自定义后端的运行模式,设置为onli
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
调用开放的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 若您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 如果两个API的所属分组、请求方法和请求路径都相同,则调用API时,会优先调用匹配模式为绝对匹配的API。
下线API 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 该操作将导致下线的API在指定的环境无法被访问,请确保已经提前告知使用此API的用户。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
解除绑定API的插件 功能介绍 解除绑定在API上的插件 解绑及时生效 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/ap
objects 服务的API版本信息列表。 scene String 场景信息。 表2 Version 参数 参数类型 描述 id String API版本ID,如v1。 version String API的最大微版本号,不支持固定填空。 min_version String API的最小微版本号,不支持固定填空。
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}
在左侧的导航栏选择“服务集成 APIC > 监控分析”,在“API监控”页签中可查看API的调用统计情况。 可查看“API总数”、“API分组总数”、“流控策略总数”的实时统计。 查看某个API的调用统计,包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。 选择“集成应用”和“API”,筛选
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“重
parameters. 分页参数不合法。 请参考API接口文档修改limit和offset参数。 400 FDI.3049 The parameter used for sorting is invalid. 排序参数不合法。 请参考API接口文档修改排序参数。 400 FDI.3050
objects 删除失败的API及错误信息 success_count Long 删除成功的API数量 表6 BatchFailure 参数 参数类型 描述 api_id String 操作失败的API ID api_name String 操作失败的APi名称 error_code