API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
专享实例
实例规格使用费用 目前API网关提供了8种实例规格，每个实例规格的性能参数如下表所示：实例规格 最大入访每秒请求数（RPS）最大入访连接数 最大入访每秒新建连接数（CPS）最大出访连接池大小 最大公网入访带宽（bps）最大公网出访带宽（bps...
API监控的维度
可以对 API 的调用量、错误分布、响应时间、流量大小等维度进行监控。
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
使用限制
限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多创建5个未绑定域名的API分组，...
共享实例
API网关的共享实例适用于开发测试、评估和小规模的生产环境使用。在您使用共享实例时，使用费用由API调用量（次数）费用和公网出访流量费用两部分构成。1.API调用量费用 共享实例的API调用量费用，根据您发布的API实际发生的调用量阶梯计费...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
数据服务
加工后的数据供应用读取：通过数据工具对数据进行加工汇总后，业务应用希望读取这部分加工后的数据进行业务处理，则可通过API的方式快速输出。当需要变更读取的逻辑时，只需要调整API背后的数据逻辑，而不需要重新发布应用。目前API网关...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
API分组的归属实例迁移
1 不同实例的适用场景 共享实例（VPC）：多租户共享出口IP与带宽，易受其他租户影响，更适合开发测试、评估和小规模的生产环境使用。专享实例（VPC）：用户可以通过支付规格配置费用自助购买更高的RPS，获取独享的资源，包含公网入口IP地址...
QueryRequestLogs-获取请求日志
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API网关灰度发布最佳实践
API网关客户在应用迭代过程中会不断有新版本API发布，在新版本正式发布前，可以使用灰度流量控制先进行小规模验证，将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行，通过收集使用体验的数据，对应用新版本的...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
为RAM用户授权
本文为您介绍云控制API的RAM权限管理。您可以为RAM用户授予不同的权限，提供给您企业的员工用来使用云控制API，从而让您避免与其他用户共享云账号密钥，降低您企业的信息安全风险。前提条件 您已创建RAM用户（子用户）。具体操作，请参见 ...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
计费概述
API网关支持共享实例和专享实例两种使用模式，两种实例适用于不同的使用场景，具体关于两种实例的差异可以详见 实例类型与选择指南。专享实例适合场景：提供高性能和高SLA保证，适合生产环境使用。共享实例适合场景：开发测试、评估和小...
共享实例
共享实例的所有云资源包括ECS/SLB/Redis等均被所有共享实例用户共享，无法保证后端延时及性能，易受其他租户影响，更适合开发测试、评估和小规模的生产环境使用。规格与限制 共享实例（VPC）每个用户同region最大入访每秒请求数(RPS)1000 ...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
Mock
配置 Mock 在 API 编辑页面-定义API后端服务，来配置 Mock。1.填写 Mock 返回结果 Mock 返回结果，可以填写您真实的返回结果。目前支持是 Json、XMl、文本等格式作为 Mock 返回结果。如：{"result":{"title":"API 网关 Mock 测试",.} } ...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
如何配置出访连接池告警
若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个实例最大支持的出访RPS是1200，超过1200后，如果请求进入API网关，后端连接池被占满，API网关会让请求进入一个等待队列，...
产品优势
多种客户端接入支持 同一个 API 发布后，既支持 mPaaS 移动端 iOS 和 Android 的应用接入，也支持非移动端小程序、H5、Web、后端应用等应用接入。多协议/多语言异构集成 支持不同语言，不同技术栈实现的业务系统之间进行无缝集成，支持协议...
DescribeInstancePackets-获取实例的数据包数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceNewConnections-查询实例的新连接数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceDropConnections-获取实例的丢失链接
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeInstanceSlbConnect-获取实例的Slb链接
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
后端路由
1.2.Condition条件表达式 1.2.1 基本语法 Condition表达式与SQL表达式类似，基础表达形式为$A='A' and '$B='B' 参数以$开头，可以引用在API中定义的参数（API为映射与透传方式均可），如果您在API中定义了名为query1的参数，则$query1 可以...
DescribeInstanceDropPacket-获取实例丢弃的数据数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
RequestParameter
描述 节点名 RequestParameter 子节点 ApiParameterName String 参数名 Location String 参数位置，取值为：BODY、HEAD、QUERY、PATH ParameterType String 参数类型，取值为：String、Int、Long、Float、Double、Boolean，分别表示字符、...
授权信息
API：是指操作对应的API接口。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。资源类型：是指操作中支持授权的资源类型。具体说明如下：对于必选的资源类型，用背景高亮的方式表示。对于不支持资源...
UpgradeResourcePackage-升级资源包服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 用户...
产品使用是怎么收费的？
按 API 被调用的次数、使用的流量及指定的缓存大小收费，公测期间免费。
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
实例类型与选择指南
1.API网关实例类型 API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡、服务器、存储等，API分组必须挂载在合法的实例下才能运行，目前API网关有如下的实例类型供您选择：1.1.实例类型说明 共享实例...
参数访问控制插件
2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用JWT认证，JWT中有userId和userType两个claim,我们这个插件的校验条件为：当userType=admin时，允许所有的路径。当userType=user时，仅允许/{userId}路径一致的请求。在...
缓存插件
通过缓存可以将后端返回的应答缓存在API网关服务层面，有效降低后端的负荷，增加平滑度。1.使用方法 仅缓存 GET 方法的应答 不缓存使用 默认分组二级域名 的请求，默认分组二级域名有1000次/天的限制（海外Region及中国香港限制100次/天）...
QueryPriceEntityList-商品定价对象列表查询
接口说明 本 API 是用来查询一个商品下有哪些定价对象。定价对象是用来计量和计算费用的最小产品能力。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试...
断路器插件（仅专享实例）
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
CreateResourcePackage-创建资源包服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您