开放搜索api-开放搜索api文档介绍内容-阿里云

应用场景

API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...

配置后端服务Host（域名头）

Host概述当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...

名词解释

名词解释应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权授予某个APP调用某个API...

RemoveIpControlApis-解除API与IP访问控制的绑定

接口说明此功能面向开放 API 的用户即时生效，解除后该 API 的对应环境将不会有 IP 访问控制调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

SetIpControlApis-绑定IP访问控制与API关系

接口说明此功能面向开放 API 的用户支持多个 API 批量操作，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权...

RemoveSignatureApis-解除API与后端签名密钥的绑定

接口说明此功能面向开放 API 的用户即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...

RemoveTrafficControlApis-解除API与流控策略的绑定

接口说明此功能面向开放 API 的用户用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...

业务运营报表

搜索请求设置user_id参数当日进行搜索的用户数人均搜索PV 访问搜索的用户平均搜索成功的次数搜索PV/搜索UV 依赖通过SDK/API搜索时，搜索请求设置user_id参数用户平均搜索次数，搜索次数多一方面体现用户对搜索感兴趣，另一方面体现用户...

DeleteApi-删除 API 定义

接口说明此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算...

VPC内网访问API网关

API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...

DeployApi-发布 API

接口说明此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，...

AbolishApi-下线 API

接口说明此功能面向开放 API 的用户，和发布 API 相对应将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算...

为分组绑定插件

3.快速使用登录API网关控制台，左侧栏找到 开放API —— 插件管理。单击右上角创建插件，在页面中自定义插件名称，选择插件类型，配置插件规则。配置好插件规则后，点击创建，随后在插件列表中就可以看到刚刚创建的插件了。点击右侧的绑定...

CreateApi-创建 API

接口说明此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...

AttachPlugin-绑定插件到API上

接口说明此接口面向开放 API 的用户绑定操作只能选择发布状态的 API 绑定以后及时生效修改插件后及时生效调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...

DeletePlugin-删除插件

接口说明此接口面向开放 API 的用户。必须先解除 API 和插件的绑定关系，否则删除报错。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下...

DescribeSignaturesByApi-查询API绑定的后端签名密钥

接口说明此功能面向开放 API 的用户调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称类型必填 ...

导出标准OAS定义

概述本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...

产品简介

API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...

Nacos

API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...

使用SDK调用API

1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在调用API 的已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在 开放API 的...

SetTrafficControlApis-添加指定流控策略与API的绑定

接口说明此功能面向开放 API 的用户用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...

DescribeApisByIpControl-查询IP访问控制绑定的API

接口说明此功能面向开放 API 的用户分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称 ...

DescribeApisByTrafficControl-查询指定流控策略下已...

接口说明此功能面向开放 API 的用户分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称 ...

DescribeDeployedApis-查询已发布 API 列表

接口说明此功能面向开放 API 的用户调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 ...

业务运营报表

搜索请求设置user_id参数当日进行搜索的用户数人均搜索PV 访问搜索的用户平均搜索成功的次数搜索PV/搜索UV 依赖通过SDK/API搜索时，搜索请求设置user_id参数用户平均搜索次数，搜索次数多一方面体现用户对搜索感兴趣，另一方面体现用户...

DescribeApiDoc-查询API说明文档

接口说明此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...

DescribeApisBySignature-查询签名密钥绑定的API列表

接口说明此功能面向开放 API 的用户分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略...

DescribeApiHistories-查询API历史发布的版本列表

接口说明此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录调用该接口能获取 API 历史版本号数据，用于其他接口的调用调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...

公网访问API域名方法

1、查看所需访问的Ha3实例域名对应的IP 登录OpenSearch-召回引擎版控制台，找到对应的实例，查看API域名地址。登录ha3实例中配置的专有网络，登录一台ECS机器，使用ping命令ping ha3实例的API域名，获取对应的地址。2、创建公网NAT网关 ...

DescribeApis-查询定义中的 API 列表

接口说明此功能面向开放 API 的用户接口返回所有定义中的 API 列表，以及概况信息请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果调试您可以在OpenAPI Explorer中直接运行该...

API/SDK数据导入

2.API/SDK不支持设置数据源插件，请自行拼接、处理后传入OpenSearch应用中。比如，array类型使用API上传时，注意不要上传为string格式，而是上传为数组类型。例：/定义Map对象存储上传文档数据,此为文档2 Map,Object>doc2=Maps....

A/B测试报表

搜索UV UserView：访问过搜索结果页的用户数同一个用户无论访问多少次都只记1 依赖通过SDK/API搜索时，搜索请求设置user_id参数当日进行搜索的用户数翻页率翻页请求占搜索PV的比例翻页请求PV/搜索PV 翻页请求占总搜索PV的比例，衡量...

导入标准OAS定义

API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义主要包括...

产品简介

API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...

API/SDK数据导入

OpenSearch中的数据，既支持数据源导入，也支持无数据源，通过API/SDK/控制台上传文件的方式导入数据。通过API/SDK导入非常灵活，完全由用户控制。字段类型对应关系 OpenSearch 字段类型 API推送字段类型 INT int、long INT_ARRAY int[]、...

API 数据源

本文将介绍以API为数据源时如何添加表。添加表在实例详情>表管理页，点击添加表：填写表的基础信息，点击下一步：配置说明：表名称：可自定义数据分片数：分片数设置时，各索引表分片数需保持一致；或至少一个索引表分片数为1，其余...

API报警设置

4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...

RESTFUL API搜索处理

系统提供了丰富的搜索语法以满足用户各种场景下的搜索需求。URL/{indexName}/search 以上 URL 省略了请求Header参数及编码等因素。以上 URL 中省略了访问应用的 host 地址。请求协议 HTTP 请求方式 POST 支持格式 JSON 签名机制可用以下...

RESTFUL API搜索处理

系统提供了丰富的搜索语法以满足用户各种场景下的搜索需求。URL/{indexName}/search 以上 URL 省略了请求Header参数及编码等因素。以上 URL 中省略了访问应用的 host 地址。请求协议 HTTP 请求方式 POST 支持格式 JSON 签名机制可用以下...

开放搜索api

新品推荐