检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。其中,签名密钥就是API安全保护机制的一种。租户创建一个签名密钥,并将签名密钥与API进行绑定,则服务集成在请求这个API
修改流控策略 功能介绍 修改指定流控策略的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instances
SSL证书管理 概述 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA Connect控制台
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey
响应消息头 调用API时,APIC增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加APIC调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从APIC接收请求到后端返回消息头的用时
配置响应缓存策略 ROMA Connect支持通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在APIC中,当客户端发送相同的请求时,APIC不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到APIC
删除APP的访问控制 功能介绍 删除客户端配置的访问控制信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic
删除自定义认证 功能介绍 删除自定义认证 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/instances/
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances
导入自定义后端API 功能介绍 导入自定义后端API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:后端API的Swagger扩展定义”章节 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
配置API的凭据配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。 约束与限制 同一个凭据只能绑定一个凭据配额策略
创建后端自定义认证 如果您需要把自己的认证系统用于后端服务请求的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指ROMA Connect使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
查询可绑定当前API的插件 功能介绍 查询可绑定当前API的插件信息。 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时
查询APP Code列表 功能介绍 查询App Code列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances
查询应用配置列表 功能介绍 查询应用配置列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{
设置APP的访问控制 功能介绍 设置客户端配置的访问控制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instances
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey
配置API的访问控制 访问控制可控制访问API的IP地址和账户,保护后端服务。您可以创建访问控制策略,允许/禁止某个IP地址或账号访问绑定策略的API。 访问控制策略和API本身是相互独立的,只有将API绑定访问控制策略后,访问控制策略才对API生效。 约束与限制 同一个API在同一个环境中只能绑定一个相同限制类型的访问控制策略
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2