检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API管理(V1) 创建API 修改API 删除API 查询API详情 查询API列表 批量删除API 批量发布或下线API 调试API 父主题: 服务集成API(V1)
查询可绑定当前API的插件 功能介绍 查询可绑定当前API的插件信息。 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /
创建API分组 概述 API分组是同一类业务API的集合,API开发者以API分组为单位,管理分组内的所有API。每个API都要归属到某个API分组下,在创建API前应提前创建API分组。 前提条件 每个API分组都要归属到某个集成应用下,在创建API分组前您需要有可用的集成应用,否则请提前创建集成应用。
配置API授权(可选) 概述 仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 若API开启了简易认证,可直接使用集成应用中配置的AppCode进行简易安全认证,无需使用Key和Secret进行签名认证。
查询后端API测试结果 功能介绍 在某个实例中查询后端API的测试结果。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/a
修改API配置 概述 API的环境类信息、控制策略信息、密钥类信息、API授权的黑白名单以及未发布到RELEASE环境的API,为非资产数据,在导入集成资产后需要重新配置。 环境类信息包括独立域名、环境变量、负载通道的云服务器信息、非默认的环境。 控制策略信息包括流量控制策略、访
查询可绑定当前插件的API 功能介绍 查询可绑定当前插件的API信息。 支持分页返回 支持API名称模糊查询 支持已绑定其他插件的API查询返回 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
body_bytes_sent API请求的Body体大小,单位字节。 34 api_name API名称。 35 app_name 当使用APP认证访问时,请求方使用的APP名称。 36 provider_app_id API所属的APP ID。 37 provider_app_name API所属的APP名称。
Site实例中,地址需要填写为APIC连接地址的IP,例如“192.100.0.10”。 说明: 如果接入的API为服务集成中创建的API时,因为API的默认子域名每天最多只能访问1000次,建议不要使用API的默认子域名接入API,避免因超过访问次数限制后导致接入数据源失败。建议使用API的独立域名接入。
定时调用API 通过在ROMA Connect中创建API定时任务,可以实现定时自动调用API的功能。 前提条件 添加到定时任务中的API必须已发布,否则请先发布API。 添加到定时任务中的API必须为“APP认证”或“无认证”的安全认证方式。 ROMA Connect的实例配置
导入自定义后端API 功能介绍 导入自定义后端API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:后端API的Swagger扩展定义”章节 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动
在左侧的导航栏选择“服务集成 APIC > API分析”,在“调用分析”页签中可查看API的调用统计情况。 可查看“API总数”、“API分组总数”、“流控策略总数”的实时统计。 查看某个API的调用统计,包括“请求次数”、“出错统计”、“数据流量”和“调用延时”。 选择“集成应用”和“API”,筛选要查
设备集成API(V1) 产品管理 设备管理 规则引擎 父主题: 历史API
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义ROMA
AclBindApiInfo objects 本次查询返回的API列表 表5 AclBindApiInfo 参数 参数类型 描述 api_id String API编号 api_name String API名称 group_name String API分组名称 api_type Integer
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义ROMA
objects 本次查询到的后端API部署结果对象列表 表4 LdApiDeployHistoryInfo 参数 参数类型 描述 id String 部署的编号 ld_api_id String 部署的后端API编号 group_id String 部署的前端API分组编号 env_id
调用API失败的原因是什么? 调用API失败的场景分为三种:同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。 VPC内调用API失败时,请检查域名是否和API自动分配的域名一致,如果域名错误,会导致调用API失败。 不同VPC之间调用API失败时,请检查两个VPC的网络
获取指定版本ID的API版本信息 功能介绍 获取指定版本ID的API版本信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /{version} 表1 路径参数
权”。 授权完成后,在授权API页面,单击API左侧的“”,可展开并查看已授权的集成应用列表。 表1 API授权配置 参数 配置说明 API授权的环境 选择要授权API所在的发布环境。 集成应用 勾选要授予API调用权限的集成应用。 访问参数 为授权的集成应用设置访问参数。访问参