日志字段详情
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
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...
DescribeApisByApp-根据应用查询API列表
10 ApiUid string 否 API 的 ID b19240592b1b4e74961fb8438ed7550c ApiName string 否 API 名称 getPersonInfo Path string 否 API 请求路径/tt Method string 否 API 的请求 HTTP Method POST Description string 否 API 描述信息 test ...
请求结构
本文主要介绍 PolarDB-X 支持的API请求结构，包括服务地址、请求协议和请求方法等。服务地址 PolarDB-X 支持的API服务接入地址请参见下表。地域（部署位置）接入地址（Endpoint）华东1（杭州）polardbx.cn-hangzhou.aliyuncs.com 华北2...
DescribeApi-查询 API 定义
取值：true:请求 API 时强制检查这个字段，防止 API 的重放攻击 false:不检查这个字段 true Visibility string API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境，会在所有用户的控制台“发现 API”页面展示 ...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
支持HTTP2.0
API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。可客户端和服务器可以把HTTP消息分解为互不依赖的帧，...
调用方式
HTTP调用 云消息队列 RabbitMQ 版 HTTP调用是向 云消息队列 RabbitMQ 版 API的服务端地址发送HTTP请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。云消息队列 ...
调用方式
Serverless应用引擎SAE（Serverless App Engine）的API支持HTTP调用、SDK调用和OpenAPI开发者门户调用。HTTP调用 您可以通过向服务端发送HTTP或HTTPS协议请求调用云产品 SAE。为了获得更高的安全性，推荐您使用HTTPS协议发送请求。在使用...
请求签名
为保证API的安全调用，KMS会对每个API请求通过签名（Signature）进行身份验证。安全验证 安全验证基于KMS实例的应用接入点Client Key，使用非对称签名算法完成，以便实现以下需求：确认发起API请求的用户身份。因为在发送请求前需要用户...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
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....
请求签名
为保证API的安全调用，KMS会对每个API请求通过签名（Signature）进行身份验证。安全验证 安全验证基于KMS实例的应用接入点Client Key，使用非对称签名算法完成，以便实现以下需求：确认发起API请求的用户身份。因为在发送请求前需要用户...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
使用外部授权 API
网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为调用自定义的远程接口。本文将引导您使用外部授权 API。完整的操作步骤如下：编写外部授权 API：在本地开发定义一个...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
DescribePluginApis-查询插件绑定的API列表
10 TotalCount integer 返回结果总数 7 ApiSummarys object[]API 信息集合 ApiId string API 编号 accc8c68b7294b1cb4928741*Description string API 描述信息 API描述信息 GroupName string API 所属的分组名称 myGroup2 GroupId string ...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
错误码
调用物联网数据服务的数据API时，您可能会收到物联网返回的错误信息。本文介绍常见的错误码及其含义。调用API出错时，请根据返回的错误信息修复问题，然后重新发起调用。关于如何查看API请求参数的信息，请参见 管理API。若未能解决问题，...
请求费用
您对OSS的所有操作都是通过调用OSS API实现的，OSS会根据调用的API次数收取请求费用。如果您的业务涉及访问冷归档存储类型的数据时，需要对这部分数据进行解冻，解冻过程还会产生数据取回请求费用。说明 本文仅说明相关计费项及付费方式。...
后端路由
当前请求的域名 CaRequestHandleTime：请求处理的UTC时间 CaAppId：请求参数的AppId CaAppKey：请求参数的AppKey CaClientIp：客户端IP CaApiName：创建时候的API名字 CaHttpScheme：请求的协议 HTTP ,HTTPS CaClientUa: 客户端上传的...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
使用Python依赖
vvr-6.x及以上版本 python.executable:venv.zip/venv/bin/python python.client.executable:venv.zip/venv/bin/python vvr-6.x以下版本 python.executable:venv.zip/venv/bin/python 使用第三方Python包 说明 下述内容中的 Zip Safe、PyPI ...
概述
发起 API 请求的 URL 由不同参数拼凑而成，有固定的 请求结构。URL 中包含 公共参数、您的 签名 和某个 API 的具体参数。每篇 API 文档均给出了 URL 请求示例供您参考，但是为了方便显示，我们并没有编码这些 URL 示例，您需要在发起请求前...
为什么要定义参数？
参数是 API 请求的重要组成部分，网关可以根据参数定义给你的用户生成 API 手册。
错误码
说明 API 请求异常的原因可能是控制台没有下发配置或者网关没有及时更新配置。排查方式如下：检查网关是否配置了相应的 API 且 API 的状态是否为 已发布。检查客户端的 API 调用路径和分组等信息是否与网关维护的一致。检查请求的 host、...
重试机制
新版SDK重试机制 新版 SDK 对 OpenAPI 请求中遇到网络问题的情况会进行重试，对于业务报错则不会重试。在请求中通过运行时参数配置重试，优先级为 RuntimeOption->默认；默认不会进行重试，如果打开重试配置未配置重试次数，则默认最多重试...
使用后端服务提高管理效率
本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
配置API输入组件
配置API输入组件后，可以读取API数据源中的数据至Dataphin，进行数据集成与数据开发。本文为您介绍如何配置API输入组件。前提条件 在开始执行操作前，请确认您已完成以下操作：已创建API数据源。具体操作，请参见 创建API数据源。进行API...
调用方式
您可以通过发送HTTP GET请求调用威胁情报API，并按照接口说明在请求中加入相应的请求参数。调用接口后系统会返回处理结果。请求和返回结果都使用UTF-8字符集进行编码。请求结构 威胁情报的API是RPC风格，您可以通过发送HTTP GET请求调用...
配置API输入组件
配置API输入组件后，可以读取API数据源中的数据至Dataphin，进行数据集成与数据开发。本文为您介绍如何配置API输入组件。前提条件 在开始执行操作前，请确认您已完成以下操作：已创建API数据源。具体操作，请参见 创建API数据源。进行API...
CreateApi-创建 API
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:CreateApi Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定的分组编号 08ae4aa0f95e4321849ee57f4e0b3077 ApiName string 是 设置 API 的名称，...
如何使您的API支持HTTPS？
首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。
公共请求头
本文为您介绍 KMS实例API 的公共请求头参数列表和示例。参数列表 KMS实例API 是基于HTTP协议的Protocol Buffers风格接口。它支持一组可以在所有API请求中使用的公共请求头（Header），如下表所示。请求头名称 类型 是否必须 描述 Accept ...
公共请求头
本文为您介绍 KMS实例API 的公共请求头参数列表和示例。参数列表 KMS实例API 是基于HTTP协议的Protocol Buffers风格接口。它支持一组可以在所有API请求中使用的公共请求头（Header），如下表所示。请求头名称 类型 是否必须 描述 Accept ...
- 产品推荐
- 这些文档可能帮助您