API 安全治理
文档中心>API 安全治理

快速入门

最近更新时间:2024-11-01 16:49:22

我的收藏

前提条件

您需要完成 注册腾讯云 账号,并完成 实名认证
已购买 API 安全治理

步骤1:创建应用

通常,某些特定功能的实现需要通过一组相关的 API 来实现,API 安全治理的应用管理模块可以帮您高效、便捷地管理一组有关联的 API。本文介绍在 API 安全治理控制台创建一个应用的步骤。
1. 登录 API 安全治理控制台,在左侧导航栏中选择应用,进入应用列表页。

2. 单击新建应用,输入应用配置信息。

参数名称
参数说明
应用名称
必填,最长32个字符,支持中文、大小写字母、数字、_、()、(),平台唯一。
应用密钥
必填,最长32个字符,支持中文、大小写字母、数字。
描述
最长64个字符。
3. 单击确定,即可创建应用。


步骤3:创建 API

该任务指导通过 API 安全治理控制台在已创建好的应用下创建一个后端对接 的 API。

1. API > API 列表页面,单击新建 API

2. 单击新建 API,输入 API 配置信息。

参数名称
参数说明
所属应用
选择 步骤1 创建的应用。
API 名称
必填,最长32个字符,支持中文、大小写字母、数字、_、()、(),平台唯一。
鉴权方式
签名:适用于需要通过 AKSK 鉴权保护的 API。
登录:适用于需要登陆态会话保护的站点类 API。
无:适用于开放类 API。
3. 单击下一步,输入 API 后端配置信息。

参数名称
参数说明
访问路径
此 API 的对外访问路径。
后端服务
此 API 对应的后端服务地址。
协议类型
此 API 对应的后端服务协议类型,支持 http 和 https。
协议版本
此 API 对应的后端服务协议版本,支持 1.0、1.1 和 2.0。
原始路径
此 API 对应的后端服务访问路径。
4. 单击下一步,输入 API 高级配置信息。

参数名称
参数说明
流量控制
配置此 API 的限流算法、限流方案及超时控制。
健康检查
配置此 API 对应的后端服务的 7 层健康检查方案,默认使用 4 层健康检查。
格式转换
配置此 API 请求和响应的数据格式协议类型。
IP 黑名单
配置此 API 的 IP 黑名单,和 IP 白名单互斥。
IP 白名单
配置此 API 的 IP 白名单,和 IP 黑名单互斥。
3. 单击保存,即可完成创建 API。


步骤3:调试 API

通过 API 调试页面,您可以在配置完 API 后立即验证 API 的正确性,发起模拟 API 调用并查看具体请求响应。如果 API 未按照您期望的方式工作,可以根据响应,重新修改配置以符合您的设计期望。
在调试页面,选择应用及发布的 API 后,单击调试,即可查看本次调试的返回结果。