检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
通过标签查询实例列表 功能介绍 通过标签查询实例列表 接口约束 使用策略授权用户时,需要包含apig:instance:listByTags的授权项才允许调用此接口. 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/resource-instances/filter
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps
查看API绑定的签名密钥列表 功能介绍 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/sign
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息。 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instanc
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 环境上存在已发布的API时,该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{proj
查看实例特性列表 功能介绍 查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
查询插件列表 功能介绍 查询一组符合条件的API网关插件详情。 支持分页 支持根据插件类型查询 支持根据插件可见范围查询 支持根据插件编码查询 支持根据名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances
进入控制台页面。 在左上角单击服务列表,选择“API网关 APIG”。 在“实例管理”页面中,单击实例名称。 在“实例信息”页面关闭“出口地址”。
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/a
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 调用方法 请参见如何调用API。 URI POST /v2/{
源IP流量限制 单个IP地址调用API次数上限。您可以选择配置实例的“real_ip_from_xff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 参数流控配置
导入API失败有哪些原因? 可能原因1:单次导入的API数量超出上限。当前单次最高能导入300个API,如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。 可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调用方法 请参见如何调用API。
描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择在FunctionGraph中创建的函数。 身份来源 设置用于认证的请求参数,支持添加Header参数和Query参数,其中Header的参数名不区分大小写。
publish_id String 发布记录的编号 auth_type String API的认证方式 req_uri String API的访问地址 响应消息样例: { "total": 1, "size": 1, "apis": [{ "id": "5bbc47e2-95b
从X-Forwarded-For头中获取IP。例如到达API网关的X-Forwarded-For头中依次有IP1,IP2,IP3 三个IP地址,xff_index取0时获取IP1,xff_index取1时获取IP2,xff_index取-1时获取IP3。 -1 int32有效值 app_route
API名称 purchase_id String 订购关系编号 remark String API描述 req_uri String API的访问地址 响应消息样例: { "total": 3, "size": 3, "apis": [{ "id": "cb498965-8ac
VPC通道中主机的端口号。 balance_strategy Integer 分发算法。 1:加权轮询(wrr) 2:加权最少连接(wleastconn) 3:源地址哈希(source) 4:URI哈希(uri) create_time Timestamp VPC通道的创建时间。 响应消息样例: {