简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
适配硬件链路和操作系统
AT模组驱动框架只处理与模组交互的逻辑，您还需适配硬件链路、操作系统接口和模组特性。本文介绍硬件链路和操作系统接口的适配。背景信息 硬件链路和操作系统的适配是开发AT模组驱动的重要组成部分，可助您实现AT模组的设备接入物联网平台...
概述
使用流程 API 网关的完整使用流程如下：如上图所示，通过 API 网关实现 API 发布与调用，API 发布者与订阅者分别需要进行以下操作：API 发布者：开发后端系统：在本地完成后端系统的开发，包括 编写 API 服务 等。创建系统集群：在控制台...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
SetApisAuthorities-给多个API添加APP访问权限
接口说明 此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
版本说明
变更时间：2021-12-21 变更集发布说明：调整评价接口必填字段 OpenAPI 名称 变更内容概要 操作 EvaluateTicket OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。删除错误码：500 ...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
授权系统API
在应用管理列表，选择目标 操作 列中，选择 更多>系统API授权。在右侧 系统API授权 面板中，选中对应的功能模块，开通系统OpenAPI调用权限。重要 其他角色用户支持了解当前应用有哪些API调用权限，无权限进行授权操作。
授权系统API
在应用管理列表，选择目标 操作 列中，选择 更多>系统API授权。在右侧 系统API授权 面板中，选中对应的功能模块，开通系统OpenAPI调用权限。重要 其他角色用户支持了解当前应用有哪些API调用权限，无权限进行授权操作。
HTTPS 证书报错
但老版本操作系统的根证书对这些机构（证书颁发机构）的不信任或者信任时间已经过期。解决方案 升级客户端根证书。如：Java+Linux 升级 OpenSSL 客户端即可，其他操作系统+编程语言，请升级编程语言中 HTTPS 使用的根证书。联系 API 提供者...
DescribePurchasedApis-获取购买的 API 列表
RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...
DeleteApiGroup-删除 API 分组
接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
AuthorizedApi
AuthorizedApis 描述"class="reference-link">描述 应用和API的对应关系 节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ...
ModifyApiGroup-修改API分组的信息
接口说明 此功能面向 API 提供者 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
创建授权对象
说明 当应用创建成功后，系统会自动给应用分别配一个 APPID，可在 API 订阅>应用管理 中的应用详情页查看。对于内部系统的应用，您需要输入其 应用名称，可自动获取其 APPID 与类型。所属公司/部门：可选，用于识别应用所属的公司或部门。...
DescribePurchasedApiGroup-获取购买的 API 组
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribePurchasedApiGroup Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID，系统生成，全局唯一 102b631ae1094e33a77c45312226184e ...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
使用 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...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
CreateApiGroup-创建API分组
接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
开通IPv6
API网关专享实例支持开通IPv6能力，开通后，系统会为实例分配公网IPv6入访地址以及公网IPv6出访地址。前提条件 API网关专享实例。概述 API网关专享实例支持开通IPv6入口能力以及出访能力，如图。IPv6入口能力：开通后，系统会为实例分配...
版本说明
变更时间：2024-04-18 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetSecretParameter OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-04-18 变更集发布...
DeleteDomain-删除域名
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteDomain Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID，系统生成，全局唯一 927d50c0f2e54b359919923d908bb015 DomainName ...
概述
了解做为API网关管理员，如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API，安全性很低，适合临时测试的场景，不建议使用。使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
DeleteMonitorGroup-删除监控分组
删除API分组对应的云监控的应用分组。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
ResetAppSecret-重置 app 密钥
关联操作 apigateway:ResetAppSecret Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 AppKey string 是 App 的 Key，用于调用 API 时使用 60030986 NewAppKey string 否 设置的新的 AppKey，需要全局唯一 testAppKey ...
SdkGenerateByGroup-按分组生成SDK
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:SdkGenerateByGroup Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 api 分组 id，系统生成，全局唯一 1a991a450b9548a1a3df38fd3af117c2 Language ...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
- 产品推荐
- 这些文档可能帮助您