简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
伪类型
伪类型 名字 描述 any 表示一个函数可以接受任意输入数据类型 anyelement 表示一个函数可以接受任意数据类型 anyarray 表示一个函数可以接受任意数组数据类型 anynonarray 表示一个函数可以接受任意非数组数据类型 anyenum 表示一个函数...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
DescribePurchasedApis-获取购买的 API 列表
CE5722A6-AE78-4741-A9B0-6C817D360510 PageSize integer 每页条目 10 TotalCount integer 返回结果的总条数 20 PurchasedApis object[]由 purchasedapi 组成的数组格式，返回 api 调用延迟监控信息 Visibility string 可见性，可选值：...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
HTTP API SQL接口开发手册
对于Java语言的应用开发，建议基于Java JDBC Driver构建时序引擎的应用程序，具体请参见 Java JDBC Driver开发手册。说明 单机版不支持此功能。请求路径与方法 请求路径 请求方法 描述/api/v2/sql POST 发送并执行SQL语句。请求内容 请求...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
CreateRule-创建授权规则
[{"HostGroupId":"1","HostAccountNames":["root"]}]Hosts 数组 Host 结构 字段 类型 描述 HostId string 主机 ID HostAccountIds array[string]主机账号 ID 数组 HostGroups 数组 HostGroup 结构 字段 类型 描述 HostGroupId string 主机...
发送 HTTP 请求（C#）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
DescribeApisByIpControl-查询IP访问控制绑定的API
20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId string API 编号 3b81fd160f5645e097cc...
DescribeApiIpControls-查询API的IP访问控制绑定情况
10 TotalCount integer 返回结果的总条数 1 ApiIpControls object[]由 ApiIpControlItem 组成的数组格式，返回 IP 访问控制的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146f186e38e8e70fc8...
DescribeApisByTrafficControl-查询指定流控策略下已...
20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId string API 编号 3b81fd160f5645e097cc...
ScaleWithAdjustment-基于指定调整规则触发性扩缩容
false：异步流程，即修改伸缩组内的期望实例数时，不会立刻触发伸缩组的实际扩缩容活动，需等待期望实例数变化后，系统自动检测期望实例数与伸缩组内当前实例数不一致，才会触发扩缩容活动。说明 关于期望实例数的更多信息，请参见 期望...
RemoveInstances
如果当前伸缩组的实例数（TotalCapacity）减去该接口指定的实例数小于伸缩组内最小实例数（MinSize），则调用失败。调用该接口返回成功，只是表示弹性伸缩服务接受了该接口调用的请求，伸缩活动可以执行，但不代表伸缩活动能够执行成功。您...
RemoveInstances-从一个伸缩组删除一台或多台实例
如果当前伸缩组的实例数（TotalCapacity）减去该接口指定的实例数小于伸缩组内最小实例数（MinSize），则调用失败。调用该接口返回成功，只是表示弹性伸缩服务接受了该接口调用的请求，伸缩活动可以执行，但不代表伸缩活动能够执行成功。您...
DescribeHistoryApis-查询API发布版本定义列表
6C87A26A-6A18-4B8E-8099-705278381A2C PageSize integer 指定分页查询时每页行数，最大值 50，默认值为 10 10 TotalCount integer 返回结果的总条数 20 ApiHisItems object[]由 ApiHisItem 组成的数组格式，返回 API 的信息 Status string...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
DescribeDeployedApis-查询已发布 API 列表
ID CEF72CEB-54B6-4AE8-B225-F876FF7BZ002 PageSize integer 返回指定的每页条数 10 TotalCount integer 返回结果的总条数 2 DeployedApis object[]由 DeployedApiItem 组成的数组格式，返回 API 的信息 Visibility string 可见性，可选值...
DescribeApiSignatures-查询API签名密钥绑定情况
10 TotalCount integer 返回结果的总条数 20 ApiSignatures object[]由 ApiSignatureItem 组成的数组格式，返回签名密钥的信息项 BoundTime string 后端签名密钥绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146f186e...
DescribeApiTrafficControls-查询API流控策略绑定概况
10 TotalCount integer 返回结果的总条数 20 ApiTrafficControls object[]由 ApiTrafficControlItem 组成的数组格式，返回流控策略的信息项 BoundTime string 流控策略绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146...
DescribeApisBySignature-查询签名密钥绑定的API列表
10 TotalCount integer 返回结果的总条数 20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId...
StopServerlessJobs-批量停止Serverless作业
按照作业ID或子任务ID（数组作业）停止集群中一个或多个Serverless作业。当传入数组作业的作业ID时，会停止该作业下的所有子任务。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
ScaleWithAdjustment
区别于ExecuteScalingRule接口，您无需提前创建伸缩规则，直接调用API ScaleWithAdjustment接口快速基于指定调整规则触发弹性扩缩容。接口说明 调用该接口前，请确保满足以下条件：伸缩组处于Active状态。伸缩组内没有执行中的伸缩活动。当...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
读API
本文介绍读API算子的使用方式和注意事项。用途 读API算子可以访问用户指定的接口并解析返回值，产生一张临时表，供后续节点进一步加工处理。适用场景 计算链路 计算引擎 是否支持 离线 ALL 是 实时 Blink 否 在线 内置 否 使用说明 前置...
数组函数
Hologres从 V1.1.46版本开始支持text类型数组，且text数组将会被转为int8数组进行排序，返回排序后的text数组。Hologres从 V1.3.18版本开始支持int4、int8、float4、float8、boolean类型数组，且对text类型数组按字典序排序。array_sort...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
TrafficControl
UserDefault Integer 每个用户默认的流控值 AppDefault Integer 每个APP默认的流控值 SpecialPolicies SpecialPolicy 由 SpecialPolicy 组成的数组格式，返回特殊流控策略信息 CreatedTime String 创建时间（格林威治时间）ModifiedTime ...
GroupInvokeFlow-批量运行工作流
ClientToken 只支持 ASCII 字符，且不能超过 64 个字符 abcdefghijklmn TotalCount integer 是 该组执行包含的执行数，需要和 Data.Items 数组中的个数一致 1 Tags string 否 为该分组下的每次执行打标签，格式为 JSON 数组，数组内为对应...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
函数功能发布记录
HQE MAX_BY与MIN_BY 1.3.19 数组函数 array_max array_min array_contains array_except array_distinct array_union 新增函数 新增部分数组函数 HQE 数组函数 1.3.18 数组函数 array_sort 功能优化 array_sort函数支持更多类型数组。...
DetachInstances
调用DetachInstances从一个伸缩组移出一台或多台ECS实例、ECI实例或托管实例。接口说明 调用该接口前，请确保满足以下条件：目标伸缩组必须处于启用（Enable）状态。目标伸缩组没有正在进行的伸缩活动。说明 目标伸缩组没有正在进行的伸缩...
ExecuteScalingRule
接口说明 调用该接口需注意以下几点：调用该接口前，请确保满足以下条件：伸缩组处于 Active 状态。伸缩组没有执行中的伸缩活动。当伸缩组没有执行中的伸缩活动时，该接口可以绕过冷却时间（Cooldown）直接执行伸缩活动。如果伸缩规则需要...
CreateCluster-创建集群
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RegionId string 是 区域 ...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
SubmitServerlessJob-提交Serverless作业
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
SpecialPolicy
SpecialPolicies 描述"class="reference-link">描述 特殊流控策略信息项的类型 节点名"class="reference-link">节点名 SpecialPolicy 子节点...应用 USER：用户 Specials Special 由 Special 组成的数组格式，返回特殊流控策略数据项信息
CreateBgpGroup-为指定的VBR创建一个BGP组
为指定的边界路由器（VBR）创建一个BGP组。接口说明 您可以通过边界网关协议 BGP（Border Gateway Protocol）实现 VBR 与本地 IDC 的互通。每个 BGP 组关联一个 VBR，您仅需将与 VBR 通信的 BGP 邻居添加到对应的 BGP 组中，然后在 VBR 中...
CreateBgpGroup-为指定的VBR创建一个BGP组
为指定的边界路由器（VBR）创建一个BGP组。接口说明 您可以通过边界网关协议 BGP（Border Gateway Protocol）实现 VBR 与本地 IDC 的互通。每个 BGP 组关联一个 VBR，您仅需将与 VBR 通信的 BGP 邻居添加到对应的 BGP 组中，然后在 VBR 中...
- 产品推荐
- 这些文档可能帮助您