APP管理 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 创建App Code 自动生成App Code 查看App Code详情 查询App Code列表 删除App Code 父主题: 共享版API(仅存量用户使用)
签名密钥绑定关系管理 对象模型 查看签名密钥未绑定的API列表 绑定签名密钥 查看签名密钥绑定的API列表 查看API绑定的签名密钥列表 解除绑定 父主题: 共享版API(仅存量用户使用)
API管理 对象模型 创建API 修改API 删除API 发布API 下线API 批量发布或下线API 查看API详情 查询API列表 查询API历史版本列表 根据版本编号下线API 查看版本详情 查询API运行时定义 调试API 父主题: 共享版API(仅存量用户使用)
API绑定ACL策略 对象模型 将API与ACL策略进行绑定 查看API绑定的ACL策略列表 查看ACL策略绑定的API列表 查看ACL策略未绑定的API列表 解除API与ACL策略的绑定 批量解除API与ACL策略的绑定 父主题: 共享版API(仅存量用户使用)
审计日志和访问日志记录 APIG默认使用审计日志服务(CTS)记录OpenAPI的执行日志,用户可以在CTS服务页面查看租户最近的操作日志。具体操作请参考审计与日志。 APIG和云日志服务(LTS)集成,推荐租户在APIG页面开通日志分析功能,可以快速获取并分析API的调用日志。
HTTP&HTTPS:把后端服务请求转发给指定HTTP&HTTPS后端服务。 负载通道:是否使用负载通道访问后端服务。如果选择“使用”,您需要提前创建负载通道。 后端URL:配置要转发的后端服务请求地址。 后端超时(ms):后端服务请求的超时时间,默认为5000ms。
单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:客户端与服务端连接时,除了客户端需要验证所连接的服务器是否正确之外,服务端也需要验证接入的客户端是否正确。 约束与限制 仅支持添加pem编码格式的SSL证书。
单向认证:客户端与服务端连接时,客户端需要校验服务端SSL证书合法性。 双向认证:客户端与服务端连接时,除了客户端需要校验服务端SSL证书合法性,服务端也需要校验客户端SSL证书合法性。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status 否 Integer 后端服务器状态 1:可用 2:不可用 port 否 Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id 否 String 后端云服务器的编号。
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。
x-apigateway-plugins 含义:API网关定义的API插件服务。
待废弃字段 tags 否 []String 标签 包含一个服务名称标签和若干其它标签 服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark
API定义范围 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。
x-apigateway-backend 含义:API网关定义的API后端服务定义。
自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。
修改API 功能介绍 修改指定API的信息,包括后端服务信息。 调用方法 请参见如何调用API。
x-apigateway-backend.httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。
x-apigateway-backend.functionEndpoints 含义:API网关定义的FUNCTION类型API后端服务定义。
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。