前言 Android SDK提供的API接口，根据功能特性可以分为以下几类：配置接口：SDK初始化、安全设置、性能优化、网络适配等 域名解析接口：同步/异步/非阻塞解析、预解析、缓存管理等 排查追踪接口：会话跟踪、日志管理、调试支持等 自定义...
API授权（RAM）：查看API授权（RAM），通过阿里云访问控制服务为不同用户或应用分配API访问权限，实现安全、细粒度的资源管理与操作授权。使用CLI：使用阿里云CLI调用API。ListHttpApis 获取HTTP API列表。配置RAM授权 操作 访问级别 资源...
背景信息 服务端通常根据客户端请求携带的凭证信息（即Token）来保护对外暴露的API接口的通信安全。Token形式没有严格规定，一般根据实际业务场景决定。如果Token采用的是JSON WEB Token(JWT)，那么在任何时间、任何地点都可以利用公钥来对...
{#accountId}:httpapi/{#HttpApiId} 无 无 apig:GetHttpApiOperation GetHttpApiOperation get*HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} 无 无 apig:GetHttpApiRoute GetHttpApiRoute none*HttpApi acs:apig:{#...
{#accountId}:httpapi/{#HttpApiId} 无 无 apig:GetHttpApiOperation GetHttpApiOperation get*HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} 无 无 apig:GetHttpApiRoute GetHttpApiRoute none*HttpApi acs:apig:{#...
apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId} 无 无 apigateway:DescribeApiMarketAttributes DescribeApiMarketAttributes get*ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId} 无 无 apigateway:...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
详情如下：版本 接口地址 说明 V3.17.0及以上 中文接口：接口文档 英文接口：API Reference 不涉及。V3.17.0以下 中文接口：接口文档 英文接口：API Reference 旧接口转换新接口需要辅助工具。如需转换，请下载 辅助工具。iOS端接口 iOS端...
历史接口 API 标题 API概述 CreateAndAttachPolicy Create and Attach Policy CreateAndAttachPolicy。UpdateAndAttachPolicy 更新并挂载策略 更新并挂载策略。环境管理 环境管理 GetEnvironment 查询环境 查询环境。UpdateEnvironment ...
历史接口 API 标题 API概述 CreateAndAttachPolicy Create and Attach Policy CreateAndAttachPolicy。UpdateAndAttachPolicy 更新并挂载策略 更新并挂载策略。环境管理 环境管理 GetEnvironment 查询环境 查询环境。UpdateEnvironment ...
创建REST API并添加接口 REST API主要面向以业务为中心的开发团队，适用于API First、API精细化管理等场景，支持通过控制台或者基于OpenAPI 导入的方式创建。具体详情，请参见 创建REST API并添加接口。添加策略 添加API接口后，您需要通过...
接口、API 授权范围 支持对 接口、路由 或 API 进行访问控制。接口、路由、API 生效API 选择需要授权接口或路由所属的API。接口、路由 生效版本 如果REST API开启了版本管理，需要选择生效版本。接口 选择接口 选择需要授权的接口。接口 ...
云原生API网关支持为API和接口挂载插件规则，提供灵活且安全的API管理服务，增强服务的可扩展性。本文主要介绍如何在API和接口列表中为指定的API或者接口挂载插件规则。说明 在API和接口挂载插件规则时，若网关实例未安装插件，支持一键...
根据不同类型的 API 服务，编辑相应的参数值：HTTP API API 名称：必填，该 API 的接口名称，方便后续维护。接口描述：选填，更详细的 API 描述。接入系统：必填，API 所属的业务系统。请求 Path：必填，URL Path，可使用${} 包含 path ...
本文为您介绍如何使用云原生API网关查看REST API和接口的监控数据，包括QPS、请求成功率和请求平均时延三大黄金指标，以便您对云原生API网关的性能进行实时监控和评估，确保服务的高效运行。前提条件 创建网关实例 创建REST API并添加接口 ...
变更时间：2025-02-25 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetAttachmentUploadUrl OpenAPI 错误码发生变更。查看变更详情 查看API文档 ListProducts OpenAPI 错误码发生变更。查看变更详情 查看API文档 ListCategories Open...
rg-acfm*q 导出任务参数描述 API 资产任务（apisec_api）参数描述 参数的详细取值可以参考接口 DescribeApisecApiResources 的同名参数。名称 类型 示例值 描述 startTime Integer 1741449600 查询的开始时间，格式为 Unix 时间戳（UTC ...
版本管理 是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。开启 版本管理 功能后，需要配置 使用方式。说明 选择 使用方式 为 Query 时...
GetUserInfo path string 接口路径。user description string 接口描述。获取用户信息 response HttpApiResponseContract 接口响应参数定义。request HttpApiRequestContract 接口请求参数定义。mock HttpApiMockContract 接口 Mock 配置，...
创建REST API并添加接口 管理API版本 发布API 在线调试API 下线API 版本管理 当API存在版本变更时，可通过版本管理实现新旧API的并存与升级。管理API版本 发布历史管理 记录API发布信息，并支持发布回滚。切换历史版本 API策略管理 对API及...
名称 类型 描述 示例值 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版本 发布API 在线调试API 下线API 版本管理 当API存在版本变更时，可通过版本管理实现新旧API的并存与升级。管理API版本 发布历史管理 记录API发布信息，并支持发布回滚。切换历史版本 API策略管理 对API及接口...
名称 类型 描述 示例值 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...
调试 您可以在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 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
本文旨在为您详细介绍在云原生API网关中如何使用、管理、开发和上传插件，以及如何在API和接口列表中为指定的API或者接口挂载插件规则。此外，还将指导您通过WebIDE一站式完成自定义插件的开发和编译。使用Lua插件 在云原生API网关开发中，...
云原生API网关支持对API和接口级进行添加策略和配置插件，提高API和接口的安全性、性能和可维护性。重要 策略配置修改后即时生效，无需重新发布。API级策略的插件配置默认应用于接口级。接口不允许删除API级策略，支持接口级的策略覆盖API...
本文旨在为您介绍API网关如何查看网关监控数据、在云原生API网关开启日志投递、云原生API网关开启链路追踪、云原生API网关开启Metrics投递、以及如何通过云原生API网关查看REST API和接口的监控数据。这些功能将帮助您更高效地管理和优化...
API（旧接口）API（新接口）API说明 实例运维 GetInstanceDownstream-根据起始的实例查询该实例的下游。GetPhysicalInstanceLog-获取实例执行的日志，如果实例重跑了多次，则会有多条日志。GetScriptInstance-查询脚本的实例信息，包括实例...
Model API适用于面向人工智能应用开发的团队，提供了更加灵活和智能的AI网关配置和调试能力。它可以用于各种AI代理、AI观测、消费者鉴权、内容安全防护等插件的预置。本文主要介绍了如何创建、调试Model API。创建Model API 打开 AI网关...
发布API 前提条件 在发布API之前，确保API中已经定义并创建了接口。操作步骤 云原生API网关提供了实例内和实例外两种发布API的方式：实例外API 登录 云原生API网关控制台。左侧导航栏选择 API，并在顶部菜单栏选择地域。单击目标API。单击...
本文介绍如何使用OpenAPI调用API网关接口查询API 网关实例列表。步骤一：查看OpenAPI文档 在调用OpenAPI前，建议您先阅读对应的接口文档 DescribeInstances，了解、学习调用该接口所需要的参数及权限等，更多信息请参见 API概览。步骤二：...
部署结构示意图如下：支持API优先的开发模式及多实例管理，提供API生命周期管理能力 API优先强调在设计和开发应用程序时，首先从 API 的设计开始。这种方法鼓励开发者通过定义和创建API来确定系统边界和服务之间的交互，然后再构建后端服务...
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
3.2.2.API定义导入 原API网关和云原生API网关都支持标准的OAS协议，您只需要将API定义从原API网关上导出成API定义文件（OAS协议），然后在云原生API网关进行导入就可以：在原API网关导出整个分组的API定义，文档参考 导出标准OAS定义。...
接口说明 此功能面向 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 环境别名。测试 ...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
名称 类型 描述 示例值 object HTTP API 发布版本信息 revisionId string API 发布的版本号。apr-xxx environmentInfo object 环境信息。environmentId string 环境 ID。env-xxx name string 环境名。test alias string 环境别名。测试 ...