检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
在导出API页面中,配置API导出相关信息。 表2 导出API 参数 说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 选择要导出的API。若不配置,则默认导出API分组在所选环境下的所有的API。 API定义范围 选择要导出的API定义信息范围。
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API E
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
删除后端API 功能介绍 在某个实例中删除后端API。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
测试后端API 功能介绍 测试后端API是否可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic/instan
在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签上方单击“更多 > 导出API”。 在导出API页面中,配置API导出相关信息。 表2 导出API 参数 配置说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 自定义选
消息集成API MQS实例管理 主题管理 应用权限管理 消息管理 消费组管理
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:前端API的Swagger扩展定义”章节。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
导出API 功能介绍 导出分组下API的定义信息,导出文件内容符合swagger标准规范。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{pro
$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绑定流控策略 设置特殊流控 签名密钥管理 签名密钥绑定关系管理 ACL策略管理 API绑定ACL策略 OpenAPI接口 VPC通道管理 客户端配置 客户端配额 APP授权管理
$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的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多 > 下线”。 在下线API弹窗中,选择要下线API的环境,完成后单击“确定”。 父主题: API管理
参数 是否必选 参数类型 描述 api_type 否 String API类型 data:数据API function:函数API scripts 否 Array of LdApiScriptBase objects API脚本信息列表 表4 LdApiScriptBase 参数 是否必选
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多