简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
配置重写策略（公测中）
a/FunctionName/func-a/Qualifier/1/svc-a.1/func-a/f.c/helloworld/f.c/helloworld/func 不匹配 正则重写 正则重写模式中，匹配规则和重写规则遵守标准的正则表达式。关于正则表达式的规范，请参见 正则表达式语法。关于正则重写匹配的...
配置重写策略（公测中）
a/FunctionName/func-a/Qualifier/1/svc-a.1/func-a/f.c/helloworld/f.c/helloworld/func 不匹配 正则重写 正则重写模式中，匹配规则和重写规则遵守标准的正则表达式。关于正则表达式的规范，请参见 正则表达式语法。关于正则重写匹配的...
如何获取错误信息
其中 X-Ca开头的均为网关返回，比较重要信息是：/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪 X-Ca-Request-Id:7AD052CB-EE8B-4...
API 管理
},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本迭代过程中，新版本服务正式发布前通过API网关进行灰度发布，A/B Test的通用方法实践。该方法的核心是通过配置后端路由插件来确保可以控制服务升级对用户造成的影响。一、概述 灰度发布是指在API的新、旧...
GetPrice-资源询价
该接口为询价接口，用户可通过此接口查询资源价格。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限...
多级API网关
创建分发API 我们创建一个分发API，这个API设置为匿名访问，Method设置为Get，Path设置为/distributeAPI，这个API所属的分组的访问域名为：17ff4c9189004a1d87b557606b767334-cn-huhehaote.alicloudapi.com 1.2.2.创建、绑定后端路由插件 ...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
Logo识别
图像检测接口响应时间依赖图像的下载时间。请保证被检测图像所在的存储服务稳定可靠，建议您使用阿里云OSS存储或者CDN缓存等。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...
GetDataAPIServiceDetail
调用该接口获取数据算法服务API详情。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
DeleteIndexVersion-删除索引的版本
接口说明 方法 DELETE URI/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName} 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码...
授权应用
本文列出了授权应用相关的 API 及其请求参数、返回参数。创建授权应用 sofa.apigateway.authapp.create 用于创建一个授权应用。请求参数 名称 类型 是否必填 示例 描述 param AuthAppInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户...
CreateCluster-添加集群
接口说明 方法 POST URI/openapi/ha3/instances/{instanceId}/clusters 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的...Api网关支持的模型可以参考如下定义：{"required":["name","photoUrls"],"type":"object","properties":{"id":{"format":"int64","type":"integer"},"category":{"$ref":...
CreateDataAPIService
调用该接口创建数据算法服务API。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
GetResources-查询资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。此 API 包括资源的 Get 和 List 功能，根据不同的请求路径，用户可分别调用资源 List 和 Get 能力。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您...
GetPrometheusInstance-获取指定Prometheus实例信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 RegionId string 是 地域 ...
CreateResource-创建资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
交互式涂抹分割
返回数据 名称 类型 示例值 描述 RequestId String 7574ee8f-38a3-4b1e-9280-11c33ab46e51 请求ID。Data Object 返回的结果数据内容。该数据需要在异步任务执行成功后，通过调用 GetAsyncJobResult 接口，对其Result字段进行JSON反序列化...
ListDataSources-查询资源属性可选值
用户通过此接口查询资源属性可选值（RegionID、ZoneId等）。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求...
DeleteIndex-删除索引
接口说明 方法 DELETE URI/openapi/ha3/instances/{instanceId}/indexes/{indexName}?dataSource=xxx 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 ...
InstallAckOperator
ClientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF*用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。返回数据 名称 类型 示例值 描述 RequestId String EFA88951-7A6F-4A8E-AB8...
CreateSnapshot
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/instances/...
DeleteResource-删除资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
ModifyClusterOfflineConfig-修改集群的配置信息
id E7B7D598-B080-5C8E-AA35-D43EC0D5F886 result object 结果 {} 返回示例 {"requestId":"0A6EB64B-B4C8-CF02-810F-E660812972FF","result":[]} 详情可参考 响应结构 示例 正常返回示例 JSON 格式 {"requestId":"E7B7D598-B080-5C8E-AA35-...
业务监控API集成
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/api/monitor/push/{...
CancelTask
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/instances/...
ModifyIndexPartition-修改索引分区信息
接口说明 方法 PUT URI/openapi/ha3/instances/{instanceId}/index-partition 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
RolloverDataStream
请求示例 POST/openapi/instances/es-cn-nif24adwc0082*/data-streams/ds-001/rollover HTTP/1.1 公共请求头 正常返回示例 JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC*...
UpdateResource-更新资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。如果更新资源在任何时候失败，云控制 API 不会将资源回滚到先前的状态。由于资源 API 目前不支持回滚，当用户遇到 API 部分失败时，需手动调用 GetResources...
StopTask-停止fsm任务
接口说明 方法 PUT URI/openapi/ha3/instances/{ instanceId }/stop-task/{ fsmId } 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是...
下载数据集文件名称列表
Web前端直接调用 小程序场景下直接调用 Android端直接调用 iOS端直接调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 ...
DeleteDataStream
示例 请求示例 DELETE/openapi/instances/es-cn-nif24adwc0082*/data-streams/ds-001 HTTP/1.1 公共请求头 正常返回示例 JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC*",...
DeleteVpcEndpoint
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 DELETE/openapi/instances...
CloseManagedIndex
5718-45B5-9D4D-70B3FF*HTTP/1.1 Host:elasticsearch.aliyuncs.com Content-Type:application/json 正常返回示例 JSON 格式 HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC*",...
火车票识别
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。接入指引 1.注册阿里云账号：打开 阿里云官网，在阿里云官网右上角，单击 立即注册，按照操作提示...
GetCloudClusterAllUrl-获取云产品各种URL
目前该API接口已标记为弃用，推荐使用替代API：ARMS(2019-08-08)-GetRemoteWriteUrl。获取云监控云产品读写地址，pushgateway，grafana 地址。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
CloseHttps
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求头 该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。请求语法 POST/openapi/instances/{...
- 产品推荐
- 这些文档可能帮助您