SDK下载及使用指南
若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务（包括在 API 市场购买的 API 服务）注意这里的 API 服务是指在 API 市场购买的，或者您在 API 网关接入开放的，或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...
GetServiceTemplateParameterConstraints-查询ROS模板...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
DescribeContainerGroupEvents-查询容器组事件列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
HTTP 转 SOFARPC 入门
步骤五：创建应用 在左侧导航栏单击 API 订阅>应用管理 页，单击列表右上方的 创建应用。在 创建应用 窗口，选择 应用类型 为 应用。输入 应用名称，用于识别应用。本例使用 hello。单击 确定。应用添加完成后，订阅者需在应用详情页，获取...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
使用简单认证（AppCode）方式调用API
API调用者到API网关控制台的”应用管理“找到AppCode/AppSecret进行签名认证的调用或者AppCode进行简单认证的API调用。2.创建支持简单认证方式API API提供者在创建API安全认证方式时需要选择”阿里云APP”；AppCode认证选项选择允许AppCode...
后端服务调不通
在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以根据后端服务的实际耗时对"后端超时"进行调整，共享实例最大支持30000ms，专享实例最大支持120000ms。说明 ...
ListTransitRouterRouteTables-查询企业版转发路由器...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
参数映射与校验规则
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...
DescribeDataCaches-查询数据缓存
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API网关灰度发布最佳实践
基于JWT的灰度：当API绑定JWT插件时，API网关可以从JWT中解析没有加密过的用户身份相关的claim，比如用户userId，支持按照从 Token 中解析得到的参数路由到不同后端，从而实现灰度发布。比如用户可以参考本文 3.2 节给出的插件配置，通过...
HTTPS 证书报错
证书不合法 API 提供者使用的证书其他非主流机构颁发的证书，此类证书使用浏览器访问是没有问题的，因为浏览器会自动更新根证书。但老版本操作系统的根证书对这些机构（证书颁发机构）的不信任或者信任时间已经过期。解决方案 升级客户端根...
UntagResources-删除用户标签和资源的关系
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:UntagResources Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 ResourceType string 是 资源类型定义，目前分组，插件，应用接入了标签，API 相关操作基于分组的标签...
共享实例
共享实例的所有云资源包括ECS/SLB/Redis等...总的公网最大入访带宽是5120M 最大公网出访带宽(bps)最大公网出访带宽就是实例页出口地址 IP的总和，一个IP是200M SLA 99.9%（2023年10月30号之前新建的API）99.0%（2023年10月30号之后新建的API）
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
CreateIpControl-新增IP访问控制
接口说明 调用本接口之前，您需要了解：此功能面向 API 提供者。IP 访问控制创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。具体的 IP 策略可以在创建 IP 控制时添加 当 IP 访问控制下策略为空时，该策略无效。...
ListTagResources-用户查询标签接口
目前分组，插件，应用接入了标签，API 相关操作基于分组的标签：apiGroup plugin app api apiGroup NextToken string 否 下一个查询开始 Token 1d2db86sca4384811e0b5e8707e68181f ResourceId array 否 资源 ID。N 的取值范围为：[1,50]...
故障排除
CC API在调用时可能会遇到一些错误，遇到错误时以错误码为依据进行故障排除，本文为您介绍 常见错误码的解决方案。云产品运行时错误码 云产品API运行时返回的错误码。以下两个错误码为云产品运行时错误，如想获取云产品详细错误信息，需...
实例变配
操作步骤 登录 API网关控制台 单击左侧的 实例 菜单，在 实例列表 的tab页面，找到要变配的实例，单击实例右侧的 升配 或 降配 链接，会跳转到实例变配页面。3.页面上选择要变配的 实例规格。4.勾选 API网关服务协议，然后单击 立即购买，...
AddIpControlPolicyItem-增加IP访问控制策略
接口说明 调用该接口时请注意：此功能面向 API 提供者。增加该策略后，所有绑定该访问控制的 API，即时生效。一个 IP 访问控制下最多添加 100 条策略。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，...
ModifyIpControlPolicyItem-修改IP访问控制下的策略
接口说明 此功能面向 API 提供者 增加该策略后，所有绑定该访问控制的 API，即时生效 修改是某条策略内容的全量修改 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
EvaluateTicket-评价工单
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 TicketId string 是 工单号...
后端签名插件
API绑定后端签名插件后，API 网关向您后端服务请求时会使用这一对Key和Secret对请求内容进行加签处理，您后端服务可以对网关发送过来的请求做对称加签计算，对比网关的签名和服务器端计算的签名是否一致就可以对网关做身份验证。...
使用AliOS Things对接ID²-SE
接口详细信息，请参考 SE 芯片驱动API文档。aos.mk内容如下：集成fm1280 SE驱动接口后，se文件夹结构如下图。使用代码 aos make id2_app@stm32f103vb-fmse-c config 编译id2测试app，确定编译结果中依赖的库是libkm_se。使用烧录工具烧写...
创建系统集群
系统集群表示 API 网关接收到前端请求后转发到真实业务系统的集群。本文介绍如何在 API 网关控制台快速创建系统集群。目前 API 网关支持创建 HTTP、SOFARPC、DUBBO、TRIPLE 和 SOFA_TR 五种协议类型的系统集群。说明 公有云环境中，创建 ...
DescribeBackups-查询备份集列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
插件数据集
API网关为用户提供了功能强大、支持热更新插件体系，大量核心能力均被迁移到插件体系中，截止目前为止API网关已经为用户提供了12种插件。插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活...
后端内网域名解析（仅专享实例）
后端内网域名指的是在API网关中配置的后端服务地址。当后端服务地址为内网域名时，API网关提供实例级别的后端服务内网域名解析。概述 例如，后端服务使用的内网域名是通过 PrivateZone 解析时，解析只能在客户指定的VPC内生效，API网关不在...
参数访问控制插件
2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用JWT认证，JWT中有userId和userType两个claim,我们这个插件的校验条件为：当userType=admin时，允许所有的路径。当userType=user时，仅允许/{userId}路径一致的请求。在...
实例类型与选择指南
1.API网关实例类型 API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡、服务器、存储等，API分组必须挂载在合法的实例下才能运行，目前API网关有如下的实例类型供您选择：1.1.实例类型说明 共享实例...
ReopenTicket-重开工单
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 TicketId string 是 工单...
错误码
说明 API 请求异常的原因可能是控制台没有下发配置或者网关没有及时更新配置。排查方式如下：检查网关是否配置了相应的 API 且 API 的状态是否为 已发布。检查客户端的 API 调用路径和分组等信息是否与网关维护的一致。检查请求的 host、...
在AliOS Things上适配ID²-SE
接口详细信息，请参考 SE 芯片驱动API文档。打开 AliOSThings/security/irot/se/aos.mk，添加文件夹，文件夹名称命名为对应SE芯片名称，本文示例中命名为fm1280。将SE芯片驱动的实现代码放入fm1280文件夹，并设置SE_CHIP_NAME为fm1280。...
- 产品推荐
- 这些文档可能帮助您