API unsupport the channel
API unsupport the channel:HTTP，API 只允许 HTTPS 访问，而发起 API 请求时却使用了 HTTP，则会得到此提示。API unsupport the channel:HTTPS，API 只允许 HTTP 访问，而 API 请求却使用的是HTTPS，则会得到此提示。解决方案：API ...
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
OpenAPI 门户
使用场景 查看 OpenAPI 文档 OpenAPI 门户 提供完整的 OpenAPI 文档，包含接口说明、流控信息、授权信息、请求参数、返回数据、返回说明、返回示例、错误码、变更历史等。您可通过阅读 OpenAPI 文档判断它是否能够满足您的业务场景。Open...
API网关
日志字段 说明 owner_id API提供者的阿里云账号ID apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod HTTP请求方法 path 请求路径 domain 调用...
使用REST API发起请求
使用REST API发起请求适用于对程序自定义要求较高的场景。您需要手动编写代码计算签名并将签名添加到REST API请求中。OSS仅支持虚拟托管（Virtual Hosted）风格的REST API请求。OSS域名构成规则 针对OSS的网络请求，除了 GetService...
请求结构
本文主要介绍 PolarDB-X 支持的API请求结构，包括服务地址、请求协议和请求方法等。服务地址 PolarDB-X 支持的API服务接入地址请参见下表。地域（部署位置）接入地址（Endpoint）华东1（杭州）polardbx.cn-hangzhou.aliyuncs.com 华北2...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
为什么要定义参数？
参数是 API 请求的重要组成部分，网关可以根据参数定义给你的用户生成 API 手册。
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
错误码
调用物联网数据服务的数据API时，您可能会收到物联网返回的错误信息。本文介绍常见的错误码及其含义。调用API出错时，请根据返回的错误信息修复问题，然后重新发起调用。关于如何查看API请求参数的信息，请参见 管理API。若未能解决问题，...
通过向导模式创建API（服务单元）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（服务或单元），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 ...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
通过注册方式创建API
请求方式 API请求方式包括GET和LIST：GET：请求服务器获取指定的某个资源。LIST：请求服务器获取某一部分的资源。API分组 选择当前项目下配置的API分组，如需创建，请参见 创建服务分组。描述 填写对API简单的描述。128字符以内。协议 仅...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
最佳实践：API请求参数的选填设置
通过数据源封装数据API时，在某些业务场景下，需要设置API的请求参数为选填参数。当开发人员设置API的请求参数为选填参数后，调用方即可在调用API时自行选择是否要传入具体的请求参数值，实现更灵活的查询方式。本文将为您介绍如何在不同的...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
支持HTTP2.0
API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。可客户端和服务器可以把HTTP消息分解为互不依赖的帧，...
底纹报表
底纹UV 请求底纹且返回成功的用户数，即不包括被限流等原因导致返回错误的请求 同一个用户无论请求多少次都只记1 依赖通过SDK/API请求时，底纹请求中上传了user_id参数 当日请求过底纹的用户数 底纹请求报错次数 由于被限流等原因导致返回...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
请求结构
服务地址 API 的服务接入...请求参数 每个请求都需要指定要执行的操作，即 Action 参数（例如 CreateDatabase），以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数。字符编码 请求及返回结果都使用 UTF-8 字符集进行编码。
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
HTTP 转 SOFARPC 入门
客户端请求的ak、sk，就是应用的密钥信息 gateway.accessKey=<SOFA_ACCESS_KEY_ID>gateway.secretKey=<SOFA_ACCESS_KEY_SECRET>apigateway.url=<yourGatewayURL>@Value("${gateway.accessKey}")private String accessKey;Value("${gateway....
热搜报表
热搜UV 请求热搜且返回成功的用户数，即不包括被限流等原因导致返回错误的请求 同一个用户无论请求多少次都只记1 依赖通过SDK/API请求时，热搜请求中上传了user_id参数 当日请求过热搜的用户数 热搜请求报错次数 由于被限流等原因导致返回...
发起请求概述
您可以使用REST API或封装了REST API的阿里云SDK向OSS发起请求。认证系统收到请求后，会通过凭证验证请求的发送者身份。身份验证成功后，您可以操作相应的OSS资源。发起请求 您可以使用以下方式向OSS发起请求：阿里云SDK：使用阿里云SDK...
使用外部授权 API
网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为调用自定义的远程接口。本文将引导您使用外部授权 API。完整的操作步骤如下：编写外部授权 API：在本地开发定义一个...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
公共参数
公共请求参数是用于标识目标API、用户身份、签名等通用信息的参数，每次发起API请求时均需要携带这些参数。如非必要，在每个单独的接口文档中不再对这些参数进行说明。公共请求参数 公共请求参数应作为HTTP请求的消息头（Header）携带在...
错误码
说明 API 请求异常的原因可能是控制台没有下发配置或者网关没有及时更新配置。排查方式如下：检查网关是否配置了相应的 API 且 API 的状态是否为 已发布。检查客户端的 API 调用路径和分组等信息是否与网关维护的一致。检查请求的 host、...
FailCards-销卡
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 Iccids array 是 卡的 ...
使用后端服务提高管理效率
本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...
后端路由
当前请求的域名 CaRequestHandleTime：请求处理的UTC时间 CaAppId：请求参数的AppId CaAppKey：请求参数的AppKey CaClientIp：客户端IP CaApiName：创建时候的API名字 CaHttpScheme：请求的协议 HTTP ,HTTPS CaClientUa: 客户端上传的...
概述
发起API请求的URL由不同参数拼凑而成，有固定的 请求结构。URL中包含公共参数、你的 签名机制 和某个API的具体参数。每篇API文档均给出了URL请求示例供你参考，但是为了方便显示，我们并没有编码这些URL示例，你需要在发起请求前自行编码。...
ListDataServiceApiTest
列出数据服务API测试记录，只能查询最近一个月数据 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action ...
下拉提示报表
每请求且返回成功一次记1 当日请求下拉提示（且返回成功）的次数 下拉提示UV 请求下拉提示且返回成功的用户数，不包括返回错误的请求 同一个用户无论请求多少次都只记1 依赖通过SDK/API请求时，下拉提示请求上传user_id参数 当日请求过下拉...
RejectVpcPeerConnection-拒绝VPC对等连接
调用RejectVpcPeerConnection接口拒绝VPC对等连接实例的请求。接口说明 对于跨账号的 VPC 对等连接实例，接收端可以拒绝连接请求。拒绝连接请求的 VPC 对等连接实例变为 已拒绝状态。RejectVpcPeerConnection 不支持对同一个对等连接实例...
错误信息查询
无效的语言模型参数 请根据通义听悟API文档修改您的请求参数，然后再重新发起请求。400 BRK.InvalidAudioFormat Invalid audio format.无效的音频编码格式参数 请根据通义听悟API文档修改您的请求参数，然后再重新发起请求。400 BRK....
参数访问控制插件
1.概述 访问控制插件可以根据请求参数或上下文，来执行条件判断，用于过滤不希望传递到后端的请求，参考 参数与条件表达式的使用 来了解如何定义参数和使用条件表达式。2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用...
公共错误码
本文介绍API请求发生错误时的公共错误码。当API请求发生错误时，服务端会返回错误信息，包括HTTP状态码和响应Body中的具体错误细节。其中响应Body中的错误细节使用Protocol Buffers编码，使用如下消息定义：message Error { int32 ...
- 产品推荐
- 这些文档可能帮助您