检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API绑定插件 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个，如果再次绑定同类型的插件，那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project
增加一个ACL策略，策略类型通过字段acl_type来确定（permit或者deny），限制的对象的类型可以为IP或者DOMAIN，这里的DOMAIN对应的acl_value的值为租户名称，而非“www.exampleDomain.com”之类的网络域名。 调用方法 请参见如何调用API。 URI POST
String API的版本 字符长度不超过16 req_protocol 否 String API的请求协议： HTTP HTTPS BOTH：同时支持HTTP和HTTPS WEBSOCKET 默认：HTTPS req_method 是 String API的请求方式： GET POST
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个，如果再次绑定同类型的插件，那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project
响应消息头中X-Subject-Token的值）。 响应参数 状态码： 201 表3 响应Body参数 参数 参数类型 描述 app_code String App Code值 支持英文、数字，+_!@#$%-/=，且只能以英文、数字和+、/开头，64-180个字符。 id String
String API的版本 字符长度不超过16 req_protocol 否 String API的请求协议： HTTP HTTPS BOTH：同时支持HTTP和HTTPS WEBSOCKET 默认：HTTPS req_method 是 String API的请求方式： GET POST
实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时
定义认证中的参数关系如下所示： Header中的请求参数：对应自定义认证中参数位置为Header的身份来源，其参数值在您调用使用该前端自定义认证的API时传入 Query中的请求参数：对应自定义认证中参数位置为Query的身份来源，其参数值在您调用使用该前端自定义认证的API时传入
ResponseInfoHeader 参数 参数类型 描述 key String 分组自定义响应的响应头的key，支持英文字母、数字和中划线，长度为1到128位 value String 分组自定义响应的响应头的value，为长度为1到1024位的字符串 最小长度：1 最大长度：1024 状态码： 400 表8
ken接口获取（响应消息头中X-Subject-Token的值）。 响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of PluginInfo
用户流量限制是指一个API在时长之内每一个用户能访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用，表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。
响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 signs Array of SignatureWithBindNum objects 本次查询到的签名密钥列表 表5 SignatureWithBindNum 参数
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息。 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instanc
ubject-Token的值）。 响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 plugin_id String 插件编码。 plugin_name String 插件名称。支持汉字，英文，数字，中划线，下划线，且只能以英文和汉字开头，3-255字符。
00 最小值：1 最大值：500 缺省值：20 api_id 是 String API的编号 sign_id 否 String 签名密钥的编号 sign_name 否 String 签名密钥的名称 env_id 否 String 环境编号 请求参数 表3 请求Header参数 参数
用户流量限制是指一个API在时长之内每一个用户能访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用，表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。
将签名密钥绑定到API后，则API网关请求后端服务时就会使用这个签名密钥进行加密签名，后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥；一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
配置。 简单请求的跨域访问 如果是创建新的API，在定义API请求时，打开“支持跨域（CORS）”开关。详细的使用指导，可参考简单请求。 图2 支持跨域 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“Method”为“OPTIONS”的API，作为预检请求。
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
