基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
监控指标参考
具体指标项如下：指标名称 单位 描述 GetObject请求平均E2E延时 毫秒 请求API为GetObject的成功请求的平均端到端延时。GetObject请求平均服务器延时 毫秒 请求API为GetObject的成功请求的平均服务器延时。GetObject请求最大E2E延时 毫秒 ...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
CreateApi-创建 API
Key string 否 标签的键 env Value string 否 标签的 value value 返回参数 名称 类型 描述 示例值 object ApiId string 本次创建 API 的 ID 8afff6c8c4c6447abb035812e4d66b65 RequestId string 本次创建 API 的请求 ID 6C87A26A-6A18-4B8...
进阶场景四：调用HTTP服务
云函数提供了ctx.httpclient HTTP请求方法。无需额外依赖，您就可以请求任何HTTP和HTTPS协议的Web服务。例如，请求一个网页，代码示例如下。module.exports=async ctx=>{ const res=await ctx.httpclient.request('...
Batch-批量调用API
93433894994ad2e1 status integer 子请求的返回状态码，可参考相应子请求 API 文档 200 body object 子请求的响应结果，可参考相应子请求 API 文档 any 子请求的响应 body {"domain_id":"1","drive_id":"1","file_id":"9520943DC264"} 示例...
状态码
需要进行权限校验，确认当前登录用户是否有权限调用请求API。404 Not Found 请求失败，未在服务器上发现请求所希望得到的资源。需要确认请求的API参数是否正确。405 Method Not Allowed 请求行中指定的请求方法不能被用于请求相应的资源。...
API调试及自助排错
可以在Trace日志中可以查看API网关收到的请求、API网关的处理详情、API网关发给后端服务的请求、API网关收到的应答、API网关给客户端返回的应答。如果使用的是子账号或者角色扮演账号，发送请求前需要勾选 记录Trace日志，则需要确保使用的...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
DeleteDBInstance
返回数据 名称 类型 示例值 描述 RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteDBInstance&RegionId=cn-hangzhou &DBInstanceName=pxc-*&公共请求参数 正常返回示例 ...
DeleteDB
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteDB&RegionId=cn-hangzhou &DBInstanceName=pxc-*&DbName=testdb&公共请求参数 正常...
CreateSuperAccount
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=CreateSuperAccount&RegionId=cn-hangzhou &DBInstanceName=pxc-*&AccountName=dba&...
CreateBackup
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。Data Array of Account BackupSetId Long 627833 备份集ID。示例 请求示例 http(s):/[Endpoint]/?Action=CreateBackup&RegionId=...
DeleteAccount
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?Action=DeleteAccount&DBInstanceName=pxc-*&AccountName=testaccount&RegionId=...
数据报表
全栈可观测应用提供丰富的仪表盘，用于展示Web页面、小程序的性能指标、JS错误、API请求、资源访问等信息。前提条件 已接入用户体验数据。具体操作，请参见 接入Web的用户体验数据、接入小程序的用户体验数据。功能入口 登录 日志服务控制...
Web&H5监控详情
API请求 API请求提供了以API为维度的请求数、请求耗时、状态码等数据，您可以根据某个API进行针对性分析。在API请求页面，您可以查看API的异常请求和请求明细。在快捷筛选区域（图示①），您可以快速选择需要筛选的条件。在趋势图区域...
小程序监控详情
小程序监控主要面向如钉钉、微信等超级App中的小程序应用，提供包括页面访问、资源加载、API请求调用、JS错误等性能数据的采集、分析能力，支持单用户会话追踪，还原真实用户操作场景，采集问题堆栈及上下文信息，快速追溯问题根源，帮助...
SetupDrdsParams
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C 请求ID。Success Boolean true 请求是否成功。示例 请求示例 http(s):/[Endpoint]/?RegionId=cn-hangzhou &DrdsInstanceId=drdsjiii1b49*&ParamLevel=DB&Action=SetupDrdsParams&...
RotateSecret
RequestId String 10257c86-269d-43aa-aaf3-90ed4144bb7c 请求ID。关于公共请求参数的详情，请参见 公共参数。示例 请求示例 http(s):/[Endpoint]/?Action=RotateSecret&SecretName=RdsSecret/Mysql5.4/MyCred&VersionId=000000123&<公共...
DeployGateway
RequestId String 8FEAFE9D-66C2-46AB-833B-35269EC7524C 请求ID。Success Boolean true 请求是否成功。TaskId String t-0001xv7je35800307*任务ID。示例 请求示例 http(s):/[Endpoint]/?Action=DeployGateway&GatewayClass=Basic&...
如何有效防止API的重放攻击？
API网关提供了一套有效防止重放攻击的方法。开启API网关的防重放，需要您使用“阿里云APP”的认证方式。通过这种签名认证方式，每个请求只能被使用一次，从而防止重放。阿里云APP：是基于请求内容计算的数字签名，用于API网关识别用户身份...
调用方式
介绍产品调用API请求的请求和返回模式。请求结构 地址标准化的API是RPC风格，您可以通过发送HTTP GET请求调用 API。其请求结构如下：https://Endpoint/?Action=xx&Parameters 其中：Endpoint：地址标准化API的服务接入地址为 address-...
创建 API
1.2 定义API请求 定义用户如何请求API，包括协议、请求Path、HTTP Method、入参请求模式、和入参定义。参数 描述 请求协议 支持HTTP、HTTPS。请求Path Path指相对于服务host，API的请求路径。请求Path可以与后端服务实际Path不同，您可以...
DescribeApiProductApis-查询API产品绑定的API列表
ID dd46297680014a7e8e318308f3345951 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 1e377f18142345dfb700cd8911c2463a Path string API 的请求路径/test Method ...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
日志字段详情
event.serviceName 事件相关的云资源名称，例如Vpc event.sourceIpAddress 事件发生的源IP地址 event.userAgent 发送API请求的客户端代理标识 event.requestParameters.HostId API请求输入参数中的主机ID event.requestParameters.Name API...
术语表
例如，电商网站的登录、查询商品详情、提交订单等，分别对应一次用户行为中的多个请求API。VU 虚拟用户数，表示压测能力。例如100 VU，即表示有100个独立的线程分别连续发送请求。VUM 计量单位，VUM=VU*Min。虚拟用户数 同时发送压测请求的...
如何获取错误信息
其中 X-Ca开头的均为网关返回，比较重要信息是：/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪 X-Ca-Request-Id:7AD052CB-EE8B-4...
后端签名插件
6.调试模式 为了方便后端签名接入与调试，可以开启 Debug 模式进行调试，具体方法如下：请求API网关的 Header 中添加 X-Ca-Request-Mode=debug。后端服务在 Header 中读取 X-Ca-Proxy-Signature-String-To-Sign 即可，因为 HTTP Header 中...
请求中编码问题
API请求编码问题 客户端请求API网关时，需要对参数值进行utf-8的urlEncode，这样能避免特殊参数或者中文出现乱码。注意：query、header、body位置编码需要在签名计算后，签名时用原始值。以下代码可参考：...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
调用方式
介绍产品调用API请求的请求和返回模式。请求结构 支持与服务的API是RPC风格，您可以通过发送HTTP GET请求调用支持与服务 API。其请求结构如下：http://Endpoint/?Action=xx&Parameters 其中：Endpoint：API的服务接入地址为 supportplan....
IP访问控制插件
appId:219810#(可选)如果配置了appId则该条目仅对该AppId生效-blocks:#IP地址-79.11.XX.XX#使用IP地址方式配置-blocks:#用户VPC-192.168.XX.XX/32#专享实例场景，从用户VPC内访问API网关的请求，API网关看到的来源地址处于这个地址段 需要...
请求结构
本节介绍产品调用 RPC 风格 API 请求的请求模式。虚商集成接口调用是向API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。PRC 风格 API ...
API网关流量安全
API网关服务端平均延时过高告警 API网关后端服务器错误率过高告警 API网关请求成功率过低告警 API网关服务端平均延时过高告警 告警ID sls_app_audit_dataflow_at_api_latency 告警名称 API网关服务端平均延时过高告警 版本号 1 类别 云平台...
请求结构
发起 API 请求的 URL 由不同参数拼凑而成，有固定的请求结构。URL 中包含如下：服务地址 通讯协议 请求方法 公共头参数 每个 API 的特有参数 每篇 API 文档均给出了 URL 请求示例供您参考，我们并没有编码这些 URL 示例，您需要在发起请求...
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
- 产品推荐
- 这些文档可能帮助您