DescribeSystemParameters-查询系统参数列表
接口说明 此功能面向开放 API 的用户 此接口返回定义 API 时可选择接收的系统参数列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
步骤一：资源准备
在创建API的 定义API后端服务 配置向导页，填写Mock的返回信息。后端配置 选择 自定义后端服务，后端服务类型 选择 Mock，Mock的返回结果 如下所示，HTTP Status Code 配置为 200。在 Mock Header 区域，单击 新增一条，Header Name 为 ...
通过服务编排的方式创建API
定义组合API返回的字段并以return返回，其中 f1，f2 为返回字段名 c1，c2 为返回字段的取值变量。let result=seq.map("f1",c1,"f2",c2);return result;脚本说明 场景1：调用多个API，并将多个API的结果统一返回：#根据业务需求，编写计算...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
数据服务概述
设计理念 数据服务作为DMS的模块，其基于DMS上受控的数据定义API，与SQL Console中执行SQL时的权限控制、数据脱敏等功能检查保持一致。数据服务基于Serverless架构，您无需关注服务器、网络等运行环境相关的基础设施，只需专注于API的定义...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
API网关的审计事件
DescribeApisByApp 按应用查询定义中的API列表。DescribeApisByBackend 根据后端查询API列表。DescribeApisByIpControl 查询IP访问控制绑定的API。DescribeApisByRule 通过规则获取API列表。DescribeApisByRuleForConsole 通过规则获取API...
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
应用场景
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
HTTP自动跳转HTTPS
分组内的所有API定义的请求协议都已勾选HTTPS。操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的...
上传API至API网关
尽管插件做了很多推测，但仍应使用明确的声明定义API。声明精确的请求方法，使用@PostMapping 和@GetMapping，而不是@RequestMapping。使用@PostMapping 时，需声明精确的consumes。consumes对应HTTP请求的Content-Type，Content-Type中...
上传API至API网关
尽管插件做了很多推测，但仍应使用明确的声明定义API。声明精确的请求方法，使用@PostMapping 和@GetMapping，而不是@RequestMapping。使用@PostMapping 时，需声明精确的consumes。consumes对应HTTP请求的Content-Type，Content-Type中...
支持 HTTPS
可以在【开放API】-【API列表】找到相应API，【API定义】-编辑-【请求基础定义】中进行修改。API支持的协议包括：HTTP：只允许HTTP访问，不允许HTTPS HTTPS：只允许HTTPS访问，不允许HTTP HTTP和HTTPS：两者均可，调整后，API支持HTTPS协议...
自定义参数
若您的压测场景中需要自定义参数，或者在参数传递过程中需要二次定义参数，可以使用自定义参数功能实现。本文介绍自定义全局参数和自定义业务会话参数的方法。自定义全局参数 自定义的全局参数在整个压测场景中生效，具体操作步骤如下：...
自定义参数
若您的压测场景中需要自定义参数，或者在参数传递过程中需要二次定义参数，可以使用自定义参数功能实现。本文介绍自定义全局参数和自定义串联链路参数的方法。自定义全局参数 自定义的全局参数在整个压测场景中生效，具体操作步骤如下：...
API插件管理
4、输出参数 如上图为例，输出参数以data、errorInfo和status为主体结构，且不可编辑，status的返回值为string，仅接收success为成功的返回值，所以接入的api返回需要满足以下结构，否则会报错“插件API 返回结果与定义不一致。{"data":{"a...
基本概念
编排实例是一个可运行的独立部署的应用程序，承载工作流以及工作流节点所依赖的相关服务连接。工作流 工作流是以步骤的方式完成对业务流程的编排定义，也是编排实例的运行核心。工作流由一系列触发器和操作节点组成。您可以通过可视化的...
基于Swagger完成API网关与用户CICD流程整合
API网关通过访问这些接口，自动获取Swagger定义 创建API分组 用户可以在API网关控制台手动创建分组，或者通过 CreateApiGroup-创建API分组 创建分组。用户创建分组后，可以进行绑定独立域名以及绑定证书等操作。通过OpenAPI导入API并发布 ...
数据服务审批策略
支持管理员从DataWorks空间级别为每次发布的数据服务API定义发布审批流程。使用限制 企业版的DataWorks支持使用数据服务审批策略。新建审批策略 进入数据治理中心页面。登录 DataWorks控制台，切换至目标地域后，单击左侧导航栏的 数据治理...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
阿里云API网关试用服务协议
在使用阿里云API网关服务过程中，您需要对API定义/API流控/API访问权限自行操作，您将对自行操作的行为及其产生的结果负责；3.2.2.尽管目前使用阿里云API网关服务您仍不需付费，但在使用阿里云API网关过程中如您使用了阿里云的其他收费服务...
服务总线
模型定义如下：qrcodePayAndPush接口定义如下：7.2 服务提供的开发示例 需要实现服务模型中的API定义，应用必须实现声明的服务模型的所有的API定义，并且实现的API 入参和出参需要完全保持一致。示例代码：@Slf4j@Controller@Configuration...
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
常用类及其方法
无 返回值类型：普通的资源定义返回 Entry 对象，代表本次资源的调用。异步资源定义返回 AsyncEntry 对象，代表本次异步资源的调用。更多使用请参见 定义资源。托管资源定义类SentinelWrapper 说明 SentinelWrapper在Java SDK 1.8.0及以上...
常用类及其方法
无 返回值类型：普通的资源定义返回 Entry 对象，代表本次资源的调用。异步资源定义返回 AsyncEntry 对象，代表本次异步资源的调用。更多使用请参见 定义资源。托管资源定义类SentinelWrapper 说明 SentinelWrapper在Java SDK 1.8.0及以上...
使用简单认证（AppCode）方式调用API
注意：定义API参数的时候，不需要定义携带AppCode的头或者Header参数。3.调用方法 API提供者将API设置成允许AppCode调用之后，API调用者就可以使用简单认证方式进行调用了，不用再在客户端实现复杂的签名算法了。本章我们介绍下如何通过...
PAIFlow Manifest参数说明
image:镜像 command:运行命令 args:运行参数 详细定义 API版本、元信息以及输入输出定义等详情，请参见 公共格式。spec:initContainers:初始化容器列表-name:容器名 image:镜像 command:运行命令 args:运行参数 container:主容器 image:...
HTTP 转 SOFARPC 入门
在 定义 API 步骤中，您需要配置以下信息：API 分组：必选，选择上一步创建的 API 分组。API 名称：必填，用于识别 API，支持英文字母、中文、数字、下划线（_）、连接符（-），32 个字符以内。本示例使用 sofarpc。说明 同一个 API 分组下...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
版本说明
变更时间：2024-04-18 变更集发布说明：OpenAPI 名称 变更内容概要 操作 DescribeAuthorizedApps OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-04-18 变更集...
版本说明
变更时间：2022-03-08 变更集发布说明：ListMessages接口新增ErrorCode过滤 OpenAPI 名称 变更内容概要 操作 ListMessages OpenAPI 入参发生变更、OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入...
测试与发布API
返回条数 用于定义测试API时返回数据的条数：如果请求方式为LIST，则支持选择 返回条数，最大可返回10000条数据。请求方式为GET，不支持修改 返回条数。配置完成后，单击 测试 进行测试API与数据源数据的连通性。单击 查看脚本，支持查看...
版本说明
变更时间：2024-04-17 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetProject OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-01-08 变更集发布说明：Open...
集成函数计算
根据 函数计算 的 InvokeFunction-调用函数 API定义，函数返回结果类型为Byte，对应实际的数据类型。函数内部返回值可以是字符串JsonObject、JsonArray或者各种基础数据类型。流程调用接收到返回结果之后，会统一将结果封装成一个...
版本说明
新增入参：PipCode 变更时间：2023-12-12 变更集发布说明：OpenAPI 名称 变更内容概要 操作 QueryAccountBalance OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码...
- 产品推荐
- 这些文档可能帮助您