检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表10 responses参数说明 名称 是否必选 参数类型
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表9 responses参数说明 名称 是否必选 参数类型
API的描述,长度为1~1000个字符。 请求体内容描述 填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。 根据下表参数信息,配置安全配置。 表3 安全配置 参数 说明 类型 API类型: 公开:选择“公开”类型时,API支持上架。 私有:选择“私有”类型时,当该API所在分组上架时,该API不会上架。
致,则可证明API请求确实来自API网关,而不是其他伪造请求。 VPC通道(负载通道) API网关通过VPC通道访问部署在VPC内的服务,您可以借助API网关将部署在VPC中的后端服务开放给第三方用户调用。 自定义认证 自定义认证指在API调用过程中,用户可自行定义认证规则,实现
配置API策略 配置API的传统策略 配置API的插件策略
String AppCode简易认证类型,默认为disable。 disable:不开启简易认证 header:开启简易认证且AppCode位置在HEADER。 父主题: APIG的API设计文件扩展定义
配置管理 对象模型 查询租户配置详情 父主题: 共享版API(仅存量用户使用)
实例配置特性 功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
查询租户实例配置列表 功能介绍 查询租户实例配置列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表9 responses参数说明 名称 是否必选 参数类型
需要服从URI规范。 timeout 是 Integer API网关请求后端服务的超时时间。超时时间最大值可以通过实例特性backend_timeout配置修改。 单位:毫秒。 最小值:1 最大值:600000 remark 否 String 描述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
mapped_param_location 是 String 编排后的参数位置,支持query和header。 表5 OrchestrationMap 参数 是否必选 参数类型 描述 map_param_list 否 Array of strings 用于映射编排后参数的列表配置,当orchestration_str
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表9 responses参数说明 名称 是否必选 参数类型
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表9 responses参数说明 名称 是否必选 参数类型
Time 创建时间 表4 identities参数说明 名称 类型 说明 name String 参数名称 location String 参数位置: HEADER:头 QUERY:query 响应消息样例: { "name":"Authorizer_9dlh", "type":"FRONTEND"
BACKEND:后端 表2 Identity 参数 是否必选 类型 说明 name 是 String 参数名称。 location 是 String 参数位置。 validation 否 String 参数校验表达式,默认为null,不做校验。 父主题: APIG的API设计文件扩展定义
向API提供者获取请求参数中要携带的第三方认证信息。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 API调用支持长连接。但是需要适当使用长连接,避免占用太多资源。 构造API请求,示例如下:
函数工作流服务开放 API网关可以将无服务器服务(即函数工作流服务)作为后端服务开放给合作伙伴,与传统的服务相比,函数工作流服务具有易开发、易部署、易维护的特点。使用函数工作流服务,快速构建后端业务逻辑处理,将这些业务逻辑函数通过API网关的标准API接口开放,并发能力得到线性扩展。