版本说明
变更时间：2024-02-26 变更集发布说明：OpenAPI 名称 变更内容概要 操作 QueryAvatar OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。QueryAvatarList OpenAPI 返回结构发生变更...
实例级别访问控制
API网关提供实例级别的访问控制，您可以分别配置针对IPv4和IPv6的访问控制策略组应用于实例，仅专享实例支持配置实例级别访问控制策略，并且仅对公网生效。1.创建访问控制策略组 1.1 在API网关控制台中实例页面，单击 访问控制，即进入访问...
HTTPS 证书报错
2.API提供者的 SSL 证书过期 提供者的 SSL 证书过期。解决方案 联系 API 提供者，要求其更换 SSL 证书。程序中忽略检查 SSL 证书有效性（不推荐），忽略后会有请求被劫持的安全风险。只在与 API 提供商无法提供兼容性更好的主流 SSL 证书，...
应用管理
apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq","apiStatus":"CLOSED","workspaceId":"antdemo"}]},"result_code":"OK"} 通过 APP ID 查询 API 分页列表 sofa.apigateway.app.api.list 用于查询指定 APPID 的应用所订阅的 API 分页列表。...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dytnsapi.aliyuncs.com华北2（北京）cn-beijing dytnsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dytnsapi.aliyuncs.com华北5（呼和浩特）...
插件数据集
4.2.JWT认证插件配置 目前API网关的JWT认证插件已经集成了数据集的能力。JWT认证插件的使用场景有一个典型的需求就是屏蔽已经获得了正式Token，但被拉到黑名单的用户请求。API网关的JWT认证插件为这种场景结合插件数据集的能力上线了根据...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dypnsapi.aliyuncs.com华北2（北京）cn-beijing dypnsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dypnsapi.aliyuncs.com华北5（呼和浩特）...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dyvmsapi.aliyuncs.com华北2（北京）cn-beijing dyvmsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dyvmsapi.aliyuncs.com华北5（呼和浩特）...
API/SDK数据导入
2.API/SDK不支持设置数据源插件，请自行拼接、处理后传入OpenSearch应用中。比如，array类型使用API上传时，注意不要上传为string格式，而是上传为数组类型。例：/定义Map对象存储上传文档数据,此为文档2 Map,Object>doc2=Maps....
API/SDK数据导入
2.API/SDK不支持设置数据源插件，请自行拼接、处理后传入OpenSearch应用中。比如，array类型使用API上传时，注意不要上传为string格式，而是上传为数组类型。例：/定义Map对象存储上传文档数据,此为文档2 Map,Object>doc2=Maps....
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北2（北京）cn-beijing dysmsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dysmsapi.aliyuncs.com华北5（呼和浩特）cn-huhehaote dysmsapi.aliyuncs.com华北6（乌兰察布）...
DataWorks OpenAPI概述
版本 QPS限制 每日调用次数上限 基础版 1级、2级、3级API总QPS≤5 每日API总调用次数≤100次 标准版 每日API总调用次数≤1000次 专业版 每日API总调用次数≤10000次 企业版 1级API QPS≤50 2级API QPS≤20 3级API QPS≤5 1级、2级API 每日...
多级API网关
假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：http://backend1.alicloudapi.com:8080/business1API2 Method:GET Path:/business2 后端地址为：http://backend2.alicloudapi.com:8080/business2 1.1.4.对两个业务...
DescribeApiGroups-查询 API 分组列表
4AA0-BB69-FE2743D9AE62 PageSize integer 返回指定的每页条数 10 TotalCount integer 返回结果的总条数 2 ApiGroupAttributes object[]返回分组集合 BasePath string 基准路径/v2/BillingStatus string 计费状态，取值：NORMAL：正常 ...
DescribeApis-查询定义中的 API 列表
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DescribeApis Read 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 否 指定的分组编号 c4a4d2de657548a2bd485d5d4df42b4a ApiId string 否 指定的 API 编号 f...
AttachPlugin-绑定插件到API上
接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态的 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ALIYUN:ApiGateway:Authorization
ALIYUN:ApiGateway:Authorization类型用于给API授权App的访问权限。语法 {"Type":"ALIYUN:ApiGateway:Authorization","Properties":{"ApiIds":List,"AppIds":List,"GroupId":String,"StageName":String,"Description":String,...
DeleteAccessControlList-删除访问控制策略
acl-uf6fpfdg3b5muska7uqem 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID EF924FE4-2EDD-4CD3-89EC-34E4708574E7 示例 正常返回示例 JSON 格式 {"RequestId":"EF924FE4-2EDD-4CD3-89EC-34E4708574E7"} 错误码 访问 ...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
SetAppsAuthToApiProduct-批量授权多个APP给指定API...
批量授权多个APP给指定的API产品 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
DescribePluginTemplates-获取插件模板列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
按机器人查询订阅的行业包
请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListSubscriptionByRobot 系统规定参数，取值：ListSubscriptionByRobot RobotCode String 是 1cY9drMec4b2uzS2 机器人code 返回数据 名称 类型 示例值 描述 RequestId String ...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
DescribeGroupTraffic-查询分组流量
RELEASE:线上 PRE:预发 TEST:测试 RELEASE GroupId string 是 指定要操作 API 所属分组 ID 16df9d11caa04900bcafe23b38a81600 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID EF924FE4-2EDD-4CD3-89EC-34E4708574E7 ...
升级行业包
将商家订阅的行业包升级...Action=UpgradePackage&RobotCodes=["1cY9drMec4b2uzS2"]&PackageDTO={"PackageCode":"common","PackageVersion":"2"}&Operator={"OperatorId":"10006","OperatorName":"张三"}&公共请求参数 正常返回示例 XML 格式 ...
TagResources-创建标签资源关系（用户标签）
n 的取值范围为[1,50]string 是 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID EF924FE4-2EDD-4CD3-89EC-34E4708574E7 示例 正常返回示例 JSON 格式 {"RequestId":"EF924FE4-2EDD-4CD3-89EC-34E4708574E7"} 错误码 访问...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
停止节目单
7eaa-461d-8f29-4bec2eb9*</ProgramId></StopPlaylistResponse>JSON 格式 {"StopPlaylistResponse":{"RequestId":"5c6a2a0d-f228-4a64-af62-20e91b96*","ProgramId":"445409ec-7eaa-461d-8f29-4bec2eb9*"} } 错误码 访问 错误中心 查看更多...
DescribeDeployedApi-查询API在指定环境中的定义
EF924FE4-2EDD-4CD3-89EC-34E4708574E7 Description string 描述信息 Api description GroupName string API 分组名称 Weather GroupId string 分组编号 bc77f5b49c974437a9912ea3755cd834 DeployedTime string 部署时间，格式为 yyyy-mm-...
DeleteLayer-删除层
pairec-cn-abcdefg1234 返回参数 名称 类型 描述 示例值 object Schema of Response RequestId string Id of the request 8F457D79-C4A2-5E8C-83E4-0D089456E2AC 示例 正常返回示例 JSON 格式 {"RequestId":"8F457D79-C4A2-5E8C-83E4-0D...
DeleteHbaseHaSlb
对照CreateHbaseHaSlb接口，此接口用于删除对应的高可用thrift或高可用phoenix。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必...
ListSnapshotJobs-获取截图任务列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 StartOfCreateTime string ...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本迭代过程中，新版本服务正式发布前通过API网关进行灰度发布，A/B Test的通用方法实践。该方法的核心是通过配置后端路由插件来确保可以控制服务升级对用户造成的影响。一、概述 灰度发布是指在API的新、旧...
GetAttachmentUploadUrl-查询附件上传OSS地址
查询附件上传OSS地址。...JSON 格式 {"Code":0,"Message":"success","RequestId":"ED195C2C-787F-511C-8204-714456781861","Success":true,"Data":{"ObjectKey":"cdb5d174-c282-4b2d-9048-e74ea2223127.jpg","PutSignedUrl":...
ListVideos-获取多个视频的信息
调用ListVideos接口获取媒体集中的视频信息列表，返回结果以视频加入媒体集的时间升序排序。接口说明 此接口已不再维护，建议使用新版（2020-09-30 版本）查询与统计 相关接口。关于新版与旧版 API 的对比，请参见 新旧版本使用指引 中的 ...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
- 产品推荐
- 这些文档可能帮助您