检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
前提条件 已调用API。 查看API的调用日志 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日志”,将“启动日志记录”修改为,即启用日志记录能力。 “日志组”和“日志流”设置请参见日志管理,完成后单击“确定”。
根据实际业务在左侧导航栏上方选择实例。 创建SSL证书。 在左侧导航栏选择“API管理 > API策略”。 在“SSL证书管理”页签中,单击“创建SSL证书”。 表1 配置单向认证的证书信息 参数 配置说明 证书名称 填写证书名称。 可见范围 此处选择“当前实例”。 证书内容 -----Start
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
API网关共享版是否可以升级到专享版? 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案: 新购买专享版实例。 导出共享版中的API。 将API导入到专享版。 重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 父主题: 产品咨询
向API提供者获取请求参数中要携带的第三方认证信息。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 API调用支持长连接。但是需要适当使用长连接,避免占用太多资源。 构造API请求,示例如下:
单击“VPC通道名称”,进入VPC通道详情页面。 单击“云服务器”,进入“云服务器”页签。 根据您的需要为VPC通道增加/删除云服务器或编辑云服务器的权重。 增加云服务器 单击“添加云服务器”,弹出“添加云服务器”对话框。 勾选需要添加的云服务器,并且设置权重,单击“添加”。 待添加的云服务器的安全组必须允许100
填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。 根据下表参数信息,配置安全配置。 表3 安全配置 参数 说明 类型 API类型: 公开:选择“公开”类型时,API支持上架。 私有:选择“私有”类型时,当该API所在分组上架时,该API不会上架。 安全认证 API认证方式:
签名密钥类型: hmac basic public_key aes basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在
是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号 请求消息
PI,通过负载通道访问CCE工作负载中的实例地址。 方式二:在API网关中一键式导入CCE工作负载,自动生成API和负载通道,通过负载通道访问CCE工作负载中的实例地址。 (可选)配置工作负载标签实现灰度发布 通过CCE工作负载的标签配置,实现灰度发布。灰度发布是服务发布策略之一
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是
API网关(APIG)专享版提供基础版、专业版、企业版、铂金版等多个实例规格版本,每个规格对应不同的官网价。不同规格差异体现为每秒最大请求数、带宽、内网每秒新建连接数等,详情请参考产品规格。 用户可以根据自己的业务场景选择合适的APIG专享版规格,在此做如下推荐: 如果用户对API并发调用、带宽的
VCP通道类型默认为服务器类型。 当type=3,microservice_info不为空,VPC通道类型为微服务类型。 修改负载通道时vpc通道类型不会修改,直接使用原有的vpc通道类型。 此字段待废弃,请使用vpc_channel_type字段指定负载通道类型。 缺省值:2
查看监控指标与配置告警 APIG支持的监控指标 配置APIG的监控告警 查看APIG的监控指标 查看APIG的带宽监控 查看APIG的API调用日志
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升
tificate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号
新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。 API网关控制台中已经限定您无法创建HEADER位置的x-auth-token
方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Key、Secret),在调用API时,API网关服务根据密钥对进行身份核对,完成鉴权。Key唯一且不可重置,支持重置Secret。 配置APIG的API简易认证AppCode API配置简易认证