简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
业务运营报表
搜索请求设置user_id参数 当日进行搜索的用户数 人均搜索PV 访问搜索的用户平均搜索成功的次数 搜索PV/搜索UV 依赖通过SDK/API搜索时，搜索请求设置user_id参数 用户平均搜索次数，搜索次数多一方面体现用户对搜索感兴趣，另一方面体现用户...
业务运营报表
搜索请求设置user_id参数 当日进行搜索的用户数 人均搜索PV 访问搜索的用户平均搜索成功的次数 搜索PV/搜索UV 依赖通过SDK/API搜索时，搜索请求设置user_id参数 用户平均搜索次数，搜索次数多一方面体现用户对搜索感兴趣，另一方面体现用户...
API说明
Authentication API 定义数据源相关性 Correlations API 数据源相关 Data source API 文件夹相关 Folder API 文件夹权限相关 Folder Permissions API 文件夹/仪表盘搜索相关 Folder/Dashboard Search API 库元素相关 Library Element API ...
数据服务API
进入API查找界面 进入数据地图页面。登录 DataWorks控制台，切换至目标地域后，单击左侧导航栏的 数据治理>数据地图，在右侧页面中单击 进入数据地图。在搜索框上方，选择 API 类目，进入查找API的页面。查找API 在API类目下的搜索框中输入...
热搜报表
热搜引导但搜索无结果的比例 热搜引导且无结果的搜索PV/引导搜索PV 依赖通过SDK/API应用搜索时，搜索请求中设置了from_request_id参数 热搜引导搜索但无结果的次数 引导搜索PV-CTR 热搜引导搜索的点击率 热搜引导搜索的搜索IPV/引导搜索PV ...
底纹报表
底纹引导且无结果的搜索PV/引导搜索PV 依赖通过SDK/API应用搜索时，搜索请求中设置了from_request_id参数 底纹引导搜索但无结果的次数 引导搜索PV-CTR 底纹引导搜索的点击率 底纹引导搜索的搜索IPV/引导搜索PV 依赖通过SDK/API应用搜索时，...
NFS协议
其中，尽快刷回NAS服务端，则涉及NAS所提供的如下多节点一致性模型：基于超时的最终一致性 NFS会缓存目录或者文件的属性（FileAttr），操作系统会根据FileAttr是否发生变化，来判断这个目录或者文件是否在其他ECS被修改过。同时，加载...
管理应用
搜索 API：在 API 列表右上方的搜索框中，可通过 API 名称搜索已订阅的 API。更改展示设置：更改列设置：在 API 列表右上方的功能区域，单击 列设置 按钮。在打开的列展示框中，您可勾选或取消 API 列表的展示项目，也可将某一项固定在左/...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
管理路由规则
搜索 API：在 API 列表右上方的搜索框中，可通过 API 名称搜索已绑定的 API。更改展示设置：更改列设置：在 API 列表右上方的功能区域，单击 列设置 按钮。在打开的列展示框中，您可勾选或取消 API 列表的展示项目，也可将某一项固定在左/...
管理授权对象
搜索 API：在 API 列表右上方的搜索框中，可通过 API 名称搜索已绑定的 API。更改展示设置：更改列设置：在 API 列表右上方的功能区域，单击 列设置 按钮。在打开的列展示框中，您可勾选或取消 API 列表的展示项目，也可将某一项固定在左/...
管理 CORS 规则
搜索 API：在 API 列表右上方的搜索框中，可通过 API 名称搜索已绑定的 API。更改展示设置：更改列设置：在 API 列表右上方的功能区域，单击 列设置 按钮。在打开的列展示框中，您可勾选或取消 API 列表的展示项目，也可将某一项固定在左/...
迁移开源HDFS的数据到文件存储 HDFS 版
如果有处于写入状态的文件时，需判断文件是否有效。如果文件无效，则直接删除文件。hdfs rm如果文件有效，则不能直接删除，请考虑恢复问题文件租约。hdfs debug recoverLease-path<path-of-the-file>-retries<retry times>
通用数据查询与管理
如果需要快速地查找数据，例如查找工作空间、数据源中的表、数据分析和数据服务中的代码或API，您可以在数据地图中进行查找。进入数据地图 登录 DataWorks控制台，切换至目标地域后，单击左侧导航栏的 数据治理>数据地图，在右侧页面中单击...
使用简单认证（AppCode）方式调用API
阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述 对于请求的签名认证方式，可以参考...
API概览
术语表 术语 全称 中文 说明 app application 应用 一个应用即一个完整的搜索服务 错误码 API 描述 错误码 返回错误码说明 公共调用方式 API 描述 授权机制 详细说明验签过程 应用操作接口 API 描述 数据处理 上传、修改、删除文档 搜索 ...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
创建后端为函数计算的API
6 调试API API网关提供了在线调试的功能，因此一般建议在API网关上完成API配置之后，可以先通过此功能确认API是否配置成功，然后再通过client端进行调用。步骤11 调试API 在 API列表页，点击前面步骤中新增的API，进入详情页，点击 调试API...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
Linux系统挂载NFS协议文件系统
其中，“尽快”刷回NAS服务端，则涉及NAS所提供的如下多节点一致性模型：基于超时的最终一致性 NFS会缓存目录或者文件的属性（FileAttr），操作系统会根据FileAttr是否发生变化，来判断这个目录或者文件是否在其他ECS被修改过。同时，加载...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
文件存储NAS自定义权限策略参考
Resource":["acs:nas:*:*:filesystem/07d*294"]}],"Version":"1"} 彻底删除回收站中暂存文件的权限 通过自定义权限策略授予RAM用户彻底删除文件系统回收站中暂存文件的权限。其中，07d*294 为文件系统实例ID，请根据实际值替换。{...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
DescribePurchasedApis-获取购买的 API 列表
RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...
DescribeHistoryApis-查询API发布版本定义列表
查询API历史发布版本列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
计费常见问题
本文介绍文件存储NAS（通用型NAS/极速型NAS）计费常见问题。包括通用型NAS资源包如何使用或抵扣、NAS服务如何停止计费、购买资源包为什么还欠费等问题。开通NAS服务后，就开始计费吗？仅开通NAS服务，不会产生费用。当您在通用型NAS中写入...
新功能发布记录
全部 参数与条件表达式的使用 API调试功能 支持Basic Auth认证调试 调试支持 multipart/form-data，可在调试页面调试文件上传 调试页面支持选择是否允许获取trace的token 全部 API调试及自助排错 2023-11 功能名称 功能描述 发布地域 相关...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您