检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
调用API 调用开放的API 配置跨域访问API 定时调用API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导
查询设备影子 功能介绍 查询设备影子。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/link/instances/{in
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
API指标统计值查询-最近一段时间 功能介绍 根据API的ID和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。 为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/
查询插件下绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 绑定关系列表中返回的API在对应的环境中可能已经下线 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API
String 后端API返回类型 缺省值:json api_signature_id String 后端API为签名认证时绑定的签名密钥编号 最小长度:1 最大长度:64 roma_app_id String 后端API归属的集成应用编号 更新后端API时,status=4为后端API的已部
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:前端API的Swagger扩展定义”章节。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
查询后端API列表 功能介绍 获取某个实例下的所有后端API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/i
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
配置API授权(可选) 概述 若函数API使用了APP认证方式,则需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 前提条件 API的安全认证方式为“APP认证”。 API已发布到环境,否则请先发布API。
查询MQS实例详情 功能介绍 查询指定MQS实例详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/mqs/instances/{instance_id}
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“
更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。 最小长度:2 最大长度:256 method 是 String 后端API请求方法。 支持GET、PUT、POST、DELETE 更新后端API时,status=4为后端API的已部署
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
导出API 功能介绍 导出分组下API的定义信息,导出文件内容符合swagger标准规范。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{pro
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。 最小长度:2 最大长度:256 method String 后端API请求方法。 支持GET、PUT、POST、DELETE 更新后端API时,status=4为后端API的已部署状
$context.apiName: API的名称 $context.apiId:API的ID $context.appName: API调用者的APP对象名称 $context.appId:API调用者的APP对象ID $context.requestId:当次API调用生成跟踪ID $context