检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
下线API 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
Connect实例的“服务集成 APIC > API列表”中查看并编辑该发布的API。 支持的动作 接收API调用 配置参数 参数 说明 API名称 填写API的名称,根据规划自定义。该名称会在对应ROMA Connect实例的“服务集成 APIC > API列表”中展示。 安全认证 选择安全认证方式,当前支持以下方式
历史API 服务集成API(V1) 设备集成API(V1)
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“
调用API 调用开放的API 配置跨域访问API 定时调用API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导
参数 是否必选 参数类型 描述 api_type 否 String API类型 data:数据API function:函数API scripts 否 Array of LdApiScriptBase objects API脚本信息列表 表4 LdApiScriptBase 参数 是否必选
开放API 创建API分组 创建负载通道(可选) 创建API 调试API 创建发布环境和环境变量(可选) 发布API 绑定域名 配置调用授权(可选) 父主题: 服务集成指导
API管理 下线API 导入导出API 添加SSL证书 添加简易认证凭据 附录:API的Swagger扩展定义 父主题: 服务集成指导
API绑定插件 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,原来已经绑定的同类型插件,会直接覆盖。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自
查询后端API测试结果 功能介绍 在某个实例中查询后端API的测试结果。 URI GET /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id}/test 表1 路径参数 参数 是否必选 参数类型
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,原来已经绑定的同类型插件,会直接覆盖。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自
删除API分组 功能介绍 删除指定的API分组。 分组下存在API时分组无法删除,需要删除所有分组下的API后,再删除分组。 删除分组时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。
删除API分组 功能介绍 删除指定的API分组。 分组下存在API时分组无法删除,需要删除所有分组下的API后,再删除分组。 删除分组时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。
objects 删除失败的API及错误信息 success_count Long 删除成功的API数量 表6 BatchFailure 参数 参数类型 描述 api_id String 操作失败的API ID api_name String 操作失败的APi名称 error_code
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 注意:当action = online时,接口返回的响应中publish_id,version_id, publish_time字段才有含义。 调试 您可以在API Explore
能访问1000次,建议不要使用API的默认子域名接入API,避免因超过访问次数限制后导致接入数据源失败。建议使用API的独立域名接入。 请求方式 选择API的请求方式。 认证方式 选择API的请求认证方式。 None:无需认证,任何人都可以调用API。 Basic Auth:使用
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}