检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
参数 是否必选 参数类型 描述 api_type 否 String API类型 data:数据API function:函数API scripts 否 Array of LdApiScriptBase objects API脚本信息列表 表4 LdApiScriptBase 参数 是否必选
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。 最小长度:2 最大长度:256 method 是 String 后端API请求方法。 支持GET、PUT、POST、DELETE 更新后端API时,status=4为后端API的已部署
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多 > 下线”。 在下线API弹窗中,选择要下线API的环境,完成后单击“确定”。 父主题: API管理
$context.apiName: API的名称 $context.apiId:API的ID $context.appName: API调用者的APP对象名称 $context.appId:API调用者的APP对象ID $context.requestId:当次API调用生成跟踪ID $context
Connect实例的“服务集成 APIC > API列表”中查看并编辑该发布的API。 支持的动作 接收API调用 配置参数 参数 说明 API名称 填写API的名称,根据规划自定义。该名称会在对应ROMA Connect实例的“服务集成 APIC > API列表”中展示。 安全认证 选择安全认证方式,当前支持以下方式
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
调用API 调用开放的API 配置跨域访问API 定时调用API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导
导入API 已创建的API产品资产,可以将API导入到资产中。 登录新版ROMA Connect控制台。 在左侧导航栏选择“资产中心>我的资产”。 单击一个API产品类型的资产,并切换到“API资产”页签。 单击“导入api”,弹出“添加API资产”弹窗。 选择“从ROMA中导入”或“外部上传”,进行API导入。
查询后端API测试结果 功能介绍 在某个实例中查询后端API的测试结果。 URI GET /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id}/test 表1 路径参数 参数 是否必选 参数类型
历史API 服务集成API(V1) 设备集成API(V1)
重试或联系技术支持工程师检查是否数据面同步异常 400 APIG.3608 Cannot edit APIs in the API Designer. 没有权限操作API设计器创建的API 不允许操作,请操作其他API 400 APIG.3610 When the backend uses
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 注意:当action = online时,接口返回的响应中publish_id,version_id, publish_time字段才有含义。 调试 您可以在API Explore
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“
撤销后端API 功能介绍 在某个实例中取消部署后端API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic/in
删除后端API 功能介绍 在某个实例中删除后端API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/in
创建后端API 功能介绍 在某个实例中创建后端API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic/inst
开放API 创建API分组 创建负载通道(可选) 创建API 调试API 创建发布环境和环境变量(可选) 发布API 绑定域名 配置调用授权(可选) 父主题: 服务集成指导