检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
访问密钥保护关闭时,所有IAM用户可以管理(包含创建、启用/停用或删除)自己的访问密钥。 访问密钥保护开启时,仅管理员可以管理用户的访问密钥。 如果您无法管理您的访问密钥,请联系管理员: 由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。
在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 单击“重置Secret”。 在弹窗中单击“确定”。 父主题: 配置API调用授权(可选)
√ √ API分组变量管理 √ √ 高级功能 自定义认证 √ √ 支持对接API云商店 √ 即将支持 支持API策略路由 √ √ 运维分析展示 √ √ 支持后端负载均衡 × √ 支持内部API管理 × √ 后端支持对接私有云 × √ 支持对接专线服务 × √ 插件 × √ 日志分析
在左侧导航栏选择“API管理 > 凭据管理”,创建凭据。 单击“创建凭据”,填写凭据名称后,然后单击“确定”。 绑定API。 单击凭据名称,进入凭据详情。在“关联API”区域,单击“绑定API”,选择API并“确定”。 验证。
表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用API网关服务的所有功能。
操作步骤 方式一:在API网关控制台的实例管理中开通自动续费。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待续费的实例上单击“更多 > 开通自动续费”。 在“开通自动续费”页面,设置如下参数。。
API分组 API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 环境 为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。
在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。 根据流控诉求,配置策略基本信息。 表1 策略基本信息 参数 配置说明 策略名称 根据规划自定义名称。 流控类型 此处选择“高性能流控”模式。
操作步骤 方式一:在API网关控制台的实例管理中变更计费模式。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待变更计费模式的实例上单击“更多 > 转按需”。 确认信息后,单击“到期转按需”。 方式二:在控制台的费用中心中变更计费模式。
单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。 单击“查看更多监控”,进入云监控界面,参考创建告警规则为API网关创建告警规则。 父主题: 监控
如果填写了终端节点服务名称,购买实例后,在实例详情中的“终端节点管理”页签下展示名称为{region}.{终端节点服务名称}.{终端节点服务ID};如果终端节点服务名称为空,购买实例后,在实例详情中的“终端节点管理”页签下展示名称为{region}.{apig}.
在左侧导航栏选择“API管理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,根据下表参数说明,填写环境信息。 表1 环境信息 参数 说明 环境名称 API环境名称。支持英文,数字,下划线,且只能以英文开头,长度为3-64个字符。 描述 环境描述信息。
在“费用 > 账单管理 > 流水和明细账单 > 流水账单”中,“消费时间”即按需产品的实际使用时间。 查看指定资源的账单 使用实例ID查询账单 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看的实例上复制实例ID。 在主菜单中选择“费用 > 费用账单”。
检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 > 实例信息”界面开启出口地址。 检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子网的通信。
在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 直接创建”,根据下表参数说明,在弹框中填写分组信息。 表1 分组信息表 参数 说明 分组名称 API分组名称,用于将API接口进行分组管理。
在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“访问控制策略”区域,单击“绑定”。 根据下表参数说明,在弹窗中配置策略信息。 表1 绑定访问控制策略 参数 说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。
在“费用中心 > 账单管理”页面将生成如下三条账单信息: 按需:2023/04/18 15:00:00 ~ 2023/04/18 16:00:00,在15:29:16 ~ 16:00:00间产生费用 按需:2023/04/18 16:00:00 ~ 2023/04/18 17:00
可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。