检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
e_value”或“default”时需要配置。 填写编排后的参数名称。 参数类型 当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。 选择参数类型。 string number 参数位置 当“是否预处理策略”开关关闭或者“编
请求方法 URI GET /v1.0/apigw/resources/outline/apis 请求消息 无 响应消息 表2 参数说明 名称 类型 说明 instance_num Integer API总个数 nums_off_release Integer 未发布到release环境的API个数
客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“访问控制策略”区域,单击“绑定”。 在弹窗中配置策略信息。
建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。
请求方法 URI DELETE /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String API的编号 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content
0策略,流控限制值为实例“配置参数”中“ratelimit_api_limits”的参数运行值。 如果一个API绑定传统流量控制策略后,继续绑定流量控制2.0策略,传统流量控制策略会失效。 参数流控的规则最多可定义100个。 策略内容最大长度65535。 如果您的实例不支持流量控制2
API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 参数 说明
eny”表示认证失败。 “context”字段为可选,支持字符串类型键值对,当实例支持authorizer_context_support_num_bool特性时,键值对的值支持number类型或boolean类型,键值不支持JSON对象或数组。 context中的数据为您自定义
单击“创建密钥”,弹出“创建密钥”对话框。 填写如表1所示信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型,可选择“HMAC”和“Basic”。 Key 与“Secret”配合使用,表示签名密钥对。 HMAC:填写hmac认证所使用密钥对的Key。
企业或开发者通过API网关开放自身的服务与数据。 图1 API网关服务开放API 开放API的业务使用流程如下图所示。 图2 API网关服务开放API基本流程 创建实例 共享版无需购买实例,可直接进入共享版。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 绑定域名 在开
足任何一个策略后端的API请求,都将转发到默认的API后端。 “系统参数-前端认证参数”策略条件的“条件值”只支持字符串、整数、布尔值三种类型的值。 一个API最多定义5个策略后端。 父主题: 通过匹配系统参数-前端认证参数调用API的策略后端
origin: "CONSTANT" description: "调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称,由字母、数字、下划线、连线、点组成,以字母开头,最长32字节 header位置的参数名称不区分大小写
在华为云商店中,入住卖家中心,将您的API开放售卖。 将API上架到华为云商店售卖。 此部分操作在华为云商店完成,您需要作为卖家入驻云商店,然后发布API商品。 专享版实例暂不支持将API上架到云商店公开售卖。 父主题: 其他
调试API时,后端超时时间最大支持60s。 前提条件 已搭建完成后端服务。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页签,选择待调试的API,单击“调试”。 配置URL和API请求参数。
凭据配额策略用于限制客户端(API调用者)在某个时间周期内的API调用次数,支持自定义重置时间。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“凭据配额策略”区域,单击“绑定”。 在弹窗中选择已有策略或单击“创建新策略”。
端服务请求Path为“/Stage/AA”。 图1 环境变量示意图 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 单击“分组信息”页签。 在“环境变量”区域,选择环境。如果未创建环境,可单击“创建环境”创建。
X-Apig-Upstream-Latency 从API网关请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug,且后端服务类型不为Mock时,返回此参数 X-Apig-RateLimit-api API流量控制信息 示例:remain:9,limit:10,time:10
不支持HTTP。 每个凭据最多可创建5个AppCode。 生成APPCode 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“AppCodes”区域,单击“添加AppCode”。
可以绑定多个API。 如果API未绑定流控策略,流控限制值为实例“配置参数”中“ratelimit_api_limits”的参数运行值。 配置参数说明 表1 配置参数说明 参数 说明 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控针对单个API进行流量统计和控制;