# API网关 APIG > 构建、管理和部署任意规模的API服务 ## 服务公告 - [授权项变更公告](https://support.huaweicloud.com/bulletin-apig/apig_09_0004.md): 自2025年11月15日起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。自2024年9月起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。全部Region。自定义策略中未包含以上新增的授权项时,用户无权访问以上API。创建或更新自定义策略,添加以上新增的授权项以及依赖授权项,并 - [漏洞修复策略](https://support.huaweicloud.com/bulletin-apig/apig_09_0002.md): SDK漏洞:针对APIG提供的SDK所涉及的漏洞会根据风险等级在修复时间内对外发布修复版本,由客户自行升级SDK版本进行修复。针对APIG提供的SDK所涉及的漏洞会根据风险等级在修复时间内对外发布修复版本,由客户自行升级SDK版本进行修复。其他漏洞:按照版本正常升级流程解决。按照版本正常升级流程解决。为了防止客户遭遇不当风险,除漏洞背景信 ## 产品介绍 - [图解API网关](https://support.huaweicloud.com/productdesc-apig/apig_01_0001.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [什么是API网关](https://support.huaweicloud.com/productdesc-apig/apig_0080101651.md): API网关(API Gateway)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,能快速将企业服务能力包装成标准API接口,帮助您轻松构建、管理和部署任意规模的API,并上架API云商店进行售卖。借助API网关,可以简单、快速、低成本、低风险地实现内部系统集成和业务能力开放。API网关帮助您变现服务能力的同时,降低企业研发 - [产品优势](https://support.huaweicloud.com/productdesc-apig/apig-pd-180307002.md): 只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。API网关采用同步加异步混合流控的方式,通过多种算法, - [应用场景](https://support.huaweicloud.com/productdesc-apig/apig-pd-180307003.md): 随着企业的高速发展、业务的快速变化,需要企业内部系统跟随业务需求一同变化,但是企业内部系统存在相互依赖关系,为保持系统的通用性与稳定性,很难应对业务的变化。而API网关使用RESTful API, 帮您简化服务架构,通过规范化、标准化的API接口,快速完成企业内部系统的解耦及前后端分离。同时,复用已有能力,避免重复开发造成的资源浪费。当今 - [产品功能](https://support.huaweicloud.com/productdesc-apig/apig_01_0012.md): 本页面介绍了API网关服务支持的主要功能。关于各功能支持的地域(Region)信息,可通过控制台查询详情。涵盖API的创建、发布、下线及删除的整个生命周期管理功能。借助API生命周期管理功能,用户能够迅速、高效地开放成熟的业务能力。详情请参考开放API流程。API网关将流量入口和微服务治理能力融合,用一个网关去同时支持了k8s Ingre - [产品规格差异](https://support.huaweicloud.com/productdesc-apig/apig-specifications.md): 专享版API网关QPS(Query Per Second,每秒查询率)吞吐受应答大小、是否开启HTTPS、是否开启gzip等多种因素影响。下表是API网关处于30%CPU水位下的QPS参考值,参考场景为无认证和单机流控模式。安全水位指能够在突发流量增长至双倍的情况下,API网关系统依然维持高吞吐量和低延迟性能。不同实例规格的带宽和内网连接 - [身份认证与访问控制](https://support.huaweicloud.com/productdesc-apig/apig_01_0008.md): 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。证书校验:APIG支持对后端服务进行证书校验。身份认证:APIG提供签名密钥进行后端访问身份认证。流量控制:APIG通过凭据、API、IP、用户等多维度的流控策略保护系统。黑白名单:AP - [数据保护技术](https://support.huaweicloud.com/productdesc-apig/apig_01_0009.md): 安全通道:APIG支持HTTPs协议,保证网络传输安全,同时支持创建安全通道访问后端服务。防重放、防篡改:APIG通过内部算法,从数据入口屏蔽恶意调用。 - [审计与日志](https://support.huaweicloud.com/productdesc-apig/apig_01_0010.md): 云审计服务(Cloud Trace Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。用户开通云审计服务后,系统将开始记录APIG资源的操作事件,并为您保存最近7天的操作记录。CTS支持记录的APIG操作请参见 - [监控安全风险](https://support.huaweicloud.com/productdesc-apig/apig_01_0011.md): 云监控服务为用户的云上资源提供了立体化监控平台。通过云监控您可以全面了解云上的资源使用情况、业务的运行状况,并及时收到异常告警做出反应,保证业务顺畅运行。APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。关于APIG支持的监控指标,以及如何创建监控告 - [认证证书](https://support.huaweicloud.com/productdesc-apig/apig_01_0006.md): 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。合规证书下载华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。资源中心华为云安全服务提供了网络安全专用产品安全检测证书、软件著作权等证书,供用户下载和参考。具体请查看合规资质证书。合规资质证书 - [约束与限制](https://support.huaweicloud.com/productdesc-apig/apig-pd-180307005.md): 如果您需要修改默认限制值,请参考如何申请扩大配额。修改实例参数配置,请参考配置参数。新增或修改的APIG资源存在数据同步延迟,需要5-10秒才生效。在高并发情况下会出现略超最大配额数限制的情况,不影响资源的正常使用。 - [权限管理](https://support.huaweicloud.com/productdesc-apig/apig-pd-190529006.md): 如果您需要对华为云上创建的APIG资源,为企业中的员工设置不同的访问权限,以达到不同员工之间的权限隔离,您可以使用统一身份认证服务(Identity and Access Management,简称IAM)进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能,可以帮助您安全的控制华为云资源的访问。如果华为账号已经能满足您的 - [API认证](https://support.huaweicloud.com/productdesc-apig/apig_01_0014.md): API认证(Application Programming Interface Authentication,应用程序接口认证)是验证API调用者身份的安全机制。它确保只有授权用户或系统才能访问特定API资源,防止未授权访问和数据泄露。通过API认证,企业可以保护核心业务数据,控制API访问权限,构建安全可靠的API生态系统。随着企业数字 - [访问控制](https://support.huaweicloud.com/productdesc-apig/apig_01_0015.md): 访问控制是API网关中用于限制API访问来源的安全机制。它支持IP地址和账号两种维度的访问策略,调用方只有在策略允许范围内才能访问API,否则请求将被网关直接拦截。访问控制为API提供了网络层或身份层的入口防护,是API安全治理的基础手段。企业将业务能力通过API开放后,API即成为外部访问的统一入口。在开放场景下,API面临的情况与内部 - [流量控制](https://support.huaweicloud.com/productdesc-apig/apig_01_0016.md): 流量控制是API网关中保障服务稳定性的核心能力,通过基于API、用户、源IP、凭据等多维度的速率限制,在请求超出流量阈值时拒绝请求,返回限流响应,从而防止后端服务因突发流量过载崩溃,避免级联故障扩散与个别调用方过度占用资源,保障业务平稳运行。随着互联网应用的普及,系统面临流量突增、恶意攻击等挑战。传统架构难以应对突发流量,容易导致服务响应 - [其他相关概念](https://support.huaweicloud.com/productdesc-apig/apig-pd-180307004.md): API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。为了方 ## 计费说明 - [计费概述](https://support.huaweicloud.com/price-apig/apig_08_0001.md): 根据下文您可以快速了解API网关的计费模式、计费项、续费、欠费等主要计费信息。计费模式专享版API网关提供包年/包月和按需两种计费模式,以满足不同场景下的用户需求。包年/包月是一种预付费模式,即先付费再使用,按照订单的购买周期进行结算,因此在购买之前,您必须确保账户余额充足。按需计费是一种后付费模式,即先使用再付费,按照API网关实际使用 - [计费模式概述](https://support.huaweicloud.com/price-apig/apig_08_0003.md): 专享版API网关按实例版本费用+公网带宽费用计费。计费模式详情请参考表表1和表2。实例版本详情请参考产品规格,实例版本价格详情请参考价格详情,每种实例版本提供包年/包月、按需计费两种计费模式,以满足不同场景下的用户需求。包年/包月:一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买周期越长,享受的折扣越大。一般适用于设备需求 - [包年/包月](https://support.huaweicloud.com/price-apig/apig_08_0004.md): 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。包年/包月计费模式需要用户预先支付一定时长的费用,适用于长期、稳定的业务需求。以下是一些适用于包年/包月计费模式的业务场景:稳定业务 - [按需计费](https://support.huaweicloud.com/price-apig/apig_08_0005.md): 按需计费适用于短期使用、实例无需7x24小时运行等场景。假设您计划使用1个专业版实例,开启公网出口,公网带宽大小为5Mbit/s,使用时长1小时,在价格计算器页面底部,您将看到所需的配置费用。配置费用包括版本、公网带宽、实例数以及使用时长。按需计费时,实例按秒计费,每一个小时整点结算一次费用(以GMT+08:00时间为准),结算完毕后进入 - [计费项](https://support.huaweicloud.com/price-apig/apig_08_0007.md): API网关提供包年/包月模式和按需模式,包年/包月模式计费项信息请参考表1,按需模式计费项信息请参考表2。以按需使用为例,假设您已开通API网关实例专业版且未使用公网带宽,该版本按需计费的实例版本单价为12.88元/小时/实例。您于2023/03/08 15:50:04在API网关上购买了1个实例,在2023/03/10 17:50:00 - [变更计费模式概述](https://support.huaweicloud.com/price-apig/apig_08_0010.md): 在开通使用API网关后,如果发现当前计费模式无法满足您的业务需求,您可以变更计费模式。按需付费变更为包年/包月,需要您按需购买相应的版本,生成新的订单并支付后,包年/包月计费模式立即生效。包年/包月变更为按需付费,需要您提交工单申请退订已经购买生效的包年/包月订单,退订之后自动转为按需付费模式。退订包年/包月后,不能再享受包年/包月提供的 - [按需转包年/包月](https://support.huaweicloud.com/price-apig/apig_08_0011.md): 如果您需要长期使用当前按需购买的实例,可以将该实例转为包年/包月计费模式,以节省开支。按需计费变更为包年/包月会生成新的订单,用户支付订单后,包年/包月资源将立即生效。假设用户于2023/04/18 15:29:16购买了实例,由于业务需要,于2023/04/18 16:30:30执行按需转包年/包月操作,生成类型为“按需转包年/包月”的 - [包年/包月转按需](https://support.huaweicloud.com/price-apig/apig_08_0012.md): 创建一个包年/包月实例后,您可以将该实例的计费模式转为按需计费,回收部分成本,同时更加灵活地按需使用实例。包年/包月转按需,需包年/包月计费模式到期后,按需的计费模式才会生效。实例计费模式为“包年/包月”。方式一:在API网关控制台的实例管理中变更计费模式。方式二:在控制台的费用中心中变更计费模式。可在“到期转按需项”页签查询已经设置到期 - [续费概述](https://support.huaweicloud.com/price-apig/apig_08_0014.md): 包年/包月实例到期后会影响实例正常运行。如果您想继续使用,需要在指定的时间内为实例续费,否则实例资源会自动释放,数据丢失且不可恢复。续费操作仅适用于包年/包月实例,按需计费实例不需要续费,只需要保证账户余额充足即可。包年/包月实例在到期前续费成功,所有资源得以保留,且实例的运行不受影响。实例到期后的状态说明,请参见到期后影响。包年/包月实 - [手动续费](https://support.huaweicloud.com/price-apig/apig_08_0015.md): 包年/包月实例从购买到被自动删除之前,您可以随时在控制台为实例续费,以延长实例的使用时间。请确认包年/包月实例还未到期。 - [自动续费](https://support.huaweicloud.com/price-apig/apig_08_0016.md): 自动续费可以减少手动续费的管理成本,避免因忘记手动续费而导致实例被自动删除。自动续费的规则如下所述:以实例的到期日计算第一次自动续费日期和计费周期。实例自动续费周期以您选择的续费时长为准。例如,您选择了3个月,实例即在每次到期前自动续费3个月。在实例到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3: - [费用账单](https://support.huaweicloud.com/price-apig/apig_08_0017.md): 您可以在“费用 > 费用账单”查看资源的费用账单,以了解该资源在某个时间段的使用量和计费信息。包年/包月计费模式的资源完成支付后,会实时上报一条账单到计费系统进行结算。按需计费模式的资源按照固定周期上报使用量到计费系统进行结算。按需计费模式产品根据使用量类型的不同,分为按小时、按天、按月三种周期进行结算,具体扣费规则可以参考按需产品周期结 - [欠费说明](https://support.huaweicloud.com/price-apig/apig_08_0018.md): 使用API网关服务时,您的账户可用额度小于待结算的账单,即被判定为账户欠费。欠费后,可能会影响服务资源的正常运行,请及时充值。在按需计费模式下账户的余额不足。或者在包年/包月模式,带宽按需计费模式下账户的余额不足。按需计费时,实例按秒计费,每一个小时整点结算一次费用(以GMT+08:00时间为准),结算完毕后进入新的计费周期。系统会在每个 - [停止计费](https://support.huaweicloud.com/price-apig/apig_08_0019.md): 对于包年/包月计费模式的实例资源,您在购买时会一次性付费,服务将在到期后自动停止使用。如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订。如果您已开启“自动续费”功能,为避免继续产生费用,请在自动续费扣款日(默 - [成本管理](https://support.huaweicloud.com/price-apig/apig_08_0020.md): API网关(APIG)专享版提供基础版、专业版、企业版、铂金版等多个实例规格版本,每个规格对应不同的官网价。不同规格差异体现为每秒最大请求数、带宽、内网每秒新建连接数等,详情请参考产品规格。用户可以根据自己的业务场景选择合适的APIG专享版规格,在此做如下推荐:如果用户对API并发调用、带宽的要求不高,建议使用APIG专享版基础版实例。如 ## 快速入门 - [快速开放并调用API](https://support.huaweicloud.com/qs-apig/apig-ug-180307002.md): 本章节将为您介绍如何快速使用API网关,这里以APP认证类型的简易认证为例,快速开放并调用API。简易认证仅支持HTTPS或GRPCS方式调用API。准备工作在使用APIG之前,需要确保有可用的网络环境,请提前准备VPC、子网和安全组。在使用APIG之前,需要确保有可用的网络环境,请提前准备VPC、子网和安全组。创建实例创建实例时,根据实 - [入门实践](https://support.huaweicloud.com/qs-apig/apig-ug-180307014.md): 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 ## 用户指南 - [APIG业务使用流程](https://support.huaweicloud.com/usermanual-apig/apig_03_0001.md): API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关支持专享版和共享版(存量用户)功能。共享版功能已下线,不支持新用户使用,当前仅存量用户可以使用,共享版功能操 - [通过IAM角色或策略授予使用APIG的权限](https://support.huaweicloud.com/usermanual-apig/apig_03_0140.md): 如果您需要对您所拥有的APIG进行角色与策略的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以:根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用APIG资源。根据企业用户的职能,设置不同的访问 - [通过IAM身份策略授予使用APIG的权限](https://support.huaweicloud.com/usermanual-apig/apig_03_0051.md): 如果您需要对您所拥有的APIG服务进行身份策略的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以:根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建用户或用户组,让员工拥有唯一安全凭证,并使用APIG资源。根据企业用户的职能,设置不同的 - [创建APIG实例](https://support.huaweicloud.com/usermanual-apig/apig_03_0037.md): 在使用APIG前,您需要创建一个APIG实例。APIG实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。开启公网入口或公网出口后,可能产生带宽费用,计费详情请参考弹性公网IP计费说明。创建NLB规格实例时,需要购买弹性负载均衡,计费详情请参考弹性负载均衡计费说明。用户权限如果您使用系统角色相关权限,需要同时拥 - [开放API流程](https://support.huaweicloud.com/usermanual-apig/apig_03_0127.md): 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。创建API分组每个API都归属到某一个API分组下,在创建API前应提前创建API分组。每个API都归属到某一个API分组下,在创建API前应提前创建API分组。添加API的SSL证书如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此 - [创建API分组](https://support.huaweicloud.com/usermanual-apig/apig_03_0005.md): 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。目前支持以下创建分组方式:直接创建创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。导入API设 - [添加API的SSL证书](https://support.huaweicloud.com/usermanual-apig/apig_03_0055.md): 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。如果不配置SSL证书,将无法保障请求的链路安全,建议配置。单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。双向认证:客户端与服务端连接时, - [配置API的调用域名](https://support.huaweicloud.com/usermanual-apig/apig_03_0006.md): APIG的调用域名包含调试域名和独立域名。调试域名是在API分组创建后,系统为分组自动分配的一个内部测试使用的域名,此域名每天最多可以访问1000次。因此,在开放API时,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。独立域名可分为内网域名和公网域名两种:内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问A - [创建API的负载通道(可选)](https://support.huaweicloud.com/usermanual-apig/apig_03_0040.md): 负载通道主要用于将服务通过API网关开放给外部访问。它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能(服务器通道类型),以及自动同步服务节点变更的能力(微服务通道类型)和使用已有的负载通道能力(引用负载通道类型),从而实现后端服务的负载均衡或自动同步服务节点的变更或重复使用负载通道。创建负载通道后,在创建A - [通过APIG创建REST API](https://support.huaweicloud.com/usermanual-apig/apig_03_0010.md): REST API(Representational State Transfer Application Programming Interface)是基于HTTP协议,通过对API的操作来实现客户端和服务器之间的通信,一种用于构建网络应用程序的软件架构风格。它广泛应用于Web开发、移动应用程序开发和云服务等领域,成为了现代应用程序开发的 - [通过APIG创建GRPC API](https://support.huaweicloud.com/usermanual-apig/apig_03_0078.md): API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言(Interface Definition Language,缩写IDL),同时底层的消息 - [调试APIG创建的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0012.md): API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。后端路径中含有环境变量的API,不支持调试。如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。调试API时,后端超时时间最大支持60s。已创建API。选择请求方法、请求协议、域名等,然后配置API请求参数。 - [配置API的发布环境和环境变量(可选)](https://support.huaweicloud.com/usermanual-apig/apig_03_0007.md): 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个A - [发布APIG创建的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0014.md): 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。同一个API在每个环境中最多记录10条最新的发布历史。如果API在选择的环境中 - [API调用授权概述](https://support.huaweicloud.com/usermanual-apig/apig_03_0057.md): API调用者在调用使用APP认证的API时,可以通过凭据进行API认证或AppCode进行简易的API认证。APP认证类型包含下表中列举的类型,更多详情请参考调用APIG开放的API章节。下文介绍凭据和AppCode的配置,您可以根据业务需求选择其中一种进行认证。配置APIG的API认证凭据在API网关中创建一个凭据,生成密钥对(Key、 - [配置APIG的API认证凭据](https://support.huaweicloud.com/usermanual-apig/apig_03_0056.md): 使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对配置在SDK中,API网关服务根据密钥对进行身份核对,完成鉴权。使用无认证、华为IAM认证的API、自定义认证,无需创建凭据。已 - [配置APIG的API简易认证AppCode](https://support.huaweicloud.com/usermanual-apig/apig_03_0058.md): 简易认证指在调用API时,HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。本视频演示如何在API网关服务上通过简易认证调用API。因产品功能演进,操作界面可能存在差异,相关视频仅供参考,具体 - [配置APIG的AIAPIKey认证](https://support.huaweicloud.com/usermanual-apig/apig_03_0139.md): APIG支持AI API(Artificial Intelligence Application Programming Interface,人工智能应用编程接口)通过AIAPIKey进行鉴权认证。这种方式不仅能够高效地控制AI API的访问权限,还能够实现对多租户场景下的精细权限管理。AIAPIKey认证指在调用API时,HTTP请求头 - [调用APIG开放的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0046.md): API提供者在API网关开放自己的API后,API调用者从API网关中调用API。AIAPIKey认证受限使用,如需使用,请提交工单申请。如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。如果在API网关控制台“API管理 > API策略 > SSL证书管理”界面的“创建SSL证书” - [跨域调用APIG开放的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0011.md): 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。浏览器将CORS请求分为两类:简单请求简单跨域请求的场景需要满足以下两个条件:请求方法是HEAD,GET,或者POST。HTTP的头信息不超出以下范围: - [APIG的API响应消息头说明](https://support.huaweicloud.com/usermanual-apig/apig_03_0047.md): 调用API时,API网关增加下表中的响应消息头。X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 - [APIG的API错误码说明](https://support.huaweicloud.com/usermanual-apig/apig_03_0048.md): 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。通过APIG接口管理API,发生错误时,产生的错误码请参考错误码章节处理。使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。 - [管理API概述](https://support.huaweicloud.com/usermanual-apig/apig_03_0133.md): API创建完成后,您还可以进行以下相关操作管理API。查看或编辑APIG的API信息:您可以通过查看API的基本信息来确认API的调用信息,通过编辑API的基本信息来更改服务信息。配置API的自定义认证:您可以通过自定义认证来配置业务自己的认证方式。配置API的参数编排规则:您可以通过不同算法规则,将请求参数映射为新的请求参数。自定义AP - [查看或编辑APIG的API信息](https://support.huaweicloud.com/usermanual-apig/apig_03_0016.md): API列表支持查看或编辑当前实例下所有的API,查看或编辑API的运行环境、请求方法、请求路径等信息。支持查看API的监控视图、前端配置或后端配置信息。支持编辑API、发布API、下线API、调试API、API授权、删除API或克隆API操作。如果您希望通过API查看或编辑API信息,请参考查询API详情或修改API。 - [配置API的前端自定义认证](https://support.huaweicloud.com/usermanual-apig/apig_03_0069.md): 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。自定义认证包括前端和后端两种类型:前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。后端自定义认证:指API的后端服务使用自定义的认证函数,对来自APIG转发的后端服务请求进行安全认证。本章节主要介绍如何创建一个前端自定义认证。您需 - [配置API的后端自定义认证](https://support.huaweicloud.com/usermanual-apig/apig_03_0130.md): 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。后端自定义认证:指API的后端服务使用自定义的认证函数,对来自APIG转发的后端服务请求进行安全认证。本章节主要介绍如何创建一个后端自定义认证。您需要先创建一个函数后端作为认证函数, - [配置API的参数编排规则](https://support.huaweicloud.com/usermanual-apig/apig_03_0110.md): API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。在编排规则列表中显示已创建的规则,表示创建成功。参数编排规则创建完成后,您可以为API关联参数编排规则。具体操作,请参考通过APIG创建REST API章节。如果您希望通过API创建编排规则,请参考创建编排规则。 - [自定义API的错误响应信息](https://support.huaweicloud.com/usermanual-apig/apig_03_0008.md): 网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。例如,“default”网关的响应内容为:您可以自定义为:JSON体的内容可以按需定制,包括增减字段内容。每个分组最多 - [克隆APIG的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0076.md): API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。已创建API,如果未创建API,请通过APIG创建REST API。在左侧导航栏中显示已创建的API,表示克隆成功。API克隆完成后,通过调试API,验证服务是否正常。 - [下线APIG的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0070.md): 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。已创建API分组和分组内的API。API已发布到指定环境。单个下线API。在左侧选择API,然后在右上角单击“下线”,弹出“下线API”对话框。批量下线API,最多同时下线1000 - [导入导出API的兼容性说明](https://support.huaweicloud.com/usermanual-apig/apig_03_0083.md): 在API网关中导入或导出API时,OpenAPI规范(OpenAPI Specification,简称OAS)与API网关对象定义之间存在兼容性差异,主要体现在对象映射、参数类型、路径语法等方面。详细兼容性说明请参见下文。API网关支持OpenAPI规范。OpenAPI规范是定义一个标准的、与具体编程语言无关的RESTful API的规范 - [通过API设计文件导入API](https://support.huaweicloud.com/usermanual-apig/apig_03_0067.md): 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前,您需要了解APIG的兼容性说明,并在API定义中补全API网关的扩展定义。您也可以参考以下示例导入API到API网关:导入HTTP类型后端服务API示例导入HTTP VPC类型后端服务API示例导入FUNCTION类型后端服务A - [通过CSE微服务导入API](https://support.huaweicloud.com/usermanual-apig/apig_03_0074.md): API网关支持导入微服务引擎(Cloud Service Engine,简称CSE)的微服务。将微服务作为后端服务,在API网关中开放API,提供给API调用者使用。微服务引擎详细介绍请参考微服务引擎CSE章节。微服务引擎计费详情请参考微服务引擎计费说明。仅支持导入未开启安全认证的CSE微服务。您需保证当前实例与微服务实例地址网络可达,否 - [通过CCE工作负载导入API](https://support.huaweicloud.com/usermanual-apig/apig_03_0071.md): API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)的工作负载,将工作负载作为后端服务,在API网关中开放API,提供给API调用者使用。云容器引擎计费详情请参考云容器引擎计费说明。仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。您需要确保当前实例与CCE集群所属同一个VPC中,或通过其 - [导出APIG的API](https://support.huaweicloud.com/usermanual-apig/apig_03_0015.md): APIG支持把已创建的API按照OAS标准定义的格式导出,方便用户用于迁移、备份、共享等场景。API网关参数限制:暂不支持formData和body位置的请求参数定义。暂不支持consumes和produces定义。header位置的参数名称,不区分大小写。暂不支持formData和body位置的请求参数定义。暂不支持consumes和p - [x-apigateway-auth-type](https://support.huaweicloud.com/usermanual-apig/apig_03_0085.md): 含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0)Swagger示例:OpenAPI示例: - [x-apigateway-request-type](https://support.huaweicloud.com/usermanual-apig/apig_03_0086.md): 含义:API网关定义的API请求类型,支持public和private。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-match-mode](https://support.huaweicloud.com/usermanual-apig/apig_03_0087.md): 含义:API网关定义的API请求URL的匹配模式,支持NORMAL和SWA。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-cors](https://support.huaweicloud.com/usermanual-apig/apig_03_0088.md): 含义:API网关定义的API请求是否支持跨域。作用域:Operation Object(2.0)/Operation Object(3.0)示例:开启跨域访问的API请求,响应会增加如下头域: - [x-apigateway-is-send-fg-body-base64](https://support.huaweicloud.com/usermanual-apig/apig_03_0106.md): 含义:是否对与FunctionGraph交互场景的请求体进行Base64编码,boolean类型。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-any-method](https://support.huaweicloud.com/usermanual-apig/apig_03_0089.md): 含义:API网关定义的API请求方法,用以匹配未指定定义的HTTP方法。作用域:Path Item Object(2.0)/Path Item Object(3.0)示例: - [x-apigateway-backend](https://support.huaweicloud.com/usermanual-apig/apig_03_0090.md): 含义:API网关定义的API后端服务定义。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-backend.parameters](https://support.huaweicloud.com/usermanual-apig/apig_03_0091.md): 含义:API网关定义的API后端参数定义。作用域:x-apigateway-backend示例: - [x-apigateway-backend.httpEndpoints](https://support.huaweicloud.com/usermanual-apig/apig_03_0092.md): 含义:API网关定义的HTTP类型API后端服务定义。作用域:x-apigateway-backend示例: - [x-apigateway-backend.httpVpcEndpoints](https://support.huaweicloud.com/usermanual-apig/apig_03_0093.md): 含义:API网关定义的HTTP VPC类型API后端服务定义。作用域:x-apigateway-backend示例: - [x-apigateway-backend.httpVpcMemberGroupEndpoints](https://support.huaweicloud.com/usermanual-apig/apig_03_0136.md): 含义:API网关定义的HTTP VPC类型API后端服务定义。此扩展定义受限使用,如需使用,请提交工单开通。作用域:x-apigateway-backend示例: - [x-apigateway-backend.httpVpcMemberGroupEndpoints.memberGroupUrlInfos](https://support.huaweicloud.com/usermanual-apig/apig_03_0137.md): 含义:API网关定义的HTTP VPC类型API后端服务定义。此扩展定义受限使用,如需使用,请提交工单开通。作用域:x-apigateway-backend示例: - [x-apigateway-backend.functionEndpoints](https://support.huaweicloud.com/usermanual-apig/apig_03_0094.md): 含义:API网关定义的FUNCTION类型API后端服务定义。作用域:x-apigateway-backend示例: - [x-apigateway-backend.mockEndpoints](https://support.huaweicloud.com/usermanual-apig/apig_03_0095.md): 含义:API网关定义的MOCK类型API后端服务定义。作用域:x-apigateway-backend示例: - [x-apigateway-backend-policies](https://support.huaweicloud.com/usermanual-apig/apig_03_0096.md): 含义:API网关定义的API后端策略。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-backend-policies.conditions](https://support.huaweicloud.com/usermanual-apig/apig_03_0097.md): 含义:API网关定义的API后端策略条件。作用域:x-apigateway-backend-policies示例: - [x-apigateway-ratelimit](https://support.huaweicloud.com/usermanual-apig/apig_03_0098.md): 含义:引用流控策略。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-ratelimits](https://support.huaweicloud.com/usermanual-apig/apig_03_0099.md): 含义:流控策略名称与关联策略映射。作用域:Swagger Object示例: - [x-apigateway-ratelimits.policy](https://support.huaweicloud.com/usermanual-apig/apig_03_0100.md): 含义:流控策略定义。作用域:x-apigateway-ratelimits示例: - [x-apigateway-ratelimits.policy.special](https://support.huaweicloud.com/usermanual-apig/apig_03_0101.md): 含义:特殊流控策略定义。作用域:x-apigateway-ratelimits.policy示例: - [x-apigateway-access-control](https://support.huaweicloud.com/usermanual-apig/apig_03_0102.md): 含义:引用访问控制策略。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-access-controls](https://support.huaweicloud.com/usermanual-apig/apig_03_0103.md): 含义:访问控制策略名称与关联策略映射。作用域:Swagger Object示例: - [x-apigateway-access-controls.policy](https://support.huaweicloud.com/usermanual-apig/apig_03_0104.md): 含义:访问控制策略定义。作用域:x-apigateway-access-controls示例: - [x-apigateway-plugins](https://support.huaweicloud.com/usermanual-apig/apig_03_0105.md): 含义:API网关定义的API插件服务。作用域:Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-auth-opt](https://support.huaweicloud.com/usermanual-apig/apig_03_0115.md): 含义:APP简易认证方式参数。作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0)Swagger示例:securityDefinitions: apig-auth-app: type: apiKey name: Authorization in: - [x-apigateway-result-normal-sample](https://support.huaweicloud.com/usermanual-apig/apig_03_0117.md): 含义:成功响应示例。作用域: Operation Responses示例: - [x-apigateway-result-failure-sample](https://support.huaweicloud.com/usermanual-apig/apig_03_0118.md): 含义:失败响应示例。作用域: Operation Responses示例: - [x-apigateway-authorizer](https://support.huaweicloud.com/usermanual-apig/apig_03_0119.md): 含义:自定义认证对象。作用域: Security Scheme Object示例: - [x-apigateway-response](https://support.huaweicloud.com/usermanual-apig/apig_03_0120.md): 含义:API的网关响应名称。作用域: Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-responses](https://support.huaweicloud.com/usermanual-apig/apig_03_0121.md): 含义:自定义网关响应类型。作用域: Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-pass-through](https://support.huaweicloud.com/usermanual-apig/apig_03_0122.md): 含义:API的请求参数是否透传。always为是,never为否。作用域: Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-sample](https://support.huaweicloud.com/usermanual-apig/apig_03_0123.md): 含义: API的请求参数示例值。作用域: Operation Object(2.0)/Operation Object(3.0)示例: - [x-apigateway-content-type](https://support.huaweicloud.com/usermanual-apig/apig_03_0124.md): 含义: API的请求内容类型。作用域: Operation Object(2.0)示例: - [x-apigateway-orchestrations](https://support.huaweicloud.com/usermanual-apig/apig_03_0125.md): 含义: API请求参数的编排规则列表。作用域: Operation Object(2.0)/Operation Object(3.0)示例: - [配置API的流量控制](https://support.huaweicloud.com/usermanual-apig/apig_03_0025.md): 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过配置流控策略,针对部分API进行流量控制。本视频演示如何在API网关服务上设置流量控制。因产品功能演进,操作界面可能存在差异,相关视频仅供参考,具体以实际环境为准。API配置流控策略相当于流控 - [配置API的访问控制](https://support.huaweicloud.com/usermanual-apig/apig_03_0027.md): 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账号,您可以通过设置黑白名单来访问API。实例级访问控制策略请参考表1。白名单:支持配置IP/账号名/账号ID的白名单访问,不在白名单列表中的请求将会被拒绝。黑名单:支持配置IP/账号名/账号ID的黑名单,在黑名单列表中的请求将会被API网关拒绝。本视 - [配置API的后端服务签名校验](https://support.huaweicloud.com/usermanual-apig/apig_03_0028.md): 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关传过来的Authori - [配置API的跨域资源共享](https://support.huaweicloud.com/usermanual-apig/apig_03_0021.md): 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参见跨域调用APIG开放的API。跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力,可快速、灵活地实现AP - [配置API的响应缓存](https://support.huaweicloud.com/usermanual-apig/apig_03_0111.md): 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API网关不支持缓存数据加密,对于响应中的敏感数据存在安全风险,请谨慎配置策略。策略参 - [配置API的HTTP响应头](https://support.huaweicloud.com/usermanual-apig/apig_03_0022.md): API响应是指API网关向客户端返回的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。如果此策略在当前实例中不支持,请提交工单升级实例到最新版本。策略参数会明文展示,为防止信息泄露,请谨慎配置。同一个环境中,一个API只能被一个HTTP响应头策略绑定,但一个HTTP响应头策略 - [配置API的流量控制2.0](https://support.huaweicloud.com/usermanual-apig/apig_03_0054.md): 流量控制2.0策略可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。基础流控可以对API、用户、凭据、源IP进行多维度流控,与已有的配置API的流量控制功能一致但不兼容。可以对API、用户、凭据、源IP进行多维度流控,与已有的配置API的流量控制功能一致但不兼容。参数流控支持根据Header、Path、 - [配置API的Kafka日志推送](https://support.huaweicloud.com/usermanual-apig/apig_03_0061.md): Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。同一个环境中,一个API只能被一个Kafka日志推送策略绑定,但一个Kafka日志推送策略可以绑定多个API。同一个APIG实例内最多可创建5个Kafka日志推送策略。如需 - [配置API的断路器](https://support.huaweicloud.com/usermanual-apig/apig_03_0023.md): 断路器是API网关用于在后端服务性能异常时保护系统的内置机制。当后端服务连续出现N次超时或响应延迟较高时,断路器会自动触发降级策略,向调用方返回预设的错误信息,或将请求转发至指定的降级处理服务。一旦后端服务恢复正常,断路器将关闭降级状态,系统请求也随之恢复常态。如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。同一个环境中,一个 - [配置API的第三方认证](https://support.huaweicloud.com/usermanual-apig/apig_03_0077.md): 您可通过配置第三方认证策略,将自定义鉴权服务接入API网关。网关在调用后端服务前,会先请求您的鉴权服务进行认证,只有收到成功响应后才会继续执行后续操作。如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。第三方认证原理图如下,第三方认证策略绑定API后,您可以参考调用APIG开放的API调用。同一个环境中,一个API只能被一个第三 - [配置API的流量镜像](https://support.huaweicloud.com/usermanual-apig/apig_03_0112.md): API网关提供了镜像客户端请求的能力,将发送到源后端的流量复制一份到镜像服务中,在不影响业务后端的情况下,便于对请求内容进行具体的分析和统计。如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。同一个环境中,一个API只能被一个流量镜像策略绑定,但一个流量镜像策略可以绑定多个API。镜像请求返回的响应会被忽略。镜像请求的请求体大小 - [配置API的OIDC认证](https://support.huaweicloud.com/usermanual-apig/apig_03_0134.md): APIG提供一种支持OIDC协议的鉴权方式。当用户选择以这种鉴权方式来通过网关访问后端服务时,API网关会与IDP服务交互获取token和用户信息,将得到的信息附加到后端服务请求中。不仅可以获取访问权限,还能确认用户的真实身份,并确保身份信息在传输过程中的安全性和完整性。OIDC(OpenID Connect):是一种身份认证协议,它在提 - [配置API的JWT认证](https://support.huaweicloud.com/usermanual-apig/apig_03_0135.md): JWT(JSON Web Token)是一种轻量级的认证信息格式,广泛应用于API身份验证场景。您可以为API绑定JWT认证策略,利用私钥签发Token并附加在请求中,网关会使用公钥对Token进行鉴权,从而实现API的安全访问控制。API网关支持两种JWKS(JSON Web Key Set)公钥设置方式:在策略中配置远程服务地址,网关 - [配置API认证凭据的配额控制](https://support.huaweicloud.com/usermanual-apig/apig_03_0059.md): 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。选择已有策略:单击“选择已有策略”后,选择策略。创建新策略:请参考表1所示配置策略。在“凭据配额策略”区域显示已创建的策略,表示 - [配置API认证的凭据访问控制](https://support.huaweicloud.com/usermanual-apig/apig_03_0060.md): 凭据访问控制可控制访问API的凭据IP地址,保护后端服务。您可以为凭据设置访问控制策略,允许/禁止某个IP地址的凭据访问API。在“访问控制策略”区域显示已创建的访问控制策略,表示访问控制策略创建成功。如果您希望通过API创建凭据访问控制策略,请参考设置APP的访问控制。 - [查看或编辑APIG实例信息](https://support.huaweicloud.com/usermanual-apig/apig_03_0038.md): 实例创建完成后,可在控制台查看和编辑实例的配置信息。如果您希望通过API查看或编辑实例信息,请参考查询专享版实例详情或更新专享版实例。 - [配置APIG实例参数](https://support.huaweicloud.com/usermanual-apig/apig_03_0039.md): 配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。部分参数受限使用,如需使用,请提交工单申请。 - [配置APIG实例标签](https://support.huaweicloud.com/usermanual-apig/apig_03_0075.md): 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。一个实例最多可以添加20个标签。标签由键和值组成,值可以为空。标签键:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: - [配置APIG的终端节点信息](https://support.huaweicloud.com/usermanual-apig/apig_03_0063.md): 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。在同一区域中,可实现云内跨VPC访问/开放API。终端节点计费详情请参考终端节点计费说明。目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。NLB系列规格实例不支持终端节点管理功能。 - [自定义APIG的客户端访问端口](https://support.huaweicloud.com/usermanual-apig/apig_03_0109.md): API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。独立域名与端口相关约束与限制内容,请参考约束与限制。根据实际业务,选择请求协议,并填写入方向端口。在“分组信息”页面的“域名管理”区域,将已绑定独立域名的端口修改为新增的入端口或在绑 - [变更APIG的实例规格](https://support.huaweicloud.com/usermanual-apig/apig_03_0064.md): 当实例规格无法满足您的业务需求时,您可以进行规格变更操作升配到更高规格版本。“包年/包月”计费模式的实例,选择要变更的目标规格后,需补齐差价。“按需计费”模式的实例变更规格时不需要补齐差额。关于实例规格变更的计费详情,请参考计费详情页面。当前支持ELB类型的实例规格变更,除墨西哥城一、北京一区域外,其他区域都支持规格变更。规格变更过程中, - [APIG支持的监控指标](https://support.huaweicloud.com/usermanual-apig/apig_03_0032.md): 本节定义了API网关服务上报云监控服务的监控指标的命名空间、监控指标列表和维度定义,用户可以通过云监控服务提供的管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。云监控服务最大支持4个层级维度,维度编号从0开始,编号3为最深层级。例如监控指标中的维度信息为“instance_id,api_id”时,表示对应的监控指标的维 - [配置APIG的监控告警](https://support.huaweicloud.com/usermanual-apig/apig_03_0033.md): 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 - [查看APIG的监控指标](https://support.huaweicloud.com/usermanual-apig/apig_03_0034.md): 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。查看某个API的调用统计,包括“请求次数”、“调用延时”、“数据流量”和“出错统计”,同时可以选择要查看数据的时间段范围。支持的时间范围有:近1小时数据每2分钟刷新一次。近6小时数据每2小时刷新一次。近一天数据每2小时刷新一次。近一周和近一月数据每天 - [查看APIG的带宽监控](https://support.huaweicloud.com/usermanual-apig/apig_03_0073.md): API网关支持查看出入口带宽各项指标的监控数据,了解带宽的网络情况和使用率。已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。NLB系列规格实例不支持带宽监控功能。用户可以进入弹性负载均衡页面查看EIP、ELB监控信息。 - [查看APIG的API调用日志](https://support.huaweicloud.com/usermanual-apig/apig_03_0042.md): APIG提供了API的可视化分析和统计能力,支持查看API的调用日志。云日志服务计费详情请参考云日志服务计费说明。已调用API。已创建日志组,如果未创建,请创建日志组。已创建日志流,如果未创建,请创建日志流。在“日志分析”页签单击“日志与追踪配置”。在弹窗中配置日志信息,完成后单击“确定”。日志搜索:支持对采集成功的日志数据进行搜索与分析 - [云审计服务支持的APIG操作列表](https://support.huaweicloud.com/usermanual-apig/apig_03_0052.md): 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,则需要先开通云审计服务。云审计服务包含以下功能:记录审计日志审计日志查询审计日志转储事件文件加密关键操作通知通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。API Gateway操作列表见下表:AIAP - [在CTS事件列表查看云审计事件](https://support.huaweicloud.com/usermanual-apig/apig_03_0053.md): 云审计服务能够为您提供云服务资源的操作记录,记录的信息包括发起操作的用户身份、IP地址、具体的操作内容的信息,以及操作返回的响应信息。根据这些操作记录,您可以很方便地实现安全审计、问题跟踪、资源定位,帮助您更好地规划和利用已有资源、甄别违规或高危操作。本节介绍如何在云审计服务控制台查看或导出最近7天的操作记录。事件即云审计服务追踪并保存的 - [APIG使用流程](https://support.huaweicloud.com/usermanual-apig/apig_0080101651.md): API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关的开放API和调用API功能,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。开放API企业或开发者通过API网关开放自身的服务与数据。API网关服务开放API开放API的业务使用 - [进入共享版控制台](https://support.huaweicloud.com/usermanual-apig/apig_03_0108.md): 存量用户进入共享版控制台操作如下。 - [创建API分组](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307015.md): 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。一个API只能属于某一个API分组。创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。共享版中的API, - [绑定域名](https://support.huaweicloud.com/usermanual-apig/apig-ug-180327076.md): 开放API前,您需要为API分组绑定一个或多个独立域名,API网关通过独立域名定位到此分组。共享版中,不同分组下不能绑定相同的独立域名。在绑定域名前,您需要理解以下2个概念:子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。独立域名:您自定义的域名,最多可以添加5个独立 - [删除分组](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307018.md): API分组在创建后,如需对创建的数据进行删除,可以删除此分组。如果API分组下存在API,API分组无法被删除。已创建分组。在待删除的API分组所在行,单击“更多 > 删除”。单击“分组名称”,进入分组详情页面,在右上角单击“删除”。 - [新增网关响应](https://support.huaweicloud.com/usermanual-apig/apig-lgug-200226001.md): 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。例如,“default”网关的响应内容为:您可以自定义为:JSON体的内容可以按需定制,包括增减字段内容。API提供 - [创建API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307020.md): API提供者把API接口配置在API网关中,开放后端能力。创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。已创建API分组。如果未创建API分组,可在本操作页面中创建API分组。如果后端服务需要使用VPC通道,请 - [开启跨域访问](https://support.huaweicloud.com/usermanual-apig/apig-ug-180621094.md): 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。浏览器将CORS请求分为两类:简单请求简单跨域请求的场景需要满足以下两个条件:请求方法是HEAD,GET,或者POST。HTTP的头信息不超出以下范围 - [调试API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307025.md): API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。后端路径中含有环境变量的API,不支持调试。如果API已绑定流控策略,在调试API时,流控策略无效。已创建API分组和分组内的API。已搭建完成后端服务。在待调试的API所在行,单击“更多 > 调试”。单击“API名称”, - [授权API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307021.md): API在创建后,通过指定授权给某些应用,让指定应用能够调用API。仅在API发布到环境后,才支持被授权。仅在API为APP认证时,才支持授权给应用。已创建API分组和分组内的API。(可选)已创建环境。已创建应用。在待授权的API所在行,单击“更多 > 授权”,进入“授权API”页面。单击“添加应用”,弹出“授权应用”对话框。勾选待授权的 - [发布API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307023.md): 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。同一个API在每个环境中最多记录10条最新的发布历史。已创建API分组和分组内 - [下线API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307024.md): 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。已创建API分组和分组内的API。API已发布到该环境。在待下线的API所在行,单击“更多 > 下线”,弹出“下线API”对话框。单击“API名称”,进入API详情页面。在右上角单 - [删除API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307027.md): 已发布的API不再提供服务,可以将API删除。该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。已上架云商店的API,无法被删除。已发布的API,需要先下线API,再删除。在待删除的API所在行,单击“更多 > 删除”。单击“API名称”,进入API详情页面。在右上角单击“删除”。如果需要批量删 - [导入API](https://support.huaweicloud.com/usermanual-apig/apig-ug-181025104.md): API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。导入API前,您需要在导入的API定义文件中补全Sw - [导出API](https://support.huaweicloud.com/usermanual-apig/apig-ug-181204105.md): 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。云商店购买的API不支持导出。已创建API分组和API。 - [创建流控策略](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307029.md): 流量控制可限制单位时间内API的被调用次数,保护后端服务。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。流控策略和API本身是相互独立的,只有将流控策略绑定API后,流控策略才对绑定的API生效。同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。如果API未绑定流控策略,共享版 - [删除流控策略](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307032.md): 当已创建的流控策略不再提供服务时,可以将此流控策略删除。已创建流控策略。在待删除的流控策略所在行,单击“删除”。单击待删除的策略名称,进入流量控制详情页面,在右上角单击“删除”。仅在流控策略未绑定任何API时,支持删除,否则请先解绑API。在流量控制详情页面,单击待解绑API所在行的“解除”。如果需要批量删除流控策略,则勾选待删除的流控策 - [添加特殊应用或租户](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307033.md): 如果需要为某个应用/租户设置特定的流控值,则通过添加特殊应用/租户可以实现。已创建应用,或已获取其他应用ID/租户ID。添加已有应用:单击“已有应用”,选择已有应用,输入阈值。添加其他应用:单击“其他”,输入其他用户的应用ID和阈值。特殊应用流控值和应用流量限制值共同作用时,以特殊应用流控值为准。例如:API流量限制值为10,应用流量限制 - [删除特殊应用或租户](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307035.md): 在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。已创建流控策略。已添加特殊应用/租户。 - [创建访问控制策略](https://support.huaweicloud.com/usermanual-apig/apig-ug-180712097.md): 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。同一个环境中一个API只能被一个访问控制策略绑定,一个访问控制 - [删除访问控制策略](https://support.huaweicloud.com/usermanual-apig/apig-ug-180712100.md): 当已创建的访问控制策略不再需要时,可以将此访问控制策略删除。已创建访问控制策略。在待删除的访问控制策略所在行,单击“删除”。单击待删除的访问控制策略名称,进入访问控制详情页面,在右上角单击“删除”。仅在访问控制策略未绑定任何API时,支持删除,否则请先解绑API。如果需要批量删除访问控制策略,则勾选待删除的访问控制策略,单击“删除”。最多 - [创建环境和环境变量](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307037.md): API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。当创建API时定义了变 - [删除环境](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307039.md): 已创建的环境不再提供服务,可以将环境删除。已创建环境。仅在环境未被API发布时,支持删除。 - [创建并使用签名密钥](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307041.md): 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关传过来的Author - [删除签名密钥](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307045.md): 如果某一个密钥不再提供服务,则可以将其删除。已创建密钥。在待删除的密钥所在行,单击“删除”。单击“密钥名称”,进入签名密钥详情页面。在右上角单击“删除”。仅在签名密钥未绑定任何API时,支持删除,否则请先解绑API。 - [创建VPC通道](https://support.huaweicloud.com/usermanual-apig/apig-ug-180425081.md): VPC通道主要用于将部署在VPC内的服务通过API网关开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时VPC通道具有负载均衡功能,从而实现后端服务的负载均衡。创建VPC通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的VPC通道。例如,VPC中包含6台ECS,已创建一条V - [删除VPC通道](https://support.huaweicloud.com/usermanual-apig/apig-ug-180425083.md): 已创建的VPC通道不再需要时,可以直接删除。如果API已经使用VPC通道,且API已发布到环境,此时无法删除此VPC通道。已创建VPC通道。在待删除的VPC通道所在行,单击“删除”。单击“VPC通道名称”,进入VPC通道详情页面。在右上角单击“删除”。 - [编辑健康检查配置](https://support.huaweicloud.com/usermanual-apig/apig-ug-180425084.md): VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。已创建VPC通道。健康检查信息项描述协议使用以下协议,对VPC中主机执行健康检查。TCPHTTPHTTPS默认为TCP协议。路径健康检查时的目标路径。仅在协议不为“TCP”时,需要设置。检查端口健康检查的目标端口。缺省时为VPC中主机的端口号。正常阈值判定VPC中主机正常的依据为 - [在VPC通道中编辑云服务器配置](https://support.huaweicloud.com/usermanual-apig/apig-ug-180502087.md): 在创建VPC通道后,可以通过编辑云服务器为VPC通道增加/删除云服务器或编辑云服务器的权重。已创建VPC通道。增加云服务器单击“添加云服务器”,弹出“添加云服务器”对话框。勾选需要添加的云服务器,并且设置权重,单击“添加”。待添加的云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。单击“添加云 - [创建自定义认证](https://support.huaweicloud.com/usermanual-apig/apic-ug-190430105.md): 自定义认证包含两种认证:前端自定义认证和后端自定义认证。前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证 - [删除自定义认证](https://support.huaweicloud.com/usermanual-apig/apic-ug-190430106.md): 当自定义的认证已不再需要时,可以删除自定义认证。自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。已在API中使用的自定义认证无法被删除。已创建自定义认证。 - [支持的监控指标](https://support.huaweicloud.com/usermanual-apig/apig-ug-180427085.md): 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。共享版:SYS.APIG - [创建告警规则](https://support.huaweicloud.com/usermanual-apig/apig-ug-180524089.md): 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。API已被调用。 - [查看监控指标](https://support.huaweicloud.com/usermanual-apig/apig-ug-180427086.md): 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。已创建API分组和分组内的API。查看API的各项监控指标。监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中,具体步骤请参见配置OBS数据存储。 - [创建应用并获取授权](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307049.md): 使用APP认证的API,需要在API网关中创建一个应用,以生成应用ID和密钥对(AppKey、AppSecret)。将创建的应用绑定API后,才可以使用APP认证调用API。在API调用过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《API网关开发指南》。从云商店 - [删除应用](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307051.md): 已创建的应用不再提供服务,可以将应用删除。从云商店购买的API生成的应用,不支持删除。已创建应用。在待删除的应用所在行,单击“删除”。单击“应用名称”,进入应用详情页面,在右上角单击“删除”。仅在应用未绑定任何API时,支持删除,否则请先解绑API。 - [重置AppSecret](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307053.md): AppKey唯一且不可重置,AppSecret支持重置,将AppSecret的值重新改变。重置完成后,原先的AppSecret将失效,绑定此应用的API将无法调用,请更新AppSecret,并重新调用API。已创建应用。 - [为简易认证添加AppCode](https://support.huaweicloud.com/usermanual-apig/apig-lgug-200227001.md): 简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填应用详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Appkey和AppSecret做签名和校验,也可以 - [查看应用绑定的API详情](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307054.md): 在应用绑定API后,查看应用绑定的API详情。已创建应用。应用已绑定API。 - [SDK](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307056.md): API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。API使用APP认证时,请根据需要下载SDK包和文档,参考文档完成API的调用。如需查看文档,请单击“SDK文档”。 - [已购买API](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307057.md): API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。已购买的API,需要通过APP认证方式调用。已从云商店购买了API。查看此分组下已购买的API列表和此分组的详细信息。右侧返回结果回显区域打印API调用的Response信息。 - [调用API](https://support.huaweicloud.com/usermanual-apig/apig-ug-0011.md): API提供者在API网关开放自己的API后,API调用者从API网关中调用API。如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。在调用API前,您需要向API提供者获取API的调用信息。获取API的请求信息在API网关控制台选择“开放API > API管理”,单击API的名称进入 - [响应消息头](https://support.huaweicloud.com/usermanual-apig/apig-ug-180830102.md): 调用API时,API网关增加如下响应消息头。X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 - [错误码](https://support.huaweicloud.com/usermanual-apig/apig-ug-180530090.md): 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。 - [云审计服务支持的APIG操作列表](https://support.huaweicloud.com/usermanual-apig/apig-ug-180307058.md): 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。云审计服务包含以下功能:记录审计日志审计日志查询审计日志转储事件文件加密关键操作通知通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。如果需要关闭云审计服务,具体步骤请参见删除追 - [在CTS事件列表查看云审计事件](https://support.huaweicloud.com/usermanual-apig/apig-ug-0021.md): 云审计服务能够为您提供云服务资源的操作记录,记录的信息包括发起操作的用户身份、IP地址、具体的操作内容的信息,以及操作返回的响应信息。根据这些操作记录,您可以很方便地实现安全审计、问题跟踪、资源定位,帮助您更好地规划和利用已有资源、甄别违规或高危操作。本节介绍如何在云审计服务控制台查看或导出最近7天的操作记录。事件即云审计服务追踪并保存的 ## 最佳实践 - [APIG最佳实践汇总](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0051.md): 本文汇总了基于API网关服务(APIG,API Gateway)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松构建基于APIG的业务。 - [使用APIG专享版开放CCE工作负载方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0021.md): 云容器引擎(Cloud Container Engine,即CCE)中的工作负载,以及微服务,可通过API网关将服务能力以API形式对外开放。开放CCE工作负载支持以下两种方式,推荐使用方式一直接创建负载通道的方式开放CCE工作负载。方式一在API网关中直接创建负载通道,通过负载通道访问CCE工作负载中的实例地址,动态监测工作负载下实例I - [使用APIG专享版开放CCE工作负载资源规划](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0022.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [使用APIG专享版开放CCE工作负载操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0023.md): 准备CCE工作负载信息在通过API网关将容器的工作负载对外开放前,需要在云容器引擎控制台创建CCE集群(VPC网络模型)或Turbo集群。在通过API网关将容器的工作负载对外开放前,需要在云容器引擎控制台创建CCE集群(VPC网络模型)或Turbo集群。开放CCE工作负载方式一:在API网关中直接创建负载通道并开放API,通过负载通道访问 - [准备CCE工作负载信息](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0058.md): 登录云容器引擎控制台,在“集群管理”页面购买CCE Standard集群或CCE Turbo集群。此处选择CCE Standard集群,容器网络模型为“VPC网络”,具体操作步骤请参见购买CCE集群。集群创建完成后,记录容器网段。在APIG专享版实例的“路由”中添加容器网段。进入API网关控制台,在左侧导航栏中“实例管理”。单击对应实例名 - [方式一:通过创建负载通道的方式开放CCE工作负载](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0059.md): 进入API网关控制台,在左侧导航栏上方选择实例。在左侧导航栏中选择“API管理 > API策略”。在“负载通道”页签中单击“创建负载通道”。基本信息配置。基本信息配置参数配置说明通道名称填写负载通道名称,根据规划自定义。此处填写“VPC_demo”。端口填写已创建工作负载的容器端口,指工作负载中pod里业务直接对外开放的接口。此处填写“8 - [方式二:通过导入CCE工作负载的方式开放CCE工作负载](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0060.md): 进入API网关控制台,在左侧导航栏上方选择实例。在左侧导航栏中选择“API管理 > API分组”。单击“创建API分组 > 导入CCE工作负载”。填写导入CCE工作负载的信息。工作负载信息配置参数配置说明所属分组工作负载所属分组,此处默认为“生成新的分组”。集群选择已创建的集群。命名空间选择已创建集群中的命名空间,此处选择“default - [(可选)配置工作负载标签实现灰度发布](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0061.md): 灰度发布是服务发布策略之一,旨在通过调整流量分配权重,逐步将流量从旧版本引导到新版本实例上。服务发布升级过程中可以逐步验证版本是否符合预期,如果版本符合预期,则可以逐渐加大新版本实例流量占比,减小旧版本实例流量占比,直至将新版本服务权重增加到100,旧版本服务权重减少至0,完成从旧版本到新版本服务的引流。云容器引擎CCE工作负载根据Pod - [使用APIG专享版开放本地数据中心的服务能力](https://support.huaweicloud.com/bestpractice-apig/apig-bp-200108001.md): API网关的后端服务有3类部署形态:后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。后端服务部署在公网环境中,即可以直接通过公网地址访问。后端服务部署在本 - [使用APIG专享版跨VPC开放后端服务方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0016.md): 当用户后端服务器所在的VPC与创建实例所选择的VPC处于不同的场景时,该如何完成服务配置,以实现跨VPC对接?本文以Elastic Load Balance(弹性负载均衡ELB)为例,讲述如何在API网关上开放内网ELB中的服务。帮助用户根据业务诉求进行灵活配置,无需修改原有业务网络架构,直接将请求转发到后端服务上。VPC1、VPC2、A - [使用APIG专享版跨VPC开放后端服务资源规划](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0017.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [使用APIG专享版跨VPC开放后端服务操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0018.md): 创建VPC创建两个VPC,VPC1为API网关所在VPC,VPC2为后端应用所在VPC。创建两个VPC,VPC1为API网关所在VPC,VPC2为后端应用所在VPC。创建实例在VPC1上创建APIG专享版实例。在VPC1上创建APIG专享版实例。创建弹性负载均衡在VPC2上创建弹性负载均衡。在VPC2上创建弹性负载均衡。创建对等连接创建V - [使用APIG专享版跨VPC开放后端服务实施步骤](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0019.md): 单击已创建弹性负载均衡的名称,在“监听器”页签中单击“添加监听器”。配置监听器名称、前端协议及端口,单击“下一步”。配置后端服务器组名称、后端协议和分配策略类型,单击“下一步”。添加后端服务器,单击“下一步”。单击“提交”。下图所示为配置后的信息。在弹窗中填写路由信息。本端和对端的路由信息参数说明本端路由虚拟私有云已创建的虚拟私有云“VP - [使用APIG专享版实现gRPC服务的路由转发方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0037.md): gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征是使用protobuf(protocol buffers)作为其接口定义语言(Interface Definition Language,缩写IDL),同时底层的消息交换格式也是使用protobuf。当用 - [使用APIG专享版实现gRPC服务的路由转发操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0039.md): 创建API创建gRPC类型的API,前后端协议均为GRPCS。创建gRPC类型的API,前后端协议均为GRPCS。发布API将gRPC类型的API发布到环境上。将gRPC类型的API发布到环境上。验证使用gRPC客户端测试gRPC服务可用性,如果服务端正常返回响应,则表示gRPC服务可用。使用gRPC客户端测试gRPC服务可用性,如果服务 - [使用APIG专享版实现gRPC服务的路由转发实施步骤](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0040.md): 客户端与服务端均为gRPC类型。服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用,它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。在“API运行”页面中,API的URL不显示调用方 - [使用APIG专享版实现WebSocket服务的转发](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0050.md): API网关支持WebSocket API,其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议,建立在单个TCP连接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不足。它广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。WebSocket AP - [使用APIG专享版实现http到https自动重定向方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0032.md): API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https)由于浏览器限制,非GET或非HEAD方法的重定向 - [使用APIG专享版实现http到https自动重定向操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0034.md): 开启重定向开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。验证重定向验证重定向功能是否生效。验证重定向功能是否生效。 - [使用APIG专享版实现http到https自动重定向实施步骤](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0035.md): 已创建API,API前端配置的请求协议必须选择“HTTPS”或“HTTP&HTTPS”。API已发布。API所属API分组已绑定独立域名和SSL证书。API的相关操作及绑定域名和SSL证书,请参见《API网关用户指南》。在浏览器的地址栏中输入“https://API请求路径”后回车。在键盘上按F12。在“网络”页签中状态码显示“200”表 - [使用APIG专享版实现不同后端服务的调用方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0046.md): API网关支持定义多个策略后端,通过不同的策略条件,将API请求转发到不同的后端服务中,用以满足不同的调用场景。例如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用前端自定义认证参数,为特殊调用方分配专用的后端服务。本方案以“系统参数-前端认证参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发 - [使用APIG专享版实现不同后端服务的调用操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0048.md): 配置API前端在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证(APP认证或IAM认证),并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证(APP认证或IAM认证),并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。配置API后端 - [使用APIG专享版实现不同后端服务的调用实施步骤](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0049.md): 已创建自定义认证函数,如果未创建请创建函数章节创建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。自定义认证函数已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。设置“默认后端”的后端服务类型为“ - [使用APIG专享版对接后端FunctionGraph](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0077.md): 在现代软件开发中,API网关是前端与后端之间的桥梁,扮演着至关重要的角色。然而,当集成多种服务(如HTTP、FunctionGraph、Mock等)时,可能会遇到服务间通信不畅、集成复杂度高的问题。如何简化流程、提升效率?通过API网关连接多种类型的后端服务,可以有效降低集成难度,更好地适配现有业务。本文将演示如何创建一个Function - [通过VPCEP实现跨VPC访问APIG专享版NLB实例开放的API](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0078.md): 客户端和APIG专享版NLB实例在同一区域的不同VPC中,由于VPC之间逻辑隔离,客户端和NLB实例不能直接通信。您可以通过以下任意一个方式实现跨VPC访问:创建VPC对等连接,将两个VPC的网络打通,实现跨VPC访问。具体步骤请参考对等连接。利用VPC终端节点在不同VPC间建立跨VPC的连接通道,实现客户端通过内网访问NLB实例开放的A - [通过NAT网关实现APIG专享版NLB实例的公网出口访问](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0079.md): APIG专享版NLB实例部署在无弹性公网IP(EIP)的私有子网中,因此访问公网后端服务需要配置公网NAT网关实现。通过配置公网NAT网关的SNAT规则,可实现实例安全、可控地访问互联网。客户端通过私有连接访问VPC内的APIG,APIG通过公网出口访问后端服务则经由NAT网关出站,全程保持安全隔离。已创建APIG专享版NLB系列规格实例 - [使用FunctionGraph服务实现APIG的自定义认证](https://support.huaweicloud.com/bestpractice-apig/apig-bp-200706001.md): 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。API网关支持的自定义认证需要借助函数工作流服务实现,用户在函数工作流中创建自定义认证函数,API网关调用该函数,实现自定义认证。下面以Basic认证为例 - [使用APIG的APP认证和自定义认证实现API的双重认证](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0012.md): 双重认证指用户根据业务需求自定义API认证策略,再结合APP认证/IAM认证,从而实现API的双重认证方式,保障API的安全性。本文以API前端认证使用APP认证和自定义认证结合场景为例,具体说明如何创建使用双重认证的API。在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。API网关支持的自定 - [配置APIG专享版与客户端间的单向认证或双向认证](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0041.md): API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证。单向认证:客户端与服务端连接时,客户端需要校验服务端SSL证书合法性。双向认证:客户端与服务端连接时,除了客户 - [使用APIG专享版的流量控制2.0策略实现API的精细流控方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0009.md): 当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。APIG提供了传统流量控制策略,从API、用户、凭据、源IP等多个维度进行流控。然而,随着用户多样性以及需求多样性的增加,传统流控策略无法满足更加精细的流量控制场景。比如针对 - [使用APIG专享版的流量控制2.0策略实现API的精细流控操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0010.md): 假设您对一个API有如下的流控诉求:默认API流量限制为100次/60秒,用户流量限制为5次/60秒。对请求头header字段为“Host=www.abc.com”的限制为10次/60秒。对于请求头test_header的值为userA的请求,限流20次/60秒;同时对于test_header的值为userB的请求,也限流20次/60秒。 - [使用APIG专享版的流量控制2.0策略实现API的精细流控实施步骤](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0011.md): 登录API网关控制台,创建流量控制2.0策略。在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。根据流控诉求,配置策略基本信息。策略基本信息参数配置说明策略名称根据规划自定义名称。流控类型此处选择“高性能流控”模式。策略生效范围此处选择“单个API生效”,对单个API进行流量统计和控制。时 - [使用APIG专享版的JWT认证策略实现身份认证和密钥轮转](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0082.md): JWT(JSON Web Token)是一种基于JSON的轻量级令牌,通过数字签名实现信息的安全传递,广泛应用于身份认证、信息交换等场景。JWT常用于身份认证的令牌,利用无状态特性实现高效跨场景身份验证。用户通过认证服务器生成JWT,客户端通过在请求中携带Token来访问受保护的资源。网关收到请求后,验证JWT的有效性(签名、有效期等), - [使用WAF对APIG进行安全防护](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0002.md): 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。方案一:API分组通过域名方式对外提供服务,具备更强的可扩展性。登录API网关控制台,在左侧导航栏中选择“API管理 > API分组”。单击“创建分组 > 直接创建”,填写分组名称完成创建。单击已创建分组名称,进入分组详情。在“分组信息”页签中,查看调试域 - [使用DDoS防护服务为APIG抵御DDoS攻击方案概述](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0004.md): 当用户在公网中调用APIG上公开的业务API时,会存在DDoS攻击风险,为防范DDoS攻击,华为云提供了DDoS防护服务。下文讲述如何对接DDoS高防服务来进行抵御DDoS攻击。DDoS攻击详情请参见常见DDoS攻击类型。所有Region都可以配置。可指定保底带宽和弹性带宽。对接高防后,如果开启了WEB基础防护或者CC防护,APIG将无法 - [使用DDoS防护服务为APIG抵御DDoS攻击资源规划](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0005.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [使用DDoS防护服务为APIG抵御DDoS攻击操作流程](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0006.md): 购买DDoS高防购买DDoS高防实例,为对接做准备。购买DDoS高防实例,为对接做准备。接入域名添加域名和证书。添加域名和证书。注册公网域名将防护域名注册到DNS服务上。将防护域名注册到DNS服务上。绑定防护域名将防护域名绑定到API分组上。将防护域名绑定到API分组上。创建API在绑定域名的分组上创建一个API。在绑定域名的分组上创建一 - [使用DDoS防护服务为APIG抵御DDoS攻击实施步骤](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0007.md): 已创建API分组,详细操作请参见《用户指南》。根据业务需求,配置参数信息。详情请参考DDoS高防操作指南。单击“立即购买”,确认产品信息无误后,单击“去支付”。填写域名信息。添加用户网站的防护域名和域名绑定的证书。如果没有域名,可通过域名注册商申请;证书可通过云证书管理服务申请。填写的域名须备案,如果没有备案,请参考域名备案。添加用户网站 - [APIG安全最佳实践](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0062.md): 安全性是华为云与您的共同责任。华为云负责云服务自身的安全,提供安全的云;作为租户,您需要合理使用云服务提供的安全能力对数据进行保护,安全地使用云。详情请参见责任共担。本文提供了APIG使用过程中的安全最佳实践,旨在提供可操作的规范性指导以提升整体安全能力。依据该指导文档,能够持续评估APIG的安全状态,有效结合APIG提供的多种安全功能, - [使用APIG专享版实现请求自定义信息打印到LTS日志流](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0083.md): 默认日志仅记录通用调用信息,无法携带业务维度的请求标识。当出现调用异常时,开发者难以按用户身份、来源渠道等业务关键字段快速检索日志,往往需要跨系统关联多份日志才能定位问题,排查效率低且成本高。API网关支持将API的调用日志推送至LTS日志流,日志采用固定格式并预留自定义字段。用户可以通过自定义日志字段,将请求参数值(如请求头、查询参数、 - [APIG共享版迁移到专享版](https://support.huaweicloud.com/bestpractice-apig/apig-bp-0052.md): APIG共享版即将退市,为了避免影响用户的业务,需要将共享版上已有资源迁移到专享版上继续使用。基于APIG共享版使用了云商店功能暂不支持迁移。基于APIG共享版使用了跨用户授权功能暂不支持迁移。基于APIG共享版使用了ELB通道类型的VPC通道暂不支持迁移。由DataArts创建的共享版资源需要由DataArts服务提供迁移。涉及以上特殊 ## 开发指南 - [使用场景](https://support.huaweicloud.com/devg-apig/apig-dev-180526060.md): API网关主要涉及以下几个开发场景:API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。使用APP认证(签名认证)调用API:API调用者通过API网关提供Key、Secret和SDK,对API请求进行签名认证。使用IAM认证(Token认证)调用API:API调用 - [认证前准备](https://support.huaweicloud.com/devg-apig/apig-dev-180907066.md): APP认证方式调用API,需要提前获取如下信息:获取API的请求信息在APIG实例控制台选择“API管理 > API列表”,单击API名称进入API详情,在“API运行”页签的API名称下方查看API的域名、请求路径和请求方法。在APIG实例控制台选择“API管理 > API列表”,单击API名称进入API详情,在“API运行”页签的AP - [APP认证工作原理](https://support.huaweicloud.com/devg-apig/apig-dev-180307034.md): 构造规范请求。将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。使用规范请求和其他信息创建待签字符串。使用AK/SK和待签字符串计算签名。 - [Java](https://support.huaweicloud.com/devg-apig/apig-dev-180307002.md): 使用Java语言调用APP认证的API时,您需要先获取SDK,然后导入示例代码,最后参考调用API示例调用API。已获取API调用信息,具体参见认证前准备。已安装IDEA 2022.2.1,如果未安装,请至IDEA官方网站下载。已安装JDK8及以上,JDK17以下版本的Java Development Kit,如果未安装,请至Oracle - [Go](https://support.huaweicloud.com/devg-apig/apig-dev-180307015.md): 使用Go语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。本章节以IntelliJ IDEA 2022.2.1版本为例介绍。已获取API的调用信息,具体参见认证前准备。已安装Go安装包1.14或以上版本,如果未安装,请至Go官方下载页面下载。已安装IntelliJ IDEA 2022.2.1 - [Python](https://support.huaweicloud.com/devg-apig/apig-dev-180307016.md): 使用Python语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。本章节以IntelliJ IDEA 2018.3.5版本为例介绍。已获取API的调用信息,具体请参见认证前准备。已安装Python安装包2.7.9或3.X版本,如果未安装,请至Python官方下载页面下载。Python安装完成 - [C#](https://support.huaweicloud.com/devg-apig/apig-dev-180307017.md): 使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。已获取API的调用信息,具体参见认证前准备。已安装Visual Studio 2019 version 16.8.4或以上版本,如果未安装,请至Visual Studio官方网站下载。请在API网关控制台选择“帮助中心 - [JavaScript](https://support.huaweicloud.com/devg-apig/apig-dev-180307018.md): 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。JavaScript SDK支持Node.js、浏览器等运行环境。关于开发环境搭建,本章节以IntelliJ IDEA 2018.3.5版本、搭建Node.js环境为例。浏览器只提供代码示例说明。已获取API调用信息, - [PHP](https://support.huaweicloud.com/devg-apig/apig-dev-180521058.md): 使用PHP语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。本章节以IntelliJ IDEA 2018.3.5版本为例介绍。已获取API的调用信息,具体参见认证前准备。已安装IntelliJ IDEA 2018.3.5或以上版本,如果未安装,请至IntelliJ IDEA官方网站下载。已安 - [C++](https://support.huaweicloud.com/devg-apig/apig-dev-180813064.md): 使用C++语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。已获取API的调用信息,具体参见认证前准备。安装openssl库。apt-get install libssl-dev安装curl库。apt-get install libcurl4-openssl-dev请在API网关控制台选择“帮助中心”,在“S - [C](https://support.huaweicloud.com/devg-apig/apig-dev-180813065.md): 使用C语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。已获取API的调用信息,具体参见认证前准备。安装openssl库。apt-get install libssl-dev安装curl库。apt-get install libcurl4-openssl-dev请在API网关控制台选择“帮助中心”,在“SDK - [Android](https://support.huaweicloud.com/devg-apig/apig-dev-180919068.md): 使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。已获取API的调用信息,具体参见认证前准备。已安装Android Studio 4.1.2或以上版本,如果未安装,请至Android Studio官方网站下载。请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中 - [curl](https://support.huaweicloud.com/devg-apig/apig-dev-180525061.md): 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。已获取API的调用信息,具体参见认证前准备。请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载JavaScript SDK的最新版本,并解压。在浏览 - [Token认证](https://support.huaweicloud.com/devg-apig/apig-dev-180307020.md): 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。Token认证:通过Token认证调用请求。AK/SK认证:通过AK(Access Key ID)/SK(Secret Access K - [AK/SK认证](https://support.huaweicloud.com/devg-apig/apig-dev-180307021.md): 使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。AK:访问密钥ID。与私有访问密钥关联的唯一标识符,访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。SK:与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。如果已生成过AK/SK,则可跳过此步骤,找到原 - [签名前准备](https://support.huaweicloud.com/devg-apig/apig_04_0022.md): 获取签名密钥信息:在APIG控制台选择“API管理 > API策略 > 策略管理”,单击签名密钥名称进入详情页面,在“策略内容”区域查看Key和Secret。 - [Java](https://support.huaweicloud.com/devg-apig/apig-dev-180307037.md): 使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。本章节以IntelliJ IDEA 2018.3.5版本为例介绍。API绑定签名密钥后,发给后端的请求中才会添加签名信息。已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。已获取签名密钥的Key和Se - [Python](https://support.huaweicloud.com/devg-apig/apig-dev-180307036.md): 使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。本章节以IntelliJ IDEA 2018.3.5版本为例介绍。API绑定签名密钥后,发给后端的请求中才会添加签名信息。已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。已获取签名密钥的Key和 - [C#](https://support.huaweicloud.com/devg-apig/apig-dev-190326069.md): 使用C#语言进行后端服务签名时,您需要先获取SDK,然后打开工程,最后参考校验后端签名示例校验签名是否一致。API绑定签名密钥后,发给后端的请求中才会添加签名信息。已获取签名密钥的Key和Secret,请参见签名前准备获取。已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。在API网关控制台选择“帮助中心”,在 ## API参考 - [使用前必读](https://support.huaweicloud.com/api-apig/apig-api-190529263.md): 欢迎使用API网关(API Gateway),API网关为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。您可以使用本文档提供的API对API网关进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。在调用API网关的API前,请确保已经充分了解API网关相关概念,详细信息请参见产品 - [API概览](https://support.huaweicloud.com/api-apig/apig-api-overview02.md): API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 - [构造请求](https://support.huaweicloud.com/api-apig/apig-api-180713011.md): 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。请求URI由如下部分组成。{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传 - [认证鉴权](https://support.huaweicloud.com/api-apig/apig-api-190529268.md): 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。Token认证:通过Token认证调用请求。AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加 - [返回结果](https://support.huaweicloud.com/api-apig/apig-api-190529269.md): 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。对于创建API分组(专享版API)接口,如果调用后返回状态码为201,则表示请求成功。对应请求消息头,响应同样也有消息头,如Content-type。对于创建API分组(专享 - [创建API分组 - CreateApiGroupV2](https://support.huaweicloud.com/api-apig/CreateApiGroupV2.md): API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授 - [修改API分组 - UpdateApiGroupV2](https://support.huaweicloud.com/api-apig/UpdateApiGroupV2.md): 修改API分组属性。其中name和remark可修改,其他属性不可修改。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须 - [删除API分组 - DeleteApiGroupV2](https://support.huaweicloud.com/api-apig/DeleteApiGroupV2.md): 删除指定的API分组。删除API分组前,要先下线并删除分组下的所有API。删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需 - [查询分组详情 - ShowDetailsOfApiGroupV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfApiGroupV2.md): 查询指定分组的详细信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGrou - [查询分组列表 - ListApiGroupsV2](https://support.huaweicloud.com/api-apig/ListApiGroupsV2.md): 查询API分组列表。如果是租户操作,则查询该租户下所有的分组;如果是管理员权限账号操作,则查询的是所有租户的分组。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份 - [校验API分组名称是否存在 - CheckApiGroupsV2](https://support.huaweicloud.com/api-apig/CheckApiGroupsV2.md): 校验API分组名称是否存在。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGr - [创建环境 - CreateEnvironmentV2](https://support.huaweicloud.com/api-apig/CreateEnvironmentV2.md): 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测 - [修改环境 - UpdateEnvironmentV2](https://support.huaweicloud.com/api-apig/UpdateEnvironmentV2.md): 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型 - [删除环境 - DeleteEnvironmentV2](https://support.huaweicloud.com/api-apig/DeleteEnvironmentV2.md): 删除指定的环境。该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。环境上存在已发布的API时,该环境不能被删除。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具 - [查询环境列表 - ListEnvironmentsV2](https://support.huaweicloud.com/api-apig/ListEnvironmentsV2.md): 查询符合条件的环境列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:environ - [新建变量 - CreateEnvironmentVariableV2](https://support.huaweicloud.com/api-apig/CreateEnvironmentVariableV2.md): 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。环境变量定义在API分组上,该分组下的所有API都可以使用这些变量 - [删除变量 - DeleteEnvironmentVariableV2](https://support.huaweicloud.com/api-apig/DeleteEnvironmentVariableV2.md): 删除指定的环境变量。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:environme - [查询变量详情 - ShowDetailsOfEnvironmentVariableV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfEnvironmentVariableV2.md): 查询指定的环境变量的详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:enviro - [查询变量列表 - ListEnvironmentVariablesV2](https://support.huaweicloud.com/api-apig/ListEnvironmentVariablesV2.md): 查询分组下的所有环境变量的列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:env - [修改变量 - UpdateEnvironmentVariableV2](https://support.huaweicloud.com/api-apig/UpdateEnvironmentVariableV2.md): 修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权 - [创建流控策略 - CreateRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/CreateRequestThrottlingPolicyV2.md): 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策 - [修改流控策略 - UpdateRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/UpdateRequestThrottlingPolicyV2.md): 修改指定流控策略的详细信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:reque - [删除流控策略 - DeleteRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/DeleteRequestThrottlingPolicyV2.md): 删除指定的流控策略,以及该流控策略与API的所有绑定关系。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依 - [查询流控策略列表 - ListRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/ListRequestThrottlingPolicyV2.md): 查询所有流控策略的信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:request - [查询流控策略详情 - ShowDetailsOfRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfRequestThrottlingPolicyV2.md): 查询指定流控策略的详细信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:reque - [批量删除流控策略 - BatchDeleteThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/BatchDeleteThrottlingPolicyV2.md): 批量删除流控策略。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:requestThr - [创建API - CreateApiV2](https://support.huaweicloud.com/api-apig/CreateApiV2.md): 添加一个API,API即一个服务接口,具体的服务能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。API的真实后端服务目前支持四种类型:传统的HTTP/HTTPS形式的web后端、 - [修改API - UpdateApiV2](https://support.huaweicloud.com/api-apig/UpdateApiV2.md): 修改指定API的信息,包括后端服务信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig - [删除API - DeleteApiV2](https://support.huaweicloud.com/api-apig/DeleteApiV2.md): 删除指定的API。删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略 - [发布或下线API - CreateOrDeletePublishRecordForApiV2](https://support.huaweicloud.com/api-apig/CreateOrDeletePublishRecordForApiV2.md): 对API进行发布或下线。发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户 - [查询API详情 - ShowDetailsOfApiV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfApiV2.md): 查询指定的API的详细信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api:g - [查询API列表 - ListApisV2](https://support.huaweicloud.com/api-apig/ListApisV2.md): 查询API列表,返回API详细信息、发布信息等,但不能查询到后端服务信息和API请求参数信息请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级 - [批量删除API - BatchDeleteApisV2](https://support.huaweicloud.com/api-apig/BatchDeleteApisV2.md): 批量删除api。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api:batchDe - [校验API定义 - CheckApisV2](https://support.huaweicloud.com/api-apig/CheckApisV2.md): 校验API定义。校验API的路径或名称是否已存在请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项 - [调试API - DebugApiV2](https://support.huaweicloud.com/api-apig/DebugApiV2.md): 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为 - [批量发布或下线API - BatchPublishOrOfflineApiV2](https://support.huaweicloud.com/api-apig/BatchPublishOrOfflineApiV2.md): 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件 - [查询API历史版本列表 - ListApiVersionsV2](https://support.huaweicloud.com/api-apig/ListApiVersionsV2.md): 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须 - [切换API版本 - ChangeApiVersionV2](https://support.huaweicloud.com/api-apig/ChangeApiVersionV2.md): API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求 - [查询API运行时定义 - ListApiRuntimeDefinitionV2](https://support.huaweicloud.com/api-apig/ListApiRuntimeDefinitionV2.md): 查询指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。API的定义分为临时定义和运行时定义,分别代表如下含义:临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态运行时定义:API在发布到某个环境时,对发布时的API的临时定 - [查询版本详情 - ListApiVersionDetailV2](https://support.huaweicloud.com/api-apig/ListApiVersionDetailV2.md): 查询某个指定的版本详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api:get - [根据版本编号下线API - DeleteApiByVersionIdV2](https://support.huaweicloud.com/api-apig/DeleteApiByVersionIdV2.md): 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别 - [创建签名密钥 - CreateSignatureKeyV2](https://support.huaweicloud.com/api-apig/CreateSignatureKeyV2.md): 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。其中,签名密钥就是API安全保护机制的一种。租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收 - [修改签名密钥 - UpdateSignatureKeyV2](https://support.huaweicloud.com/api-apig/UpdateSignatureKeyV2.md): 修改指定签名密钥的详细信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:signa - [删除签名密钥 - DeleteSignatureKeyV2](https://support.huaweicloud.com/api-apig/DeleteSignatureKeyV2.md): 删除指定的签名密钥,删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源 - [查询签名密钥列表 - ListSignatureKeysV2](https://support.huaweicloud.com/api-apig/ListSignatureKeysV2.md): 查询所有签名密钥的信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:signatu - [绑定签名密钥 - AssociateSignatureKeyV2](https://support.huaweicloud.com/api-apig/AssociateSignatureKeyV2.md): 签名密钥创建后,需要绑定到API才能生效。将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。请参见如何调用API - [解除API与签名密钥的绑定关系 - DisassociateSignatureKeyV2](https://support.huaweicloud.com/api-apig/DisassociateSignatureKeyV2.md): 解除API与签名密钥的绑定关系。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api - [查询API绑定的签名密钥列表 - ListSignatureKeysBindedToApiV2](https://support.huaweicloud.com/api-apig/ListSignatureKeysBindedToApiV2.md): 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源 - [查询签名密钥未绑定的API列表 - ListApisNotBoundWithSignatureKeyV2](https://support.huaweicloud.com/api-apig/ListApisNotBoundWithSignatureKeyV2.md): 查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源 - [查询签名密钥绑定的API列表 - ListApisBindedToSignatureKeyV2](https://support.huaweicloud.com/api-apig/ListApisBindedToSignatureKeyV2.md): 查询某个签名密钥上已经绑定的API列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig - [绑定流控策略 - AssociateRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/AssociateRequestThrottlingPolicyV2.md): 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略 - [解除API与流控策略的绑定关系 - DisassociateRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/DisassociateRequestThrottlingPolicyV2.md): 解除API与流控策略的绑定关系。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api - [查询流控策略绑定的API列表 - ListApisBindedToRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/ListApisBindedToRequestThrottlingPolicyV2.md): 查询某个流控策略上已经绑定的API列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig - [查询流控策略未绑定的API列表 - ListApisUnbindedToRequestThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/ListApisUnbindedToRequestThrottlingPolicyV2.md): 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别 - [查询API绑定的流控策略列表 - ListRequestThrottlingPoliciesBindedToApiV2](https://support.huaweicloud.com/api-apig/ListRequestThrottlingPoliciesBindedToApiV2.md): 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须) - [批量解绑流控策略 - BatchDisassociateThrottlingPolicyV2](https://support.huaweicloud.com/api-apig/BatchDisassociateThrottlingPolicyV2.md): 批量解除API与流控策略的绑定关系请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:ap - [创建特殊设置 - CreateSpecialThrottlingConfigurationV2](https://support.huaweicloud.com/api-apig/CreateSpecialThrottlingConfigurationV2.md): 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。为流控策略添加一个特殊设置的对象,可以是AP - [修改特殊设置 - UpdateSpecialThrottlingConfigurationV2](https://support.huaweicloud.com/api-apig/UpdateSpecialThrottlingConfigurationV2.md): 修改某个流控策略下的某个特殊设置。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:re - [删除特殊设置 - DeleteSpecialThrottlingConfigurationV2](https://support.huaweicloud.com/api-apig/DeleteSpecialThrottlingConfigurationV2.md): 删除某个流控策略的某个特殊配置。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:req - [查询特殊设置列表 - ListSpecialThrottlingConfigurationsV2](https://support.huaweicloud.com/api-apig/ListSpecialThrottlingConfigurationsV2.md): 查询给流控策略设置的特殊配置。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:requ - [APP授权 - CreateAuthorizingAppsV2](https://support.huaweicloud.com/api-apig/CreateAuthorizingAppsV2.md): APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权 - [解除授权 - CancelingAuthorizationV2](https://support.huaweicloud.com/api-apig/CancelingAuthorizationV2.md): 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须 - [查询APP已绑定的API列表 - ListApisBindedToAppV2](https://support.huaweicloud.com/api-apig/ListApisBindedToAppV2.md): 查询APP已经绑定的API列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app - [查询APP未绑定的API列表 - ListApisUnbindedToAppV2](https://support.huaweicloud.com/api-apig/ListApisUnbindedToAppV2.md): 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型 - [查询API已绑定的APP列表 - ListAppsBindedToApiV2](https://support.huaweicloud.com/api-apig/ListAppsBindedToApiV2.md): 查询API绑定的APP列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api:l - [查询API概况 - ListApiQuantitiesV2](https://support.huaweicloud.com/api-apig/ListApiQuantitiesV2.md): 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限 - [查询API分组概况 - ListApiGroupsQuantitiesV2](https://support.huaweicloud.com/api-apig/ListApiGroupsQuantitiesV2.md): 查询租户名下的API分组概况。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:inst - [查询APP概况 - ListAppQuantitiesV2](https://support.huaweicloud.com/api-apig/ListAppQuantitiesV2.md): 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问 - [绑定域名 - AssociateDomainV2](https://support.huaweicloud.com/api-apig/AssociateDomainV2.md): 用户自定义的域名,需要增加A记录才能生效,具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授 - [绑定域名证书 - AssociateCertificateV2](https://support.huaweicloud.com/api-apig/AssociateCertificateV2.md): 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。本章节主要介绍为特定域名绑定证书。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API, - [修改域名 - UpdateDomainV2](https://support.huaweicloud.com/api-apig/UpdateDomainV2.md): 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备 - [解绑域名 - DisassociateDomainV2](https://support.huaweicloud.com/api-apig/DisassociateDomainV2.md): 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必 - [设置调试域名是否可以访问 - UpdateSlDomainSettingV2](https://support.huaweicloud.com/api-apig/UpdateSlDomainSettingV2.md): 禁用或启用API分组绑定的调试域名请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:ap - [删除域名证书 - DisassociateCertificateV2](https://support.huaweicloud.com/api-apig/DisassociateCertificateV2.md): 如果域名证书不再需要或者已过期,则可以删除证书内容。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略 - [查询域名证书 - ShowDetailsOfDomainNameCertificateV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfDomainNameCertificateV2.md): 查询域名下绑定的证书详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGro - [创建ACL策略 - CreateAclStrategyV2](https://support.huaweicloud.com/api-apig/CreateAclStrategyV2.md): 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com”之类的网络域名。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当 - [修改ACL策略 - UpdateAclStrategyV2](https://support.huaweicloud.com/api-apig/UpdateAclStrategyV2.md): 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身 - [删除ACL策略 - DeleteAclV2](https://support.huaweicloud.com/api-apig/DeleteAclV2.md): 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必 - [批量删除ACL策略 - BatchDeleteAclV2](https://support.huaweicloud.com/api-apig/BatchDeleteAclV2.md): 批量删除指定的多个ACL策略。删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访 - [查询ACL策略详情 - ShowDetailsOfAclPolicyV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfAclPolicyV2.md): 查询指定ACL策略的详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:acl:ge - [查询ACL策略列表 - ListAclStrategiesV2](https://support.huaweicloud.com/api-apig/ListAclStrategiesV2.md): 查询所有的ACL策略列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:acl:li - [将API与ACL策略进行绑定 - CreateApiAclBindingV2](https://support.huaweicloud.com/api-apig/CreateApiAclBindingV2.md): 将API与ACL策略进行绑定。同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如 - [解除API与ACL策略的绑定 - DeleteApiAclBindingV2](https://support.huaweicloud.com/api-apig/DeleteApiAclBindingV2.md): 解除某条API与ACL策略的绑定关系请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:a - [批量解除API与ACL策略的绑定 - BatchDeleteApiAclBindingV2](https://support.huaweicloud.com/api-apig/BatchDeleteApiAclBindingV2.md): 批量解除API与ACL策略的绑定请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api - [查询ACL策略绑定的API列表 - ListApisBindedToAclPolicyV2](https://support.huaweicloud.com/api-apig/ListApisBindedToAclPolicyV2.md): 查询ACL策略绑定的API列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:acl: - [查询ACL策略未绑定的API列表 - ListApisUnbindedToAclPolicyV2](https://support.huaweicloud.com/api-apig/ListApisUnbindedToAclPolicyV2.md): 查询ACL策略未绑定的API列表,需要API已发布请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权 - [查询API绑定的ACL策略列表 - ListAclPolicyBindedToApiV2](https://support.huaweicloud.com/api-apig/ListAclPolicyBindedToApiV2.md): 查询API绑定的ACL策略列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:api: - [创建自定义认证 - CreateCustomAuthorizerV2](https://support.huaweicloud.com/api-apig/CreateCustomAuthorizerV2.md): 创建自定义认证请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:customAuthor - [修改自定义认证 - UpdateCustomAuthorizerV2](https://support.huaweicloud.com/api-apig/UpdateCustomAuthorizerV2.md): 修改自定义认证请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:customAuthor - [删除自定义认证 - DeleteCustomAuthorizerV2](https://support.huaweicloud.com/api-apig/DeleteCustomAuthorizerV2.md): 删除自定义认证请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:customAuthor - [查询自定义认证详情 - ShowDetailsOfCustomAuthorizersV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfCustomAuthorizersV2.md): 查询自定义认证详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:customAuth - [查询自定义认证列表 - ListCustomAuthorizersV2](https://support.huaweicloud.com/api-apig/ListCustomAuthorizersV2.md): 查询自定义认证列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:customAuth - [导出API - ExportApiDefinitionsV2](https://support.huaweicloud.com/api-apig/ExportApiDefinitionsV2.md): 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授 - [导入API - ImportApiDefinitionsV2](https://support.huaweicloud.com/api-apig/ImportApiDefinitionsV2.md): 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使 - [创建VPC通道 - CreateVpcChannelV2](https://support.huaweicloud.com/api-apig/CreateVpcChannelV2.md): 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。每个用户最多创建30个VPC通道。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请 - [更新VPC通道 - UpdateVpcChannelV2](https://support.huaweicloud.com/api-apig/UpdateVpcChannelV2.md): 更新指定VPC通道的参数使用传入的后端实例列表对VPC通道进行全量覆盖,如果后端实例列表为空,则会全量删除已有的后端实例;使用传入的后端服务器组列表对VPC通道进行全量覆盖,如果后端服务器组列表为空,则会全量删除已有的服务器组;请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备 - [删除VPC通道 - DeleteVpcChannelV2](https://support.huaweicloud.com/api-apig/DeleteVpcChannelV2.md): 删除指定的VPC通道请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:loadBalan - [查询VPC通道详情 - ShowDetailsOfVpcChannelV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfVpcChannelV2.md): 查询指定的VPC通道详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:loadBal - [查询VPC通道列表 - ListVpcChannelsV2](https://support.huaweicloud.com/api-apig/ListVpcChannelsV2.md): 查询VPC通道列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:loadBalanc - [添加或更新后端实例 - AddingBackendInstancesV2](https://support.huaweicloud.com/api-apig/AddingBackendInstancesV2.md): 为指定的VPC通道添加后端实例如果指定地址的后端实例已存在,则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。引用负载通道类型的负载通道不支持添加或更新后端实例。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用 - [查询后端实例列表 - ListBackendInstancesV2](https://support.huaweicloud.com/api-apig/ListBackendInstancesV2.md): 查询指定VPC通道的后端实例列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:lo - [更新后端实例 - UpdateBackendInstancesV2](https://support.huaweicloud.com/api-apig/UpdateBackendInstancesV2.md): 更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。如果未指定修改的云服务器组,则进行全量覆盖。引用负载通道类型的负载通道不支持更新后端实例。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策 - [删除后端实例 - DeleteBackendInstanceV2](https://support.huaweicloud.com/api-apig/DeleteBackendInstanceV2.md): 删除指定VPC通道中的后端实例引用负载通道类型的负载通道不支持删除后端实例。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为 - [批量修改后端服务器状态可用 - BatchEnableMembers](https://support.huaweicloud.com/api-apig/BatchEnableMembers.md): 批量修改后端服务器状态可用。引用负载通道类型的负载通道不支持修改后端服务器状态可用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类 - [批量修改后端服务器状态不可用 - BatchDisableMembers](https://support.huaweicloud.com/api-apig/BatchDisableMembers.md): 批量修改后端服务器状态不可用。引用负载通道类型的负载通道不支持修改后端服务器状态不可用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资 - [修改VPC通道健康检查 - UpdateHealthCheck](https://support.huaweicloud.com/api-apig/UpdateHealthCheck.md): 修改VPC通道健康检查。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:loadBal - [添加或更新VPC通道后端服务器组 - CreateMemberGroup](https://support.huaweicloud.com/api-apig/CreateMemberGroup.md): 在APIG中创建VPC通道后端服务器组,VPC通道后端实例可以选择是否关联后端实例服务器组,以便管理后端服务器节点。如果指定名称的后端服务器组已存在,则更新对应后端服务器组信息。如果请求体中包含多个重复名称的后端服务器定义,则使用第一个定义。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该I - [查询VPC通道后端云服务组列表 - ListMemberGroups](https://support.huaweicloud.com/api-apig/ListMemberGroups.md): 查询VPC通道后端云服务组列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:load - [查询VPC通道后端服务器组详情 - ShowDetailsOfMemberGroup](https://support.huaweicloud.com/api-apig/ShowDetailsOfMemberGroup.md): 查询指定的VPC通道后端服务器组详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:l - [删除VPC通道后端服务器组 - DeleteMemberGroup](https://support.huaweicloud.com/api-apig/DeleteMemberGroup.md): 删除指定的VPC通道后端服务器组请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:loa - [更新VPC通道后端服务器组 - UpdateMemberGroup](https://support.huaweicloud.com/api-apig/UpdateMemberGroup.md): 更新指定VPC通道后端服务器组。当负载通道为nacos微服务类型时,不支持修改服务器组权重。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级 - [API统计信息查询-最近一段时间 - ListLatelyApiStatisticsV2](https://support.huaweicloud.com/api-apig/ListLatelyApiStatisticsV2.md): 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份 - [查询监控数据 - ListMetricData](https://support.huaweicloud.com/api-apig/ListMetricData.md): 查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型 - [分组统计信息查询-最近一小时内 - ListLatelyGroupStatisticsV2](https://support.huaweicloud.com/api-apig/ListLatelyGroupStatisticsV2.md): 根据API分组的编号查询该分组下所有API被调用的总次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身 - [创建分组自定义响应 - CreateGatewayResponseV2](https://support.huaweicloud.com/api-apig/CreateGatewayResponseV2.md): 新增分组下自定义响应请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGroup: - [查询分组自定义响应详情 - ShowDetailsOfGatewayResponseV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfGatewayResponseV2.md): 查询分组自定义响应详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGroup - [修改分组自定义响应 - UpdateGatewayResponseV2](https://support.huaweicloud.com/api-apig/UpdateGatewayResponseV2.md): 修改分组自定义响应请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGroup:u - [删除分组自定义响应 - DeleteGatewayResponseV2](https://support.huaweicloud.com/api-apig/DeleteGatewayResponseV2.md): 删除分组自定义响应请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGroup:d - [查询分组下指定错误类型的自定义响应 - ShowDetailsOfGatewayResponseTypeV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfGatewayResponseTypeV2.md): 查询分组下指定错误类型的自定义响应请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:ap - [修改分组下指定错误类型的自定义响应 - UpdateGatewayResponseTypeV2](https://support.huaweicloud.com/api-apig/UpdateGatewayResponseTypeV2.md): 修改分组下指定错误类型的自定义响应。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:a - [删除分组指定错误类型的自定义响应配置 - DeleteGatewayResponseTypeV2](https://support.huaweicloud.com/api-apig/DeleteGatewayResponseTypeV2.md): 删除分组指定错误类型的自定义响应配置,还原为使用默认值的配置。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别 - [查询分组自定义响应列表 - ListGatewayResponsesV2](https://support.huaweicloud.com/api-apig/ListGatewayResponsesV2.md): 查询分组自定义响应列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:apiGroup - [查询API的标签列表 - ListTagsV2](https://support.huaweicloud.com/api-apig/ListTagsV2.md): 查询API的标签列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance - [实例配置特性 - CreateFeatureV2](https://support.huaweicloud.com/api-apig/CreateFeatureV2.md): 为实例配置需要的特性。支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策 - [查询实例特性列表 - ListFeaturesV2](https://support.huaweicloud.com/api-apig/ListFeaturesV2.md): 查询实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见 - [查询实例支持的特性列表 - ListInstanceFeatures](https://support.huaweicloud.com/api-apig/ListInstanceFeatures.md): 查询实例支持的特性列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instanc - [查询某个实例的租户配置列表 - ListProjectCofigsV2](https://support.huaweicloud.com/api-apig/ListProjectCofigsV2.md): 查询某个实例的租户配置列表,用户可以通过此接口查询各类型资源配置及使用情况。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。GET /v2/{p - [查询租户实例配置列表 - ListInstanceConfigsV2](https://support.huaweicloud.com/api-apig/ListInstanceConfigsV2.md): 查询租户实例配置列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。GET /v2/{project_id}/apigw/instance/co - [创建专享版实例(按需) - CreateInstanceV2](https://support.huaweicloud.com/api-apig/CreateInstanceV2.md): 创建按需专享版实例请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:c - [查询专享版实例详情 - ShowDetailsOfInstanceV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfInstanceV2.md): 查询专享版实例详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:g - [更新专享版实例 - UpdateInstanceV2](https://support.huaweicloud.com/api-apig/UpdateInstanceV2.md): 更新专享版实例请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:upd - [查询专享版实例创建进度 - ShowDetailsOfInstanceProgressV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfInstanceProgressV2.md): 查询专享版实例创建进度请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance - [实例更新或绑定EIP - AddEipV2](https://support.huaweicloud.com/api-apig/AddEipV2.md): 实例更新或绑定EIP(仅当实例为LVS类型时支持)请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权 - [实例解绑EIP - RemoveEipV2](https://support.huaweicloud.com/api-apig/RemoveEipV2.md): 实例解绑EIP请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:unb - [开启实例公网出口 - AddEngressEipV2](https://support.huaweicloud.com/api-apig/AddEngressEipV2.md): 实例开启公网出口。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别 - [更新实例出公网带宽 - UpdateEngressEipV2](https://support.huaweicloud.com/api-apig/UpdateEngressEipV2.md): 更新实例出公网带宽。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键 - [关闭实例公网出口 - RemoveEngressEipV2](https://support.huaweicloud.com/api-apig/RemoveEngressEipV2.md): 关闭实例公网出口。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别 - [开启实例公网入口 - AddIngressEipV2](https://support.huaweicloud.com/api-apig/AddIngressEipV2.md): 开启实例开启公网入口,仅当实例为ELB类型时支持。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问 - [更新实例入公网带宽 - UpdateIngressEipV2](https://support.huaweicloud.com/api-apig/UpdateIngressEipV2.md): 更新实例入公网带宽,仅当实例为ELB类型时支持。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级 - [关闭实例公网入口 - RemoveIngressEipV2](https://support.huaweicloud.com/api-apig/RemoveIngressEipV2.md): 关闭实例公网入口,仅当实例为ELB类型时支持。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别 - [查询可用区信息 - ListAvailableZonesV2](https://support.huaweicloud.com/api-apig/ListAvailableZonesV2.md): 查询可用区信息请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。GET /v2/{project_id}/apigw/available-zone - [查询专享版实例列表 - ListInstancesV2](https://support.huaweicloud.com/api-apig/ListInstancesV2.md): 查询专享版实例列表当IAM用户不具有apig:instances:list角色与策略权限或apig:instance:list身份策略权限时,调用当前API将返回一个空列表,而不是权限错误信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色 - [删除专享版实例 - DeleteInstancesV2](https://support.huaweicloud.com/api-apig/DeleteInstancesV2.md): 删除专享版实例请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:del - [登记实例入口IP信息 - RegisterIngressIps](https://support.huaweicloud.com/api-apig/RegisterIngressIps.md): 登记实例入口IP信息,仅当实例为NLB系列规格时支持。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的 - [注销实例入口IP信息 - UnregisterIngressIps](https://support.huaweicloud.com/api-apig/UnregisterIngressIps.md): 注销实例入口IP信息,仅当实例为NLB系列规格时支持。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的 - [批量添加负载均衡器 - BatchAddExtraElbs](https://support.huaweicloud.com/api-apig/BatchAddExtraElbs.md): 批量添加负载均衡器,仅当实例为NLB系列规格时支持。当添加的弹性负载均衡器中已有监听端口为80、443或在APIG配置的自定义端口的监听器时,force_overwrite_enabled必须置为true,否则无法正常添加该ELB。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需 - [查看负载均衡器列表 - ListExtraElbs](https://support.huaweicloud.com/api-apig/ListExtraElbs.md): 查看负载均衡器列表,仅当实例为NLB系列规格时支持。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授 - [批量解绑负载均衡器 - BatchDisassociateExtraElbs](https://support.huaweicloud.com/api-apig/BatchDisassociateExtraElbs.md): 批量解绑负载均衡器,仅当实例为NLB系列规格时支持。解绑时,会同时删除监听端口为80、443或在APIG配置的自定义端口的监听器。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权 - [创建专享版实例(包周期) - CreateOrder](https://support.huaweicloud.com/api-apig/CreateOrder.md): 创建包周期专享版实例。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig::createP - [创建包周期规格变更订单 - CreatePrepayResize](https://support.huaweicloud.com/api-apig/CreatePrepayResize.md): 创建包周期规格变更订单。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instanc - [按需规格变更 - CreatePostPayResizeOrder](https://support.huaweicloud.com/api-apig/CreatePostPayResizeOrder.md): 创建按需规格变更订单。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance - [查询实例约束信息 - ShowRestrictionOfInstanceV2](https://support.huaweicloud.com/api-apig/ShowRestrictionOfInstanceV2.md): 查询实例约束信息请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:ge - [查询实例终端节点连接列表 - ListEndpointConnections](https://support.huaweicloud.com/api-apig/ListEndpointConnections.md): 查询实例终端节点连接列表。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须) - [接受或拒绝终端节点连接 - AcceptOrRejectEndpointConnections](https://support.huaweicloud.com/api-apig/AcceptOrRejectEndpointConnections.md): 接受或拒绝实例节点连接。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条 - [查询实例的终端节点服务的白名单列表 - ListEndpointPermissions](https://support.huaweicloud.com/api-apig/ListEndpointPermissions.md): 查询当前实例终端节点服务的白名单列表。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型 - [批量添加实例终端节点连接白名单 - AddEndpointPermissions](https://support.huaweicloud.com/api-apig/AddEndpointPermissions.md): 批量添加实例终端节点连接白名单。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为 - [批量删除实例终端节点连接白名单 - DeleteEndpointPermissions](https://support.huaweicloud.com/api-apig/DeleteEndpointPermissions.md): 批量删除实例终端节点连接白名单。当实例规格为NLB系列规格时,不支持该接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为 - [查询项目下所有实例标签 - ListProjectInstanceTags](https://support.huaweicloud.com/api-apig/ListProjectInstanceTags.md): 查询项目下所有实例标签。使用策略授权用户时,需要包含apig:instanceTags:list的授权项才允许调用此接口请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如 - [查询单个实例标签 - ListInstanceTags](https://support.huaweicloud.com/api-apig/ListInstanceTags.md): 查询单个实例的标签。使用策略授权用户时,需要包含apig:instanceTags:list、apig:instances:get的授权项才允许调用此接口请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权 - [批量添加或删除单个实例的标签 - BatchCreateOrDeleteInstanceTags](https://support.huaweicloud.com/api-apig/BatchCreateOrDeleteInstanceTags.md): 批量添加或删除单个实例的标签。使用策略授权用户时,需要包含apig:instances:get、apig:instanceTags:create、apig:instanceTags:delete的授权项才允许调用此接口请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API - [查询包含指定标签的实例数量 - ShowInstancesNumByTags](https://support.huaweicloud.com/api-apig/ShowInstancesNumByTags.md): 查询包含指定标签的实例数量。使用策略授权用户时,需要包含apig:instance:getNumByTags的授权项才允许调用此接口。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略 - [通过标签查询实例列表 - ListInstancesByTags](https://support.huaweicloud.com/api-apig/ListInstancesByTags.md): 通过标签查询实例列表使用策略授权用户时,需要包含apig:instance:listByTags的授权项才允许调用此接口.请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备 - [导入微服务 - ImportMicroservice](https://support.huaweicloud.com/api-apig/ImportMicroservice.md): 导入微服务。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:instance:impo - [获取SSL证书列表 - ListCertificatesV2](https://support.huaweicloud.com/api-apig/ListCertificatesV2.md): 获取SSL证书列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:certifica - [创建SSL证书 - CreateCertificateV2](https://support.huaweicloud.com/api-apig/CreateCertificateV2.md): 创建SSL证书。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:certificate - [域名绑定SSL证书 - BatchAssociateCertsV2](https://support.huaweicloud.com/api-apig/BatchAssociateCertsV2.md): 域名绑定SSL证书。目前暂时仅支持单个绑定,请求体当中的certificate_ids里面有且只能有一个证书ID。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具 - [域名解绑SSL证书 - BatchDisassociateCertsV2](https://support.huaweicloud.com/api-apig/BatchDisassociateCertsV2.md): 域名解绑SSL证书。目前暂时仅支持单个解绑,请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要 - [查询证书详情 - ShowDetailsOfCertificateV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfCertificateV2.md): 查询证书详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:certificate: - [删除SSL证书 - DeleteCertificateV2](https://support.huaweicloud.com/api-apig/DeleteCertificateV2.md): 删除ssl证书接口,删除时只有没有关联域名的证书才能被删除。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名 - [修改SSL证书 - UpdateCertificateV2](https://support.huaweicloud.com/api-apig/UpdateCertificateV2.md): 修改SSL证书。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:certificate - [SSL证书绑定域名 - BatchAssociateDomainsV2](https://support.huaweicloud.com/api-apig/BatchAssociateDomainsV2.md): SSL证书绑定域名。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策 - [SSL证书解绑域名 - BatchDisassociateDomainsV2](https://support.huaweicloud.com/api-apig/BatchDisassociateDomainsV2.md): SSL证书解绑域名。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(* - [获取SSL证书已绑定域名列表 - ListAttachedDomainsV2](https://support.huaweicloud.com/api-apig/ListAttachedDomainsV2.md): 获取SSL证书已绑定域名列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:cert - [创建插件 - CreatePlugin](https://support.huaweicloud.com/api-apig/CreatePlugin.md): 创建插件信息。插件不允许重名插件不允许重名插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授 - [修改插件 - UpdatePlugin](https://support.huaweicloud.com/api-apig/UpdatePlugin.md): 修改插件信息。插件不允许重名插件不允许重名插件不支持修改类型和可见范围插件不支持修改类型和可见范围请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项 - [删除插件 - DeletePlugin](https://support.huaweicloud.com/api-apig/DeletePlugin.md): 删除插件。必须先解除API和插件的绑定关系,否则删除报错必须先解除API和插件的绑定关系,否则删除报错请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授 - [查询插件列表 - ListPlugins](https://support.huaweicloud.com/api-apig/ListPlugins.md): 查询一组符合条件的API网关插件详情。支持分页支持分页支持根据插件类型查询支持根据插件类型查询支持根据插件可见范围查询支持根据插件可见范围查询支持根据插件编码查询支持根据插件编码查询支持根据名称模糊查询支持根据名称模糊查询请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用A - [查询插件详情 - ShowPlugin](https://support.huaweicloud.com/api-apig/ShowPlugin.md): 查询插件详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:plugin:getRe - [插件绑定API - AttachApiToPlugin](https://support.huaweicloud.com/api-apig/AttachApiToPlugin.md): 绑定插件到API上。只能选择发布状态的API只能选择发布状态的API绑定以后及时生效绑定以后及时生效修改插件后及时生效修改插件后及时生效相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。请参见如何调用API。账 - [API绑定插件 - AttachPluginToApi](https://support.huaweicloud.com/api-apig/AttachPluginToApi.md): 绑定插件到API上。只能选择发布状态的API只能选择发布状态的API绑定以后及时生效绑定以后及时生效修改插件后及时生效修改插件后及时生效相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。请参见如何调用API。账 - [解除绑定插件的API - DetachApiFromPlugin](https://support.huaweicloud.com/api-apig/DetachApiFromPlugin.md): 解除绑定在插件上的API。解绑及时生效解绑及时生效请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权 - [解除绑定API的插件 - DetachPluginFromApi](https://support.huaweicloud.com/api-apig/DetachPluginFromApi.md): 解除绑定在API上的插件。解绑及时生效解绑及时生效请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权 - [查询插件下绑定的API - ListPluginAttachedApis](https://support.huaweicloud.com/api-apig/ListPluginAttachedApis.md): 查询指定插件下绑定的API信息。用于查询指定插件下已经绑定的API列表信息用于查询指定插件下已经绑定的API列表信息支持分页返回支持分页返回支持API名称模糊查询支持API名称模糊查询绑定关系列表中返回的API在对应的环境中可能已经下线绑定关系列表中返回的API在对应的环境中可能已经下线请参见如何调用API。账号具备所有API的调用权限, - [查询API下绑定的插件 - ListApiAttachedPlugins](https://support.huaweicloud.com/api-apig/ListApiAttachedPlugins.md): 查询指定API下绑定的插件信息。用于查询指定API下已经绑定的插件列表信息用于查询指定API下已经绑定的插件列表信息支持分页返回支持分页返回支持插件名称模糊查询支持插件名称模糊查询请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具 - [查询可绑定当前插件的API - ListPluginAttachableApis](https://support.huaweicloud.com/api-apig/ListPluginAttachableApis.md): 查询可绑定当前插件的API信息。支持分页返回支持分页返回支持API名称模糊查询支持API名称模糊查询支持已绑定其他插件的API查询返回支持已绑定其他插件的API查询返回请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请 - [查询可绑定当前API的插件 - ListApiAttachablePlugins](https://support.huaweicloud.com/api-apig/ListApiAttachablePlugins.md): 查询可绑定当前API的插件信息。支持分页返回支持分页返回支持插件名称模糊查询支持插件名称模糊查询请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访 - [创建APP - CreateAnAppV2](https://support.huaweicloud.com/api-apig/CreateAnAppV2.md): 创建一个APP。APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权 - [修改APP - UpdateAppV2](https://support.huaweicloud.com/api-apig/UpdateAppV2.md): 修改指定APP的信息。其中可修改的属性为:name、remark、related_domain_id、related_project_id,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当 - [删除APP - DeleteAppV2](https://support.huaweicloud.com/api-apig/DeleteAppV2.md): 删除指定的APP。APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访 - [重置密钥 - ResettingAppSecretV2](https://support.huaweicloud.com/api-apig/ResettingAppSecretV2.md): 重置指定APP的密钥。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:rese - [校验APP - CheckAppV2](https://support.huaweicloud.com/api-apig/CheckAppV2.md): 校验app是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、remark,其他信息不显示。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。 - [查询APP详情 - ShowDetailsOfAppV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfAppV2.md): 查询指定APP的详细信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:ge - [查询APP列表 - ListAppsV2](https://support.huaweicloud.com/api-apig/ListAppsV2.md): 查询APP列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:listLis - [创建APP Code - CreateAppCodeV2](https://support.huaweicloud.com/api-apig/CreateAppCodeV2.md): App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级 - [自动生成APP Code - CreateAppCodeAutoV2](https://support.huaweicloud.com/api-apig/CreateAppCodeAutoV2.md): 创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须 - [删除APP Code - DeleteAppCodeV2](https://support.huaweicloud.com/api-apig/DeleteAppCodeV2.md): 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类 - [查询APP Code详情 - ShowDetailsOfAppCodeV2](https://support.huaweicloud.com/api-apig/ShowDetailsOfAppCodeV2.md): App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级 - [查询APP Code列表 - ListAppCodesV2](https://support.huaweicloud.com/api-apig/ListAppCodesV2.md): 查询App Code列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:li - [查询凭据关联的凭据配额 - ShowAppBoundAppQuota](https://support.huaweicloud.com/api-apig/ShowAppBoundAppQuota.md): 查询指定凭据关联的凭据配额。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:g - [设置APP的访问控制 - UpdateAppAcl](https://support.huaweicloud.com/api-apig/UpdateAppAcl.md): 设置凭据的访问控制。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:updat - [查询APP的访问控制详情 - ShowDetailsOfAppAcl](https://support.huaweicloud.com/api-apig/ShowDetailsOfAppAcl.md): 查询APP的访问控制详情。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:ge - [删除APP的访问控制 - DeleteAppAcl](https://support.huaweicloud.com/api-apig/DeleteAppAcl.md): 删除凭据的访问控制信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:app:del - [创建AIAPIKey - CreateAiApiKey](https://support.huaweicloud.com/api-apig/CreateAiApiKey.md): 创建AIAPIKey,适用于AI场景下的API Key认证。AIAPIKey功能,需要开启白名单后才可以使用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略 - [查询AIAPIKey列表 - ListAiApiKeys](https://support.huaweicloud.com/api-apig/ListAiApiKeys.md): 查询AIAPIKey列表。AIAPIKey功能,需要开启白名单后才可以使用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为 - [查询AIAPIKey详情 - ShowDetailsOfAiApiKey](https://support.huaweicloud.com/api-apig/ShowDetailsOfAiApiKey.md): 查询AIAPIKey详情。AIAPIKey功能,需要开启白名单后才可以使用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为 - [删除AIAPIKey - DeleteAiApiKey](https://support.huaweicloud.com/api-apig/DeleteAiApiKey.md): 删除AIAPIKey。删除后,将无法使用该AIAPIKey进行认证。AIAPIKey功能,需要开启白名单后才可以使用。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下 - [创建凭据配额 - CreateAppQuota](https://support.huaweicloud.com/api-apig/CreateAppQuota.md): 创建凭据配额请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:clientQuota:c - [获取凭据配额详情 - ShowAppQuota](https://support.huaweicloud.com/api-apig/ShowAppQuota.md): 获取凭据配额详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:clientQuota - [获取凭据配额列表 - ListAppQuotas](https://support.huaweicloud.com/api-apig/ListAppQuotas.md): 获取凭据配额列表。支持根据名称模糊查询请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig: - [修改凭据配额 - UpdateAppQuota](https://support.huaweicloud.com/api-apig/UpdateAppQuota.md): 修改凭据配额请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:clientQuota:u - [删除凭据配额 - DeleteAppQuota](https://support.huaweicloud.com/api-apig/DeleteAppQuota.md): 删除凭据配额。删除凭据配额时,同时删除凭据配额和凭据的关联关系请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别 - [查询凭据配额已绑定的凭据列表 - ListAppQuotaBoundApps](https://support.huaweicloud.com/api-apig/ListAppQuotaBoundApps.md): 查询凭据配额已绑定的凭据列表。支持按凭据名称模糊匹配请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授 - [凭据配额绑定凭据列表 - AssociateAppsForAppQuota](https://support.huaweicloud.com/api-apig/AssociateAppsForAppQuota.md): 凭据配额绑定凭据列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:clientQuo - [解除凭据配额和凭据的绑定 - DisassociateAppQuotaWithApp](https://support.huaweicloud.com/api-apig/DisassociateAppQuotaWithApp.md): 解除凭据配额和凭据的绑定请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:clientQ - [查询凭据配额可绑定的凭据列表 - ListAppQuotaBindableApps](https://support.huaweicloud.com/api-apig/ListAppQuotaBindableApps.md): 查询凭据配额可绑定的凭据列表。支持按凭据名称模糊搜索请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授 - [异步导出API - ExportApiDefinitionsAsync](https://support.huaweicloud.com/api-apig/ExportApiDefinitionsAsync.md): 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授 - [异步导入API - ImportApiDefinitionsAsync](https://support.huaweicloud.com/api-apig/ImportApiDefinitionsAsync.md): 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使 - [获取异步任务结果 - ShowAsyncTaskResult](https://support.huaweicloud.com/api-apig/ShowAsyncTaskResult.md): 获取异步任务结果。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:asyncTask: - [创建编排规则 - CreateOrchestration](https://support.huaweicloud.com/api-apig/CreateOrchestration.md): 创建编排规则请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。POST /v2/{project_id}/apigw/instances/{ins - [查询编排规则列表 - ListOrchestrations](https://support.huaweicloud.com/api-apig/ListOrchestrations.md): 查询编排规则列表请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。GET /v2/{project_id}/apigw/instances/{in - [查询编排规则详情 - ShowDetailsOfOrchestration](https://support.huaweicloud.com/api-apig/ShowDetailsOfOrchestration.md): 查询编排规则详情请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。GET /v2/{project_id}/apigw/instances/{in - [更新编排规则 - UpdateOrchestration](https://support.huaweicloud.com/api-apig/UpdateOrchestration.md): 更新编排规则请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。PUT /v2/{project_id}/apigw/instances/{inst - [删除编排规则 - DeleteOrchestration](https://support.huaweicloud.com/api-apig/DeleteOrchestration.md): 删除编排规则请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,当前API调用无需身份策略权限。DELETE /v2/{project_id}/apigw/instances/{i - [查询编排规则绑定的API - ListOrchestrationAttachedApis](https://support.huaweicloud.com/api-apig/ListOrchestrationAttachedApis.md): 查询指定插件下绑定的API信息用于查询指定插件下已经绑定的API列表信息用于查询指定插件下已经绑定的API列表信息支持分页返回支持分页返回支持API名称模糊查询支持API名称模糊查询请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权, - [查询实例指定的自定义入方向端口绑定的域名信息 - ListCustomIngressPortDomains](https://support.huaweicloud.com/api-apig/ListCustomIngressPortDomains.md): 查询实例指定的自定义入方向端口绑定的域名信息。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项a - [查询实例的自定义入方向端口列表 - ListCustomIngressPorts](https://support.huaweicloud.com/api-apig/ListCustomIngressPorts.md): 查询实例的自定义入方向端口列表。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名依赖的授权项apig:ins - [新增实例的自定义入方向端口 - AddCustomIngressPort](https://support.huaweicloud.com/api-apig/AddCustomIngressPort.md): 新增实例的自定义入方向端口,在同个实例中,一个端口仅能支持一种协议。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条 - [删除实例指定的自定义入方向端口 - DeleteCustomIngressPort](https://support.huaweicloud.com/api-apig/DeleteCustomIngressPort.md): 删除实例指定的自定义入方向端口,不包含默认端口80和443。请参见如何调用API。账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。如果使用角色与策略授权,具体权限要求请参见权限和授权项。如果使用身份策略授权,需具备如下身份策略权限。授权项访问级别资源类型(*为必须)条件键别名 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713015.md): 本节介绍API分组的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建API分组](https://support.huaweicloud.com/api-apig/apig-api-180713016.md): API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。HTTP/HTTPS请求方法以及URI如下表所示。请求消息样例:响应消息样例: - [修改API分组](https://support.huaweicloud.com/api-apig/apig-api-180713017.md): 修改API分组属性。其中name和remark可修改,其他属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除API分组](https://support.huaweicloud.com/api-apig/apig-api-180713018.md): 删除指定的API分组。删除API分组前,要先下线并删除分组下的所有API。删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看分组详情](https://support.huaweicloud.com/api-apig/apig-api-180713021.md): 查询指定分组的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询分组列表](https://support.huaweicloud.com/api-apig/apig-api-180713022.md): 查询API分组列表。如果是租户操作,则查询该租户下所有的分组;如果是管理租户操作,则查询的是所有租户的分组。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、page_size、page_no。URI中的参数说明如下表所示。无响应消息 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713024.md): 本节介绍API及后端服务的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建API](https://support.huaweicloud.com/api-apig/apig-api-180713025.md): 添加一个API,API即一个服务接口,具体的服务能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。API的真实后端服务目前支持三种类型:传统的HTTP/HTTPS形式的web后端、 - [修改API](https://support.huaweicloud.com/api-apig/apig-api-180713026.md): 修改指定API的信息,包括后端服务信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:{ "auth_type": "app", "auth_opt": { "app_code_auth_type": "HEADER" }, "backend_api": { - [删除API](https://support.huaweicloud.com/api-apig/apig-api-180713027.md): 删除指定的API。删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [发布API](https://support.huaweicloud.com/api-apig/apig-api-180713028.md): 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [下线API](https://support.huaweicloud.com/api-apig/apig-api-180713029.md): 将API从某个已发布的环境上下线,下线后,API将无法再被调用。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无。无 - [批量发布或下线API](https://support.huaweicloud.com/api-apig/apig-api-181219254.md): 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [查看API详情](https://support.huaweicloud.com/api-apig/apig-api-180713030.md): 查看指定的API的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询API列表](https://support.huaweicloud.com/api-apig/apig-api-180713031.md): 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、group_id、req_protocol、req_method、req_uri、auth_type、env_ - [查询API历史版本列表](https://support.huaweicloud.com/api-apig/apig-api-180713033.md): 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:env_id,env_name。URI中的参数说明如下表所示。无响应消息样例: - [根据版本编号下线API](https://support.huaweicloud.com/api-apig/apig-api-180911216.md): 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。该接口供FunctionGraph服务使用。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无。无 - [查看版本详情](https://support.huaweicloud.com/api-apig/apig-api-180911217.md): 查询某个指定的版本详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询API运行时定义](https://support.huaweicloud.com/api-apig/apig-api-180911219.md): 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。API的定义分为临时定义和运行时定义,分别代表如下含义:临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。访问某个环境上的API,其实访问 - [调试API](https://support.huaweicloud.com/api-apig/apig-api-180911220.md): 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713035.md): 本节介绍APP的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建APP](https://support.huaweicloud.com/api-apig/apig-api-180713036.md): APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。创建一个APP。HTTP/HTTPS请求方法以及URI如下表所示。请求消息样例:{ "name": "app_001", "remark": "first app", "app_key": "app_key_sample", "ap - [修改APP](https://support.huaweicloud.com/api-apig/apig-api-180713037.md): 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [重置密钥](https://support.huaweicloud.com/api-apig/apig-api-180713038.md): 重置指定APP的密钥。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除APP](https://support.huaweicloud.com/api-apig/apig-api-180713039.md): 删除指定的APP。APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [校验APP](https://support.huaweicloud.com/api-apig/apig-api-180713040.md): 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查看APP详情](https://support.huaweicloud.com/api-apig/apig-api-180713041.md): 查看指定APP的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询APP列表](https://support.huaweicloud.com/api-apig/apig-api-180713042.md): 查询APP列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、app_key、creator、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例:{ "total": 2, "size": 2, - [创建App Code](https://support.huaweicloud.com/api-apig/apig-lgapi-200226001.md): App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [自动生成App Code](https://support.huaweicloud.com/api-apig/apig-lgapi-200226002.md): 创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查看App Code详情](https://support.huaweicloud.com/api-apig/apig-lgapi-200226003.md): 查看App Code详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询App Code列表](https://support.huaweicloud.com/api-apig/apig-lgapi-200226004.md): 查询App Code列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [删除App Code](https://support.huaweicloud.com/api-apig/apig-lgapi-200226005.md): 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713044.md): 本节介绍APP与API之间的授权关系的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查看APP未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713045.md): 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:app_id、api_id、api_name、group_id、env_id、page_size、page_no。UR - [授权](https://support.huaweicloud.com/api-apig/apig-api-180713046.md): APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。HTTP/HTTPS请求方法以及URI如下表所示。请求参数样例:响应消息样例: - [查看APP已绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713047.md): 查询APP已经绑定的API列表。将API发布到相应的授权的环境后,才能查询到结果。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:app_id、 api_id 、 api_name、group_id、group_name、env_id、page_s - [查看API已绑定的APP列表](https://support.huaweicloud.com/api-apig/apig-api-180713048.md): 查询API绑定的APP列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、app_name、app_id、env_id、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [解除授权](https://support.huaweicloud.com/api-apig/apig-api-180713049.md): 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713051.md): 本节介绍环境的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建环境](https://support.huaweicloud.com/api-apig/apig-api-180713052.md): 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测 - [修改环境](https://support.huaweicloud.com/api-apig/apig-api-180713053.md): 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应参数样例: - [删除环境](https://support.huaweicloud.com/api-apig/apig-api-180713054.md): 删除指定的环境。该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查询环境列表](https://support.huaweicloud.com/api-apig/apig-api-180713055.md): 查询符合条件的环境列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:name、page_size、page_no。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713057.md): 本节介绍环境变量的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [新建变量](https://support.huaweicloud.com/api-apig/apig-api-180713058.md): 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。环境变量定义在API分组上,该分组下的所有API都可以使用这些变量 - [删除变量](https://support.huaweicloud.com/api-apig/apig-api-180713059.md): 删除指定的环境变量。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看变量详情](https://support.huaweicloud.com/api-apig/apig-api-180713060.md): 查看指定的环境变量的详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询变量列表](https://support.huaweicloud.com/api-apig/apig-api-180713061.md): 查询分组下的所有环境变量的列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:env_id、group_id、variable_name、page_size、page_no无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713063.md): 本节介绍流控策略的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建流控策略](https://support.huaweicloud.com/api-apig/apig-api-180713064.md): 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。HTTP/HTTPS请求方法以及URI如下表所示。请求消息样例:响应消息样例: - [修改流控策略](https://support.huaweicloud.com/api-apig/apig-api-180713065.md): 修改指定流控策略的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除流控策略](https://support.huaweicloud.com/api-apig/apig-api-180713066.md): 删除指定的流控策略,以及该流控策略与API的所有绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看流控策略详情](https://support.huaweicloud.com/api-apig/apig-api-180713067.md): 查看指定流控策略的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例:{ "id": "0325b671-2d50-4614-9868-22102262695d", "name": "每秒1000次", "api_call_limits": 1000, "user_call_l - [查询流控策略列表](https://support.huaweicloud.com/api-apig/apig-api-180713068.md): 查询所有流控策略的信息。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、page_size、page_no。响应消息样例:{ "total": 2, "size": 2, "throttles": [{ "id": "a3 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713070.md): 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查看流控策略未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713071.md): 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:group_id、env_id、throttle_id、api_id、api_name、page_size、p - [绑定流控策略](https://support.huaweicloud.com/api-apig/apig-api-180713072.md): 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好地保护后端API免受异常流量的冲击,保障服务的稳定运行。为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略 - [查看流控策略绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713073.md): 查询某个流控策略上已经绑定的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:group_id、env_id、throttle_id、api_id、api_name、page_size、page_no。URI中的参数说明如下表所示。无响应 - [查看API绑定的流控策略列表](https://support.huaweicloud.com/api-apig/apig-api-180713074.md): 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id 、throttle_id、throttle_name、env_id、page_size、page_no。URI中的参 - [解除绑定](https://support.huaweicloud.com/api-apig/apig-api-180713075.md): 解除API与流控策略的绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713077.md): 本节介绍特殊流控的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建特殊设置](https://support.huaweicloud.com/api-apig/apig-api-180713078.md): 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。为流控策略添加一个特殊设置的对象,可以是AP - [修改特殊设置](https://support.huaweicloud.com/api-apig/apig-api-180713079.md): 修改某个流控策略下的某个特殊设置。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除特殊设置](https://support.huaweicloud.com/api-apig/apig-api-180713080.md): 删除某个流控策略的某个特殊配置。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看特殊设置列表](https://support.huaweicloud.com/api-apig/apig-api-180713081.md): 查看给流控策略设置的特殊配置。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:strategy_id、app_name、user、 page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713083.md): API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。“操作类型”用于描述字段的属性,表示对应字段的值可 - [创建ACL策略](https://support.huaweicloud.com/api-apig/apig-api-180713084.md): 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为您的租户名称, 而非“www.exampleDomain.com”之类的网络域名。HTTP/HTTPS请求方法以及URI如下表所示。请求消息样例:响应消息样例: - [修改ACL策略](https://support.huaweicloud.com/api-apig/apig-api-180713085.md): 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除ACL策略](https://support.huaweicloud.com/api-apig/apig-api-180713086.md): 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [批量删除ACL策略](https://support.huaweicloud.com/api-apig/apig-api-190111261.md): 批量删除指定的多个ACL策略。删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [查看ACL策略详情](https://support.huaweicloud.com/api-apig/apig-api-180713089.md): 查询指定ACL策略的详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无。响应消息样例: - [查看ACL策略列表](https://support.huaweicloud.com/api-apig/apig-api-180713090.md): 查询所有的ACL策略列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、acl_type、entity_type、page_size、page_no。URI中的参数说明如下表所示。无。响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713092.md): API需要绑定ACL策略,ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型,如表1所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [将API与ACL策略进行绑定](https://support.huaweicloud.com/api-apig/apig-api-180713093.md): 将API与ACL策略进行绑定。同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。HTTPS请求方法以及URI如下表所示。请求消息样例:响应消息样例: - [查看API绑定的ACL策略列表](https://support.huaweicloud.com/api-apig/apig-api-180713094.md): 查看API绑定的ACL策略列表。HTTP/HTTPS请求方法以及URI如下表所示可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、env_id、env_name、acl_id、acl_name、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [查看ACL策略绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713095.md): 查看ACL策略绑定的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:acl_id、api_id、 api_name、group_id、env_id、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [查看ACL策略未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713096.md): 查看ACL策略未绑定的API列表,需要API已发布。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:acl_id、env_id、api_id、group_id、api_name、page_size、page_no。URI中的参数说明如下表所示。无响 - [解除API与ACL策略的绑定](https://support.huaweicloud.com/api-apig/apig-api-180713097.md): 解除某条API与ACL策略的绑定关系HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [批量解除API与ACL策略的绑定](https://support.huaweicloud.com/api-apig/apig-api-190111262.md): 批量解除API与ACL策略的绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例:{ "failure": [{ "bind_id": "81efcfd94b8747a0b21e8c04144a4e8c", "error_code": "APIG.3010", - [查询已购买的API分组列表](https://support.huaweicloud.com/api-apig/apig-api-180713110.md): 租户可以查询自己已购买的API分组列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、group_id 、group_name 、page_size、page_no。URI中的参数说明如下表所示。无响应参数样例: - [查询分组详情](https://support.huaweicloud.com/api-apig/apig-api-180713111.md): 查询已购买的指定分组的详情。HTTP/HTTPS请求方法以及URI如下表1所示URI中的参数说明如下表所示。无响应消息样例: - [查询已购买的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713112.md): 租户查询已购买的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、api_name、group_id 、group_name 、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713115.md): 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查询租户配置详情](https://support.huaweicloud.com/api-apig/apig-api-180713119.md): 查询某个租户的配置项及其配置值。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:config_name、config_id、page_size、page_no。URI中的参数说明如下所示。无响应消息样例: - [查询API分组概况](https://support.huaweicloud.com/api-apig/apig-api-180713130.md): 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。HTTP/HTTPS请求方法以及URI如下表所示。无响应消息样例: - [查询API概况](https://support.huaweicloud.com/api-apig/apig-api-180713131.md): 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。HTTP/HTTPS请求方法以及URI如下表所示。无响应消息样例: - [查询APP概况](https://support.huaweicloud.com/api-apig/apig-api-180713132.md): 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。HTTP/HTTPS请求方法以及URI如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713134.md): 本节介绍签名密钥的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建签名密钥](https://support.huaweicloud.com/api-apig/apig-api-180713135.md): 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。其中,签名密钥就是API安全保护机制的一种。租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收 - [修改签名密钥](https://support.huaweicloud.com/api-apig/apig-api-180713136.md): 修改指定签名密钥的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除签名密钥](https://support.huaweicloud.com/api-apig/apig-api-180713137.md): 删除指定的签名密钥。删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查询签名密钥列表](https://support.huaweicloud.com/api-apig/apig-api-180713138.md): 查询所有签名密钥的信息。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name。响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713140.md): 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查看签名密钥未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713141.md): 查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。HTTP/HTTPS请求方法以及URI如表3-73所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_id、page_size、page - [绑定签名密钥](https://support.huaweicloud.com/api-apig/apig-api-180713142.md): 签名密钥创建后,需要绑定到API才能生效。将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。HTTP/HTTPS - [查看签名密钥绑定的API列表](https://support.huaweicloud.com/api-apig/apig-api-180713143.md): 查询某个签名密钥上已经绑定的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_id、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例 - [查看API绑定的签名密钥列表](https://support.huaweicloud.com/api-apig/apig-api-180713144.md): 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、sign_id、sign_name、env_id、page_size、page_no。URI中的参数 - [解除绑定](https://support.huaweicloud.com/api-apig/apig-api-180713145.md): 解除API与签名密钥的绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713153.md): 本节介绍自定义域名及证书的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [绑定域名](https://support.huaweicloud.com/api-apig/apig-api-180713154.md): 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [解绑域名](https://support.huaweicloud.com/api-apig/apig-api-180713155.md): 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。无无 - [绑定域名证书](https://support.huaweicloud.com/api-apig/apig-api-180713156.md): 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。本章节主要介绍为特定域名绑定证书。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。请求消息样例:响应消息样例:{ "id": " b9be707660c5406394f8973e087bae20", "url_ - [删除域名证书](https://support.huaweicloud.com/api-apig/apig-api-180713158.md): 如果域名证书不再需要或者已过期,则可以删除证书内容。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。无无 - [查看域名证书](https://support.huaweicloud.com/api-apig/apig-lgapi-200220004.md): 查看域名下绑定的证书详情。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-api-180713160.md): 本节介绍VPC通道的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建VPC通道](https://support.huaweicloud.com/api-apig/apig-api-180713161.md): 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。每个用户最多创建30个VPC通道。HTTP/HTTPS请求方法以及URI如下表所示。请求消息样例:响应消息样例: - [更新VPC通道](https://support.huaweicloud.com/api-apig/apig-api-180713162.md): 更新指定VPC通道的参数。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除VPC通道](https://support.huaweicloud.com/api-apig/apig-api-180713163.md): 删除指定的VPC通道。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看VPC通道详情](https://support.huaweicloud.com/api-apig/apig-api-180713164.md): 查看指定的VPC通道详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查看VPC通道列表](https://support.huaweicloud.com/api-apig/apig-api-180713165.md): 查看VPC通道列表。HTTP/HTTPS请求方法以及URI如下表所示。o可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、vpc_type、page_size、page_no。无响应消息样例: - [添加后端实例(云服务器)](https://support.huaweicloud.com/api-apig/apig-api-180713166.md): 为指定的VPC通道添加云服务器。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除后端实例(云服务器)](https://support.huaweicloud.com/api-apig/apig-api-180713167.md): 删除指定VPC通道中的云服务器。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看后端实例列表(云服务器列表)](https://support.huaweicloud.com/api-apig/apig-api-180713168.md): 查看指定VPC通道的云服务器列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:name、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [API统计信息查询-最近一段时间](https://support.huaweicloud.com/api-apig/apig-api-180713172.md): 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟、小时、天。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值,服务器返回服务器的时间的上一分钟到往前推N分钟的数据;查询范围一天以内,返回一小时一个样本,其样本值为一小时内的累计值,服务器会返回最近时长横跨统计周期的数据,比如时长为大于2小时,且小于3小 - [分组统计信息查询-最近一小时](https://support.huaweicloud.com/api-apig/apig-api-180713173.md): 根据API分组的id和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/.bash_history”、“/var/log/messages”(如有)。HTTP/HTTPS - [导出分组下所有API](https://support.huaweicloud.com/api-apig/apig-api-180911238.md): 提供用户导出API定义的接口。导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。HTTP/HTTPS请求方法以及URI如下表所示。响应消息样例: - [批量导出API](https://support.huaweicloud.com/api-apig/apig-api-190108256.md): 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [导入API到新分组](https://support.huaweicloud.com/api-apig/apig-api-190108257.md): 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [导入API到已有分组](https://support.huaweicloud.com/api-apig/apig-api-190108258.md): 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [创建自定义认证](https://support.huaweicloud.com/api-apig/apig-lgapi-200220031.md): 创建自定义认证HTTP/HTTPS请求方法以及URI如下表所示。请求消息样例:响应消息样例: - [修改自定义认证](https://support.huaweicloud.com/api-apig/apig-lgapi-200220032.md): 修改自定义认证HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除自定义认证](https://support.huaweicloud.com/api-apig/apig-lgapi-200220033.md): 删除自定义认证HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看自定义认证详情](https://support.huaweicloud.com/api-apig/apig-lgapi-200220034.md): 查看自定义认证详情HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询自定义认证列表](https://support.huaweicloud.com/api-apig/apig-lgapi-200220035.md): 查询自定义认证列表HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、type、page_size、page_noURI中的参数说明如下表所示。无响应消息样例: - [使用限制](https://support.huaweicloud.com/api-apig/apig-phapi-200220036.md): 专享版API(V1)的接口,只有上海二,广州,北京四,北京一,墨西哥和圣保罗局点支持注册,且仅用于存量用户使用。请新用户在使用API时参考专享版API(V2)接口文档。 - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713015.md): 本节介绍API分组的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建API分组](https://support.huaweicloud.com/api-apig/apig-phapi-180713016.md): API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息 - [修改API分组](https://support.huaweicloud.com/api-apig/apig-phapi-180713017.md): 修改API分组属性。其中name和remark可修改,其他属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除API分组](https://support.huaweicloud.com/api-apig/apig-phapi-180713018.md): 删除指定的API分组。删除API分组前,要先下线并删除分组下的所有API。删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看分组详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713021.md): 查询指定分组的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询分组列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713022.md): 查询API分组列表。如果是租户操作,则查询该租户下所有的分组;如果是管理员操作,则查询的是所有租户的分组。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、page_size、page_no。URI中的参数说明如下表所示。无响应消息样 - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713024.md): 本节介绍API及后端服务的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建API](https://support.huaweicloud.com/api-apig/apig-phapi-180713025.md): 添加一个API,API即一个服务接口,具体的服务能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。API的真实后端服务目前支持三种类型:传统的HTTP/HTTPS形式的web后端、 - [修改API](https://support.huaweicloud.com/api-apig/apig-phapi-180713026.md): 修改指定API的信息,包括后端服务信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:{ "auth_type": "app", "auth_opt": { "app_code_auth_type": "HEADER" }, "backend_api": { - [删除API](https://support.huaweicloud.com/api-apig/apig-phapi-180713027.md): 删除指定的API。删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [发布API](https://support.huaweicloud.com/api-apig/apig-phapi-180713028.md): 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [下线API](https://support.huaweicloud.com/api-apig/apig-phapi-180713029.md): 将API从某个已发布的环境上下线,下线后,API将无法再被调用。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无。无 - [批量发布或下线API](https://support.huaweicloud.com/api-apig/apig-phapi-181219254.md): 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [查看API详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713030.md): 查看指定的API的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713031.md): 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、group_id、req_protocol、req_method、req_uri、auth_type、env_ - [查询API历史版本列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713033.md): 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:env_id,env_name。URI中的参数说明如下表所示。无响应消息样例: - [根据版本编号下线API](https://support.huaweicloud.com/api-apig/apig-phapi-180911216.md): 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。该接口供FunctionGraph服务使用。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无。无 - [查看版本详情](https://support.huaweicloud.com/api-apig/apig-phapi-180911217.md): 查询某个指定的版本详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询API运行时定义](https://support.huaweicloud.com/api-apig/apig-phapi-180911219.md): 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。API的定义分为临时定义和运行时定义,分别代表如下含义:临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。访问某个环境上的API,其实访问 - [调试API](https://support.huaweicloud.com/api-apig/apig-phapi-180911220.md): 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713035.md): 本节介绍APP的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建APP](https://support.huaweicloud.com/api-apig/apig-phapi-180713036.md): APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。创建一个APP。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:{ "name": "app_001", "remark": "first app", "app_key": "app_key - [修改APP](https://support.huaweicloud.com/api-apig/apig-phapi-180713037.md): 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [重置密钥](https://support.huaweicloud.com/api-apig/apig-phapi-180713038.md): 重置指定APP的密钥。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除APP](https://support.huaweicloud.com/api-apig/apig-phapi-180713039.md): 删除指定的APP。APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [校验APP](https://support.huaweicloud.com/api-apig/apig-phapi-180713040.md): 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查看APP详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713041.md): 查看指定APP的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询APP列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713042.md): 查询APP列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、app_key、creator、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例:{ "total": 2, "size": 2, - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713044.md): 本节介绍APP与API之间的授权关系的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查看APP未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713045.md): 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:app_id、api_id、api_name、group_id、env_id、page_size、page_no。UR - [授权](https://support.huaweicloud.com/api-apig/apig-phapi-180713046.md): APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求参数样例:响应消息样例: - [查看APP已绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713047.md): 查询APP已经绑定的API列表。将API发布到相应的授权的环境后,才能查询到结果。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:app_id、 api_id 、 api_name、group_id、group_name、env_id、page_s - [查看API已绑定的APP列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713048.md): 查询API绑定的APP列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、app_name、app_id、env_id、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [解除授权](https://support.huaweicloud.com/api-apig/apig-phapi-180713049.md): 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713051.md): 本节介绍环境的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建环境](https://support.huaweicloud.com/api-apig/apig-phapi-180713052.md): 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测 - [修改环境](https://support.huaweicloud.com/api-apig/apig-phapi-180713053.md): 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应参数样例: - [删除环境](https://support.huaweicloud.com/api-apig/apig-phapi-180713054.md): 删除指定的环境。该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查询环境列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713055.md): 查询符合条件的环境列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:name、page_size、page_no。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713057.md): 本节介绍环境变量的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [新建变量](https://support.huaweicloud.com/api-apig/apig-phapi-180713058.md): 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。环境变量定义在API分组上,该分组下的所有API都可以使用这些变量 - [删除变量](https://support.huaweicloud.com/api-apig/apig-phapi-180713059.md): 删除指定的环境变量。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看变量详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713060.md): 查看指定的环境变量的详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询变量列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713061.md): 查询分组下的所有环境变量的列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:env_id、group_id、variable_name、page_size、page_no无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713063.md): 本节介绍流控策略的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建流控策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713064.md): 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [修改流控策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713065.md): 修改指定流控策略的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除流控策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713066.md): 删除指定的流控策略,以及该流控策略与API的所有绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看流控策略详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713067.md): 查看指定流控策略的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例:{ "id": "0325b671-2d50-4614-9868-22102262695d", "name": "每秒1000次", "api_call_limits": 1000, "user_call_l - [查询流控策略列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713068.md): 查询所有流控策略的信息。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、page_size、page_no。响应消息样例:{ "total": 2, "size": 2, "throttles": [{ "id": "a3 - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713070.md): 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查看流控策略未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713071.md): 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:group_id、env_id、throttle_id、api_id、api_name、page_size、p - [绑定流控策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713072.md): 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好地保护后端API免受异常流量的冲击,保障服务的稳定运行。为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略 - [查看流控策略绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713073.md): 查询某个流控策略上已经绑定的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:group_id、env_id、throttle_id、api_id、api_name、page_size、page_no。URI中的参数说明如下表所示。无响应 - [查看API绑定的流控策略列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713074.md): 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id 、throttle_id、throttle_name、env_id、page_size、page_no。URI中的参 - [解除绑定](https://support.huaweicloud.com/api-apig/apig-phapi-180713075.md): 解除API与流控策略的绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713077.md): 本节介绍特殊流控的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建特殊设置](https://support.huaweicloud.com/api-apig/apig-phapi-180713078.md): 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。为流控策略添加一个特殊设置的对象,可以是AP - [修改特殊设置](https://support.huaweicloud.com/api-apig/apig-phapi-180713079.md): 修改某个流控策略下的某个特殊设置。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除特殊设置](https://support.huaweicloud.com/api-apig/apig-phapi-180713080.md): 删除某个流控策略的某个特殊配置。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看特殊设置列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713081.md): 查看给流控策略设置的特殊配置。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:strategy_id、app_name、user、 page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713083.md): API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。“操作类型”用于描述字段的属性,表示对应字段的值可 - [创建ACL策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713084.md): 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求 - [修改ACL策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713085.md): 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除ACL策略](https://support.huaweicloud.com/api-apig/apig-phapi-180713086.md): 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [批量删除ACL策略](https://support.huaweicloud.com/api-apig/apig-phapi-190111261.md): 批量删除指定的多个ACL策略。删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [查看ACL策略详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713089.md): 查询指定ACL策略的详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无。响应消息样例: - [查看ACL策略列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713090.md): 查询所有的ACL策略列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、acl_type、entity_type、page_size、page_no。URI中的参数说明如下表所示。无。响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713092.md): API需要绑定ACL策略,ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型,如表1所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [将API与ACL策略进行绑定](https://support.huaweicloud.com/api-apig/apig-phapi-180713093.md): 将API与ACL策略进行绑定。同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [查看API绑定的ACL策略列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713094.md): 查看API绑定的ACL策略列表。HTTP/HTTPS请求方法以及URI如下表所示可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、env_id、env_name、acl_id、acl_name、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [查看ACL策略绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713095.md): 查看ACL策略绑定的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:acl_id、api_id、 api_name、group_id、env_id、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [查看ACL策略未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713096.md): 查看ACL策略未绑定的API列表,需要API已发布。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:acl_id、env_id、api_id、group_id、api_name、page_size、page_no。URI中的参数说明如下表所示。无响 - [解除API与ACL策略的绑定](https://support.huaweicloud.com/api-apig/apig-phapi-180713097.md): 解除某条API与ACL策略的绑定关系HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [批量解除API与ACL策略的绑定](https://support.huaweicloud.com/api-apig/apig-phapi-190111262.md): 批量解除API与ACL策略的绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例:{ "failure": [{ "bind_id": "81efcfd94b8747a0b21e8c04144a4e8c", "error_code": "APIG.3010", - [查询API分组概况](https://support.huaweicloud.com/api-apig/apig-phapi-180713130.md): 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询API概况](https://support.huaweicloud.com/api-apig/apig-phapi-180713131.md): 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询APP概况](https://support.huaweicloud.com/api-apig/apig-phapi-180713132.md): 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713134.md): 本节介绍签名密钥的对象模型,如下表所示:“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建签名密钥](https://support.huaweicloud.com/api-apig/apig-phapi-180713135.md): 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。其中,签名密钥就是API安全保护机制的一种。租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收 - [修改签名密钥](https://support.huaweicloud.com/api-apig/apig-phapi-180713136.md): 修改指定签名密钥的详细信息。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除签名密钥](https://support.huaweicloud.com/api-apig/apig-phapi-180713137.md): 删除指定的签名密钥。删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查询签名密钥列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713138.md): 查询所有签名密钥的信息。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name。响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713140.md): 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [查看签名密钥未绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713141.md): 查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。HTTP/HTTPS请求方法以及URI如表3-73所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_id、page_size、page - [绑定签名密钥](https://support.huaweicloud.com/api-apig/apig-phapi-180713142.md): 签名密钥创建后,需要绑定到API才能生效。将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。HTTP/HTTPS - [查看签名密钥绑定的API列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713143.md): 查询某个签名密钥上已经绑定的API列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_id、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例 - [查看API绑定的签名密钥列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713144.md): 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:api_id、sign_id、sign_name、env_id、page_size、page_no。URI中的参数 - [解除绑定](https://support.huaweicloud.com/api-apig/apig-phapi-180713145.md): 解除API与签名密钥的绑定关系。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713153.md): 本节介绍自定义域名及证书的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [绑定域名](https://support.huaweicloud.com/api-apig/apig-phapi-180713154.md): 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [解绑域名](https://support.huaweicloud.com/api-apig/apig-phapi-180713155.md): 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。无无 - [绑定域名证书](https://support.huaweicloud.com/api-apig/apig-phapi-180713156.md): 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。本章节主要介绍为特定域名绑定证书。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。请求消息样例:响应消息样例:{ "id": " b9be707660c5406394f8973e087bae20", "url_ - [删除域名证书](https://support.huaweicloud.com/api-apig/apig-phapi-180713158.md): 如果域名证书不再需要或者已过期,则可以删除证书内容。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。无无 - [查看域名证书](https://support.huaweicloud.com/api-apig/apig-phapi-200220004.md): 查看域名下绑定的证书详情。HTTP/HTTPS请求方法以及URI如下表所示URI中的参数说明如下表所示。无响应消息样例: - [对象模型](https://support.huaweicloud.com/api-apig/apig-phapi-180713160.md): 本节介绍VPC通道的对象模型。“操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:C:创建;U:更新;R:读取。C:创建;U:更新;R:读取。“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 - [创建VPC通道](https://support.huaweicloud.com/api-apig/apig-phapi-180713161.md): 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。每个用户最多创建30个VPC通道。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [更新VPC通道](https://support.huaweicloud.com/api-apig/apig-phapi-180713162.md): 更新指定VPC通道的参数。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除VPC通道](https://support.huaweicloud.com/api-apig/apig-phapi-180713163.md): 删除指定的VPC通道。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看VPC通道详情](https://support.huaweicloud.com/api-apig/apig-phapi-180713164.md): 查看指定的VPC通道详情。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查看VPC通道列表](https://support.huaweicloud.com/api-apig/apig-phapi-180713165.md): 查看VPC通道列表。HTTP/HTTPS请求方法以及URI如下表所示。o可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、vpc_type、page_size、page_no。无响应消息样例: - [添加后端实例(云服务器)](https://support.huaweicloud.com/api-apig/apig-phapi-180713166.md): 为指定的VPC通道添加云服务器。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除后端实例(云服务器)](https://support.huaweicloud.com/api-apig/apig-phapi-180713167.md): 删除指定VPC通道中的云服务器。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看后端实例列表(云服务器列表)](https://support.huaweicloud.com/api-apig/apig-phapi-180713168.md): 查看指定VPC通道的云服务器列表。HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:name、page_size、page_no。URI中的参数说明如下表所示。无响应消息样例: - [导出分组下所有API](https://support.huaweicloud.com/api-apig/apig-phapi-180911238.md): 提供用户导出API定义的接口。导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。HTTP/HTTPS请求方法以及URI如下表所示。响应消息样例: - [批量导出API](https://support.huaweicloud.com/api-apig/apig-phapi-190108256.md): 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [导入API到新分组](https://support.huaweicloud.com/api-apig/apig-phapi-190108257.md): 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [导入API到已有分组](https://support.huaweicloud.com/api-apig/apig-phapi-190108258.md): 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [创建自定义认证](https://support.huaweicloud.com/api-apig/apig-phapi-200220031.md): 创建自定义认证HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [修改自定义认证](https://support.huaweicloud.com/api-apig/apig-phapi-200220032.md): 修改自定义认证HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。请求消息样例:响应消息样例: - [删除自定义认证](https://support.huaweicloud.com/api-apig/apig-phapi-200220033.md): 删除自定义认证HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无无 - [查看自定义认证详情](https://support.huaweicloud.com/api-apig/apig-phapi-200220034.md): 查看自定义认证详情HTTP/HTTPS请求方法以及URI如下表所示。URI中的参数说明如下表所示。无响应消息样例: - [查询自定义认证列表](https://support.huaweicloud.com/api-apig/apig-phapi-200220035.md): 查询自定义认证列表HTTP/HTTPS请求方法以及URI如下表所示。可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值:id、name、type、page_size、page_noURI中的参数说明如下表所示。无响应消息样例: - [权限与授权项说明](https://support.huaweicloud.com/api-apig/apig-api-grant-policy_0001.md): 如果您需要对您所拥有的APIG进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),如果华为云账号所具备的权限功能已经能满足您的要求,您可以跳过本章节,不影响您使用APIG服务的其它功能。通过IAM,您可以通过授权控制主体(IAM用户、用户组、IAM委托或信任委托)对华 - [策略授权参考](https://support.huaweicloud.com/api-apig/apig-api-grant-policy_0002.md): 本章节介绍APIG基于策略授权场景下支持的策略授权项。策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下:权限:允许或拒绝某项操作。对应API接口:自定义策略实际调用的API接口。授权项:自定义策略中支持的A - [身份策略授权参考](https://support.huaweicloud.com/api-apig/Permission.md): 云服务在IAM预置了常用的权限,称为系统身份策略。如果IAM系统身份策略无法满足授权要求,管理员可以根据各服务支持的授权项,创建IAM自定义身份策略来进行精细的访问控制,IAM自定义身份策略是对系统身份策略的扩展和补充。除IAM服务外,Organizations服务中的服务控制策略(Service Control Policy,以下简称S - [分页显示查询结果](https://support.huaweicloud.com/api-apig/apig-api-180713204.md): 查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。在url后面拼接如下参数:page_size:每页查询多少条数据,如果不指定,默认20,最大值500。page_no:需要查询的页码。示例: - [过滤查询结果](https://support.huaweicloud.com/api-apig/apig-api-180713205.md): 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。示例: - [HTTP状态码](https://support.huaweicloud.com/api-apig/apig-api-180713206.md): 常用状态码表如表1所示。 - [错误码](https://support.huaweicloud.com/api-apig/ErrorCode.md): 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。更多服务错误码请参见API错误中心。 - [实例支持的APIG特性](https://support.huaweicloud.com/api-apig/apig-api-20200402.md): 专享版实例支持的APIG特性。若当前实例中无相关特性,可提交工单申请升级实例解决。 - [获取项目ID](https://support.huaweicloud.com/api-apig/apig-api-180713009.md): 项目ID还可通过调用查询指定条件下的项目信息API获取。获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区与终端节点获取。接口的认证鉴权请参见认证鉴权。响应示例如下,其中projects下的“id”即为项目ID。在调用接口的时候,部分URL - [获取账号名和账号名ID](https://support.huaweicloud.com/api-apig/apig-api-180713005.md): 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下:进入控制台首页。将鼠标移至用户名,在下拉列表中单击“我的凭证”。查看账号名和账号ID。查看账号名和账号ID。 - [CorsPluginContent](https://support.huaweicloud.com/api-apig/apig-api-CorsPluginContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [SetRespHeadersContent](https://support.huaweicloud.com/api-apig/apig-api-SetRespHeadersContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [KafkaLogContent](https://support.huaweicloud.com/api-apig/apig-api-KafkaLogContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [BreakerContent](https://support.huaweicloud.com/api-apig/apig-api-BreakerContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [RateLimitContent](https://support.huaweicloud.com/api-apig/apig-api-RateLimitContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [ThirdAuthContent](https://support.huaweicloud.com/api-apig/apig-api-ThirdAuthContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [ProxyCacheContent](https://support.huaweicloud.com/api-apig/apig-api-ProxyCacheContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [ProxyMirrorContent](https://support.huaweicloud.com/api-apig/apig-api-ProxyMirrorContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [OIDCAuthContent](https://support.huaweicloud.com/api-apig/apig-api-OIDCAuthContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [JWTAuthContent](https://support.huaweicloud.com/api-apig/apig-api-JWTAuthContent.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [修订记录](https://support.huaweicloud.com/api-apig/apig-api-180713215.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 ## SDK参考 - [SDK概述](https://support.huaweicloud.com/sdkreference-apig/apig_08_0001.md): 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。在开始使用之前,请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼 ## CLI参考 - [如何使用CLI](https://support.huaweicloud.com/clir-apig/apig_11_0001.md): 华为云命令行工具服务(Koo Command Line Interface,KooCLI,原名HCloud CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中APIG开放的API,管理和使用您的APIG资源。关于KooCLI的详细信息,请参见什么是KooCLI。在 - [CLI命令参考](https://support.huaweicloud.com/clir-apig/APIG-cli.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 ## 常见问题 - [热门咨询](https://support.huaweicloud.com/apig_faq/index.md): API的后端服务是否支持绑定私网ELB地址?API的后端服务地址支持填写私有地址(子网IP)吗?API可以绑定内网域名吗?调用API失败的可能原因调用API报“The API does not exist or has not been published in the environment”调用API报“No backend avai - [如何将API服务上架到华为云商店上售卖?](https://support.huaweicloud.com/apig_faq/HowToSaleAPIs.md): API服务上架到华为云商店,您需要按如下流程完成部署和配置:完成API的创建、发布等工作此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。其他相关操作包括“API分组”、“API管理”和“环境管理”等。此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。其他相关操作包括“API分组”、“API管理”和“环 - [API分组为什么无法上架到云商店?](https://support.huaweicloud.com/apig_faq/apig-faq-190627026.md): API分组无法上架到云商店,是因为未同时满足以下条件,请按照以下条件排查并修改。分组中的API类型为公开分组中的API的安全认证为APP认证分组中的API已经发布到RELEASE环境 - [API、环境、凭据之间的关系?](https://support.huaweicloud.com/apig_faq/apig_0084464485.md): API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)Key&Secret。将指定的API授权给指定应用(凭据)后,该应用(凭据)的持有者才可以调用已发布到环境中的指定API。同一个API发布到不同 - [API网关共享版是否可以升级到专享版?](https://support.huaweicloud.com/apig_faq/apig-faq-2005028.md): 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案:新购买专享版实例。导出共享版中的API。将API导入到专享版。重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 - [APIG控制台所有按钮均无法单击如何处理?](https://support.huaweicloud.com/apig_faq/apig-faq-2005036.md): 请检查账号是否欠费,并进行续费处理。计费相关指导,请参考计费说明。 - [怎样保护API的调用安全?](https://support.huaweicloud.com/apig_faq/apig-faq-180307003.md): 使用身份认证创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。设置访问控制策略从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。从IP地址(或地址区间)以及账号 - [怎样保证API网关调用后端服务器的安全?](https://support.huaweicloud.com/apig_faq/apig-faq-180307009.md): 通过以下方法确保API网关调用后端服务器的安全:为API绑定签名密钥。在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名信息是否一致。在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名 - [如何将API服务上架到华为云商店上售卖?](https://support.huaweicloud.com/apig_faq/HowToSaleAPIs.md): API服务上架到华为云商店,您需要按如下流程完成部署和配置:完成API的创建、发布等工作此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。其他相关操作包括“API分组”、“API管理”和“环境管理”等。此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。其他相关操作包括“API分组”、“API管理”和“环 - [API分组为什么无法上架到云商店?](https://support.huaweicloud.com/apig_faq/apig-faq-190627026.md): API分组无法上架到云商店,是因为未同时满足以下条件,请按照以下条件排查并修改。分组中的API类型为公开分组中的API的安全认证为APP认证分组中的API已经发布到RELEASE环境 - [API、环境、凭据之间的关系?](https://support.huaweicloud.com/apig_faq/apig_0084464485.md): API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)Key&Secret。将指定的API授权给指定应用(凭据)后,该应用(凭据)的持有者才可以调用已发布到环境中的指定API。同一个API发布到不同 - [API网关共享版是否可以升级到专享版?](https://support.huaweicloud.com/apig_faq/apig-faq-2005028.md): 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案:新购买专享版实例。导出共享版中的API。将API导入到专享版。重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 - [APIG控制台所有按钮均无法单击如何处理?](https://support.huaweicloud.com/apig_faq/apig-faq-2005036.md): 请检查账号是否欠费,并进行续费处理。计费相关指导,请参考计费说明。 - [怎样保护API的调用安全?](https://support.huaweicloud.com/apig_faq/apig-faq-180307003.md): 使用身份认证创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。设置访问控制策略从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。从IP地址(或地址区间)以及账号 - [怎样保证API网关调用后端服务器的安全?](https://support.huaweicloud.com/apig_faq/apig-faq-180307009.md): 通过以下方法确保API网关调用后端服务器的安全:为API绑定签名密钥。在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名信息是否一致。在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名 - [无法创建API是什么原因?](https://support.huaweicloud.com/apig_faq/apig-faq-2005007.md): API免费创建。如果被限制操作,可能原因为用户欠费,请及时充值。计费相关的详细指导,请参考计费说明。 - [API的响应码如何定义?](https://support.huaweicloud.com/apig_faq/apig-faq-2005001.md): API响应码分两种类型。一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。 - [API的后端服务是否支持绑定私网ELB地址?](https://support.huaweicloud.com/apig_faq/apig-faq-2005003.md): 专享版支持绑定私网ELB地址。共享版不支持绑定私网ELB地址,请使用VPC通道。如果是公网ELB地址,可直接使用。 - [API的后端服务地址支持填写私有地址(子网IP)吗?](https://support.huaweicloud.com/apig_faq/apig-faq-2005006.md): 专享版:支持。实例所在同一个vpc子网内IP,或者通过专线打通的本地数据中心私有地址。不支持专享版的网段:0.0.0.0/810.0.0.0/8100.125.0.0/16127.0.0.0/8169.254.0.0/16172.16.0.0/12192.0.0.0/24192.0.2.0/24192.88.99.0/24192.168. - [APIG是否支持多后端节点方案?](https://support.huaweicloud.com/apig_faq/apig-faq-180606012.md): 支持。通过VPC通道(负载通道)支持多后端节点,一个VPC通道中可以添加多个云服务器。关于VPC通道(负载通道)的详细操作,请参考负载通道。 - [API可以绑定内网域名吗?](https://support.huaweicloud.com/apig_faq/apig-faq-2005021.md): 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址,或者将CNAME类型记录解析到API分组的调试域名。更多详情请参考获取域名。 - [为什么跨域调用API失败?](https://support.huaweicloud.com/apig_faq/apig-faq-190627027.md): 可能原因API的跨域共享配置不正确。解决方法检查是否开启CORS。进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。参数配置如下:所属分组:选 - [API网关如何开放部署在华为云上的服务?](https://support.huaweicloud.com/apig_faq/apig-faq-190429024.md): 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。如果部署在华为云上的服务无公网IP地址,则将此服务的访问方式设置为VPC内网访问,在API网关中创建API时,通过VPC通道访问部署在 - [无法创建API是什么原因?](https://support.huaweicloud.com/apig_faq/apig-faq-2005007.md): API免费创建。如果被限制操作,可能原因为用户欠费,请及时充值。计费相关的详细指导,请参考计费说明。 - [API的响应码如何定义?](https://support.huaweicloud.com/apig_faq/apig-faq-2005001.md): API响应码分两种类型。一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。 - [API的后端服务是否支持绑定私网ELB地址?](https://support.huaweicloud.com/apig_faq/apig-faq-2005003.md): 专享版支持绑定私网ELB地址。共享版不支持绑定私网ELB地址,请使用VPC通道。如果是公网ELB地址,可直接使用。 - [API的后端服务地址支持填写私有地址(子网IP)吗?](https://support.huaweicloud.com/apig_faq/apig-faq-2005006.md): 专享版:支持。实例所在同一个vpc子网内IP,或者通过专线打通的本地数据中心私有地址。不支持专享版的网段:0.0.0.0/810.0.0.0/8100.125.0.0/16127.0.0.0/8169.254.0.0/16172.16.0.0/12192.0.0.0/24192.0.2.0/24192.88.99.0/24192.168. - [APIG是否支持多后端节点方案?](https://support.huaweicloud.com/apig_faq/apig-faq-180606012.md): 支持。通过VPC通道(负载通道)支持多后端节点,一个VPC通道中可以添加多个云服务器。关于VPC通道(负载通道)的详细操作,请参考负载通道。 - [API可以绑定内网域名吗?](https://support.huaweicloud.com/apig_faq/apig-faq-2005021.md): 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址,或者将CNAME类型记录解析到API分组的调试域名。更多详情请参考获取域名。 - [为什么跨域调用API失败?](https://support.huaweicloud.com/apig_faq/apig-faq-190627027.md): 可能原因API的跨域共享配置不正确。解决方法检查是否开启CORS。进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。参数配置如下:所属分组:选 - [API网关如何开放部署在华为云上的服务?](https://support.huaweicloud.com/apig_faq/apig-faq-190429024.md): 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。如果部署在华为云上的服务无公网IP地址,则将此服务的访问方式设置为VPC内网访问,在API网关中创建API时,通过VPC通道访问部署在 - [对API的修改是否需要重新发布?](https://support.huaweicloud.com/apig_faq/apig-faq-180307002.md): 需要。API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。关于API重新发布的详细指导,请参考发布API。 - [API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理?](https://support.huaweicloud.com/apig_faq/apig-faq-180606011.md): API发布到非RELEASE环境无法访问时,添加x-stage请求消息头后即可访问。例如:您也可以参考快速开放并调用API章节中的示例。 - [API发布到不同环境后,会调用不同的后端服务吗?](https://support.huaweicloud.com/apig_faq/apig-faq-181016019.md): 使用环境变量,或者在后端服务定义不同的参数,可以实现API发布到不同环境后,调用不同的后端服务。有关环境变量的详细指导,请参考创建环境变量。 - [调试API的时候,如何指定环境?](https://support.huaweicloud.com/apig_faq/apig-faq-2005027.md): 调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 - [对API的修改是否需要重新发布?](https://support.huaweicloud.com/apig_faq/apig-faq-180307002.md): 需要。API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。关于API重新发布的详细指导,请参考发布API。 - [API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理?](https://support.huaweicloud.com/apig_faq/apig-faq-180606011.md): API发布到非RELEASE环境无法访问时,添加x-stage请求消息头后即可访问。例如:您也可以参考快速开放并调用API章节中的示例。 - [API发布到不同环境后,会调用不同的后端服务吗?](https://support.huaweicloud.com/apig_faq/apig-faq-181016019.md): 使用环境变量,或者在后端服务定义不同的参数,可以实现API发布到不同环境后,调用不同的后端服务。有关环境变量的详细指导,请参考创建环境变量。 - [调试API的时候,如何指定环境?](https://support.huaweicloud.com/apig_faq/apig-faq-2005027.md): 调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 - [调用API失败的可能原因](https://support.huaweicloud.com/apig_faq/apig-faq-2005010.md): 调用API失败的场景分为三种:同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。VPC内调用API失败时,请检查域名是否和API自动分配的域名一致,如果域名错误,会导致调用API失败。不同VPC之间调用API失败时,请检查两个VPC的网络是否互通。如果不通,可以通过创建VPC对等连接,将两个VPC的网络打通,实现跨VPC访问实例 - [调用API报“414 Request URI too large”](https://support.huaweicloud.com/apig_faq/apig-faq-2005022.md): 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。有关API调用的报错信息,请参考错误码。 - [调用API报“The API does not exist or has not been published in the environment”](https://support.huaweicloud.com/apig_faq/apig-faq-19123002.md): 调用API网关中开放的API报错,请按以下顺序排查可能原因:调用API所使用的域名、请求方法、路径不正确。比如创建的API为POST方法,您使用了GET方法调用。比如访问的URL比API详情中的URL少一个“/”也会导致无法匹配上此API,例如http://7383ea59c0cd49a2b61d0fd1d351a619.apigw.re - [调用API报“No backend available”](https://support.huaweicloud.com/apig_faq/apig-faq-181016018.md): 检查后端服务是否可以访问,如果不能访问,请修改后端服务。检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 > 实例信息”界面开启出口地址。检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子 - [API的后端服务报“Backend unavailable”或“Backend timeout”](https://support.huaweicloud.com/apig_faq/apig_0087908599.md): 以下原因可能导致后端服务调用失败或者超时,请逐一排查。 - [API的后端服务报“Backend domain name resolution failed”](https://support.huaweicloud.com/apig_faq/apig-faq-0004.md): APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。可能原因APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。解决方法方法一:在创建API时,使用公网域名配置“后端服务地址”。方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服 - [调用API报“Incorrect IAM authentication information”](https://support.huaweicloud.com/apig_faq/apig-faq-0003.md): IAM认证信息错误有:Incorrect IAM authentication information: verify aksk signature failIncorrect IAM authentication information: AK access failed to reach the limit,forbiddenInco - [调用API报“Incorrect app authentication information”](https://support.huaweicloud.com/apig_faq/apig-faq-0009.md): APP认证信息错误有:Incorrect app authentication information: app not found, appkey xxxIncorrect app authentication information: verify signature fail, canonicalRequestIncorrect a - [修改API后端服务的超时时间上限“backend_timeout”后未生效](https://support.huaweicloud.com/apig_faq/apig-faq-19122004.md): 修改APIG实例参数“backend_timeout”后未生效。在“后端基础定义”中,“后端超时(ms)”未修改。进入API网关控制台,在目标API详情页面,单击“编辑”,在“定义后端服务”中配置“后端超时(ms)”。 - [APIG对API请求体的大小是否有限制?](https://support.huaweicloud.com/apig_faq/apig-faq-180606013.md): 共享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,API网关会拒绝该请求。这种场景,推荐考虑使用对象存储服务。专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。“reques - [API调用对请求的响应消息体限制](https://support.huaweicloud.com/apig_faq/apig-faq-19122003.md): API调用对请求的响应体大小没有限制。API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 - [使用iOS系统时,如何使用APP认证调用API?](https://support.huaweicloud.com/apig_faq/apig-faq-190515025.md): 目前API网关为APP认证提供了Java、Python、C、PHP、Go等多种语言的SDK与demo。当您使用iOS系统(Objective-C语言)或者其他未包含在内的语言时,请参考APP认证工作原理的指导进行APP认证。 - [新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?](https://support.huaweicloud.com/apig_faq/apig-faq-190627029.md): x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。API网关控制台中已经限定您无法创建HEADER位置的x-auth-token,您只需在调用此API时,直接在header中增加x-auth-token和其值即可。 - [是否支持移动应用调用API?](https://support.huaweicloud.com/apig_faq/apig-faq-180307004.md): API支持被移动应用调用。使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。 - [部署在VPC下的应用是否可以调用API?](https://support.huaweicloud.com/apig_faq/apig-faq-180307008.md): 默认部署在VPC下的应用可以调用API。如果域名解析失败,则参考配置内网DNS,在当前终端节点上配置DNS服务器。配置完成后,部署在VPC下的应用可以调用API。配置DNS需要配置“/etc”目录下的resolv.conf文件,指定DNS服务器的IP地址。内网DNS服务器的IP地址与您所位于的区域相关,您可通过内网DNS地址表获取内网DN - [APIG是否支持WebSocket数据传输?](https://support.huaweicloud.com/apig_faq/apig-faq-190627033.md): API网关支持WebSocket数据传输。在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 - [API的策略后端有多个时,怎么匹配和执行API请求?](https://support.huaweicloud.com/apig_faq/apig-faq-19123001.md): 当您的API配置了多个策略后端,API网关会按顺序进行匹配,匹配到其中一个立即执行API请求转发,不会进行后续的匹配。当策略后端都没有匹配成功,则按照默认后端执行API请求的转发。 - [如何通过APIG访问公网后端服务?](https://support.huaweicloud.com/apig_faq/apig-faq-0007.md): 通过开启公网入口访问,允许外部服务调用API。如果您在调用API遇到网络问题,请参考调用API失败的可能原因。 - [调用API失败的可能原因](https://support.huaweicloud.com/apig_faq/apig-faq-2005010.md): 调用API失败的场景分为三种:同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。VPC内调用API失败时,请检查域名是否和API自动分配的域名一致,如果域名错误,会导致调用API失败。不同VPC之间调用API失败时,请检查两个VPC的网络是否互通。如果不通,可以通过创建VPC对等连接,将两个VPC的网络打通,实现跨VPC访问实例 - [调用API报“414 Request URI too large”](https://support.huaweicloud.com/apig_faq/apig-faq-2005022.md): 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。有关API调用的报错信息,请参考错误码。 - [调用API报“The API does not exist or has not been published in the environment”](https://support.huaweicloud.com/apig_faq/apig-faq-19123002.md): 调用API网关中开放的API报错,请按以下顺序排查可能原因:调用API所使用的域名、请求方法、路径不正确。比如创建的API为POST方法,您使用了GET方法调用。比如访问的URL比API详情中的URL少一个“/”也会导致无法匹配上此API,例如http://7383ea59c0cd49a2b61d0fd1d351a619.apigw.re - [调用API报“No backend available”](https://support.huaweicloud.com/apig_faq/apig-faq-181016018.md): 检查后端服务是否可以访问,如果不能访问,请修改后端服务。检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 > 实例信息”界面开启出口地址。检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子 - [API的后端服务报“Backend unavailable”或“Backend timeout”](https://support.huaweicloud.com/apig_faq/apig_0087908599.md): 以下原因可能导致后端服务调用失败或者超时,请逐一排查。 - [API的后端服务报“Backend domain name resolution failed”](https://support.huaweicloud.com/apig_faq/apig-faq-0004.md): APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。可能原因APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。解决方法方法一:在创建API时,使用公网域名配置“后端服务地址”。方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服 - [调用API报“Incorrect IAM authentication information”](https://support.huaweicloud.com/apig_faq/apig-faq-0003.md): IAM认证信息错误有:Incorrect IAM authentication information: verify aksk signature failIncorrect IAM authentication information: AK access failed to reach the limit,forbiddenInco - [调用API报“Incorrect app authentication information”](https://support.huaweicloud.com/apig_faq/apig-faq-0009.md): APP认证信息错误有:Incorrect app authentication information: app not found, appkey xxxIncorrect app authentication information: verify signature fail, canonicalRequestIncorrect a - [修改API后端服务的超时时间上限“backend_timeout”后未生效](https://support.huaweicloud.com/apig_faq/apig-faq-19122004.md): 修改APIG实例参数“backend_timeout”后未生效。在“后端基础定义”中,“后端超时(ms)”未修改。进入API网关控制台,在目标API详情页面,单击“编辑”,在“定义后端服务”中配置“后端超时(ms)”。 - [APIG对API请求体的大小是否有限制?](https://support.huaweicloud.com/apig_faq/apig-faq-180606013.md): 共享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,API网关会拒绝该请求。这种场景,推荐考虑使用对象存储服务。专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。“reques - [API调用对请求的响应消息体限制](https://support.huaweicloud.com/apig_faq/apig-faq-19122003.md): API调用对请求的响应体大小没有限制。API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 - [使用iOS系统时,如何使用APP认证调用API?](https://support.huaweicloud.com/apig_faq/apig-faq-190515025.md): 目前API网关为APP认证提供了Java、Python、C、PHP、Go等多种语言的SDK与demo。当您使用iOS系统(Objective-C语言)或者其他未包含在内的语言时,请参考APP认证工作原理的指导进行APP认证。 - [新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?](https://support.huaweicloud.com/apig_faq/apig-faq-190627029.md): x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。API网关控制台中已经限定您无法创建HEADER位置的x-auth-token,您只需在调用此API时,直接在header中增加x-auth-token和其值即可。 - [是否支持移动应用调用API?](https://support.huaweicloud.com/apig_faq/apig-faq-180307004.md): API支持被移动应用调用。使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。 - [部署在VPC下的应用是否可以调用API?](https://support.huaweicloud.com/apig_faq/apig-faq-180307008.md): 默认部署在VPC下的应用可以调用API。如果域名解析失败,则参考配置内网DNS,在当前终端节点上配置DNS服务器。配置完成后,部署在VPC下的应用可以调用API。配置DNS需要配置“/etc”目录下的resolv.conf文件,指定DNS服务器的IP地址。内网DNS服务器的IP地址与您所位于的区域相关,您可通过内网DNS地址表获取内网DN - [APIG是否支持WebSocket数据传输?](https://support.huaweicloud.com/apig_faq/apig-faq-190627033.md): API网关支持WebSocket数据传输。在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 - [API的策略后端有多个时,怎么匹配和执行API请求?](https://support.huaweicloud.com/apig_faq/apig-faq-19123001.md): 当您的API配置了多个策略后端,API网关会按顺序进行匹配,匹配到其中一个立即执行API请求转发,不会进行后续的匹配。当策略后端都没有匹配成功,则按照默认后端执行API请求的转发。 - [如何通过APIG访问公网后端服务?](https://support.huaweicloud.com/apig_faq/apig-faq-0007.md): 通过开启公网入口访问,允许外部服务调用API。如果您在调用API遇到网络问题,请参考调用API失败的可能原因。 - [APIG是否支持双向认证?](https://support.huaweicloud.com/apig_faq/apig-faq-2005013.md): 专享版:支持。前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。共享版:不支持,API网关仅做HTTPS的单向认证。 - [API签名认证的内容是否包括Body体?](https://support.huaweicloud.com/apig_faq/apig-faq-2005018.md): 包括。除了几个必选的请求头部参数,Body体也是签名要素之一。例如有一个使用POST方法上传文件的API,那么在签名过程中,会取这个文件的hash值,参与生成签名信息。关于签名的详细指导,可参考:签名认证算法详解。 - [调用API提示AK/SK过期怎么处理?](https://support.huaweicloud.com/apig_faq/apig-faq-2005019.md): 客户端签名时将本地时间作为时间戳进行签名,如果本地时间与北京时间相差超过15min,网关会认为签名过期。处理方法:将本地系统时间调整为与北京时间同步,确保时间的准确性,例如现在北京时间早上8:00,设置本地系统时间为北京时间早上8:00。 - [API认证凭据问题汇总](https://support.huaweicloud.com/apig_faq/apig-faq-190627030.md): Q:最多支持创建多少个应用(凭据)?每个用户最多创建50个应用(凭据)。包括您自行创建的凭据和在云商店购买API生成的APP。Q:APP认证的API,怎样实现不同的第三方之间无法知道对方调用情况?创建多个应用(凭据),并绑定同一个API,分发给不同的第三方不一样的应用(凭据)。Q:APP认证的API,有没有限制可以给多少个第三方使用?没有 - [APIG是否支持双向认证?](https://support.huaweicloud.com/apig_faq/apig-faq-2005013.md): 专享版:支持。前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。共享版:不支持,API网关仅做HTTPS的单向认证。 - [API签名认证的内容是否包括Body体?](https://support.huaweicloud.com/apig_faq/apig-faq-2005018.md): 包括。除了几个必选的请求头部参数,Body体也是签名要素之一。例如有一个使用POST方法上传文件的API,那么在签名过程中,会取这个文件的hash值,参与生成签名信息。关于签名的详细指导,可参考:签名认证算法详解。 - [调用API提示AK/SK过期怎么处理?](https://support.huaweicloud.com/apig_faq/apig-faq-2005019.md): 客户端签名时将本地时间作为时间戳进行签名,如果本地时间与北京时间相差超过15min,网关会认为签名过期。处理方法:将本地系统时间调整为与北京时间同步,确保时间的准确性,例如现在北京时间早上8:00,设置本地系统时间为北京时间早上8:00。 - [API认证凭据问题汇总](https://support.huaweicloud.com/apig_faq/apig-faq-190627030.md): Q:最多支持创建多少个应用(凭据)?每个用户最多创建50个应用(凭据)。包括您自行创建的凭据和在云商店购买API生成的APP。Q:APP认证的API,怎样实现不同的第三方之间无法知道对方调用情况?创建多个应用(凭据),并绑定同一个API,分发给不同的第三方不一样的应用(凭据)。Q:APP认证的API,有没有限制可以给多少个第三方使用?没有 - [是否支持对API的请求并发次数做控制?](https://support.huaweicloud.com/apig_faq/apig-faq-2005026.md): 不支持。流控策略只控制单位时间内调用次数,无请求并发次数控制。每个API的访问频率不超过6000次/秒,详情请参考约束与限制章节。对API调用限制次数可通过流量控制策略控制,配置流量控制策略请参考配置API的流量控制策略章节。 - [企业账号是否有调试域名每天最多可以访问1000次的限制?](https://support.huaweicloud.com/apig_faq/apig-faq-190627032.md): 有。每个子域名(调试域名)每天最多可以访问1000次的限制同样适用于企业账号。有关子域名(调试域名)的详细指导,请参考绑定域名。 - [API调用是否存在带宽限制](https://support.huaweicloud.com/apig_faq/apig-faq-19122002.md): 共享版API网关按照流控策略以及单个请求的最大Body体(12M)进行管控,没有直接限制带宽。专享版API网关存在带宽限制,在创建实例时可以选择公网入口以及出口带宽。 - [API的流量控制策略不生效怎么处理?](https://support.huaweicloud.com/apig_faq/apig-faq-0001.md): 如果流控策略的API流量限制或源IP流量限制不生效,检查API是否绑定流控策略。如果流控策略的用户流量限制不生效,检查API的安全认证方式是否为APP认证或IAM认证。如果流控策略的应用(凭据)流量限制不生效,检查API的安全认证方式是否为APP认证。 - [怎样给指定的用户开放API?](https://support.huaweicloud.com/apig_faq/apig-faq-2005008.md): 可以采用以下两种方式:创建API时可选取APP认证方式,AppKey和AppSecret分享给指定的用户。使用访问控制策略,按照IP地址或者账号名,只允许符合允许策略的用户调用API。 - [API访问控制策略配置的IP地址是否为客户端的IP地址?](https://support.huaweicloud.com/apig_faq/apig-faq-0008.md): 访问控制策略的IP地址不一定取客户端的IP地址。APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP,它的值是服务端根据客户端的IP指定的,当客户端访问APIG时,如果中间没有任何代理,那么就会把remote_addr设为客户端IP;如果使用了某个代理,那么客户端会先访问这个代理,然后再由 - [调用绑定JWT认证策略的API报“Public key does not exist”](https://support.huaweicloud.com/apig_faq/apig-faq-0011.md): 如果JWT认证策略的公钥获取方式为“定时拉取”,请检查填入的JWKS_URI远程服务是否运行正常,调用该地址是否有JWKS公钥响应返回;此外,请检查返回的公钥是否符合正确的JWKS格式。请检查请求携带Token中的kid,是否与JWKS中某一个公钥的kid匹配;网关会使用kid查找对应的公钥,如果JWKS中没有匹配的公钥,则会报错公钥不存 - [是否支持对API的请求并发次数做控制?](https://support.huaweicloud.com/apig_faq/apig-faq-2005026.md): 不支持。流控策略只控制单位时间内调用次数,无请求并发次数控制。每个API的访问频率不超过6000次/秒,详情请参考约束与限制章节。对API调用限制次数可通过流量控制策略控制,配置流量控制策略请参考配置API的流量控制策略章节。 - [企业账号是否有调试域名每天最多可以访问1000次的限制?](https://support.huaweicloud.com/apig_faq/apig-faq-190627032.md): 有。每个子域名(调试域名)每天最多可以访问1000次的限制同样适用于企业账号。有关子域名(调试域名)的详细指导,请参考绑定域名。 - [API调用是否存在带宽限制](https://support.huaweicloud.com/apig_faq/apig-faq-19122002.md): 共享版API网关按照流控策略以及单个请求的最大Body体(12M)进行管控,没有直接限制带宽。专享版API网关存在带宽限制,在创建实例时可以选择公网入口以及出口带宽。 - [API的流量控制策略不生效怎么处理?](https://support.huaweicloud.com/apig_faq/apig-faq-0001.md): 如果流控策略的API流量限制或源IP流量限制不生效,检查API是否绑定流控策略。如果流控策略的用户流量限制不生效,检查API的安全认证方式是否为APP认证或IAM认证。如果流控策略的应用(凭据)流量限制不生效,检查API的安全认证方式是否为APP认证。 - [怎样给指定的用户开放API?](https://support.huaweicloud.com/apig_faq/apig-faq-2005008.md): 可以采用以下两种方式:创建API时可选取APP认证方式,AppKey和AppSecret分享给指定的用户。使用访问控制策略,按照IP地址或者账号名,只允许符合允许策略的用户调用API。 - [API访问控制策略配置的IP地址是否为客户端的IP地址?](https://support.huaweicloud.com/apig_faq/apig-faq-0008.md): 访问控制策略的IP地址不一定取客户端的IP地址。APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP,它的值是服务端根据客户端的IP指定的,当客户端访问APIG时,如果中间没有任何代理,那么就会把remote_addr设为客户端IP;如果使用了某个代理,那么客户端会先访问这个代理,然后再由 - [调用绑定JWT认证策略的API报“Public key does not exist”](https://support.huaweicloud.com/apig_faq/apig-faq-0011.md): 如果JWT认证策略的公钥获取方式为“定时拉取”,请检查填入的JWKS_URI远程服务是否运行正常,调用该地址是否有JWKS公钥响应返回;此外,请检查返回的公钥是否符合正确的JWKS格式。请检查请求携带Token中的kid,是否与JWKS中某一个公钥的kid匹配;网关会使用kid查找对应的公钥,如果JWKS中没有匹配的公钥,则会报错公钥不存 - [导入API失败有哪些原因?](https://support.huaweicloud.com/apig_faq/apig-faq-2005024.md): 可能原因1:单次导入的API数量超出上限。当前单次最高能导入300个API,如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。可能原因3:YAML文件格式问题,需要检查和修正。可能原因4:本地proxy网络限 - [使用Swagger文件导入API时是否有模板?](https://support.huaweicloud.com/apig_faq/apig-faq-2005025.md): 模板在开发中。您可以先配置好1~2个API,再导出作为模板。 - [导入API失败有哪些原因?](https://support.huaweicloud.com/apig_faq/apig-faq-2005024.md): 可能原因1:单次导入的API数量超出上限。当前单次最高能导入300个API,如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。可能原因3:YAML文件格式问题,需要检查和修正。可能原因4:本地proxy网络限 - [使用Swagger文件导入API时是否有模板?](https://support.huaweicloud.com/apig_faq/apig-faq-2005025.md): 模板在开发中。您可以先配置好1~2个API,再导出作为模板。