HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
产品架构
Mosng 网关根据内存中的 API 信息校验应用的请求信息（验签、解密、RPC 信息校验）。如果信息校验失败，则直接返回错误信息给应用。如果信息校验通过，则根据配置的协议（HTTP/SOFARPC/SOFAREST）将应用的请求转发到后端业务服务器。
ApiInfo
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiInfo 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String...
DeployedApiItem
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 DeployedApiItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 ...
ApiHisItem
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiHisItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
管理 API 渠道
支持对添加的 API 渠道进行查询、查看详情和修改 API 信息。创建 API 渠道后，支持对已有的 API 渠道进行查询、修改、详情查看操作。创建 API 渠道 操作步骤如下：登录 mPaaS 控制台，从左侧导航栏进入 内容中台>API 引入管理 页面。单击 ...
API 版本管理
在编辑页面，修改 API 信息后，单击 保存。在 API 编辑的内容保存成功页面，单击 立即发布。在 发布 窗口，您可以选择输入具体版本原因，单击 确定，即可发布成功。发布编辑中版本 在 版本管理>编辑中版本 中，单击 操作 列的 发布 按钮。...
ImportSwagger-通过 Swagger 创建 API
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
发布API商品
3 API网关上配置并发布API 3.1 概述 注意：需要使用入驻成功后的服务商账号在API网关上进行配置，否则在云市场服务商控制台上将无法获取到配置好的API信息。以下图的API商品为例，介绍如何在API网关上进行配置。3.2 创建API分组 首先需要在...
API概览
元数据 说明 元数据相关的API信息比较复杂，不建议使用。如果您有必须使用的需求可以搜索钉钉群号33899370加入钉钉群进行咨询沟通。权限管理 API 描述 GrantPrivileges 对用户进行授权。RevokePrivileges 移除某个用户的某个权限。数据库...
查看API资产详情
名称 说明 来源 接口信息 展示基本信息、应用请求、响应示例等信息。已在统一服务模块中创建API，并已上线。血缘关联 展示API和表的关联关系。已在统一服务模块中创建API，并已上线。用户评价 展示用户对该API的评分情况。已被申请，且使用...
查看API资产详情
名称 说明 来源 接口信息 展示基本信息、应用请求、响应示例等信息。已在统一服务模块中创建API，并已上线。血缘关联 展示API和表的关联关系。已在统一服务模块中创建API，并已上线。用户评价 展示用户对该API的评分情况。已被申请，且使用...
发送 HTTP 请求（NodeJS）
api 信息 const gateway="5jzkcn0idt3w*.apigateway.inc.alipay.net";const method="POST;const path="/simple/demo;const headers={ 'Content-Type':'application/json' };app ak const accesskey="m9hoHiqtjylG*;app sk const secretkey=...
ListDataServiceAuthorizedApis
调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 ...
API 管理
创建 API 信息 sofa.apigateway.api.create 用于快速创建一个 API 服务。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户标识 workspace_id STRING 是 default 工作空间标识 返回参数...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成API至自己的应用中，...
发送 HTTP 请求（Java）
} 注意事项 当 API 在测试环境完成测试后，通过导入导出功能把 API 信息迁移到生产环境，此时 API 对应的分组域名会发生变换（分组名称不变），所以最好通过在配置文件中配置域名的方式，将分组域名引入生产环境，方便客户端区分生产环境和...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
API详情
筛选条件 通过设置不同维度的筛选条件，查看相应的API信息。可筛选的维度包括 API、返回信息、HTTP状态码、页面、地域、操作系统、域名、网络制式、设备、浏览器、UID 和 用户名。将鼠标悬浮于一个筛选框中，单击右侧的，可删除该条件的...
调用API
调用方式 调用方式 适用场景 说明 安全级别 加密签名身份认证 应用程序开发、数据采集等。该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作，请参见 使用SDK调用API。高 简单身份认证 一般用于可视化场景，如DataV调用。该...
ApiGateway服务关联角色
本文为您介绍ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）的应用场景以及如何删除服务关联角色。背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问...
API网关-事件总线服务关联角色
本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...
API网关-监控服务关联角色
背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...
API网关-微服务集成服务关联角色
背景信息 API网关-微服务集成服务关联角色（ApiGateway-IntegrateWithMicroservices）是API网关为了访问您在企业级分布式应用服务（EDAS）和微服务引擎（MSE）下的资源，而提供的RAM角色。更多关于服务关联角色的信息请参见 服务关联角色。...
API网关-连接用户VPC服务关联角色
本文为您介绍API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApiGatewayConnectUserVpc）的应用场景以及如何删除API网关-连接用户VPC服务关联角色。背景信息 API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApi...
数据服务入门
在 生成API 对话框，配置API信息。本文示例配置如下图。主要参数介绍如下。配置项 描述 API模式 您可选择使用向导模式或脚本模式创建API。向导模式：无需具备编码能力，即可快速配置一个数据API。脚本模式：支持多表关联、复杂查询和聚合...
DataWorks OpenAPI概述
DataWorks为您提供了涵盖租户、元数据、数据开发、运维中心、数据集成等多个功能模块的OpenAPI接口，不同API的QPS限制、每日调用次数上限和支持使用的DataWorks服务版本存在差异。您可参考本文了解各OpenAPI支持的DataWorks版本及地域、...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
调用API
在API发布并授权之后，您可以通过简单身份认证（在请求头中添加AppCode）或加密签名身份认证（在请求头中添加AppKey和AppSecret）的方式调用API。本文为您介绍如何获取认证信息以及调用API的具体流程。前提条件 您需要首先发布API至API网关...
API概览
RemoveIdentityCertifiedForBidUser 取消客户实名认证信息 角色扮演 API 名称 说明 AssumeRole 获取虚商客户身份，应用于SSO，新购、续费、变配等API调用 安全访问 API 名称 说明 GetSigninToken 获取登录令牌 Login 使用登录令牌登录控制...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
管理API端点
前提条件 开通事件总线EventBridge并授权 背景信息 API端点（API Destinations）可以帮助您调用第三方SaaS系统或自建系统的HTTP接口，提供低代码的接入方式，无需更多额外架构即可完成接口调用。借助API端点，您可以轻松构建和对接SaaS应用...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
版本说明
变更时间：2022-11-21 变更集发布说明：工作流支持资源组和资源组鉴权 OpenAPI 名称 变更内容概要 操作 CloneFlow OpenAPI 描述信息更新、OpenAPI 变更为 deprecated，即将下线、OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更...
版本说明
变更时间：2024-04-13 变更集发布说明：OpenAPI 名称 变更内容概要 操作 InvokeFunction OpenAPI 入参发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入参发生变更。新增入参：x-fc-async-task-id 变更时间：2024-02...
版本说明
变更时间：2023-12-07 变更集发布说明：OpenAPI 名称 变更内容概要 操作 QuerySavingsPlansDeductLog OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 API 描述 ...
- 产品推荐
- 这些文档可能帮助您