构造请求
说明 我们提供多种编程语言的SDK及第三方SDK，可以免去您自己构造API请求的烦恼。更多信息，请参见 SDK章节。通信协议 支持HTTP、HTTPS协议。请求方法 所有接口都支持POST、GET方法。字符编码 所有接口的请求参数和返回结果编码方式都是UTF...
公共参数
介绍每个接口都需要使用的请求参数和返回参数。公共请求参数 表 1.公共请求参数表 名称 类型 是否必须 描述 Format String 否 返回消息的格式。取值：XML（默认值）|JSON Version String 是 API版本号，使用YYYY-MM-DD日期格式。固定取值：...
调用API
请求结构如下：http://Endpoint/?Action=*&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物联网边缘计算的接入地址格式分为两种：视频设备、算法服务相关API的接入地址：linkvisual.cn-shanghai.aliyuncs.com 其它API的接入地址...
调用API
请求结构如下：http://Endpoint/?Action=*&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物联网平台的接入地址格式：iot.${RegionId}.aliyuncs.com 。其中，变量${RegionId} 需替换为您的物联网平台服务的地域代码。阿里云地域...
应用管理
本文列出了应用管理相关的所有 OpenAPI 及其请求参数、返回参数。创建应用 sofa.apigateway.app.create 用于创建一个应用。请求参数 名称 类型 是否必填 示例 描述 param AppInfoVO 是 param tenant_id STRING 是 TSCPDICNT 租户标识 ...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
日志字段详情
event.serviceName 事件相关的云资源名称，例如Vpc event.sourceIpAddress 事件发生的源IP地址 event.userAgent 发送API请求的客户端代理标识 event.requestParameters.HostId API请求输入参数中的主机ID event.requestParameters.Name API...
授权应用
本文列出了授权应用相关的 API 及其请求参数、返回参数。创建授权应用 sofa.apigateway.authapp.create 用于创建一个授权应用。请求参数 名称 类型 是否必填 示例 描述 param AuthAppInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户...
调用API
请求结构如下：http://Endpoint/?Action=xx&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物联网平台的接入地址格式：iot.${RegionId}.aliyuncs.com 。其中，变量${RegionId} 需替换为您的物联网平台服务的地域代码。阿里云地域...
数据报表
全栈可观测应用提供丰富的仪表盘，用于展示Web页面、小程序的性能指标、JS错误、API请求、资源访问等信息。前提条件 已接入用户体验数据。具体操作，请参见 接入Web的用户体验数据、接入小程序的用户体验数据。功能入口 登录 日志服务控制...
API unsupport the channel
API unsupport the channel:HTTP，API 只允许 HTTPS 访问，而发起 API 请求时却使用了 HTTP，则会得到此提示。API unsupport the channel:HTTPS，API 只允许 HTTP 访问，而 API 请求却使用的是HTTPS，则会得到此提示。解决方案：API ...
配置记录HTTP请求应答日志
如果需要在日志中记录API网关收到的HTTP的请求及API网关返回给客户端的HTTP应答，您可以在分组详情中进行设置。记录请求Headers：逗号分隔需要记录的Header名称（如上图所示），'*' 记录全部 记录应答Headers：逗号分隔需要记录的Header...
请求结构
OpenAPI请求方法 支持 HTTP GET 方法发送请求，这种方式下请求参数需要包含在请求的URL中。OpenAPI请求参数 每个请求都需要指定要执行的操作，即Action参数。此外，每个操作都需要包含的 公共请求参数 和指定操作所特有的请求参数。
基本请求信息
压测API的基本请求信息一般包含API名称、压测URL、请求方式等信息。本文介绍如何配置压测API基本请求及相关示例。操作步骤 登录 PTS控制台，在左侧导航栏选择 性能测试>创建场景，然后单击 PTS压测。在 场景配置 页签的 串联链路 模块右侧...
Web&H5监控详情
应用概览 应用概览集中展示应用维度下的用户及页面、请求相关的关键指标数据，包括用户Session数、PV、UV、资源数、页面最大渲染耗时、API请求数、异常数等，展示指标趋势变化状况，帮助您快速了解应用整体性能状况。会话追踪 定位问题时...
小程序监控详情
小程序监控主要面向如钉钉、微信等超级App中的小程序应用，提供包括页面访问、资源加载、API请求调用、JS错误等性能数据的采集、分析能力，支持单用户会话追踪，还原真实用户操作场景，采集问题堆栈及上下文信息，快速追溯问题根源，帮助...
OpenAPI 门户
查看 OpenAPI 请求 根据您填写的请求参数自动生成 OpenAPI 请求，并打印到网页上，让您直观地查看到真实发送的 OpenAPI 请求。结构化输出返回结果 根据 OpenAPI 请求，返回真实的 OpenAPI 调用结果，结构化输出。生成 SDK 调用示例 根据...
API网关流量安全
API网关的API请求成功率低于规则参数 API请求成功率阈值 时，会触发告警。执行频率 固定时间间隔：1分钟 查询范围 过去2分钟 参数配置 告警名称：告警实例的名称，默认为 API网关请求成功率过低告警。您可以根据不同监控对象，命名不同的告...
调用API
请求结构如下：http://Endpoint/?Action=xx&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物联网平台的接入地址格式：iot.${RegionId}.aliyuncs.com 。其中，变量${RegionId} 需替换为您的物联网平台服务的地域代码。阿里云地域...
为什么要定义参数？
参数是 API 请求的重要组成部分，网关可以根据参数定义给你的用户生成 API 手册。
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
错误码
关于如何查看API请求参数的信息，请参见 管理API。若未能解决问题，您可 提交工单 反馈问题。说明 工单中请提供请求的 requestId 和返回的错误码。错误码 错误信息 说明 备注 401 lost of user info:%s 用户信息缺失。其中，%s 为缺失的...
API网关
consumerAppKey API请求的App Key totalLatency API请求的总延迟，单位：毫秒。customTraceId 全链路日志的Trace ID jwtClaims 从JWT中解析出来的Claim，可以在分组上配置。plugin API请求命中的插件列表及相关上下文。
资源包说明
云消息队列 RocketMQ 版 的标准版实例按照按量付费方式对API请求资源和Topic资源进行计费，针对这两个计费项，云消息队列 RocketMQ 版 分别推出API请求次数和Topic次数资源包，帮助您以更优惠的价格享受等量资源。使用的资源在资源包规格内...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
如何使您的API支持HTTPS？
首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。
签名机制
为保证API的安全调用，在调用API时阿里云会对每个API请求通过签名（Signature）进行身份验证。无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名信息。最新文档请参考:V3版本请求体&签名机制
如何有效防止API的重放攻击？
API重放攻击（Replay Attacks）又称重播攻击、回放攻击，这种攻击会不断恶意或欺诈性地重复一个有效的API请求。攻击者利用网络监听或者其他方式盗取API请求，进行一定的处理后，再把它重新发给认证服务器，是黑客常用的攻击方式之一。HTTPS...
日志字段详情
最多1024个（仅专享实例）consumerAppKey API请求的appKey totalLatency API请求的总延迟，单位毫秒 customTraceId 全链路日志的traceId jwtClaims 从JWT中解析出来的Claim，可以在分组上配置 plugin API请求命中的插件列表及相关上下文
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
请求结构
本文介绍了通过HTTP或...请求参数 您需要在每个请求中指定 公共请求参数 和具体接口规定的业务请求参数。其中，业务参数以body的方式透传，body结构说明请参见各API接口的具体描述。字符编码 请求及返回结果都使用UTF-8字符集进行编码。
发送 HTTP 请求（NodeJS）
应用的访问密钥（Access Key/Secret Key）API 的域名地址（host）、请求路径（path）、方法（method）、请求体（body）操作步骤 发送请求到网关本质上就是一个简单的 HTTP 请求，但是由于当前 API 网关要求订阅方必须加签，所以在发起 ...
请求签名
安全验证 安全验证基于KMS实例的应用接入点Client Key，使用非对称签名算法完成，以便实现以下需求：确认发起API请求的用户身份。因为在发送请求前需要用户指定生成数字签名的应用接入点Client Key，在服务端即可通过该应用接入点Client ...
路由规则
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。创建路由规则 sofa.apigateway.router.create 用于快速创建一个路由规则。请求参数 名称 类型 是否必填 示例 描述 param RouterInfoVO 是-param tenant_id STRING 是 ...
API网关监控
可监控指标包括：API请求次数统计 按实例统计API请求次数 流量统计（请求流量、应答流量）平均延时（API网关处理延时、后端处理延时）HTTP Status Code 占比统计 2.实例监控（仅专享实例）2.1 登录 API网关控制台。2.2 点击左侧栏的实例，...
联系方式
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。创建联系方式 sofa.apigateway.contact.create 用于创建一个联系方式。请求参数 名称 类型 是否必填 示例 描述 param ContactInfoVO 是 param tenant_id STRING 是 ...
概述
发起 API 请求的 URL 由不同参数拼凑而成，有固定的 请求结构。URL 中包含 公共参数、您的 签名 和某个 API 的具体参数。每篇 API 文档均给出了 URL 请求示例供您参考，但是为了方便显示，我们并没有编码这些 URL 示例，您需要在发起请求前...
新版计费项
本文档详细介绍了从不同源端数据源到OSS进行数据迁移时的费用构成，包括 OSS 产品的内外网传输费用、API请求费、解冻费用及流量费用。该文档适用于新版在线迁移服务。计费组成 概述 不同源端到目的端迁移数据的收费情况如下表所示：重要 当...
旧版计费项
共计产生API请求次数如下（示例视迁移任务正常完成，未产生迁移错误）：源地址：500×2+300×2+200×1=1800 目的地址：500×3+300×3+200×2=2800 说明 API请求的实际费用以各存储服务商定价为准，OSS的费用请参见 计量项和计费项。...
通过日志服务查看API调用日志
最多1024个（仅专享实例）consumerAppKey API请求的appKey totalLatency API请求的总延迟，单位毫秒 customTraceId 全链路日志的traceId jwtClaims 从JWT中解析出来的Claim，可以在分组上配置 plugin API请求命中的插件列表及相关上下文 2 ...
- 产品推荐
- 这些文档可能帮助您