检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
group_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：api_id、api_name、group_id 、group_name 、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选
call_limits Integer 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
查看指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义，分别代表如下含义： 临时定义：API在编辑中的定义，表示用户最后一次编辑后的API的状态 运行时定义：API在发布到某个环境时，对发布时的API的临时定义进行快照，固化出来的API的状态。
String 指定已有的分组，为空时创建新的分组 最小长度：0 最大长度：64 group_name 否 String API分组的名称,group_id为空时必填。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。
资源规划 表1 资源规划 资源 数量（个） VPC 2 API专享版实例 1 ELB 1 ECS 1 父主题： API网关专享版跨VPC开放后端服务
String 指定需要精确匹配查找的参数名称，目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
String 指定需要精确匹配查找的参数名称，目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
API网关支持http重定向到https功能。当用户的API采用http协议访问时，由于http没有传输安全与认证安全保障，可以使用API网关的重定向功能将API升级为安全的https协议访问，同时兼容已有的http协议。（2022年11月30日之后创建的实例支持http重定向到https） 约束与限制
响应内容。 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。 网关错误响应类型说明 API网关提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝
前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context
project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 plugin_id 是 String 插件编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
API。gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf（protocol buffers）作为其接口定义语言（Interface Definition Language，缩写IDL），同时底层的消息交
华为云账号具备所有接口的调用权限，如果使用账号下的IAM用户发起API请求时，该IAM用户必须具备调用该接口所需的权限，否则，API请求将调用失败。每个接口所需要的权限，与各个接口所对应的授权项相对应，只有发起请求的IAM用户被授予授权项所对应的策略，该用户才能成功调用该接口。例如，I
ken接口获取（响应消息头中X-Subject-Token的值）。 响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of PluginInfo
实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
将签名密钥绑定到API后，则API网关请求后端服务时就会使用这个签名密钥进行加密签名，后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥；一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
API网关收到请求后，执行1~3，计算签名。 将3中的生成的签名与5中生成的签名进行比较，如果签名匹配，则处理请求，否则将拒绝请求。 APP签名仅支持Body体12M及以下的请求签名。 步骤1：构造规范请求 使用APP方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与API网关使用相同的请求规范，可以
将流控策略应用于API，则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后，后续的访问将会被拒绝，从而能够较好的保护后端API免受异常流量的冲击，保障服务的稳定运行。 为指定的API绑定流控策略，绑定时，需要指定在哪
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
