API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
配置参数映射模板
API 网关支持通过配置参数映射模板的方式对请求和响应数据进行自动化修改。本文将详细介绍参数映射模板的配置语法及注意事项等。模板示例 说明 后端 SOFAREST 协议已支持绑定参数映射。请求模板#请求 body {"x":{"name":"jack"},"y":{"z":...
API概览
查询IP地址 API 描述 DescribeIpReport 获取IP地址相关的地理位置信息、域名解析、威胁类型、攻击或安全事件信息。DescribeDomainReport 调用DescribeDomainReport获取域名Whois信息、数字证书、威胁类型、相关攻击团伙或安全事件信息。...
数据服务API
数据接口API的上游血缘支持的数据源类型包括：Hologres、MySQL、PostgreSQL、SQL Server、Oracle、AnalyticDB for MySQL 3.0、AnalyticDB for PostgreSQL。说明 生成API 是通过数据源或表封装的API，因此血缘链路将包括：数据表、API、APP...
通过向导模式生成API
数据服务支持通过向导模式或脚本模式生成API，相对于脚本模式，您无需编码能力，可以可视化地配置API。本文为您介绍如何通过向导模式生成API。前提条件 配置API前，请先在 工作空间管理>数据源管理 页面配置数据源。详情请参见 配置数据源...
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
API 授权
根据您的业务需求，开启 API 授权、配置授权规则，定义授权方接口，并将授权规则应用到 API。功能介绍 API 授权功能允许业务在 MGS 上定义通用的 API 访问授权规则：创建授权 API A 并在网关管理中配置，然后到业务 API B 配置中做关联。...
API安全
API安全模块基于内置检测机制和自定义检测策略，自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务的API资产，检测API风险（例如未授权访问、敏感数据过度暴露、内部接口泄露等），通过报表还原API异常事件，...
步骤一：资源准备
创建Mock接口 实验中会对两个接口进行编排，为了方便使用，您可以使用 API网关 进行接口Mock。关于API网关的快速使用入门可参考 创建后端服务为HTTP的API，本实验仅需使用API网关的少量功能，操作步骤如下：开通API网关。在进行Mock配置...
VerifySentence-保存单个句子的校验结果
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 JsonStr string 是 完整 ...
API概览
本文罗列了 日志服务 API。项目（Project）API名称 API说明 CreateProject 创建一个Project。DeleteProject 删除目标Project。UpdateProject 更新某个指定Project的描述信息。GetProject 获取某个指定Project的详细信息。ListProject 列出...
API网关触发器概述
函数计算支持API网关作为事件源，当有请求到达后端服务设置为函数计算的API网关时，API网关会触发函数的执行。函数计算会将执行结果返回给API网关。...API网关再将函数计算返回的内容映射到statusCode、headers、body等位置返回给客户端。
设置性能基线
单个API指标 指标 描述 平均TPS值 TPS系统每秒处理事务数（Transaction Per Second），平均TPS表示压测周期内，该API的TPS的平均值。平均RT（ms）RT业务响应时间（Response Time），平均RT是该API的RT平均值，单位为ms。最大RT（ms）RT业务...
DeleteRule-删除质检规则
目前该API接口已标记为弃用，推荐使用替代API：Qualitycheck(2019-01-15)-DeleteRuleV4。对应前端功能位置：质检规则配置-删除。专有云URL：ip:port/api/client/DeleteRule.json。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您...
ListApiTemplates-查看API模板列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RegionId string 是 地域 ...
ListDataServiceApis
调用ListDataServiceApis获取数据服务API...Action=ListDataServiceApis&PageNumber=1&PageSize=10&ProjectId=10000&TenantId=10001&ApiNameKeyword=我的API名称&ApiPathKeyword=test/CreatorId=12345&公共请求参数 正常返回示例 XML 格式 ...
DeleteQualityCheckScheme-删除质检方案
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 否 入参 ...
API概览
本产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来。项目管理 API 描述 分页查询项目列表 调用ListProject获取所有项目列表。查询项目信息 调用DetailProject获取指定项目信息。新增项目 调用AddProject创建新项目。...
DeleteSchemeTaskConfig-删除质检任务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 否 入参 ...
UpdateSchemeTaskConfig-更新质检任务
接口说明 更新质检任务信息 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值...
DeleteRuleV4-删除规则（新版质检）
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RuleId long 是 规则 ID。1...
AddRuleV4-新增规则（新版质检）
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 JsonStrForRule string 是 ...
CreateQualityCheckScheme-新建质检方案
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 是 入参 ...
UpdateRuleV4-更新规则（新版质检）
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RuleId long 否 规则 ID。1...
ListDataServicePublishedApis
调用ListDataServicePublishedApis...Action=ListDataServicePublishedApis&PageNumber=1&PageSize=10&ProjectId=10000&TenantId=10001&ApiNameKeyword=我的API名称&ApiPathKeyword=test/CreatorId=12345&公共请求参数 正常返回示例 XML 格式 ...
UpdateCheckTypeToScheme-更新质检维度
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 否 入参 ...
CreateCheckTypeToScheme-新增质检维度
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 否 入参 ...
UpdateRuleById-新建或更新质检规则
目前该API接口已标记为弃用，推荐使用替代API：Qualitycheck(2019-01-15)-UpdateRuleV4。对应前端功能位置：质检规则配置-新建&更新。专有云URL：ip:port/api/client/UpdateRuleById.json。调试 您可以在OpenAPI Explorer中直接运行该接口...
GetDataServiceApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetDataServiceApi 系统规定参数。取值：...
媒体回流支持的媒体类型
广告监测 支持 支持 IMEI、IDFA、ANDROIDID、OAID、IP、操作系统、时间戳、广告组ID、广告组名称、广告计划ID、广告计划名称、创意ID、广告投放位置 是 程序化投放 开屏、信息流 使用趣媒体做投放，可支持直接回流；如果使用其他平台，数据...
功能特性
人脸相似度对比介绍 人脸相似度对比 API 二维码识别 可以识别图片（包括照片、截图等多种图片）中多个有效二维码或者条形码的位置及内容，输出图像中二维码或者条形码的位置框和其包含的文本信息。二维码识别介绍 二维码识别 API 图片编辑...
AssignReviewerBySessionGroup-会话组分配
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 否 详细...
API多版本的区别
版本差异 对比项 2016-08-15版API 2021-04-06版API Path中的 version 参数取值 Path格式为/{version}/services/xxxx 2016-08-15 2021-04-06 qualifier 位置 位于Path，例如：/version/serviceName.qualifier/xxx。位于Query，例如：/...
BatchSubmitReviewInfo-批量复核
对应前端功能位置：任务管理-任务结果-批量复核 对应私有云URL：ip:port/api/qcsBatchSubmitReviewInfo.json 对筛选范围内的所有数据进行批量复核操作。注意！此操作涉及大量更新操作，可能生效有一定延迟。调试 您可以在OpenAPI Explorer...
GetDataServicePublishedApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetDataServicePublishedApi 系统规定参数。...
RevertAssignedSession-批量回收（单通会话维度）
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 jsonStr string 否 入参 ...
RevertAssignedSessionGroup-批量回收（会话组维度）
对应前端功能位置：质检方案管理-任务结果-会话组-批量回收。专有云URL：ip:port/api/job/RevertAssignedSessionGroup.json。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
ListProduct-商品列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 CatalogId string 是 ...
授权信息
无 apigateway:ModifyApi ModifyApi Write 全部资源*无 无 apigateway:ModifyApiConfiguration ModifyApiConfiguration Write 全部资源*无 无 apigateway:ModifyApiGroup ModifyApiGroup Write 全部资源*无 无 apigateway:ModifyApi...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
- 产品推荐
- 这些文档可能帮助您