HTTP API 概览

TSDB 提供了一个基于 HTTP 的应用程序编程接口,以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问,比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的,同时也提供了替代访问策略,因为...

产品架构

Mosng 网关根据内存中 API 信息校验应用的请求信息(验签、解密、RPC 信息校验)。如果信息校验失败,则直接返回错误信息应用。如果信息校验通过,则根据配置的协议(HTTP/SOFARPC/SOFAREST)将应用的请求转发到后端业务服务器。

ImportSwagger-通过 Swagger 创建 API

API 时返回的错误信息 api already exists:apiUid=>8e274ec61cf6468e83b683719568*ModelFailed object[]本次所有通过 swagger 导入失败的 Model 信息。ErrorMsg string 错误信息 error msg ModelName string 模型名称 Region GroupId ...

DryRunSwagger-预检查swagger

调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action 元素中使用,用来给RAM用户或RAM...

DescribeDeployedApis-查询已发布 API 列表

查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK...

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

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

DescribeHistoryApis-查询API发布版本定义列表

RELEASE:线上 TEST:测试 RELEASE ApiId string 否 指定要查询 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称(模糊匹配)getPersonInfo PageSize string 否 分页参数:每页显示条数。10 PageNumber string 否...

短信发送配置指南

挂机发送短信的诉求亦或者当实际外呼到某一关键节点上就会对实际外呼用户进行发送短信的情况,具体配置步骤请参照下方示例:1、预先开通阿里云官网短信服务产品 产品开通地址:https://www.aliyun.com/product/sms 根据短信服务产品指引...

API 管理

创建 API 信息 sofa.apigateway.api.create 用于快速创建一个 API 服务。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户标识 workspace_id STRING 是 default 工作空间标识 返回参数...

ModifyApiConfiguration-修改API定义

本API用于修改API的草稿定义信息,区别于接口ModifyApi,不需要填充所有的API信息才能操作,只需指定要修改的参数进行修改。例如,当需要修改API的认证方式从匿名变为APP认证,只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...

API概览

元数据 说明 元数据相关的API信息比较复杂,不建议使用。如果您有必须使用的需求可以搜索钉钉群号33899370加入钉钉群进行咨询沟通。权限管理 API 描述 GrantPrivileges 对用户进行授权。RevokePrivileges 移除某个用户的某个权限。数据库...

API&SDK常见问题

AccessKey是否支持调用短信API?AccessKey 是阿里云账号维度,并不固定用于阿里云哪个产品。如果您是RAM子账号的AccessKey,为对应的RAM子账号授权了哪些产品的权限,对应的AccessKey就可以调用对应产品的API接口。您可以在 RAM-用户 页面...

API分组同步

模型信息 API 比较过程中,会根据API引用的模型名称判断API定义是否一致,不会检查引用模型的具体定义是否一致;若源分组API使用了模型,目标分组不存在同名模型,则模型自动同步到目标分组;若目标分组API存在源分组API引用的同名模型,源...

API概览

ModifyApiConfiguration 修改API定义 本API用于修改API的草稿定义信息,区别于接口ModifyApi,不需要填充所有的API信息才能操作,只需指定要修改的参数进行修改。例如,当需要修改API的认证方式从匿名变为APP认证,只需要传入AuthType的值...

DescribeApiProductApis-查询API产品绑定的API列表

查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...

ApiPluginSummary

描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...

概述

具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API,具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范,被广泛应用于定义和描述后端应用服务的API。现在,API网关支持...

管理 API 分组

API 列表:列出了该 API 分组下所有 API 以及 API 的概览信息,比如 API 名称,前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表,您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...

发布API商品

3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中,您需要在分组上绑定您的正式域名后,业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组,则不必您绑定域名,在云市场服务商控制台中,...

版本管理

2.单击左侧导航栏 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑,单击 编辑 按钮。编辑API定义的流程和创建API定义一致,详细信息参见 创建 API,如果您想...

管理外部授权 API

绑定 API:列出了该外部授权 API 绑定的所有 API 及其基本信息,包括 API 名称、API 分组、发布状态、前端协议类型、创建时间等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 API 的具体信息及监控数据等。配置信息:...

管理数据模型

绑定 API:列出了绑定了该数据模型的所有 API 及其基本信息,包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...

API调试及自助排错

2.调试信息获取错误信息 所有的API请求只要到达网关,网关就会返回请求结果信息。用户可以查看返回结果的头部,即Header部分,来获取API网关返回的信息。其中X-Ca开头的属性均为API网关返回,其中您需要重点关注的信息为:X-Ca-Error-Code...

DescribeApisByBackend-根据后端查询 API 列表

1 ApiInfoList object[]返回 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...

导入标准OAS定义

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

管理 CORS 规则

绑定 API 在 CORS 规则详情页的 绑定 API 页签中,可查看当前 CORS 规则已绑定 API。在绑定 API 列表中,您可以:查看 API 详情:单击 API 名称,即可跳转至该 API 的详情页,您可查看该 API 的 配置信息、版本管理、监控、流量...

简介

API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经备案且解析至...

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

查询指定IP访问控制所绑定的API列表信息接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...

查询指定流控策略下已绑定API列表信息

查询指定流控策略下已绑定的API列表信息接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...

ApiHisItem

描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiHisItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...

管理参数映射

绑定 API:列出了绑定了该映射规则的所有 API 及其基本信息,包括 API 名称,API 分组、发布状态、前端协议类型、创建时间等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情:...

DescribeApis-查询定义中 API 列表

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

ImportOAS-通过OAS导入API

APP].WarningMessages array OAS 定义中不支持的警告信息,可以忽略 string OAS 定义中不支持的警告信息,可以忽略 There is no valid api definition in your file.SuccessApis object[]预检成功 API 信息 Path string 创建 API 时配置...

管理系统集群

绑定的API:列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息,例如 API 名称,前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 ...

修改VPC授权信息,并且更新关联的API的元信息

修改VPC授权信息并更新关联的API信息。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的...

创建 API

创建API即录入API的定义,需要录入API的基本信息、服务信息、请求信息、和返回信息,然后对创建的API进行调试,及进行安全配置。经测试证明API可用后,可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面,单击创建API,即...

Nacos

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

DescribeApiDoc-查询API说明文档

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

Zookeeper

本文将介绍API网关集成Zookeeper访问微服务后端的原理,以及如何创建、发布并调用服务发现类型的API。1.概述 本文依次介绍如下步骤:原理说明 创建VPC融合专享实例(仅VPC融合实例支持Zookeeper)部署Zookeeper服务并注册微服务应用 创建...

API调用统计

API调用统计功能可以统计API被调用的详细信息,包括 开放API 和 数据服务 API。该功能仅对组织管理员可见。功能入口 您可以按照图示步骤进入API调用统计页面。API调用统计 在 API调用统计 页面,您可以查看 开放API 或 数据服务 API的 今日...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 短信服务 视觉智能开放平台 对象存储 商标服务 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用