检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
IAM认证(双重认证) 同时获取IAM认证以及自定义认证所需的认证信息。 自定义认证 向API提供者获取请求参数中要携带的自定义认证信息。 无认证 无需认证信息。 第三方认证(API策略) 向API提供者获取请求参数中要携带的第三方认证信息。 调用API 本章节仅提供请求地址和认证参数的配置指
当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API网关不支持缓存数据加密,对于响应中的敏感数据存在安全风险,请谨慎配置策略。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 响应缓存策略原理图如下: 约束与限制 同一个环境中,一个API只能被一个响应缓存策略绑定,但一个响应缓存策略可以绑定多个API。
进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 单击“创建环境”,弹出“创建环境”对话框。填写如表1所示信息。 图2 创建环境 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。
alse时为必填 extend_mode 否 String 扩展信息导入模式 merge:当扩展信息定义冲突时,merge保留原有扩展信息 override:当扩展信息定义冲突时,override会覆盖原有扩展信息 缺省值:merge simple_mode 否 Boolean 是否开启简易导入模式
alse时为必填 extend_mode 否 String 扩展信息导入模式 merge:当扩展信息定义冲突时,merge保留原有扩展信息 override:当扩展信息定义冲突时,override会覆盖原有扩展信息 缺省值:merge simple_mode 否 Boolean 是否开启简易导入模式
单击“开放API > API分组”,进入到API分组信息页面。 单击“创建分组”,弹出“创建分组”对话框。填写如表1所示信息。 表1 分组信息表 信息项 描述 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 完成分组信息填写后,单击“确定”,创建API分组。
按照版本正常升级流程解决。 修复声明 为了防止客户遭遇不当风险,除漏洞背景信息、漏洞详情、漏洞原理分析、影响范围/版本/场景、解决方案以及参考信息等内容外,APIG不提供有关漏洞细节的其他信息。 此外,APIG为所有客户提供相同的信息,以平等地保护所有客户。APIG不会向个别客户提供事先通知。
APIG是否支持WebSocket数据传输? API网关支持WebSocket数据传输。 在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 父主题: 调用API
登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。例如“API01”。 所属分组
不同类型的请求,调试界面展现的信息项有差异。 添加请求参数后,单击“发送请求”。 右侧返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。 您可
API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample String 失败返回示例,描述API的异常返回信息 backend_api 字典数据类型 后端服务:web后端详情
I生成的应用。 创建应用 进入共享版控制台。 单击“调用API > 应用管理”,进入到应用管理信息页面。 单击“创建应用”,弹出“创建应用”对话框。填写应用信息。 表1 应用信息 信息项 描述 应用名称 应用名称。 描述 对应用的介绍。 单击“确定”,创建应用。 创建应用成功后,
流量控制”,进入到流量控制信息页面。 单击待添加特殊租户的流控策略的名称,进入流控详情页面。 单击“特殊租户”,进入特殊租户页面。 单击“添加特殊租户”,弹出“添加特殊租户”对话框。 输入如表1所示信息。 图3 添加特殊租户信息 表1 特殊租户信息 信息项 描述 租户ID 2中获取的账号ID或项目ID。
加应用”,弹出“授权应用”对话框。 通过API详情页面进入,步骤如下: 单击待授权的API名称,进入API详情页面。 单击“授权信息”,进入“授权信息”页签。 单击“添加授权”,弹出“授权应用”对话框。 如果需要批量将多个API授权同一个应用,则勾选待授权的API,单击“授权”,
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 app_id 是 String 应用编号 api_id 否 String API编号 api_name 否 String API名称
单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“2xx”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见APIG的API错误码说明。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
管理APIG实例 查看或编辑APIG实例信息 配置APIG实例参数 配置APIG实例标签 配置APIG的终端节点信息 自定义APIG的客户端访问端口 变更APIG的实例规格
API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample String 失败返回示例,描述API的异常返回信息 response_id String 分组自定义响应ID
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
"发布到生产环境" } 响应消息 表4 参数说明 名称 类型 说明 success Array 发布或下线成功的信息 failure Array 发布或下线失败的API及错误信息 表5 success参数说明(批量发布) 名称 类型 说明 publish_id String 发布记录的ID