简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
DescribeRuleGroups-分页查询正则规则组
分页查询正则规则组。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用...
Web应用防火墙的审计事件
Web应用防火墙已与操作审计服务集成，您可以在操作审计中查询用户操作Web应用防火墙产生的管控事件。操作审计支持将管控事件投递到日志服务SLS的LogStore或对象存储OSS的存储空间中，满足实时审计、问题回溯分析等需求。操作审计记录了用户...
ValueTransferRule
使用正则表达式匹配到字符串后，将字符串转换为String、Integer或者Double类型。数据结构 message ValueTransferRule { required string regex=1;optional VariantType cast_type=2;} 名称 类型 是否必选 描述 regex string 是 正则表达式...
RewriteConfig
名称 类型 描述 示例值 object 重写规则配置 equalRules array 精确匹配规则列表 EqualRule 精确匹配规则 regexRules array 正则匹配规则列表 RegexRule 正则匹配规则 wildcardRules array 通配匹配规则列表 WildcardRule 通配匹配规则
可以对参数做哪些限制？
网关不仅支持参数最大值、最小值、长度、枚举校验，还支持正则、Json Schema 校验。
请求分组管理
正则表达式：指标准正则表达式，表示该分组规则对符合该正则表达式的请求有效。例如以下正则表达式：^www*：表示所有以www开头的字符串。[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+\.?符合域名格式得到匹配，例如...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
UpdatePushRule-更新推送规则
若不需要则不传值 on fileRuleRegexes array 该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制 string 文件限制正则表达式 \.java$gmtCreate string 创建时间 2023-09-03T18:20:06+08:00 gmtModified string 修改时间 2023-...
CreatePushRule-创建推送规则
block：禁止推送 warn fileRuleRegexes array 否 该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制 string 否 文件限制正则表达式 \.java$返回参数 名称 类型 描述 示例值 object Schema of Response requestId string 请求 ...
配置重写策略（公测中）
(.*)/api/v2/$1/api/v1/test/api/v2/test/api/v1-pre/test/api/v2/test 匹配顺序和优先级 三种匹配模式的优先级由高到低依次为：精确重写→通配符重写→正则重写。函数计算支持在一条路由规则下配置多条重写策略，因此，一条请求有可能匹配...
配置重写策略（公测中）
(.*)/api/v2/$1/api/v1/test/api/v2/test/api/v1-pre/test/api/v2/test 匹配顺序和优先级 三种匹配模式的优先级由高到低依次为：精确重写→通配符重写→正则重写。函数计算支持在一条路由规则下配置多条重写策略，因此，一条请求有可能匹配...
调试场景
若需重新设置出参，则单击 同步出参配置，将此正则表达式同步到该API的出参列表中。说明 场景调试结束后，如有同步的出参，需返回压测 场景配置 页签，在对应的API 出参定义 页签下，设置出参名。常见ERROR信息解答 常见报错信息。
调试场景
若需重新设置出参，则单击 同步出参配置，将此正则表达式同步到该API的出参列表中。说明 场景调试结束后，如有同步的出参，需返回压测 场景配置 页签，在对应的API 出参定义 页签下，设置出参名。Jmeter场景调试界面说明 JMeter场景调试...
RequestParameter
参数的最小值限定 MaxLength Long 当ParameterType=String，参数的最大长度限定 MinLength Long 当ParameterType=String，参数的最小长度限定 RegularExpression String 当ParameterType=String，参数验证（正则表达式）JsonScheme String ...
API 管理
正则模式：按照给定的正则表达式匹配串来进行匹配。匹配串：根据匹配模式的要求填写匹配串。单击+新增匹配规则，可添加多个 URL 路径匹配规则。单击 新增，完成自定义 API 的创建。新增的 API 将出现在 API 管理 页面。后续操作 新增 API ...
URL收敛机制说明
demo 定向关闭基于统计的收敛：您也可以通过正则式定向关闭基于统计的收敛，例如不收敛/api/v1/user/info，可以配置如下正则式。(?api/v1/user/info).)*服务端兜底收敛 ARMS服务端内置了兜底收敛机制，在前两种收敛规则不生效的情况下，...
配置自建认证鉴权
如果Token的形式是业务方自定义的格式，则服务端收到请求后，必须额外访问中心化的鉴权服务来完成鉴权操作，以此保护API接口的通信安全。云原生网关支持自定义鉴权。下面以一个示例来说明云原生网关接入自建的鉴权服务后的请求处理流程。...
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 类型 示例 描述 data ...
查询服务契约
您无需在应用中引入依赖，直接部署后，便可以通过服务契约在线查看微服务接口、路径等API信息，不但能查询提供的服务，还能方便的使用服务测试等功能。背景信息 服务契约包含了以下3个主要功能：API查询 查看服务提供者或消费者的重要API...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
参数映射与校验规则
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...
API流控规则
单击目标网关应用卡片，然后任选一种方式进入 API流控规则 的配置页面：在 接口详情 页面，单击API资源卡片右上角的加号图标。在左侧导航栏中单击 API流控规则，然后在页面右上角单击 新增流控规则。在 新增流控规则 对话框中，配置流控...
使用 RAM 管理 API
acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...
GetRuleDetail-获取规则的明细信息
目前该API接口已标记为弃用，推荐使用替代API：Qualitycheck(2019-01-15)-GetRuleV4。获取规则的明细信息。接口说明 说明 一般和 获取规则基本信息 联合使用，先用 GetRule 获取规则 ID，再以规则 ID 为参数获取规则详情。调试 您可以在...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
CreateRule-创建自定义的敏感数据识别规则
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API概览
OnsGroupSubDetail 查看Group ID的订阅信息 查看Group订阅了哪些Topic，如果Group ID对应的消费者实例不在线则查不到数据。OnsGroupDelete 删除Group 调用OnsGroupDelete删除Group。标签 API 标题 API概述 ListTagResources 查询资源绑定的...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
日志脱敏插件（仅专享实例）
匹配模式（MatchMode）：在Location为请求或响应的Body时必填，MatchMode定义了用于匹配敏感信息的正则表达式，无需指定Parameters。例如匹配特定长度的数字、邮箱地址、身份证号等。3.配置详情 在配置脱敏规则时，您可以自定义Name和...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API 分组
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
API 管理
},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...
OnsGroupSubDetail-查看Group ID的订阅信息
查看Group订阅了哪些Topic，如果Group ID对应的消费者实例不在线则查不到数据。接口说明 注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 Open...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
- 产品推荐
- 这些文档可能帮助您