名称 类型 描述 示例值 object 接口信息。operationId string 接口 ID。op-xxx method string 接口方法。枚举值：TRACE：TRACE。HEAD：HEAD。DELETE：DELETE。POST：POST。GET：GET。CONNECT：CONNECT。OPTIONS：OPTIONS。PUT：PUT。PATCH...
说明 通过数据服务功能创建的API接口存在以下调用权限限制：调用API接口的阿里云账户，需被授予Quick BI组织管理员及权限管理员的权限，且至少登录过一次Quick BI，才支持调用API接口。相关操作 完成接口创建后，您可以通过 数据服务 模块...
云原生API网关支持为API和接口挂载插件规则，提供灵活且安全的API管理服务，增强服务的可扩展性。本文主要介绍如何在API和接口列表中为指定的API或者接口挂载插件规则。说明 在API和接口挂载插件规则时，若网关实例未安装插件，支持一键...
本文旨在为您介绍API网关如何查看网关监控数据、在云原生API网关开启日志投递、云原生API网关开启链路追踪、以及如何通过云原生API网关查看REST API和接口的监控数据。这些功能将帮助您更高效地管理和优化接口性能，同时提升整体服务质量。...
路由路径相比API接口往往粒度较粗，如/user/*，这样可快速配置访问路径，实现系统间的交互。HTTP API主要面向开发或运维团队，通过路由可以快速实现业务逻辑的拆分和服务的交互，有较高的灵活性，简化业务系统间的调用逻辑。REST API 基于...
本文旨在为您详细介绍在云原生API网关中如何使用、管理、开发和上传插件，以及如何在API和接口列表中为指定的API或者接口挂载插件规则。此外，还将指导您通过WebIDE一站式完成自定义插件的开发和编译。使用Lua插件 在云原生API网关开发中，...
根据不同类型的 API 服务，编辑相应的参数值：...MPC API API 名称：必填，该 API 的接口名称，方便后续维护。接口描述：选填，更详细的 API 描述。接入系统：API 所属的业务系统。接口方法：API 服务端方法。接口名称：API 服务端接口。
本文为您介绍如何使用云原生API网关查看REST API和接口的监控数据，包括QPS、请求成功率和请求平均时延三大黄金指标，以便您对云原生API网关的性能进行实时监控和评估，确保服务的高效运行。前提条件 已完成API创建并添加接口。具体操作，...
接口说明 此功能面向开放 API 的用户 即时生效，解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
API网关 功能集 功能 功能描述 参考文档 API管理 创建API 支持通过控制台创建API，通过管控API创建API和通过导入Swagger创建API。创建 API 管理API 支持对API进行版本管理、环境管理、模型管理等操作。批量操作API 查看API操作历史 版本...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
详情如下：版本 接口地址 说明 V3.17.0及以上 中文接口：接口文档 英文接口：API Reference 不涉及。V3.17.0以下 中文接口：接口文档 英文接口：API Reference 旧接口转换新接口需要辅助工具。如需转换，请下载 辅助工具。
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
将您的API托管在API网关，通过DataV调用API网关来调用您的接口，接入方式请参见 阿里云API网关官方帮助文档。在阿里云的 云市场 中，购买相关的API服务，通过DataV调用相关的结果，获取API服务的返回结果，例如IP定位等服务。在DataV中配置...
详情如下：版本 接口地址 说明 V3.17.0及以上 中文接口：接口文档 英文接口：API Reference 不涉及。V3.17.0以下 中文接口：接口文档 英文接口：API Reference 旧接口转换新接口需要辅助工具。如需转换，请下载 辅助工具。iOS端接口 iOS端...
认证方式 实例API接口认证方式 只支持ClientKey模式。如何获取ClientKey，请参考 创建应用接入点。重要 此认证模式下，创建应用接入点时如果选择标准创建，需要注意以下两点：配置网络规则时网络类型要选Private。配置权限规则作用域要选...
添加策略 添加API接口后，您需要通过控制台为API接口添加策略，提高API的安全性、性能和可维护性。具体详情，请参见 添加策略。发布API 云原生API网关支持发布API到指定的运行实例。具体详情，请参见 发布API。在线调试API 云原生API网关...
本产品（音视频通信/2018-01-11）的OpenAPI采用 RPC 签名风格，签名细节参见 签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可...
部署结构示意图如下：支持API优先的开发模式及多实例管理，提供API生命周期管理能力 API优先强调在设计和开发应用程序时，首先从 API 的设计开始。这种方法鼓励开发者通过定义和创建API来确定系统边界和服务之间的交互，然后再构建后端服务...
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
接口说明 使用说明 本接口用于查询时间范围内创建的通信信息。例如：您可以查询通讯时长、状态、用户数等信息。QPS 限制 本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请...
同时，API服务中可以直接调用阿里云通信的短信服务接口 以及 阿里云函数计算服务。一键授权开通即可。设置模拟数据：提供了模拟测试功能 除了在函数节点里面编辑函数和服务注册中心以外，在整个租户级别，也可以通过全局服务管理编写函数。...
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
节点输出 把当前数据分析API接口的返回值作为节点输出。调用示例 以调用官方提供的数据分析公开API为例。选择 设备数离线指标查询API 接口。在 参数填写 中对应显示的请求参数项，输入待查询数据的请求参数值。如果API接口没有请求参数，...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
生成SDK与文档 支持私网访问方式 新增 允许VPC网络中的服务和应用通过私有网络地址安全地访问API 无 2024-07 功能名称 功能类型 功能描述 相关文档 云原生API网关上线 新增 整合API网关、流量网关、微服务网关和安全网关能力 提供 API 设计...
名称 类型 描述 示例值 object HTTP API 发布版本信息 revisionId string API 发布的版本号。apr-xxx environmentInfo object 环境信息。environmentId string 环境 ID。env-xxx name string 环境名。test alias string 环境别名。测试 ...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
调用DeleteEpnInstance删除边边通信实例。接口说明 实例组信息为空时才能删除。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
在 APIName 后使用-help 选项获取OpenAPI参数详情，除接口参数信息外，ROA风格OpenAPI会额外显示接口的请求方式 Method 和访问路径 PathPattern。更多信息，请参见 获取API参数详情。一般情况下，每个产品内所有API的调用风格是统一的。每...
投放相关 API 投放接口类 为投放功能的统一入口，调用类中的接口，实现智能投放的相关功能。interface CDPPromotionInterface:NSObject@end 启动组件 接口定义+(void)start;接口描述 通过调用该接口，启动智能投放组件，包括初始化所有投放...
通过导入符合阿里云 Swagger 规范的文本内容创建 API。接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，...
本文介绍如何使用OpenAPI调用API网关接口查询API 网关实例列表。步骤一：查看OpenAPI文档 在调用OpenAPI前，建议您先阅读对应的接口文档 DescribeInstances，了解、学习调用该接口所需要的参数及权限等，更多信息请参见 API概览。步骤二：...
其中，公共查询参数 clientInfo 位于url query参数里。以下是一条未编码的图片同步检测的请求示例：...其中，业务参数以body的方式透传，body结构说明请参见各API接口的具体描述。字符编码 请求及返回结果都使用UTF-8字符集进行编码。
变更时间：2025-02-10 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetMqConsumerTag OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。查看变更详情 查看API文档 CloseTicket OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。...
本文介绍本地通信HAL的相关接口。HAL_UDP_close 原型：void HAL_UDP_close(_IN_intptr_t p_socket);接口说明：调用此接口销毁指定的UDP连接，释放资源。参数说明：参数 数据类型 方向 说明 p_socket intptr_t 输入 UDP socket句柄。返回...
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
RTC自身优势 方便、快捷的使用方式：提供标准的API接口：您可以管控应用、查询数据等。支持多端SDK：PC大屏设备、移动小屏设备随意接入，提供Simulcast媒体能力，大屏看大流、小屏看小流，混合通信无压力。强大、灵活的安全机制：API安全...