脚本模式生成API 配置 说明 API名称 支持中文、英文、数字、下划线,且只能以英文或中文开头,364个字符。 API目录 一个特定功能或场景的API集合,类似文件夹,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。 您可单击“新建”进行新建,也可选择已创建的API分组。 请求Path API访问路径,例如:/v2/{projectid}/streams。 请求Path即完整的url中,域名之后、查询参数之前的部分,如下图中的“/blogs/188138”。详见下图: 统一资源定位符url说明 在请求路径中,可以使用大括号{}标识路径中的参数作为通配符。如“/blogs/{blogid}”表示/blogs后可以携带任何参数,例如“/blogs/188138”和“/blogs/0”均会匹配至/blogs/{blogid},由此API统一处理。 此外,相同域名下,不允许重复的请求路径出现。路径参数作为通配符时,名称不具备唯一性,例如“/blogs/{blogid}”和“/blogs/{xxxx}”,会被视作相同路径。 参数协议 用于传输请求的协议,支持HTTP和HTTPS协议。 HTTP属于基础的网络传输协议,无状态、无连接、简单、快速、灵活、使用明文传输,在使用上较为便捷,但是安全性欠佳。 HTTPS是在HTTP协议上进行了SSL或TLS加密校验的协议,能够有效验证身份以及保护数据完整性。相对的,访问HTTPS的API,需要配置相关的SSL证书或跳过SSL校验,否则将无法访问。 请求方式 HTTP请求方式,表示请求什么类型的操作,包含GET、POST等,遵循resultful风格。 GET:请求服务器返回指定资源,推荐使用GET请求。 POST:请求服务器新增资源或执行特殊操作,仅在注册API时使用。POST请求当前不支持body体,而是直接透传。 描述 对API进行简要描述。 标签 对API设置标签。用于标记当前API的属性,创建后可以通过标签快速检索定位API。单个API最多可设置20个标签。 审核人 拥有API的审核权限。 单击“新建”,进入“审核中心>审核人管理”页面,新建审核人。 安全认证 API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证,安全级别最高。 IAM认证:表示借助IAM服务进行安全认证,安全级别中等。 无认证:属于无防护的模式,无需认证即可访问,安全级别低,不推荐使用。 服务目录可见性 发布后,所选范围内的用户均可以在服务目录中看到此API。 当前工作空间可见 当前项目可见 当前租户可见 访问日志 勾选,则此API的查询结果将会产生记录并被保留7天,可以在“运营管理>访问日志”处通过选择“请求日期”的方式查看对应日期的日志。 最低保留期限 API解绑前预留的最低期限。0表示不设限制。 API进行停用/下线/取消授权时,会通知已授权用户,并为用户预留至少X小时,直到所有授权用户均完成解除或处理,或者到达截止时间,API才会停用/下线/取消授权。 入参定义 配置API请求中的参数,包含资源路径中的动态参数,请求URI中的查询参数和Header参数。 添加入参定义时,如果参数设定为必填,则API在访问时,必须传入指定参数;如果非必填,则在API访问时,未传入的参数,会使用默认值进行代替。 参数大小限制如下: query+path,url最大32KB header,最大128KB body, 最大128KB 以配置资源路径中的动态参数为例进行说明,例如资源路径(请求Path)设置为: /v2/{projectid}/streams,资源路径中的{projectid}为动态参数,需要在此进行配置。 1. 单击“添加”,参数名配置为projectid。 2. 参数位置选择PATH。 3. 类型设置为STRING。 4. 选择性配置示例值和描述。