检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
为简易认证添加AppCode 操作场景 简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填应用详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证
安全组 安全组用于设置端口访问规则,定义哪些端口允许被外部访问,以及允许访问外部哪些地址与端口。 例如,后端服务部署在外部网络,则需要设置相应的安全组规则,允许访问后端服务地址与API调用端口。
配置参数流控 开启参数流控配置开关,定义参数和规则,配置参数流量控制。 配置特殊流控 开启特殊流控配置开关,特殊凭据与特殊租户流量控制的使用场景。 绑定API 流量控制2.0策略绑定到API。 验证 通过相应的请求URL调用API,验证流量控制2.0策略是否生效。
建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、中文或数字开头,长度为3~255个字符。 API路径 API的请求路径。
参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 id String 响应ID default Boolean 是否为分组默认响应 create_time String 创建时间
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。
建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 首次生效时间点 设置配额策略的生效起始时间点。
json_schema String JSON校验规则 表6 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例: { "name": "market_api01", "type": 1
json_schema String JSON校验规则 表6 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例: { "name": "market_api01", "type": 1
查看域名证书 功能介绍 查看域名下绑定的证书详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate
是否支持移动应用调用API? API支持被移动应用调用。 使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。 父主题: 调用API
调用API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API
编排规则 选择编排规则。创建编排规则请参考配置API的参数编排规则。 字节限制 最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。
参数流控的规则最多可定义100个。 策略内容最大长度65535。 如果您的实例不支持流量控制2.0,请联系技术支持。 父主题: 使用APIG专享版的流量控制2.0策略实现API的精细流控
如果您需要把自己的认证系统用于API调用的认证鉴权,可以通过配置API的自定义认证来实现;需要对API进行参数编排,可以通过配置API的参数编排规则来实现;需要自定义API的错误响应信息,可以通过自定义API的错误响应信息来实现。更多API相关操作,请参考管理API。
json_schema String JSON校验规则 表8 backend_params参数说明 参数 类型 说明 id String 参数编号 req_param_id String 对应的请求参数编号 name String 参数名称 location String 参数位置
json_schema String JSON校验规则 表8 backend_params参数说明 参数 类型 说明 id String 参数编号 req_param_id String 对应的请求参数编号 name String 参数名称 location String 参数位置
total Long 满足条件的记录数 permissions Array of EndpointPermission objects 白名单记录列表 表6 EndpointPermission 参数 参数类型 描述 id String 记录编号 permission String 权限规则
CRU 否 min_num String 参数最小值 CRU 否 max_num String 参数最大值 CRU 否 min_size Integer 参数最小长度 CRU 否 max_size Integer 参数最大长度 CRU 否 regular String 正则校验规则
CRU 否 min_num String 参数最小值 CRU 否 max_num String 参数最大值 CRU 否 min_size Integer 参数最小长度 CRU 否 max_size Integer 参数最大长度 CRU 否 regular String 正则校验规则