检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08 05:05:00,则表示客户端配额策略从2020/08/08
Python 操作场景 使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。
每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击“AppCode”页签,进入AppCode的管理界面。 单击“添加AppCode”,生成AppCode。可自动生成,也可手动输入。
创建SSL证书 功能介绍 创建SSL证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
修改SSL证书 功能介绍 修改SSL证书。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
C# 操作场景 使用C#语言进行后端服务签名时,您需要先获取SDK,然后打开工程,最后参考校验后端签名示例校验签名是否一致。 准备环境 已获取签名密钥的Key和Secret,请参见签名前准备获取。 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 请
appkey配置错误。 解决方法 在API网关控制台页面的左侧导航栏中选择“API管理 > 凭据管理”。 单击对应的凭据名称,进入凭据详情。 查看“Key”值,并重新配置appkey。 Incorrect app authentication information: verify signature
欠费后,按需实例不会立即停止服务,资源进入宽限期。您需支付按需实例在宽限期内产生的费用,相关费用可在华为云控制台的“费用 > 费用账单 > 总览”页面的“欠费金额”查看,华为云将在您充值时自动扣取欠费金额。 如果您在宽限期内仍未支付欠款,那么就会进入保留期,资源状态变为“已冻结”,您将无法对处于保留期的按需计费实例执行任何操作。
包括手动续费和自动续费两种方式,您可以根据需求选择。了解更多关于续费的信息,请参见续费概述。 费用账单 您可以在“费用中心 > 账单管理”查看与API网关相关的流水和明细账单,以便了解您的消费情况。了解具体操作步骤,请参见费用账单。 欠费 在使用API网关时,账户的可用额度小于待
Java 操作场景 使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。
在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。 单击“配置参数”页签,找到您需要调整的配置项并进行修改。不同的实例规格展示的配置参数会存在不同,具体以界面为准。 表1
根据流控诉求,配置策略基本信息。 表1 策略基本信息 参数 配置说明 策略名称 根据规划自定义名称。建议您按照一定的命名规则填写名称,方便您快速识别和查找 流控类型 此处选择“高性能流控”模式。 策略生效范围 此处选择“单个API生效”,对单个API进行流量统计和控制。 时长 流量限制时长,根据诉求填写60秒。
创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。 使用API方式创建环境 您还可以使用API的方式创建环境和变量,具体操作请查看以下链接。 创建环境 新建变量 环境变量相关的FAQ API发布到不同环境后,会调用不同的后端服务吗? 父主题: 环境管理
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
表1 HTTP响应头参数说明 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“HTTP响应头”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 Name
以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。建议您按照一定的命名规则填写名称,方便您快速识别和查找。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。此处默认“default”。 委托名称 用户委托函数
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/openapi
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi/apis?env_id
Kafka日志推送参数说明 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“Kafka日志推送”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 策略基本信息