API概览
术语表 术语 全称 中文 说明 app application 应用 一个应用即一个完整的搜索服务 错误码 API 描述 错误码 返回错误码说明 公共调用方式 API 描述 授权机制 详细说明验签过程 应用操作接口 API 描述 数据处理 上传、修改、删除文档 搜索 ...
下载标注文件
Web前端直接调用 小程序场景下直接调用 Android端直接调用 iOS端直接调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 ...
3D语音驱动数字人接入指南
3D语音驱动数字人是虚拟数字人开放平台提供能够支持用户与3D数字人进行实时语音驱动的数字人产品能力。本篇文档将介绍如何接入3D语音驱动数字人。警告 目前3D语音驱动数字人公测已经结束，暂时不支持接入。使用场景 适用于一些不需要真人...
参数映射与校验规则
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.io${User}.${Group}.api.io 123.u00.api.io User:...
请求中编码问题
API请求编码问题 客户端请求API网关时，需要对参数值进行utf-8的urlEncode，这样能避免特殊参数或者中文出现乱码。注意：query、header、body位置编码需要在签名计算后，签名时用原始值。以下代码可参考：...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
ConfirmTransferInEmail-确认转入邮箱
接口说明 直接确认转入邮箱 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值...
调用API
本文主要介绍，调用物联网边缘计算云端API的请求结构和请求示例。请求结构 您可以通过发送HTTP或HTTPS请求调用物联网边缘计算的云端API。请求结构如下：http://Endpoint/?Action=*&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物...
API概览
（建议使用升级接口：SendText、SendVaml、SendCommand）数字人视频合成 API 标题 API概述 SubmitAudioTo3DAvatarVideoTask 提交3D音频合成视频任务 提交根据一段wav音频文件生成3D数字人视频任务，该接口会立即返回一个TaskUuid作为本次...
调用API
本文档主要介绍调用物联网平台云端API的请求结构和请求示例。请求结构 您可以通过发送HTTP或HTTPS请求调用物联网平台API。请求结构如下：http://Endpoint/?Action=xx&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物联网平台的接...
DescribeProductAmortizedCostByAmortizationPeriod-...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 BillingCycle string 是 摊...
QuerySettleBill-结算账单查询服务
接口说明 当月数据查询结果仅供参考，不作为对账依据；当月最终账单在次月 2 日 12 点后支持查看/导出（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。账单数据相对于实际费用消耗延迟 5 小时更新。账单数据中...
UpdateLiveRecordTemplate-更新实时录制模板
test template 返回参数 名称 类型 描述 示例值 object Schema of Response RequestId string 资源一级 ID 0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3 示例 正常返回示例 JSON 格式 {"RequestId":"0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3"} 错误...
总体使用手册
本章节主要讲述物业管理一体机的使用手册。一句话介绍 物业管理一体机是面向园区、社区、校园等多种业态空间，为其解决物业管理的边缘计算产品，重点提供云边协同的能力，实现门禁、停车、安防、楼宇BA等设备标准化接入上云，并将设备和子...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
搭建无服务器应用之手机号归属地查询
本文主要介绍配合使用API网关、函数计算和云市场三种产品，搭建一个可以查询手机号归属地的服务。在这个框架里不需要配置Web容器、不需要搭建运行环境、不需要购买负载均衡，通过配置和一段代码即可完成一个高扩容无服务器的应用服务。服务...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
API参考
对于Delta表上最常见的读写操作，可以使用Apache Spark读取器和编写器API（请参阅 表批读写 和 表流读写）。但是，有一些特定于Delta Lake的操作，您必须使用Delta Lake编程API。...说明 详情文章请参考Databricks官网文章：API参考
开发参考
API版本 API版本表示API服务所对应的版本信息，目前 实人认证服务 Open API门户 的API版本与各子产品对应。产品 版本 金融级实人认证 2019-03-07 增强版实人认证（暂停售卖）2020-06-18 实人认证（暂停售卖）2019-03-07 企业身份识别 2022-...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
错误代码表
D504CO 504 Backend service connect failed `${Reason}` 后端连接失败，请检查安全组、后端服务器启动状态、或防火墙配置，排查可参考 D504CO错误码排查 504 Backend service connect failed `Connection lease request time out` API网关...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
客户端调用API示例
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(s)请求...
后端路由
1.2.Condition条件表达式 1.2.1 基本语法 Condition表达式与SQL表达式类似，基础表达形式为$A='A' and '$B='B' 参数以$开头，可以引用在API中定义的参数（API为映射与透传方式均可），如果您在API中定义了名为query1的参数，则$query1 可以...
概述
了解做为API网关管理员，如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API，安全性很低，适合临时测试的场景，不建议使用。使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
SDK和API概览
通用文档智能 关于SDK使用的准备工作，请参考 SDK概述。关于API使用的准备工作，请参考 API使用指南。行业文档智能 关于SDK使用的准备工作，请参考 SDK概述。关于API使用的准备工作，请参考 API概览。
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
API参考
EMAS提供数据开放接口，您可以通过API访问您应用的数据。本章将产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来供您参考。移动研发平台 OpenAPI
使用SDK调用API
概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考 创建后端服务为HTTP的API，支持SDK调用的API需满足：API的安全认证方式为“阿里云APP...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
- 产品推荐
- 这些文档可能帮助您