检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
和查询等接口。 APP管理 包括APP的创建、修改、删除、重置密钥和查询等接口。 APP授权管理 包括授权、解除授权、查询授权关系等接口。 环境管理 包括环境的创建、修改、删除和查询接口。 环境变量管理 包括环境变量的创建、删除和查询等接口。 流控策略管理 包括流控策略的创建、修改、删除和查询等接口。
当客户端和服务端之间通信的合同。 创建API 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建GRPC API”。更多详细指导,请参见创建GRPC API。 根据下表参数说明,配置前端信息。配置完成后,单击“下一步”。
文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。 增加校验API定义接口。
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
实例 表1 实例约束与限制 限制项 约束与限制 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略,则拥有“APIG FullAccess”权限即可。 如果您使用自定义策略,请参考APIG自定义策略。
告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。 单击“查看更多监控”,进入云监控界面,参考创建告警规则为API网关创建告警规则。
PI网关各项监控指标。 前提条件 已创建API分组和分组内的API。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。 查看API的各项监控指标。 单击“查看更多监控”,进入云监控界面,查看更多监控数据。
访问API。 配置凭据的访问控制策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“访问控制策略”区域,单击“绑定”。 根据下表参数说明,在弹窗中配置策略信息。 表1 绑定访问控制策略
当API网关不再使用时,可以将实例退订或删除,从而避免继续收费。详细介绍请参见停止计费。 成本管理 使用API网关时,您可以根据自己的需求适当选择实例版本,避免资源浪费从而优化成本。详细介绍请参见成本管理。
16:30:30执行按需转包年/包月操作,生成类型为“按需转包年/包月”的订单。用户支付订单后,按需转包年/包月的实例立即生效。在“费用中心 > 账单管理”页面将生成如下三条账单信息: 按需:2023/04/18 15:00:00 ~ 2023/04/18 16:00:00,在15:29:16
单向认证 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 创建SSL证书。 在左侧导航栏选择“API管理 > API策略”。 在“SSL证书管理”页签中,单击“创建SSL证书”。 表1 配置单向认证的证书信息 参数 配置说明 证书名称 填写证书名称。 可见范围 此处选择“当前实例”。
API网关用户指南》。 开启重定向 登录API网关控制台页面。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入API所属分组的详情页面。 在“分组信息”页签的“域名管理”区域,找到已绑定的独立域名,在“支持http to https自动重定向”列开启重定向功能。
"request_id": "a532***5aca" } 可能原因 appkey配置错误。 解决方法 在API网关控制台页面的左侧导航栏中选择“API管理 > 凭据管理”。 单击对应的凭据名称,进入凭据详情。 查看“Key”值,并重新配置appkey。 Incorrect app authentication
凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“凭据配额策略”区域,单击“绑定”。 在弹窗中选择已有策略或单击“创建新策略”。 选择已有
如果某一个密钥不再提供服务,则可以将其删除。 前提条件 已创建密钥。 操作步骤 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 通过以下任意一种方法,弹出对话框。 在待删除的密钥所在行,单击“删除”。 单击“密钥名称”,进入签名密钥详情页面。在右上角单击“删除”。
关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面的“监控视图”区域,单击“查看更多监控”,返回“云服务监控
可。 域名问题 域名是否备案成功,且能正常解析。 域名是否绑定到正确的API分组。 子域名(调试域名)访问超过默认次数。API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。您可以通过添加独立域名来访问您开放的API。 发布问题
并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。
方案优势 帮助用户根据业务诉求进行灵活配置,无需修改原有业务网络架构,直接将请求转发到后端服务上。 约束与限制 VPC1、VPC2、APIG实例系统VPC网段不能重叠。关于APIG实例VPC网段规划,请参考表2。 父主题: 使用APIG专享版跨VPC开放后端服务
参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号