检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
参数说明 参数 是否必选 类型 说明 customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略,将x-apigateway-ratelimit属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
是否必选 类型 说明 customAccessControlName 否 x-apigateway-access-controls.policy 指定名称的访问控制策略。 如果使用该策略,需要将x-apigateway-access-control属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
华东-青岛 拉美-圣地亚哥 入门 OBS 2.0支持 调用API 主要介绍企业或开发者如何获取并调用他人在API网关开放的API,减少开发时间与成本。 支持区域: 华北-北京四 华北-乌兰察布一 华东-上海一 华南-广州 西南-贵阳一 中国-香港 亚太-曼谷 亚太-新加坡 非洲-约翰内斯堡
api_id String API编号 auth_result AuthResult object 授权结果 auth_time String 授权时间 id String 授权关系编号 app_id String APP编号 auth_role String 授权者 PROVIDER:API提供者授权
编排规则编号。 orchestration_create_time String 编排规则创建时间。 orchestration_update_time String 编排规则更新时间。 表8 OrchestrationMappedParam 参数 参数类型 描述 mapped_param_name
APIG是否支持双向认证? 调用API提示AK/SK过期怎么处理? API策略 是否支持对API的请求并发次数做控制? API调用是否存在带宽限制 怎样给指定的用户开放API? 导入导出API 导入API失败有哪些原因? 使用Swagger文件导入API时是否有模板?
API名称 group_id 否 String API分组编号 tags 否 String API标签,该参数可指定多个,多个不同的参数值为或关系;不指定或为空时,表示不筛选标签;指定为#no_tags#时,表示筛选无标签API。 最小长度:0 最大长度:128 请求参数 表3 请求Header参数
环境编号 group_id 否 String API分组编号 tags 否 String API标签,该参数可指定多个,多个不同的参数值为或关系;不指定或为空时,表示不筛选标签;指定为#no_tags#时,表示筛选无标签API。 最小长度:0 最大长度:128 请求参数 表3 请求Header参数
env_id String api授权绑定的环境ID auth_role String 授权者 auth_time String 授权创建的时间 app_name String APP的名称 app_remark String APP的描述 app_type String APP的类型:
'com.squareup.okhttp3:okhttp:3.14.3' } 创建request,输入AppKey和AppSecret,并指定域名、方法名、请求uri和body。 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOU
实例不支持,如需使用,请联系客服。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
调用方分配专用的后端服务。本方案以“系统参数-前端认证参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端的安全认证方式应选“自定义认证”或使用双重认证(APP认证或IAM认证)。 添加策略后端前
本信息相同的API。 下线APIG的API:您可以通过下线API功能,将API从相关环境中下线,暂停对外提供的服务。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 导入导出API:您可以通过API设计文件、CSE微服务、CCE工作负载、导入API到APIG。
基于被授予的权限对云服务进行操作。 API网关服务部署时通过物理区域划分,为项目级服务。授权时,“作用范围”需要选择“区域级项目”,然后在指定区域(如北京1)对应的项目(cn-north-1)中设置相关权限,并且该权限仅对此项目生效;如果在“所有项目”中设置权限,则该权限在所有区
认证名称 根据规划自定义名称。 类型 此处选择“前端”。 函数地址 单击“添加”,选择已创建函数。 版本或别名 默认“通过版本选择”。 缓存时间(秒) 30 身份来源 第一个身份来源参数位置选择“Header”,参数名填写“token”;第二个身份来源参数位置选择“Query”,参数名填写“test”。
一个签名密钥可以绑定多个API。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
编排规则编号。 orchestration_create_time String 编排规则创建时间。 orchestration_update_time String 编排规则更新时间。 表8 OrchestrationMappedParam 参数 参数类型 描述 mapped_param_name
天最多可以访问调试域名1000次。系统自动分配的域名不能用于生产业务,且仅限应用程序调试使用。 创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC
Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持variable_name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 variables
单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。如需自定义跨域的请求头、跨域的请求方法和指定授权访问的域,请使用配置API的跨域资源共享。 简单请求的跨域访问 如果是创建新的API,在“安全配置”时,勾选“开启支持跨域(CORS)