检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}
API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 环境 为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。
如何调用API 构造请求 认证鉴权 返回结果
查看APIG的监控指标 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 查看单个API的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
异步导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/insta
专享版-OpenAPI接口 导出API 导入API 父主题: 专享版API(V2)
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。 请求协议配置错误,如后端服务为HTTP,在API网关配置为HTTPS。 创建的API与后端服务配置相同的协议。 API网关客户侧后端服务链接链路不通。 排查链接链路。 父主题: 调用API
查看或编辑APIG实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 查看或编辑实例信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,根据下表参数说明,查看或编辑实例的配置信息。
参数配置如下: 所属分组:选择已开启CORS的API所在分组。 请求方法:选择OPTIONS。 请求协议:选择与已开启CORS的API相同的请求协议。 请求路径:选择与已开启CORS的API相同的请求路径或者与已开启CORS的API匹配的请求路径。 匹配模式:选择前缀匹配。 安全认证:“
配置API策略 配置API的传统策略 配置API的插件策略
API列表”,您可以查看或编辑当前实例下的所有API,也可以进入API详情查看或编辑API。 单击API名称,进入“API运行”页面。 支持查看API的监控视图、前端配置或后端配置信息。 支持编辑API、发布API、下线API、调试API、API授权、删除API或克隆API操作。 父主题: 管理API
支持http to https自动重定向 当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以开启自动重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。 仅当API的请求协议选择“HTTPS”或“HTTP&HTTPS”,且独
"replace" } 为策略绑定API 单击策略名称,进入策略详情。 在API列表区域选择环境后,单击“绑定API”。 筛选API分组以及发布环境,勾选所需的API。 支持通过API名称或标签筛选API,标签为创建API时定义的标签。 单击“确定”,绑定完成。 如果单个API不需要绑定此策略,单击API所在行的“解绑”。
Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/
说明 api_id String 下线成功的API ID api_name String 下线成功的API名称 表7 failure参数说明 名称 类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code
可在创建API分组后,为分组绑定独立域名,独立域名需要解析到实例的弹性IP地址。 例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用https://{domain}/apidemo这个URL访问您的API。其中,