变更时间：2025-02-25 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetAttachmentUploadUrl OpenAPI 错误码发生变更。查看变更详情 查看API文档 ListProducts OpenAPI 错误码发生变更。查看变更详情 查看API文档 ListCategories Open...
名称 类型 描述 示例值 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 服务，编辑相应的参数值：HTTP API API 名称：必填，该 API 的接口名称，方便后续维护。接口描述：选填，更详细的 API 描述。接入系统：必填，API 所属的业务系统。请求 Path：必填，URL Path，可使用${} 包含 path ...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API网关 功能集 功能 功能描述 参考文档 API管理 创建API 支持通过控制台创建API，通过管控API创建API和通过导入Swagger创建API。创建 API 管理API 支持对API进行版本管理、环境管理、模型管理等操作。批量操作API 查看API操作历史 版本...
本文旨在为您详细介绍在云原生API网关中如何使用、管理、开发和上传插件，以及如何在API和接口列表中为指定的API或者接口挂载插件规则。此外，还将指导您通过WebIDE一站式完成自定义插件的开发和编译。使用Lua插件 在云原生API网关开发中，...
云原生API网关支持对API和接口级进行添加策略和配置插件，提高API和接口的安全性、性能和可维护性。重要 策略配置修改后即时生效，无需重新发布。API级策略的插件配置默认应用于接口级。接口不允许删除API级策略，支持接口级的策略覆盖API...
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
本文旨在为您介绍API网关如何查看网关监控数据、在云原生API网关开启日志投递、云原生API网关开启链路追踪、云原生API网关开启Metrics投递、以及如何通过云原生API网关查看REST API和接口的监控数据。这些功能将帮助您更高效地管理和优化...
本文旨在介绍如何通过控制台管理REST API的关键步骤，包括发布、导入导出、下线API等操作。您还可以在控制台中一键生成 SDK 及其使用文档，从而高效地管理和集成 API，提升开发流程的便利性。发布API 前提条件 在发布API之前，确保API中...
部署结构示意图如下：支持API优先的开发模式及多实例管理，提供API生命周期管理能力 API优先强调在设计和开发应用程序时，首先从 API 的设计开始。这种方法鼓励开发者通过定义和创建API来确定系统边界和服务之间的交互，然后再构建后端服务...
本文介绍如何使用OpenAPI调用API网关接口查询API 网关实例列表。步骤一：查看OpenAPI文档 在调用OpenAPI前，建议您先阅读对应的接口文档 DescribeInstances，了解、学习调用该接口所需要的参数及权限等，更多信息请参见 API概览。步骤二：...
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
Model API适用于面向人工智能应用开发的团队，提供了更加灵活和智能的AI网关配置和调试能力。它可以用于各种AI代理、AI观测、消费者鉴权、内容安全防护等插件的预置。本文主要介绍了如何创建、调试Model API。创建Model API 打开 AI网关...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
示例1：通过云控制API查询VPC资源列表的权限策略 通过自定义权限策略，可授予RAM用户或角色调用云控制API ListResources 接口以及VPC DescribeVpcs 接口的权限，从而通过云控制API查询当前账号下的VPC资源列表。{"Version":"1","Statement...
创建REST API并添加接口 REST API主要面向以业务为中心的开发团队，适用于API First、API精细化管理等场景，支持通过控制台或者基于OpenAPI 导入的方式创建。具体详情，请参见 创建REST API并添加接口。添加策略 添加API接口后，您需要通过...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
名称 类型 描述 示例值 object HTTP API 发布版本信息 revisionId string API 发布的版本号。apr-xxx environmentInfo object 环境信息。environmentId string 环境 ID。env-xxx name string 环境名。test alias string 环境别名。测试 ...
名称 类型 描述 示例值 object HTTP API 发布版本信息 revisionId string API 发布的版本号。apr-xxx environmentInfo object 环境信息。environmentId string 环境 ID。env-xxx name string 环境名。test alias string 环境别名。测试 ...
ModifyApiConfiguration 修改API定义 本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值...
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:CreateApi create*ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId} 无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定的分组编号 08ae4aa...
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
ALIYUN:APIG:Operation类型用于为HTTP API创建接口。语法 {"Type":"ALIYUN:APIG:Operation","Properties":{"HttpApiId": String,"Method":String,"OperationName":String,"Path":String,"Description":String,"Mock":Map } } 属性 属性名称...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
本文档对智能投放（MCDP）组件的接口以及启动页接口进行说明。投放相关 API 投放接口类 为投放功能的统一入口，调用类中的接口，实现智能投放的相关功能。interface CDPPromotionInterface:NSObject@end 启动组件 接口定义+(void)start;...
Model API适用于面向人工智能应用开发的团队，提供了更加灵活和智能的AI网关配置和调试能力。它可以用于各种AI代理、AI观测、消费者鉴权、内容安全防护等插件的预置。本文主要介绍了如何创建、编辑、调试和删除Model API。创建Model API ...
本文介绍云原生API网关的版本变更信息，包括发布时间、功能说明以及相关文档等信息。2025年 新功能发布记录 2025-11 变更类型 功能说明 新功能 支持跨 VPC 发现 SAE K8s 服务。优化 全局认证鉴权白名单支持请求域名带端口的场景。2025-10 ...
本文旨在介绍如何通过控制台管理接口的关键步骤，包括为接口指定后端服务、添加策略、配置消费者认证等操作。为接口指定后端服务 重要 在实例外创建的API中，添加的接口默认继承其关联后端服务的配置，但不支持对后端服务进行编辑。在实例...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
通过控制台创建REST API 云原生API网关 提供了实例内和实例外两种创建API的方式：实例外API 登录 云原生API网关控制台。单击左侧导航栏 API，并在顶部菜单栏选择地域。单击 创建API。单击 REST API 卡片中的 创建，在 创建REST API 面板中...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
数据服务功能是将数据服务化，通过接口将数据库中的数据提供给上层应用。该功能仅适用于专业版。操作步骤 您可以通过以下方式进行数据服务功能设置：登录 Quick BI控制台。在Quick BI产品首页，按照下图指引，新建API。在 新建API 的 配置...