API使用规范

API 本规范中“API”指:阿里云向您提供的应用程序编程接口(Application Programming Interface,简称API),您编程后通过该应用程序编程接口,可获取阿里云提供的弹性计算服务(ECS)、关系数据库服务(RDS)和对象存储服务(OSS)等阿里...

阿里云OpenAPI

API应用程序编程接口)是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务,使开发者更容易地实现连接两个应用程序之间的功能,也使开发人员可以更轻松地开发和扩展应用程序。Open...

基础术语

中文 释义 API 应用程序编程接口,是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组,同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识,用于定位在访问的 API。...

公开与隐藏API资产

背景信息 在统一服务中上线API后,系统将自动编目及公开API资产。操作步骤 登录企业数据智能平台。在页面左上角,单击 图标,选择 运营。在顶部菜单栏,单击 资产管理。在左侧菜单栏,选择 系统资产管理>API管理,进入API资产管理页面。...

CreatePipeline-创建流水线

创建流水线API,支持创建YAML化流水线。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 POST/...

API概览

流水线 API 标题 API概述 服务连接 服务连接 CreateServiceConnection 创建服务连接 创建服务连接 CreateServiceAuth 创建服务授权 创建服务授权 CreateServiceCredential 创建服务证书 创建用户名密码类型的证书 ListServiceCredentials ...

API 概览

流水线控制 API 名称 描述 运行流水线 运行流水线 终止运行流水线 可以取消运行流水线 删除流水线成员 可以删除流水线成员 更新流水线成员 可以更新流水线成员 增加流水线成员 可以增加流水线成员 使用流水线模板创建流水线 使用流水线模板...

2021/12/15 更新日志

新功能 复制流水线时支持同步复制流水线部分设置(流水线源开启代码源触发/流水线环境信息/流水线通用变量组/流水线标签/Webhook开关)。新增流水线标签 API,查看帮助。

HTTP API 概览

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

请求结构

API i类型 接入地址 流水线相关api api-devops.cn-beijing.aliyuncs.com 请求参数 您需要通过 Action 参数指定目标操作,例如 Action=ExecutePipeline。还需要指定接口的其他参数以及公共请求参数,详情请参见公共参数。字符编码 请求及...

查看及管理API版本

线API、工作流程或函数的对应版本为历史旧版本。操作 您可以对API和工作流程进行查看和回滚操作:单击相应API或工作流程后的 API详情,进入API或工作流程详情页面进行查看。单击相应API或工作流程后的 回滚,在 确定要回滚当前版本 ...

模型管理

API网关通过使用JSON Schema定义模型,用来描述用户API约定数据的组织方式,比如参数或者返回值有哪些字段,这些...注意:API网关不维护模型和API的关联关系,删除模型时可能会引起线API的SDK导出失败等问题。因此,删除模型请谨慎操作。

按线上API关联

说明 全量新建、按应用新建、按线API关联新建时获取到该关联项。应用需在系统设置模块创建,数据API需在统一服务模块创建并上线。服务 对应上线状态的数据API。说明 目前上报API和三方API暂时不支持被解决方案获取。数据API需在统一服务...

新建解决方案

线API关联:根据已上线的API(服务)关联对应资源信息,更多信息,请参见 按线API关联。按线上场景关联:根据线上场景关联资源信息,更多信息,请参见 按线上场景关联。按逻辑表关联:根据逻辑表关联对应资源信息,更多信息,请参见 ...

2021年度更新日志

查看 API 概览 优化 API 整体参数结构 新增主机组相关 API 新增变量组相关 API 新增流水线终止、删除 API 新增流水线任务重试、终止、跳过 API 2021/8/26 新功能 支持通过多种方式设置 Node.js 版本 从预置版本中选择,Flow 默认提供了几个...

DescribePurchasedApis-获取购买的 API 列表

PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开,目前可以取值:PUBLIC:公开,如选择此类型,该 API线上...

DescribeApis-查询定义中的 API 列表

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

ModifyApi-修改API定义

接口说明"此接口面向开放 API 的用户 该接口需要全量更新,不支持部分参数更新 修改 ApiName 时需要注意,同一个分组内 API 不允许重名 修改 RequestPath 时需要注意,同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为:单用户 QPS ...

