HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
数据服务系统配置
API缓存数据存储位置 在 API缓存数据存储位置 区域，单击 修改 按钮，支持指定API缓存数据的存储位置。Dataphin系统的redis：将缓存数据存储到系统公共的Redis中，将与其他模块共享存储空间，适用于缓存数据量较小的场景。应用内存：缓存...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
相机交互
从app上获取api实例 cameraAPI.position/相机的位置属性 cameraAPI.setCameraControlEnable(enable:boolean)/设置是否允许用户操作全景模式下的相机，默认true cameraAPI.setCameraRotateEnable(enable:boolean)/设置是否允许用户旋转全景...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API调试及自助排错
这里介绍部分字段用于快速定位出错位置：TotalLatency：API网关从接收到客户端请求，到完成客户端响应的总时间 ServiceLatency：API网关向后端服务发送请求，到接收完后端服务响应的时间 通过上述两个字段可以快速分析出报错位置，当...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
参数映射与校验规则
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网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
API-KEY设置
DashScope SDK提供了多种配置API-KEY的方式，根据需求选择...3.通过文件设置 默认会读取~/.dashscope/api_key作为DASHSCOPE_API_KEY,您可以通过环境变量设置api_key保存文件位置。export DASHSCOPE_API_KEY_FILE_PATH=YOUR_API_KEY_FILE_PATH
API列表
UpdateGatewayEnablingState 更新网关启用状态 GetGateway 获取网关信息 ListGateways 获取网关信息列表 CountGateways 获取符合条件的网关数量 ListGatewaysGisInfo 获取所有网关的地理位置信息 网络管理相关API API 描述 ...
Aliyun:Serverless:Api
DefinitionUri String 否 是 包含API配置的文件的位置。必须指定 DefinitionUri 或 DefinitionBody 中的一个。返回值 Fn:GetAtt ApiId：指定的API编号。SubDomain：系统给分组绑定的二级域名，用于测试API调用情况。GroupId：API分组ID。...
ConstantParameter
描述"class="reference-link">描述 常量入参信息项的类型 节点名"class="reference-link">节点名 ConstantParameter 子节点"class="reference-link...Location String 参数位置，取值为：BODY、HEAD、QUERY、PATH Description String 参数描述
SystemParameter
描述"class="reference-link">描述 系统入参信息项的类型 节点名"class="reference-link">节点名 SystemParameter 子节点...Location String 参数位置，取值为：BODY、HEAD、QUERY、PATH DemoValue String 示例 Description String 参数描述
参数定义包含什么？
描述参数在请求中的位置（path、header、query、body）、参数说明、参数示例及参数值限制。
函数计算
API 网关再将函数计算返回的内容映射到 statusCode、header、body等位置返回给客户端。API 网关向函数计算传入参数格式：当以函数计算作为 API 网关的后端服务时，API 网关会把请求参数通过一个固定的 Map 结构传给函数计算的入参 event。...
错误码映射插件
当出现系统错误时，位置为 StatusCode,Header,BodyJsonField 等来自应答的字段取值都将为 null，在写条件表达式时需要注意，未出现系统错误时 ErrorCode 位置的取值为 OK。API网关的系统错误码会出现在 X-Ca-Error-Code 应答头及日志的 ...
获取API-KEY
API-KEY的创建、获取及权限范围。API-KEY的创建 功能位置 登录以后，右上角头像位置，鼠标悬浮后，展示API-KEY，点击后进入API-KEY管理页面。点击【创建新的API-KEY】，会自动创建一条属于这个账号的API-KEY。列表上展示API-KEY密文，点击...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
发送 HTTP 请求（Java）
说明 网关提供客户端 Demo 代码供用户参考，下载 API 订阅者 Demo 后，Demo 代码位置为：src/test/java/com/alipay/gateway/web/test/usercase/mainchain/http/ 前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关...
系统集群验证签名
说明 网关提供服务端 Demo 代码供用户下载测试，下载 API 提供者 Demo 后，Demo 接口位置为：com.alipay.gateway.common.GatewayFilter。操作步骤如下：引入网关 SDK 配置 API 服务密钥 配置 Filter 引入网关 SDK API 网关的客户端依赖 ...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
注册API
说明 工作空间定义审批流后需要走流程审批才可以发布API，详情请参见：审批中心概述 发布API后，服务资源组的配置即可在调用API时生效。您还可以在 服务开发 页面左侧目录树中对目标API进行克隆和删除等操作。您也可以在 服务管理 页面，...
位置
my.openLocation 该接口用于使用 mPaaS 小程序内置地图查看位置。使用限制 暂无境外地图数据，在中国内地（不含港澳台）以外的地区可能无法正常调用此 API。仅支持高德地图 Style 与火星坐标系。效果示例 入参 名称 类型 必填 描述 ...
数据服务入门
DataWorks数据服务的主要目标是为个人、团队和企业构建统一的数据服务总线，帮助用户统一管理面向内外部的API服务。例如，您可以将查询数据表功能快速的生成对应的API，或将已有的API注册至数据服务平台进行统一发布和管理。本文以MySQL...
RequestParameter
描述 节点名 RequestParameter 子节点 ApiParameterName String 参数名 Location String 参数位置，取值为：BODY、HEAD、QUERY、PATH ParameterType String 参数类型，取值为：String、Int、Long、Float、Double、Boolean，分别表示字符、...
API说明
AlivcLiveTranscodingConfig 云端混流（转码）配置 AlivcLiveMixStream 云端混流（转码）中每一路子画面的位置信息 推流基础接口 AlivcLiveBase API 描述 getSDKVersion 获取SDK版本号 registerSDK SDK注册License setConsoleEnabled 启用...
API 流量治理
在 API 详情页，您可以对该 API 进行流量治理，即配置限流与缓存。限流 限流指对网关到后端集群的请求进行限制。操作步骤如下：说明 目前 API 网关仅支持单机限流，即对经过网关单容器（非集群）到后端集群的请求进行限制。在 API 详情页，...
- 产品推荐
- 这些文档可能帮助您