检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将此服务的访问方式设置为VPC内网访问,在API网关中创建API时,通过VPC通道访问部署在VPC内的此服务。创建VPC通道和API的详细步骤请参见创建负载通道和创建API。 父主题: 开放API
"apig-sdk/go/core" 生成一个新的Signer,输入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
要修改,请重新输入新的证书内容或者密钥。 如果不再需要此SSL证书,在域名所在行,单击“删除SSL证书”。 常见问题 绑定域名失败常见原因:未将独立域名CNAME解析到分组的子域名上或域名重复。 添加SSL证书失败常见原因:生成证书的域名和实际添加证书所用的域名不一致。 后续操作
便您快速识别和查找 流控类型 此处选择“高性能流控”模式。 策略生效范围 此处选择“单个API生效”,对单个API进行流量统计和控制。 时长 流量限制时长,根据诉求填写60秒。 基础流控配置。 根据1,默认API在60秒内的流量限制为10次,用户流量限制为5次。 表2 基础流控配置
API请求优先匹配自定义规则中的触发条件和降级策略,仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。 如果匹配到自定义规则,则执行规则内配置的触发条件和降级策略。如果匹配到的自定义规则内未配置触发条件或降级策略,则执行上方配置的默认触发条件或降级策略。 如果未匹
APIGATEWAY_SDK; 生成一个新的Signer, 填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
解除绑定失败的API和流控策略绑定关系ID error_code String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id String 解除绑定失败的API的ID api_name String 解除绑定失败的API的名称 状态码:
鉴权服务的路径,即服务的url。 后端超时(ms) 鉴权服务请求的超时时间。超时时间不超过后端响应超时时间上限,超时时间上限可在API网关控制台的“配置参数”中查看。 自定义host头域 仅在使用负载通道时配置。 自定义后端服务请求中的Host头域,默认使用请求中原始的host头域。
Gone 被请求的资源在服务器上已经不再可用,并且没有任何已知的转发地址。 412 Precondition Failed 服务器在验证在请求的头字段中给出先决条件时,未能满足其中的一个或多个。 500 Internal Server Error 服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
API分组的子域名,由API网关分配,用户不可填写和修改 R - SL_DOMAINS Array of strings API分组的子域名列表,由API网关分配,用户不可填写和修改 R - PROJECT_ID String 创建该API分组的租户编号,即API分组的所有者 -
API认证 使用FunctionGraph服务实现APIG的自定义认证 使用APIG的APP认证和自定义认证实现API的双重认证 配置APIG专享版与客户端间的单向认证或双向认证
格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @; _sys_开头属于系统标签,租户不能输入 最小长度:1 最大长度:128 values 否 Array of strings 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符:
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上
ect-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 配额名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头 最小长度:3 最大长度:255 call_limits 是 Integer 凭据配额的访问次数限制 最小长度:1
配额名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3-255字符 call_limits Integer 凭据配额的访问次数限制 time_unit String 限定时间单位:SECOND:秒、MINUTE:分、HOUR:时、DAY:天 time_interval Integer 配额的限定时间值 remark
为可以转换成integer的string,转换后的range_start的范围为0-9223372036854775807, range_start不大于range_end。 range_end 否 String 区间终止值。 为可以转换成integer的string,转换后的range_e
响应头操作,您可以覆盖、添加、删除、跳过或新增指定的响应头。 Override:覆盖 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时,该操作只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时,添加当前响应头。
附录 分页显示查询结果 过滤查询结果 HTTP状态码 错误码 实例支持的APIG特性 获取项目ID 获取账号名和账号名ID
专享版-凭据配额管理 创建凭据配额 获取凭据配额详情 获取凭据配额列表 修改凭据配额 删除凭据配额 查询凭据配额已绑定的凭据列表 凭据配额绑定凭据列表 解除凭据配额和凭据的绑定 查询凭据配额可绑定的凭据列表 父主题: 专享版API(V2)