检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义ROMA
Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of UnbindApiForAcl objects 本次查询返回的API列表 表5 UnbindApiForAcl 参数 参数类型 描述 auth_type String API的认证方式 run_env_name
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的网络
本次查询返回的API历史版本列表 表5 ApiVersionResp 参数 参数类型 描述 version_id String API历史版本的ID version_no String API的版本号 api_id String API编号 env_id String 发布的环境编号
Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForThrottle objects 本次查询返回的API列表 表5 ApiForThrottle 参数 参数类型 描述 auth_type String API的认证方式 run_env_name
服务集成API(V1) API分组管理(V1) API管理(V1) 自定义后端服务(V1) APP授权管理(V1) 自定义认证管理(V1) 父主题: 历史API
在发布弹窗中配置前端API的相关信息,完成后单击“立即发布”,为该后端创建一个对应的前端API,并发布到环境上。 API发布完成后,自动跳转到对应前端API的API运行页面。 表2 发布配置 参数 配置说明 所属分组 选择前端API所属的API分组。若没有可用的API分组,可单击右侧的“创建分组”,创建一个API分组。
objects 本次查询到的后端API部署结果对象列表 表4 LdApiDeployHistoryInfo 参数 参数类型 描述 id String 部署的编号 ld_api_id String 部署的后端API编号 group_id String 部署的前端API分组编号 env_id
查看APP未绑定的API列表 功能介绍 查询指定环境上某个APP未绑定的API列表,包括自有API和从云市场购买的API。 URI GET /v1/{project_id}/apic/instances/{instance_id}/app-auths/unbinded-apis 表1 路径参数
查看APP未绑定的API列表 功能介绍 查询指定环境上某个APP未绑定的API列表,包括自有API和从云市场购买的API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
API指标统计值查询-最近一段时间 功能介绍 根据API的ID和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。 为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/
ApiAuthInfo 参数 参数类型 描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark
用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。
String 后端API返回类型 缺省值:json api_signature_id String 后端API为签名认证时绑定的签名密钥编号 最小长度:1 最大长度:64 roma_app_id String 后端API归属的集成应用编号 更新后端API时,status=4为后端API的已部
表5 V1ApiAuthInfo 参数 参数类型 描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark
String 后端API返回类型 缺省值:json api_signature_id String 后端API为签名认证时绑定的签名密钥编号 最小长度:1 最大长度:64 roma_app_id String 后端API归属的集成应用编号 更新后端API时,status=4为后端API的已部
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 否 String API所属的应用ID format 否 String 导出的API定义的格式 缺省值:json apis 否 Array
创建普通任务 功能介绍 创建普通任务(区别于组合任务)。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/fdi/inst
duplicated_apis Array of DuplicateApiInfo objects 该路径下冲突的API列表 表6 DuplicateApiInfo 参数 参数类型 描述 api_id String API ID api_name String API名称 group_name