简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
修改集群组件配置
使用该API可修改普通集群组件的配置以及ACK Pro集群的管控面参数配置：普通组件可配置参数列表可通过 DescribeClusterAddonMetadata API查询，详情参见 查询集群组件版本元数据。ACK Pro集群管控面组件可配置的参数列表，请参见 自定义ACK ...
修改集群组件配置
使用该API可修改普通集群组件的配置以及ACK Pro集群的管控面参数配置：普通组件可配置参数列表可通过 DescribeClusterAddonMetadata API查询，详情参见 查询集群组件版本元数据。ACK Pro集群管控面组件可配置的参数列表，请参见 自定义ACK ...
修改集群组件配置
使用该API可修改普通集群组件的配置以及ACK Pro集群的管控面参数配置：普通组件可配置参数列表可通过 DescribeClusterAddonMetadata API查询，详情参见 查询集群组件版本元数据。ACK Pro集群管控面组件可配置的参数列表，请参见 自定义ACK ...
通过向导模式创建API（服务单元）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（服务或单元），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 ...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
通过向导模式创建API（Dataphin表）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（逻辑表），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 面板，...
API流量控制支持的参数
本文为您介绍API流量控制支持的参数。API流量控制参数 API创建过程中，需要设置流量控制参数，对API调用的频率、响应超时时间、缓存失效时间等进行控制。单位时间API最大调用次数，即API调用最大QPS，手动填写，最大不超过10000。超时配置...
通过直连数据源模式创建API
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定输入参数和输出参数的来源表，再编写API SQL并解析出请求参数和返回参数，最后配置请求参数和返回参数的基本信息。参照以下图表，确定输入参数和输出参数的...
使用向导模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，可减少资源操作成本。向导模式适用于单表的简单查询，零代码通过界面化的设置完成API的封装。本文介绍如何使用向导模式创建数据API。前提条件 已...
使用向导模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，可减少资源操作成本。向导模式适用于单表的简单查询，零代码通过界面化的设置完成API的封装。本文介绍如何使用向导模式创建数据API。前提条件 已...
API授权时支持的调用参数配置
API对外授权过程中，API的开发者可以通过设置授权参数，使调用者获得授权后调用API时，某几个参数在传入授权参数以外的值时不会生效，从而防止调用者通过更改这个参数的值查询到无权限的数据，提高调用的安全性。本文为您介绍API授权时支持...
DescribeDeployedApis-查询已发布 API 列表
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
使用SQL模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，减少资源操作成本。SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询，通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建...
使用SQL模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，减少资源操作成本。SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询，通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建...
附录：API调用示例
JAVA SDK调用方式 JAVA SDK简介 Dataphin服务Java SDK是根据您自定义的所有API接口，自动生成的Java调用代码，让您无需复杂编程即可访问Dataphin服务。这里向您介绍如何使用Dataphin服务SDK。代码文件的层级结构如下：Java SDK文件夹 sdk/...
InvokeDataAPIService
调用该接口调用数据算法服务API，获取SQL查询结果。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功...
新建数据服务API-向导模式
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，可减少资源操作成本。本文介绍如何通过向导模式新建API。对原始数据层表“ys_xyk_bkxx”封装API 前提条件 工作组管理员账号登录。已创建“信息...
业务监控API集成
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/api/monitor/push/{...
使用简单认证（AppCode）方式调用API
阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述 对于请求的签名认证方式，可以参考...
数据服务入门
当请求方式选择POST时，后续API添加的 请求参数 的 参数位置，支持选择QUERY和BODY。返回类型 仅支持配置为JSON类型。可见范围 定义该API创建后的可见范围，取值包括 工作空间 和 私有。工作空间：该API对本工作空间内的所有成员可见。私有...
概述
通过向 API 的服务端地址发送 HTTPS/HTTP GET/POST 请求，并按照API接口说明，在请求中加入相应请求参数来调用 API 接口。根据请求的处理情况，系统会返回处理结果。我们将从以下方面介绍 API 的调用。调用API 公共参数 为更好的保护您的...
CreateDataAPIService
调用该接口创建数据算法服务API。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
GetServiceProvisions-查询服务开通状态
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
概述
物联网平台提供云端管理产品、设备、分组、Topic、规则、设备影子等API接口，和从云端发布消息的API接口。使用云端SDK，向API的服务端地址发送HTTPS/HTTP GET或POST请求，并按照API接口说明，在请求中加入相应请求参数来调用API。物联网...
概述
物联网平台提供云端管理产品、设备、分组、Topic、规则、设备影子等API接口，和从云端发布消息的API接口。使用云端SDK，向API的服务端地址发送HTTPS/HTTP GET或POST请求，并按照API接口说明，在请求中加入相应请求参数来调用API。物联网...
CreateUmengToken-创建友盟Token
请求语法 POST/v2/openapi/umeng/token 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回参数 名称 类型 描述 示例值 当前API暂无返回参数 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无...
升级集群
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求语法 POST/api/v2/clusters/ClusterId/upgrade ...
升级集群
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求语法 POST/api/v2/clusters/ClusterId/upgrade ...
升级集群
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求语法 POST/api/v2/clusters/ClusterId/upgrade ...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
OpenAPI 门户
使用场景 查看 OpenAPI 文档 OpenAPI 门户 提供完整的 OpenAPI 文档，包含接口说明、流控信息、授权信息、请求参数、返回数据、返回说明、返回示例、错误码、变更历史等。您可通过阅读 OpenAPI 文档判断它是否能够满足您的业务场景。Open...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
StartCollector
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/collectors/...
StopCollector
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/collectors/...
RestartCollector
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/collectors/...
使用后端服务提高管理效率
本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...
- 产品推荐
- 这些文档可能帮助您