API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
通过服务编排的方式创建API
基于已开发好的API，将多个API通过服务编排的方式创建API。本文为您介绍如何通过服务编排的方式创建API。步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 新建API 创建...
API安全
API安全模块基于内置检测机制和自定义检测策略，自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务的API资产，检测API风险（例如未授权访问、敏感数据过度暴露、内部接口泄露等），通过报表还原API异常事件，...
SubmitQuery-提交查询
请求语法 POST/webapi/query/submitQueryRequestBody 请求参数 名称 类型 必填 描述 示例值 body object 否 HTTP 请求体 sql string 否 SQL 语句。show databases workspaceId string 否 工作空间 id WS-A129E61C4892D2B4 返回参数 名称 ...
API概览
本手册将详细介绍WebAPI的功能、使用方法及详细参数的设定。API说明文档：包括应用相关API，上传数据API，数据搜索API。API访问上分为URL请求串及请求Header参数两部分，所有请求均必须包含该两部分才能执行。术语表 术语 全称 中文 说明 ...
API概览
本手册将详细介绍WebAPI的功能、使用方法及详细参数的设定。API说明文档：包括应用相关API，上传数据API，数据搜索API。API访问上分为URL请求串及请求Header参数两部分，所有请求均必须包含该两部分才能执行。术语表 术语 全称 中文 说明 ...
RunMigrationWorkflow-执行迁移工作流
POST/webapi/migration/workflow/run 请求参数 名称 类型 必填 描述 示例值 InstanceId string 是 迁移实例 ID M-EDD8BF959BB97345 返回参数 名称 类型 描述 示例值 object Data string 返回数据，值为工作流实例 ID FI-7193B85809CAD95C ...
调用方式
阿里云Elasticsearch API接口的调用是向Elasticsearch的服务端地址发送HTTP请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。服务地址 阿里云Elasticsearch的API接入...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
DescribeApisByApp-根据应用查询API列表
API 的 ID b19240592b1b4e74961fb8438ed7550c ApiName string 否 API 名称 getPersonInfo Path string 否 API 请求路径/tt Method string 否 API 的请求 HTTP Method POST Description string 否 API 描述信息 test 返回参数 名称 类型 ...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DescribeDDosEventMax-查询攻击峰值
6809 示例 正常返回示例 JSON 格式 {"Qps":26314,"RequestId":"5AE2FC86-C840-41AE-9F1A-3A2747C7C1DF","Cps":1302,"Mbps":6809 } JSON 格式 {"Qps":26314,"RequestId":"5AE2FC86-C840-41AE-9F1A-3A2747C7C1DF","Cps":1302,"Mbps":6809 } ...
DeleteUser-删除用户
删除用户。调试 您可以在OpenAPI Explorer中...user_id string 是 用户 id c9b7a5aa04d14ae3867fdc886fa01da4 返回参数 名称 类型 描述 示例值 当前API暂无返回参数 示例 正常返回示例 JSON 格式 {} 错误码 访问 错误中心 查看更多错误码。
调用方式
Web应用防火墙接口调用是向WAF API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集编码。请求结构 Web应用防火墙的API是RPC风格，您可以通过发送...
UninstallKibanaPlugin
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/instances/...
JWT认证插件
Json Web Token(RFC7519),是一种便捷的可用于网关进行请求认证的鉴权方案，API 网关 可以通过托管用户的 Public JWK 实现对请求进行JWT认证，并将 claims 作为后端参数转发给后端，以方便用户简化开发后端应用的开发。本文主要是JWT认证...
SetDomainRuleGroup
您必须先在 Web应用防火墙控制台 的 系统管理>防护规则组页面，新建规则组并获得对应规则组ID后，才可以调用本接口，为域名应用自定义规则组。QPS限制 本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，...
调用RPC API和RESTful API
您可以通过以下特点判断API类型：API参数中包含 Action 字段的是RPC API，需要 PathPattern 参数的是RESTful API。一般情况下，每个产品内所有API的调用风格是统一的。每个API仅支持特定的一种风格，传入错误的标识，可能会调用到其他API，...
ModifyProtectionModuleStatus
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文 示例中的请求示例。返回数据 名称 类型 示例值 描述 RequestId String D7861F61-5B61-46...
通过向导模式创建API（服务单元）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（服务或单元），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 ...
DescribeProtectionModuleStatus
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文 示例中的请求示例。返回数据 名称 类型 示例值 描述 ModuleStatus Integer 1 防护功能...
CreateApiDestination-创建API端点信息
创建API端点信息。接口说明 用于创建 API 端点信息。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 ...
发起查询交易
API POST：/api/v1/networks/{network}/transactions/query Url Path 参数 描述 network 通道名称 请求参数 URL Query URL Query 参数 类型 是否必选 描述 timeout Integer 否 等待查询返回的超时时间，单位秒，默认值 180 Body Content-...
Web场景防护
对于使用了主流Web框架（Servlet容器、Spring Web、Spring Boot）的应用，AHAS实现了API粒度的请求参数解析，通过配置Web流控规则，可以对请求中IP、Host、Header、URL Param等参数维度的资源调用进行流量控制，保护业务与系统的稳定性。...
数据服务入门
DataWorks数据服务的主要目标是为个人、团队和企业构建统一的数据服务总线，帮助用户统一管理面向内外部的API服务。例如，您可以将查询数据表功能快速的生成对应的API，或将已有的API注册至数据服务平台进行统一发布和管理。本文以MySQL...
通过向导模式创建API（Dataphin表）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（逻辑表），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 面板，...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
使用Web Tracking采集日志
日志服务Web Tracking功能用于在Web应用程序中跟踪用户行为并将行为数据上传到日志服务中，便于您分析用户行为等。您可以通过Web Tracking采集各种浏览器、iOS App或Android App的用户信息，例如：用户使用的浏览器、操作系统、分辨率等...
DescribeDomainBasicConfigs
调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见 公共参数。调用API的请求格式，请参见本文 示例中的请求示例。返回数据 名称 类型 示例值 描述 TotalCount Integer 1 查询到的域名...
GetUAIDApplyTokenSign-获取UAID授权Token的签名值
获取授权 Token 的其他必要参数，请参考对应运营商文档自行生成 获取授权 Token 的请求，请参考对应运营商文档，注意需要从用户移动终端的蜂窝移动网络环境下请求 获取授权 Token 请求后，请参考 UAIDVerification API 接口进行最终的 UAID...
WAF接入配置最佳实践
将网站域名接入 Web应用防火墙（Web Application Firewall，简称WAF），能够帮助您的网站防御OWASP TOP10常见Web攻击和恶意CC攻击流量，避免网站遭到入侵导致数据泄露，全面保障您网站的安全性和可用性。您可以参考本文中的接入配置和防护...
自定义API
使用自定义API节点，可调用您在外部平台开发的API作为当前服务的中间逻辑功能。前提条件 已完成业务服务的创建。详细内容请参见 创建业务服务。节点配置 在业务逻辑编辑页面的 节点 中，选择对应功能节点配置业务流，该节点配置如下。配置...
API错误码（ODPS-04CCCCX）
错误码 模块 严重等级 触发条件 处理方法 ODPS-0410001:Missing authentication parameters Web-Authentication 1 认证参数缺失，API返回400错误。补全认证参数。ODPS-0410011:Invalid authentication parameters Web-Authentication 1 ...
DescribeDeployedApis-查询已发布 API 列表
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
DescribeApiHistory-查询历史版本详情
6C87A26A-6A18-4B8E-8099-705278381A2C Description string api 描述 根据地区名称查询天气情况 GroupName string api 分组名称 dev_api GroupId string api 分组编号 cfb6ef799bf54fffabb0f02019ad2581 DeployedTime string 发布时间...
StartCollector
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/collectors/...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
StopCollector
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/collectors/...
- 产品推荐
- 这些文档可能帮助您