检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
R 是 instance_id String 实例的编号 CRU 否 instance_name String 实例的名称 CRU 否 host String 后端实例对象的主机地址 CRU 是 status Integer 后端实例对象状态 1:正常 2:异常 R 是 weight
R 是 instance_id String 实例的编号 CRU 否 instance_name String 实例的名称 CRU 否 host String 后端实例对象的主机地址 CRU 是 status Integer 后端实例对象状态 1:正常 2:异常 R 是 weight
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
在函数工作流的控制台编写函数,自定义认证的代码编写指南参见创建用于前端自定义认证的函数。 根据下表参数说明,在函数工作流页面创建一个函数。 表1 函数信息配置 参数 配置说明 选择创建方式 默认“创建空白函数”。 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目 华为云的区域默认对应一
需要服从URI规范。 timeout 是 Integer API网关请求后端服务的超时时间。超时时间最大值可以通过实例特性backend_timeout配置修改。 单位:毫秒。 最小值:1 最大值:600000 remark 否 String 描述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。
00。 orchestration_mapped_param OrchestrationMappedParam object 编排后的参数配置,isPreprocessing为false时必填。 is_preprocessing Boolean 是否为预处理策略,预处理策略只会生
orchestration_mapped_param 否 OrchestrationMappedParam object 编排后的参数配置,isPreprocessing为false时必填。 is_preprocessing 否 Boolean 是否为预处理策略,预处理策略只
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND:
专享版-OpenAPI接口 专享版-VPC通道管理 专享版-监控信息查询 专享版-分组自定义响应管理 专享版-标签管理 专享版-实例特性管理 专享版-配置管理 专享版-实例管理 专享版-实例终端节点管理 专享版-实例标签管理 专享版-微服务中心管理 专享版-SSL证书管理 专享版-插件管理 专享版-凭据管理
http时必选 enable_client_ssl 否 Boolean 是否开启双向认证。如果开启,则使用实例配置中的backend_client_certificate配置项的证书 缺省值:false status 否 Integer 健康检查状态 1:可用 2:不可用 timeout
查看此分组下已购买的API列表和此分组的详细信息。 图2 已购买API的分组详情示例 在待调试API所在行,单击“调试API”,跳转到“调试API”页面。 左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。 表1 调试API 参数名称 说明 协议 仅在“请求
7:初始化失败 8:注册失败 10:安装中 11:安装失败 12:升级中 13:升级失败 20:回滚中 21:回滚成功 22:回滚失败 23:删除中 24:删除失败 25:注销中 26:注销失败 27:创建超时 28:初始化超时 29:注册超时 30:安装超时 31:升级超时 32:回滚超时
BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND:
予策略或角色,才能使得用户组中的用户获得对应的权限,这一过程称为授权。授权后,用户就可以基于被授予的权限对云服务进行操作。 API网关服务部署时通过物理区域划分,为项目级服务。授权时,“作用范围”需要选择“区域级项目”,然后在指定区域(如北京1)对应的项目(cn-north-1)
当API的请求协议为GRPC类型时不支持配置。 result_failure_sample String 失败返回示例,描述API的异常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id
专享版-实例特性管理 实例配置特性 查看实例特性列表 查询实例支持的特性列表 父主题: 专享版API(V2)