检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API安全 使用WAF对APIG进行安全防护 使用DDoS防护服务为APIG抵御DDoS攻击
版本迁移 APIG共享版迁移到专享版
克隆APIG的API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请通过APIG创建REST API。 克隆API
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts"
links Object IAM用户的资源链接信息。 表7 user.links 参数 参数类型 描述 self String 资源链接地址。 请求示例 管理员修改名为“IAMUser”的IAM用户的密码为“IAMPassword@”。 PATCH https://iam.myhuaweicloud
配置APIG的API认证凭据 使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根
如果您使用系统策略,则拥有“APIG FullAccess”权限即可。 如果您需要对云上的资源进行精细管理,请使用IAM服务创建IAM用户及用户组,并授权,以使得IAM用户获得具体的操作权限。具体操作请参考创建用户并授权使用APIG。 在创建APIG实例前,确保已存在可用的VPC和子网。
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。
API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示借助IAM服务进行安全认证。 自定义认证:用户有自己的认证系统或服务(如使用OAuth认证),可选择“自定义认证”。 无认证:表示不需要认证。API网关对收到的调用请求不做身
APIG专享版实例配置安全认证类型 apig APIG专享版实例中如果存在API安全认证为“无认证”,则视为“不合规” apig-instances-execution-logging-enabled APIG专享版实例配置访问日志 apig APIG专享版实例未配置访问日志,视为“不合规” apig-instances-ssl-enabled
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:47 member_id 是 Object 包含组成员标识符的对象。 表4 member_id 参数 是否必选 参数类型 描述 user_id 是 String 身份源中IAM身份中心用户的全局唯一标识符(ID)。
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。
API策略 是否支持对API的请求并发次数做控制? 企业账号是否有调试域名每天最多可以访问1000次的限制? API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
调用API 调用APIG开放的API 跨域调用APIG开放的API APIG的API响应消息头说明 APIG的API错误码说明
开放API 使用APIG专享版开放云容器引擎CCE工作负载 使用APIG专享版开放本地数据中心的服务能力 使用APIG专享版跨VPC开放后端服务 使用APIG专享版实现gRPC服务的路由转发 使用APIG专享版实现WebSocket服务的转发 使用APIG专享版实现http到https自动重定向
" ] } 响应消息 表4 参数说明 名称 类型 说明 - 字典数据类型 API与签名密钥的绑定关系列表 表5 字典类型响应参数 名称 类型 说明 id String 绑定关系的ID api_id String API编号 api_name String API名称 api_remark
策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系,则策略无法执行删除操作。 创建策略 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面,单击“创建策略”。
发布APIG创建的API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 约束与限制 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。