检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
OpenAPI接口 导出API 导入API 导出自定义后端API 导入自定义后端API 父主题: 服务集成API
API管理 创建API 修改API 删除API 发布或下线API 查询API详情 查询API列表 批量发布或下线API 调试API 切换API版本 查看版本详情 根据版本编号下线API 查询API历史版本列表 查询API运行时定义 校验API定义 父主题: 服务集成API
API管理”,在“API列表”页签中单击“新建API”。 在新建API页面配置API的基本信息。 表1 基本信息配置 参数 配置说明 API名称 填写API的名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 所属分组 选择API所属的API分组。若没有可用的AP
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
、查询、删除、启动等操作。 服务集成API API分组管理 API分组相关API,包括分组的创建、修改、查询、删除等操作。 API管理 API管理相关API,包括API的创建、修改、查询、删除、发布等操作。 环境管理 环境相关API,包括环境的创建、修改、查询、删除等操作。 环境变量管理
户调用API时,使用Token或AK/SK进行API请求的安全认证。使用该方式的API仅适合同一云服务平台的用户调用。 自定义认证:表示使用自定义的函数API对API请求进行安全认证。使用该方式的API适合所有用户调用。 无认证:表示API请求不需要认证。使用该方式的API适合所有用户调用。
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了ROMA Connect如何去访问真
消息集成API MQS实例管理 主题管理 应用权限管理 消息管理 消费组管理
发布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在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 URI POST /v1/{project_id}/apic/instances/{instance_id}/apis/debug/{api_id} 表1 路径参数 参数 是否必选
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API E
境。 说明 填写API的发布说明信息。 如果API在选择的环境中已发布,再次发布将覆盖原来已发布的API。 发布API后,在“API列表”页签中单击该API的名称,进入API详情页面。在“发布历史”页签中,可以查看API的发布历史信息,并查看每个发布版本的API配置信息。 父主题:
调用API 调用开放的API 配置跨域访问API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导(旧版界面)
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了ROMA Connect如何去访问真
开放API 创建API分组 创建负载通道(可选) 创建API 调试API 创建发布环境和环境变量(可选) 发布API 绑定域名 配置API授权(可选) 父主题: 服务集成指导(旧版界面)
参数 说明 所属分组 选择前端API所属的API分组。若没有可用的API分组,可单击右侧的“创建分组”,创建一个API分组。 说明: 创建API后,将无法修改API所属的API分组,API分组关系到API的访问域名,请谨慎选择。 发布环境 选择前端API要发布的环境。如果没有您需要
创建一个API分组。 说明: 创建API后,将无法修改API所属的API分组,API分组关系到API的访问域名,请谨慎选择。 发布环境 选择前端API要发布的环境。如果没有您需要的环境,可单击右侧的“创建环境”,创建一个环境。 前端安全认证 选择前端API的安全认证方式,推荐使用APP认证方式。
API管理 下线API 导入导出API 配置API定时任务 SSL证书管理 附录:API的Swagger扩展定义 父主题: 服务集成指导(旧版界面)
在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签上方单击“更多 > 导出API”。 在导出API页面中,配置API导出相关信息。 表2 导出API 参数 配置说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 自定义选