简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API市场服务私网访问
本文档介绍作为用户如何基于计算巢...具体支持情况如下：API分类 API说明 API公网域名 API计算巢私网域名 源站部署地域 API售卖页地址 生活服务 全国快递物流查询快递查询接口 wuliu.market.alicloudapi.com wuliu.api.market.aliyunnest.com ...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
客户端调用API示例
响应头：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF#请求唯一 ID，请求一旦进入 API 网关应用后，API 网关就会生成请求 ID 并通过响应头返回给客户端，建议客户端与后端服务都记录此请求 ID，可用于问题排查与跟踪。...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
Endpoint
地域 所在城市 开服状态 外网Endpoint 外网Tunnel Endpoint 中国 华东1（杭州）已开服 http://service.cn-hangzhou.maxcompute.aliyun.com/api http://dt.cn-hangzhou.maxcompute.aliyun.com 中国 华东2（上海）已开服 ...
DescribeDeployedApi-查询API在指定环境中的定义
Mock 模式，目前可以取值：TRUE：启用 Mock 模式 FALSE：不启用 Mock 模式 TRUE ServiceAddress string 调用后端服务地址，比如后端服务完全地址为 http://api.a.com:8080/object/add?key1=value1&key2=value2，ServiceAddress 是指 ...
使用外部授权 API
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
新功能发布记录
默认透传客户端相关头 全部 2021-05 功能名称 功能描述 发布地域 相关文档 根据Path+Method搜索API API列表页面支持基于Path+Method搜索 全部 批量打标签 API列表页面批量打标功能上线 全部 2021-04 功能名称 功能描述 发布地域 相关文档 ...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
OpenAPI 门户
功能说明 网站地址：https://next.api.aliyun.com。OpenAPI 门户 要求开发者必须登录，通过用户登录身份，系统会自动获取可用的 AK 信息，调用 OpenAPI，无需用户在调试界面传入 AK 数据，提升 OpenAPI 调试的便捷性。重要 如果您使用阿里...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
断路器插件
1.断路器概述 断路器是API网关在后端出现性能问题时...errorCondition:"$StatusCode=503"#错误条件 errorThreshold:1000#错误阈值 windowInSeconds:30#超时窗口时间 openTimeoutSeconds:15#断路器开的时间 downgradeBackend:#降级后端 type:...
基于Swagger完成API网关与用户CICD流程整合
如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1：自动从您的API业务代码中获取swagger定义 步骤2：创建API分组 步骤3：通过API网关的OpenAPI导入API定义，并发布在不同的环境中 步骤4：对API进行各项额外配置 自动...
关于云市场域名更换通知
https://market.aliyun.com/products/57124001/cmapi027761.html?#sku=yuncode2176100000 ocrapi-idcard.taobao.com dgsfz.market.alicloudapi.com 操作示例：以身份证识别接口为例，云市场商品链接 ...
基于JWT的token认证
阿里云API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
公开API
公开API服务模板可帮助您创建一个无需鉴权和SDK即可直接调用的API服务，且创建之后无法再修改为需要AppKey鉴权的API。该API主要用于更简单的物联网能力输出。前提条件 已完成创建项目。详细内容，请参见 项目。创建公开API模板业务服务 ...
创建空间服务API
所属应用 API的归属应用，自定义创建，支持在系统设置模块和创建API页面新增应用，关于新建应用，更多请参见 新建应用。服务类型 支持多种服务类型。OGC WFS服务：地图服务、地理数据服务，符合OGC Web要素服务(WFS)规范。OGC WMS服务：...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
API概览
本产品（应用实时监控服务ARMS/2019-08-08）的OpenAPI采用 RPC 签名风格，签名细节参见 签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
UpdateNamespaceData
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UpdateNamespaceData 系统规定参数。取值：...
使用自定义域名调用API
域名”，记录值为”apigateway-domain-verfication=公网分组二级域名“，下面举个例子：一个分组，ID为b7eb2f79e64f4431b08bbb948ed2567e，二级域名为b7eb2f79e64f4431b08bbb948ed2567e-cn-hangzhou.alicloudapi.com，绑定的域名为单域名...
使用限制
三大运营商物联网卡人联网限制访问清单*.qq.com*weibo.com*.weibo.cn*taobao.apilocate.amap.com*.vip.com*.appvipshop.com*.iqiyipic.com*.douyin.com*.douyincdn.com*.amemv.com*.kuaishou.com*.kuaishougif.com*.kuaishouzt.com*.ksapi...
运营商限制人联网应用访问说明
三大运营商物联网卡人联网限制访问清单*.qq.com*weibo.com*.weibo.cn*taobao.apilocate.amap.com*.vip.com*.appvipshop.com*.iqiyipic.com*.douyin.com*.douyincdn.com*.amemv.com*.kuaishou.com*.kuaishougif.com*.kuaishouzt.com*.ksapi...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
GetNamespaceData
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetNamespaceData 系统规定参数。取值：...
SetDomain-给指定分组绑定自定义域名
正常返回示例 JSON 格式 {"RequestId":"0AA90E87-3506-5AA6-AFFB-A4D53B4F6231","DomainLegalStatus":"NORMAL","GroupId":"927d50c0f2e54b359919923d908bb015","SubDomain":"xxx-cn-hangzhou.alicloudapi.com","DomainName":"api.demo.com...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com 华北2（北京）cn-beijing apigateway.cn-beijing.aliyuncs.com apigateway-vpc....
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
QuerySavingsPlansDeductLog-节省计划抵扣明细查询
查询节省计划抵扣的明细数据 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
- 产品推荐
- 这些文档可能帮助您