检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 约束与限制 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 如果API在选择的环境中已发布,再次发布将覆盖原来已发布的API。 前提条件
在页面左上角选择“分组信息”页签,在“域名管理”下单击“绑定独立域名”,为API分组绑定独立域名。 具体配置参数说明请参见绑定域名。 完成后单击“确定”。 新建发布环境。 在实例控制台的“服务集成 APIC > API策略”页面,选择“环境管理”页签。 单击“创建环境”,新建API的发布环境。 完成后单击“确定”。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI POST /v1/{project_id}/apic/instances/{instance_id}/api-groups
开放API 创建API分组 创建负载通道(可选) 创建API 调试API 创建发布环境和环境变量(可选) 发布API 绑定域名 配置调用授权(可选) 父主题: 服务集成指导
境。 说明 填写API的发布说明信息。 如果API在选择的环境中已发布,再次发布将覆盖原来已发布的API。 发布API后,在“API列表”页签中单击该API的名称,进入API详情页面。在“发布历史”页签中,可以查看API的发布历史信息,并查看每个发布版本的API配置信息。 父主题:
查询后端API详情 功能介绍 查询后端API的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/inst
API的“请求协议”和“入参定义”。 新版界面:在ROMA Connect实例控制台选择“服务集成 APIC > API列表”,在页面中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“API运行”页签下,获取API的“请求协议”,在“前端配置”中可获取“入参定义”。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{
查询API指标统计值 功能介绍 查询某个实例下的API统计信息。 接口约束 调用超时或返回“request statistics error”报错时,请切换其他mode或缩短统计时长。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 URI PUT /v1/{project_id}/apic/instances/{instance_id}/api-groups/{group_id} 表1 路径参数 参数 是否必选
删除后端API 功能介绍 在某个实例中删除后端API。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
API管理 下线API 导入导出API 配置API定时任务 SSL证书管理 附录:API的Swagger扩展定义 父主题: 服务集成指导(旧版界面)
environment. 检查域名、方法、路径和注册的API是否一致。 检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名。 500 APIC.0103 The backend does not exist. 联系技术支持。 500 APIC.0104 The
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
创建API分组 概述 API分组是同一类业务API的集合,API开发者以API分组为单位,管理分组内的所有API。每个API都要归属到某个API分组下,在创建API前应提前创建API分组。 前提条件 每个API分组都要归属到某个集成应用下,在创建API分组前您需要有可用的集成应用,否则请提前创建集成应用。
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
配置API级联 API级联是指同一区域或不同区域的两个ROMA Connect实例可以建立级联关系,级联实例中的API可以使用被级联实例中的API作为后端服务,实现跨实例间的API调用。级联实例间的API调用使用专属的认证通道,避免被级联实例的API作为后端服务时的认证冲突问题。
调用API 调用开放的API 配置跨域访问API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导(旧版界面)