2023年度更新日志

支持静态语法关键字补齐 支持服务连接、构建集群、主机组动态资源自动获取补齐 2023-08-29 2023年07月 变更类型 描述 发布时间 功能 开放创建流水线、更新流水线OpenAPI(详见)2023-07-11 2023年06月 变更类型 描述 发布时间 功能 流水线...

CreateApi-创建 API

支持汉字,英文,数字,下划线,且只能以英文和汉字开头,4~50 个字符 ApiName Visibility string 是 API 是否公开,可以取值:PUBLIC:公开,如选择此类型,该 API线上环境定义,会在所有用户的控制台“发现 API”页面可见。...

ModifyApiConfiguration-修改API定义

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

DescribeDeployedApi-查询API在指定环境中的定义

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

DescribeApiHistory-查询历史版本详情

接口说明 查询指定 API 的某一次历史发布版本的定义详情,即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等,您可以通过其他的接口获取版本号来指定查询某一次发布的定义...

DescribeApi-查询 API 定义

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

DATASOURCE:ApiGateway:Apis

Apis Properties:ApiId:Ref:ApiId Outputs:Apis:Description:The information about ApiGateway apis.Value:Fn:GetAtt:ExtensionDataSource-Apis ApiIds:Description:The list of The ApiGateway api ids.Value:Fn:GetAtt:...

版本管理

1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤:1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑,单击 ...

创建后端为函数计算的API

API返回内容为前面步骤中创建的函数返回内容,函数代码如下:7 调用API 通过上述步骤,您已经创建API、创建APP、建立了授权关系,调试API完成,并将API发布到线上环境,本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...

RemoveVpcAccess-撤销 VPC 授权

接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行,请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行...

事件总线

概述 您需要依次完成以下步骤:创建后端服务 创建API分组 定义API 创建应用API授权 调试API 调用API 前提条件 您需要先开通事件总线,并创建自己的自定义事件总线,详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台,在...

API 属性说明

应用以及 mPaas 移动应用:表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用,同时也支持 mPaaS 移动客户端(iOS、Android)的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识,用于定位要访问的资源...

对象存储

创建存储空间(Bucket)阿里云对象存储OSS(Object Storage Service)是阿里云提供的海量、安全、低成本、高持久的云存储服务,OSS具有与平台无关的RESTful API接口,您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...

创建后端服务为HTTP的API

1 概述 您需要依次完成以下步骤:创建分组 定义API 创建应用API授权 调试API 调用API 2 创建分组 API分组是API的管理单元,因此需要先创建API分组,然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理,选择Region,点击 ...

使用自定义域名调用API

用户使用API网关对外提供服务时,需要使用自己拥有的域名开放自己的能力,本文主要描述如何将用户自己的域名绑定到API网关上,让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...

跨域资源访问(CORS)

用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API,仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时,需要在Header中加X-Ca-Stage参数来指定调用的环境,而浏览...

结构体说明

page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...

API网关为K8s容器应用集群提供强大的接入能力

很容易地升级应用程序容器的新版本 提供容器弹性,如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的,但是Kubernetes集群没有足够的接入能力,特别在大型应用中,它是不能够...

注册API

参数 描述 API名称 支持中文、英文、数字、下划线(_),且只能以英文或中文开头,4~50个字符。API Path API存放的路径,例如/user。说明 支持英文、数字、下划线(_)和连字符(-),且只能以(/)开头,不得超过200个字符。协议 支持 ...

简介

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

OD飞线

例如OD飞线配置了API数据源为 https://api.test,传到 请求数据接口 动作的数据为 { id:'1'},则最终请求接口为 https://api.test?id=1导入数据接口 按组件绘制格式处理数据后,导入组件,重新绘制。不需要重新请求服务端数据。具体数据...

OD飞线

例如OD飞线配置了API数据源为 http://api.test,传到 请求数据接口 动作的数据为 { id:'1'},则最终请求接口为 http://api.test?id=1导入数据接口 按组件绘制格式处理数据后,导入组件,重新绘制。不需要重新请求服务端数据。具体数据...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 对象存储 视觉智能开放平台 风险识别 短信服务 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用