检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败
修改变量 功能介绍 修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/env
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面左侧选择API。 在“监控视图”区域,查看API的各项监控指标。 查看某个API的调用统计,包括“请求次数”、“调用延时”、“数据流量”和“出错统计”,同时可以选择要查看数据的时间段范围。
修改API 功能介绍 修改指定API的信息,包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/apis/{id}
创建自定义认证 操作场景 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务
objects 自定义认证列表 表5 AuthorizerResp 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type String 自定义认证类型 FRONTEND:前端
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}
gzip配置完成后,如需修改,至少需要1分钟后。 custom_log 自定义日志功能开关,默认关闭。开启自定义日志功能后,实例下所有API的调用日志中会在指定位置打印指定参数的值。 启用后,需单击“编辑”,添加需在调用日志中打印的参数。 须知: 自定义日志只支持打印由客户端发起
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A
TPS”时,支持修改。 方法 仅在API请求的“Method”定义为“ANY”时,支持修改。 后缀 仅在API请求的“匹配模式”为“前缀模式”时,支持自定义路径。 路径 API的请求path。 路径参数 仅在API请求的“请求Path”中存在“{}”时,支持修改。 查询参数 Query的参数与参数值。
调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。 MARKET模式,接口调用者必须是API购买者或拥有者。 CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。
对匹配”,2018年8月20日修改API匹配模式设置为“前缀匹配”,并发布到RELEASE环境。然后设置2018年8月1日发布的版本为当前版本,此时API调用者调用此API时,API的匹配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布? API发布到
调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。 MARKET模式,接口调用者必须是API购买者或拥有者。 CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。
开放API 无法创建API是什么原因? API的响应码如何定义? API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? APIG是否支持多后端节点方案? API可以绑定内网域名吗? 为什么跨域调用API失败? API网关如何开放部署在华为云上的服务?
I请求进行安全认证时,同时使用自定义的函数API对API请求进行安全认证。 自定义认证 仅当“安全认证”选择“自定义认证”时需要配置。 选择已创建的前端类型自定义认证。若没有可用的自定义认证,可单击右侧的“新建自定义认证”,创建一个前端类型的自定义认证。 支持跨域CORS 是否开
协议 仅在“请求协议”为“HTTP&HTTPS”时,支持修改。 方法 仅在“Method”为“ANY”时,支持修改。 路径 仅在“匹配模式”为“前缀模式”时,支持自定义路径。 路径参数 仅在“Path”中存在“{}”时,支持修改。 请求头 HTTP Headers的参数与参数值。 查询参数
已开放的HTTP协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认80端口;如果填写该参数,则必须同时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。 当修改域名时,该参数未填表示不修改该端口。 最小值:-1 最大值:49151