创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入控制台页面，在左侧导航栏中选择 API 发布>数据...
调用API
本文档主要介绍调用物联网平台云端API的请求结构和请求示例。请求结构 您可以通过发送HTTP或HTTPS请求调用物联网平台API。请求结构如下：http://Endpoint/?Action=xx&Parameters 参数 说明 Endpoint 调用云服务的接入地址。物联网平台的接...
概述
URL 中包含公共参数、您的签名机制和某个API的具体参数。每篇 API 文档均给出了 URL 请求示例供您参考，但是为了方便显示，我们并没有编码这些URL示例，您需要在发起请求前自行编码。我们根据您的签名验证了请求后，会返回结果给您。接口...
调用API
本文档主要介绍调用物联网无线连接服务云端API的请求结构和请求示例。请求结构 您可以通过发送HTTP或HTTPS请求调用物联网无线连接服务的API。请求结构如下：http://Endpoint/?Action=xx&Parameters 参数 说明 Endpoint 调用云服务的接入...
ModifyInstanceAttribute
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 RequestId String 54CFE6B5-A18A-43...
概述
URL 中包含公共参数、您的签名和某个 API 的具体参数。每篇 API 文档均给出了 URL 请求示例供您参考，但是为了方便显示，我们并没有编码这些 URL 示例，您需要在发起请求前自行编码。我们根据您的签名验证了请求后，会返回结果给您。接口...
DisableInstancePublicAccess
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 InstanceId String dbaudit-...
注册API
参数 描述 请求参数 您可以单击 新增参数，根据页面配置API的请求参数。其中 参数位置 支持 QUERY、HEAD 和 BODY。不同的请求方式支持不同的参数位置，请根据页面提供的可选项按需选择。常量参数 参数值为固定的参数，对调用者不可见。调用...
API概览
URL中包含公共参数、您的签名和某个API的具体参数。每篇API文档均给出了URL请求示例供您参考，但是为了方便显示，我们并没有编码这些URL示例，您需要在发起请求前自行编码。我们根据您的签名验证了请求后，会返回结果给您。接口调用成功会...
请求结构
本文介绍了通过HTTP或HTTPS POST请求调用内容检测API的请求结构。请求方法 内容安全支持基于URL发起HTTP或HTTPS POST请求。请求参数是JSON格式的结构体，以http body的方式发送到服务器端。其中，公共查询参数 clientInfo 位于url query...
EnableInstancePublicAccess
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 InstanceId String dbaudit-...
返回结果
请求成功 请求成功会返回对应的成功状态码，有数据的会返回请求数据。不同的 API 请求返回的数据内容和格式不同，请查阅 写入数据 和 读取数据。请求失败 如果错误发生，API 将为各个错误返回一个对应格式化的 JSON 对象。该对象包含的字段...
计费概述
请求费用 请求费用按照调用API的请求次数计费。说明 请求计费的API列表参见 计费项 中计费项 StandardQueryL0、StandardQueryL1 和 StandardQueryL2 所涉及的API。因参数错误、权限错误等产生的请求响应状态码为4XX的请求，需要按照请求...
通过向导模式生成API
当您需要对API的请求参数进行预处理或对查询结果进行二次加工时，您可以在API编辑页面的右侧导航栏中，单击 过滤器，根据需要勾选 使用前置过滤器 或 使用后置过滤器，并选择 函数类型 后，单击前置过滤器或后置过滤器右侧的下拉框选择目标...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
数据服务入门
API Path API的存放路径，即相对于服务Host，API的请求路径。该配置用于拼接API的调用地址。本文示例路径配置为/user。协议 支持HTTP及HTTPS。如果您需要通过HTTPS协议调用API，请在发布API至网关后，在API网关控制台绑定独立域名并上传SSL...
管控事件结构定义
apiVersion 当 eventType 取值为 ApiCall 时，事件代表一个API的调用。此时，该字段为API的版本信息。eventCategory 事件分类。取值：Management（管控事件）。eventId 事件ID。eventName 事件名称。具体含义如下：如果 eventType 取值为 ...
管控事件结构定义
apiVersion 当 eventType 取值为 ApiCall 时，事件代表一个API的调用。此时，该字段为API的版本信息。eventCategory 事件分类。取值：Management（管控事件）。eventId 事件ID。eventName 事件名称。具体含义如下：如果 eventType 取值为 ...
StartInstance
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 InstanceId String dbaudit-...
调用MNS的API请求时报错“403 SignatureDoesNotMatch...
问题描述 调用MNS的API请求时报错“403 SignatureDoesNotMatch”。问题原因 通过MNS HTTP API发送请求时，需要在Authorization Header中加入签名值，当签名值和服务器端计算的不一致时，请求会被拒绝，服务器返回“403 ...
ConfigInstanceWhiteList
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 InstanceId String dbaudit-...
MoveResourceGroup
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 RequestId String EA54CD13-9D3B-...
配置API输入组件
配置API输入组件后，可以读取API数据源中的数据至Dataphin，进行数据集成与数据开发。本文为您介绍如何配置API输入组件。前提条件 在开始执行操作前，请确认您已完成以下操作：已创建API数据源。具体操作，请参见 创建API数据源。进行API...
配置API输入组件
配置API输入组件后，可以读取API数据源中的数据至Dataphin，进行数据集成与数据开发。本文为您介绍如何配置API输入组件。前提条件 在开始执行操作前，请确认您已完成以下操作：已创建API数据源。具体操作，请参见 创建API数据源。进行API...
ClearInstanceStorage
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 InstanceId String dbaudit-...
ModifyInstanceStorage
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 InstanceId String dbaudit-...
UntagResources
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 RequestId String 8EC13467-A84C-401...
使用前后端链路追踪诊断API错误原因
在前端监控中，即便已知API的请求耗时，也无从知晓准确的网络传输性能、后端服务的调用链路及性能，因而无法快速准确地排查应用API问题。前后端链路追踪功能可以解决此类问题，它会将API请求从前端发出到后端调用的链路串联起来，真实还原...
RejectVpcPeerConnection-拒绝VPC对等连接
调用RejectVpcPeerConnection接口拒绝VPC对等连接实例的请求。接口说明 对于跨账号的 VPC 对等连接实例，接收端可以拒绝连接请求。拒绝连接请求的 VPC 对等连接实例变为 已拒绝状态。RejectVpcPeerConnection 不支持对同一个对等连接实例...
API安全
API安全模块支持自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务中开放的API资产，检测API风险（例如敏感数据泄露、内部接口暴露等），并通过报表还原API异常事件，提供详细的风险处理建议和API生命周期管理...
分析错慢调用链
对压测中错误请求或延迟过高的请求，可以通过分析错误请求与慢请求调用链来洞察问题根因。前提条件 创建压测场景，具体操作，请参见 创建压测场景。开通ARMS应用监控服务，并且已挂载ARMS探针或已接入可观测链路追踪 Opentelemetry 版。...
附录：API调用示例
JAVA SDK调用方式 JAVA SDK简介 Dataphin服务Java SDK是根据您自定义的所有API接口，自动生成的Java调用代码，让您无需复杂编程即可访问Dataphin服务。这里向您介绍如何使用Dataphin服务SDK。代码文件的层级结构如下：Java SDK文件夹 sdk/...
公共参数
本文档列举了物联网络管理平台 API 的公共请求参数和公共返回参数。公共请求参数是调用每个 API 时都需要使用的请求参数。名称 类型 是否必需 描述 Format String 是 返回值的类型，支持 JSON 和 XML 类型。Version String 是 API版本号，...
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
签名机制
为保证API的安全调用，在调用API时阿里云会对每个API请求通过签名（Signature）进行身份验证。无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名信息。概述 RPC API要按如下格式在API请求的Query中增加签名（Signature）：...
基于Swagger完成API网关与用户CICD流程整合
该方法的核心是以swagger为桥接，通过API网关的ImportSwagger接口来完成您的API的自动创建和更新。一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关...
参数与条件表达式的使用
本文讲述API网关的参数以及条件表达式的使用。1.概述 在插件中，支持用户从当前的 请求、应答 或 系统上下文 中获取参数，并使用自定义的 条件表达式 对参数进行判断，本文描述 参数 的定义方法与 条件表达式 的书写方法。2.参数的定义 2.1...
签名机制
为保证API的安全调用，在调用API时阿里云会对每个API请求通过签名（Signature）进行身份验证。使用HTTPS协议提交请求，需要在请求中包含签名信息。概述 RPC API要按以下格式在API请求的Query中增加签名（Signature）。...
TagResources
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 RequestId String 23DD5EDB-EAC7-44A...
ListTagResources
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文示例中的请求示例。返回数据 名称 类型 示例值 描述 NextToken String 52EcpzBpR86EEpcc....
- 产品推荐
- 这些文档可能帮助您