API多版本的区别
版本差异 对比项 2016-08-15版API 2021-04-06版API Path中的 version 参数取值 Path格式为/{version}/services/xxxx 2016-08-15 2021-04-06 qualifier 位置 位于Path，例如：/version/serviceName.qualifier/xxx。位于Query，例如：/...
自定义服务API
除了使用预置指标API和产品数据API外，您还可以根据业务需要，新建自定义服务API获取数据指标和自定义存储表的数据。本文介绍如何创建自定义服务API。前提条件 已创建数据源相关的指标和存储表，具体信息，请参见 指标概述 和 自定义存储表...
请求中编码问题
API请求编码问题 客户端请求API网关时，需要对参数值进行utf-8的urlEncode，这样能避免特殊参数或者中文出现乱码。注意：query、header、body位置编码需要在签名计算后，签名时用原始值。以下代码可参考：...
RequestConfig
API path RequestMode String 是 请求的模式，取值为：MAPPING、MAPPING_PASSTHROUGH、PASSTHROUGH，分别表示入参映射（过滤未知参数）、入参映射（透传未知参数）、入参透传 BodyFormat String 否 POST/PUT请求时，表示数据以何种方式传递...
如何配置Path与后端服务地址中的动态参数？
在配置 Path 时，控制台可以自动带出后端服务地址中的动态参数，您需要将其与 Path 中动态参数对应上即可。
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
Doc
命令列表 表 1.TairDoc命令 命令 语法 说明 JSON.SET JSON.SET key path json[NX|XX]创建key并将JSON的值存储在对应的path中，若key及目标path已经存在，则更新对应的JSON值。JSON.GET JSON.GET key path[FORMAT XML|YAML][ROOTNAME root]...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
后端服务地址如何录入？
后端服务地址可以是域名，也可以是 IP，录入时，要以 http:// ...后端服务地址中的动态参数需要配合 Path 中的动态参数使用，在配置 Path 时，配置与 Path 的映射关系。示例：https://api.domain.com/resource/subresource/[subresourceid]
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API调用授权
BSS OpenAPI的权限为 bssapi:【API名称】，例如 bssapi:QueryOrder 或 bssapi:QueryInstanceBill。为了兼容控制台权限，以下表格中API对应的权限点同样可以使用。对于权限策略中，Allow或Deny一个API对应的任何一个权限点，权限策略都会...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。...Path 中支持动态参数，用[param]表示，如：instance/disk/[diskid]，可以与后端服务地址中的动态参数进行映射。
JSON函数
JSON_CONTAINS：判断指定Path中是否包含 candidate 的值；若未指定Path，则判断Target中是否包含 candidate 指定的值。JSON_CONTAINS_PATH：判断JSON中是否包含Path列表中的路径。JSON_REMOVE：从 json 中移除 json_path 指定的元素，并...
ModifyInstanceSpec-网关实例变配
API网关实例升降配置变更接口。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
参数访问控制插件
2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用JWT认证，JWT中有userId和userType两个claim,我们这个插件的校验条件为：当userType=admin时，允许所有的路径。当userType=user时，仅允许/{userId}路径一致的请求。在...
阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
Tunnel操作
说明 macOS系统中 path 值只能使用绝对路径，例如文件归档在MaxCompute客户端的 bin 目录中，此时 path 需要设置为 D:\MaxCompute\bin\文件名.后缀名。project_name：可选。目标表所属项目空间名称。跨项目空间访问表时需要指定该参数。...
模型管理
同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的POJO类。这样可以增强用户传入参数的便利性，同时可以方便用户反序列化返回的数据。API网关模型定义基于 JSON架构草案4 的规范，但...
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
JSON函数
目前仅支持字符串，如果 json_path 中提取的值类型是数值型，该函数先自动将 value_to_compare 中的字符串转换成数值型，再与 value_to_compare 进行比较。operator：比较操作符，支持LT或<、GT或>、LTE或、GTE或>=、E或=、NE或!或，不区分...
导入数据模型
API 网关会从 Swagger 2.0 文件中的 Model 或 Swagger 文件 3.0 中的 Schema 解析参数名称，参数结构，参数类型并转换后导入数据模型，可直接在 API 中自动生成示例入参的 JSON，数据模型也可直接在流程编排中进行参数配置，参数映射等。...
改写回源URL
待改写的Path^(.*)$说明^(.*)$代表任意字符，()代表的是一个分组，可以在目标Path中通过$1来调用分组的变量内容。目标Path/image$1 说明$1表示正则表达式中第一对圆括号中的表达式匹配到的内容，$2是第二个小括号里面的内容，依此类推。...
改写回源URL
待改写的Path^(.*)$说明^(.*)$代表任意字符，()代表的是一个分组，可以在目标Path中通过$1来调用分组的变量内容。目标Path/image$1 说明$1表示正则表达式中第一对圆括号中的表达式匹配到的内容，$2是第二个小括号里面的内容，依此类推。...
利用 API 实现资源和成本管理
利用 BssOpenAPI 实现资源和成本管理 BssOpenAPI 提供的功能 BssOpenAPI 是阿里云提供的实例、订单、账单和卡券管理等系列工具的API集合产品。通过 BssOpenAPI 我们可以实现从产品基本信息查询，到钱账票的统一管理功能。资源概念 BssOpen...
Pulumi安装
将Pulumi加入到PATH中。Windows和macOS系统使用自动安装命令会自动设置PATH，可跳过此步骤。Linux系统需要使用以下命令加入PATH：export PATH=$PATH:$HOME/.pulumi/bin 验证安装是否成功。pulumi version 可以通过阿里云主账号来使用Pulumi...
新功能发布记录
跨账号API元数据迁移 跨Region API元数据迁移 API元数据本地备份与恢复 全部 导出标准OAS定义 2023-06 功能名称 功能描述 发布地域 相关文档 Path支持多国语言文字及常用符号 允许用户将多国语言及产品字符配置到请求Path中去 全部 VPC融合...
查看API操作历史
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
注册API
说明 工作空间定义审批流后需要走流程审批才可以发布API，详情请参见：审批中心概述 发布API后，服务资源组的配置即可在调用API时生效。您还可以在 服务开发 页面左侧目录树中对目标API进行克隆和删除等操作。您也可以在 服务管理 页面，...
使用SDK调用API
{{group}}.md`对应Group的API接口文档` lib文件夹*sdk-core-java-1.1.5.jar `sdk的core包，为本SDK的依赖包`*sdk-core-java-1.1.5-sources.jar`上述依赖包的源码`*sdk-core-java-1.1.5-javadoc.jar`core包的文档` Readme.md`本SDK使用指南`...
创建 API 分组
API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组 登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击...
绑定/解绑 API
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API...
参数设置
请求参数：设置 Path 中的动态参数和 URL Query 参数，参数名称保证唯一。参数名称：必填，参数的名称。说明 如果为 Path 参数，请保证名称与请求 Path 中的一致。例如，请求 Path 为/pets/${id}，此时参数名称应为 id。参数位置：必填，...
产品架构
API 网关主要由 GW Controller 和 Mosng 两个组件构成，GW Controller 将数据推送给 Mosng 后，Mosng 开始对外提供服务。本文主要结合这两个组件介绍 API 网关架构。API Gateway 系统主要由以下组件构成：GW Controller：网关控制台，负责...
API概览
SwitchApi 切换指定环境中正在运行中的API定义 指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。DryRunSwagger 预检查swagger 使用swagger导入swagger之前先预先检查swagger的语法是否规范。应用 API 标题 ...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
SwitchApi-切换指定环境中正在运行中的API定义
指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
URL请求分类函数
api_path 通过函数推导出URL请求路径对应的接口。regex_tpl 通过算法推导出的正则表达式。输出结果 url_path|api_path|regex_tpl-+-+-/gl/balance/666398186799140|/gl/balance/*|\/gl\/balance\/[0-9].+gl/glaccount/30579281472076|/gl/...
创建授权对象
说明 当应用创建成功后，系统会自动给应用分别配一个 APPID，可在 API 订阅>应用管理 中的应用详情页查看。对于内部系统的应用，您需要输入其 应用名称，可自动获取其 APPID 与类型。所属公司/部门：可选，用于识别应用所属的公司或部门。...
- 产品推荐
- 这些文档可能帮助您