检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
$context.apiName: API的名称 $context.apiId:API的ID $context.appName: API调用者的APP对象名称 $context.appId:API调用者的APP对象ID $context.requestId:当次API调用生成跟踪ID $context
参数 说明 所属分组 选择前端API所属的API分组。若没有可用的API分组,可单击右侧的“创建分组”,创建一个API分组。 说明: 创建API后,将无法修改API所属的API分组,API分组关系到API的访问域名,请谨慎选择。 发布环境 选择前端API要发布的环境。如果没有您需要
SK进行API请求的安全认证。使用该方式的API仅适合同一云服务平台的用户调用。 无认证:表示API请求不需要认证。使用该方式的API适合所有用户调用,安全级别低,请谨慎使用。 请求方法 选择API的请求方法。 请求Path 填写API的请求路径。 匹配模式 选择API请求路径的匹配模式。
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签上方单击“更多 > 导出API”。 在导出API页面中,配置API导出相关信息。 表2 导出API 参数 配置说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 自定义选
导出API 功能介绍 导出分组下API的定义信息,导出文件内容符合swagger标准规范。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{pro
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:前端API的Swagger扩展定义”章节。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
在导出API页面中,配置API导出相关信息。 表2 导出API 参数 说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 选择要导出的API。若不配置,则默认导出API分组在所选环境下的所有的API。 API定义范围 选择要导出的API定义信息范围。
历史API 服务集成API(V1) 设备集成API(V1)
调用API 调用开放的API 配置跨域访问API 定时调用API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
API管理 下线API 导入导出API 配置API定时任务 SSL证书管理 附录:API的Swagger扩展定义 父主题: 服务集成指导(旧版界面)
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}
下线API 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多
设备集成API 设备分组管理 设备管理 订阅管理 产品模板 产品管理 规则引擎 服务管理
如何调用API 构造请求 认证鉴权 返回结果