API概览
EnableInstanceAccessControl 设置实例上的访问控制 本功能为API网关专享实例提供实例级别的访问控制能力；设置实例上的访问控制。DisableInstanceAccessControl 关闭实例上的访问控制 本功能为API网关专享实例提供实例级别的访问控制能力...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
SetAccessControlListAttribute-修改访问控制策略名称
本功能为API网关专享实例提供实例级别的访问控制能力；修改访问控制策略名称。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
混合云API集中管理
说明 本文的架构设计仅为更清晰的说明如何跨VPC之间的API调用，您在类似场景下使用时，只需要为API网关提供一个VPC（本例中为vpc-1）用于与其他环境（如其他Region的VPC、或本地数据中心）进行互通，此VPC除了为API网关提供接入外，并不...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
CreateLogConfig-创建日志配置
为API创建日志服务的配置。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
DeleteAccessControlList-删除访问控制策略
本功能为API网关专享实例提供实例级别的访问控制能力；删除访问控制策略。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的...
概述
了解做为API网关管理员，如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API，安全性很低，适合临时测试的场景，不建议使用。使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全...
智能标签
智能标签，是通过对视频中视觉、文字、语音、行为等信息进行分析，结合多模态信息融合及对齐技术，实现高准确率内容识别，自动输出视频的多维度内容标签，将非结构化信息转化为结构化信息。可应用于视频智能分析、视频审核、视频搜索、视频...
DisableInstanceAccessControl-关闭实例上的访问控制
本功能为API网关专享实例提供实例级别的访问控制能力；关闭实例上的访问控制。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
调用API
调用方式 调用方式 适用场景 说明 安全级别 加密签名身份认证 应用程序开发、数据采集等。该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作，请参见 使用SDK调用API。高 简单身份认证 一般用于可视化场景，如DataV调用。该...
EnableInstanceAccessControl-设置实例上的访问控制
本功能为API网关专享实例提供实例级别的访问控制能力；设置实例上的访问控制。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
CreateAccessControlList-创建访问控制策略
本功能为API网关专享实例提供实例级别的访问控制能力；创建访问控制策略，每个用户每个region下只允许创建5个访问控制策略。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
约束规范
返回结果是将SOAP XML转化为JSON格式。RESTful>HSF 支持开放一个接口某个指定方法。支持 java.util.Map 参数。返回结果固定为JSON格式。WebService>WebService 支持MTOM等附件数据传输方式的调用。支持透传式调用后端接入服务。需要使用CSB...
环境管理
目前API网关支持两种方式，一种是为API分组的不同环境绑定不同的域名，另一种方式是在 Header 中增加入参 X-Ca-Stage 的信息。本文将会分别介绍在API网关两种不同的后端服务类型（VPC、HTTP ）情况下，如何结合两种不同的前端调用方式（X-...
RemoveAccessControlListEntry-删除IP条目
本功能为API网关专享实例提供实例级别的访问控制能力；在实例的访问控制策略中删除IP条目。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
AddAccessControlListEntry-添加IP条目
本功能为API网关专享实例提供实例级别的访问控制能力；在实例的访问控制策略中添加IP条目。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
D504CO错误码排查
API网关最大出访连接池大小可以按照这个原则来估算连接池是否够用：出访连接池是指API网关到后端服务的连接池，若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个实例最大...
DescribeAccessControlListAttribute-查看访问控制...
本功能为API网关专享实例提供实例级别的访问控制能力；查看访问控制策略详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
专享实例
API网关最大出访连接池大小的估算可以按照这个原则来估算连接池是否够用：出访连接池是指API网关到后端服务的连接池，若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个...
如何配置出访连接池告警
若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个实例最大支持的出访RPS是1200，超过1200后，如果请求进入API网关，后端连接池被占满，API网关会让请求进入一个等待队列，...
DescribeAccessControlLists-查询访问控制策略列表
本功能为API网关专享实例提供实例级别的访问控制能力；查看访问控制策略列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
多级API网关
API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关在调用自身时会使用AK生成签名发送给目标API网关进行鉴权认证。一个典型的场景是，用户有个负责分发的API，这个API绑定一个后端路由...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API 属性说明
响应参数 属性 必填项 说明 成功响应示例 否 为 API 订阅者提供请求成功时的返回数据参考。失败响应示例 否 为 API 订阅者提供请求失败时的返回数据参考。错误码 否 HTTP 默认错误代码。错误信息 否 自定义错误提示信息。描述 否 错误码的...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。...还可以为API绑定 客户端签名说明文档 等安全配置。
创建 CORS 规则
注意事项 通过 创建 CORS 按钮所创建的 CORS 规则的生效范围均为 API 级别。在 CORS 规则列表中，有一条名为 当前环境级别 CORS 规则 的置顶规则，生效范围为 当前环境级别。该规则无法删除，默认状态为关闭。如果开启该环境级别规则，则对...
API网关流量安全
执行频率 固定时间间隔：1分钟 查询范围 过去2分钟 参数配置 告警名称：告警实例的名称，默认为 API网关服务端平均延时过高告警。您可以根据不同监控对象，命名不同的告警名称便于识别。严重度：严重、高、中、低、报告。默认值为高。服务...
使用自定义域名调用API
您在正式生产环境开放API时，需要为API分组绑定独立域名才可正常使用，不受此项限制。1.2 域名备案 在中国内地REGION绑定独立域名到分组上的前提是独立域名需要在阿里云备案或者在阿里云备案接入。海外REGION不需要域名备案。说明 绑定内网...
ModifyApiGroup-修改API分组的信息
ID，系统生成，全局唯一 523e8dc7bbe04613b5b1d726c2a7889d GroupName string API 分组名称 NewWeather Description string API 分组描述 New weather informations.SubDomain string 系统为 API 分组分配的二级域名 523e8dc7bbe04613b5b1d...
API调试及自助排错
其中X-Ca开头的属性均为API网关返回，其中您需要重点关注的信息为：X-Ca-Error-Code。API网关系统错误码，当请求出现错误被网关拦截后，由API网关提供的错误码。X-Ca-Request-Id。请求唯一ID，请求一旦进入API网关应用后，API网关就会生成...
使用HTTPS并用域名访问
您在正式生产环境开放API时，需要为API分组绑定独立域名才可正常使用，不受此项限制。独立域名需要满足以下几点：中国内地Region的独立域名需要在 阿里云备案 或者将备案接入阿里云。独立域名要CNAME解析到该分组的二级域名上，然后操作...
创建后端服务为VPC内资源的API
网关的出口IP为API分组所在的实例的出口地址。先通过 API网关控制台-【API管理】-【分组管理】-【分组详情】查看分组所在实例。点击左侧栏 实例与集群，单击实例类型，找到对应实例查看到出口地址信息。7.调试API API网关提供了在线调试的...
发布API商品
二级域名为API网关自动分配，无需进行调整；请求Path、HTTP Method、入参请求模式，您可根据API及后端服务的情况来进行设置，本例中HTTP Method选择的POST，其他的使用默认值；入参定义，本例中配置了三种不同位置的参数，同时配置了默认值...
管理API端点
本文介绍如何创建、查看、编辑、删除连接配置和API端点，帮助您快速集成其他应用。前提条件 开通事件总线EventBridge并授权 背景信息 API端点（API Destinations）可以帮助您调用第三方SaaS系统或自建系统的HTTP接口，提供低代码的接入方式...
VPC融合专享实例
购买说明 如图所示为API网关专享实例的购买页面，在实例类型选择VPC融合专享实例后，可以为将要创建的VPC融合类型专享实例进行配置。创建VPC融合类型专享实例需要指定以下配置：用户VPC ID：指定和API网关进行连接的用户VPC，创建以后不可...
安装SDK
本文为您介绍云控制API的SDK安装方法。安装操作 云控制API 为您提供以下开发语言的SDK安装方法。语言 安装方式 Java Java SDK安装 Go Go SDK安装 Python Python SDK安装 TypeScript TypeScript SDK安装 PHP PHP SDK安装 Swift Swift SDK...
产品数据API
使用标签功能，为API自定义标识，以便灵活管理API。重要 一个API最多可添加5个标签。API描述 输入API的描述，说明API的功能等信息。返回类型 调用API后，返回数据的格式，固定为JSON。在 配置参数并测试 页面，修改以下配置参数和高级设置...
参数映射与校验规则
6.Http Header处理规则 一般来讲，所有以 X-Ca-开头的Header均为API网关保留Header,API网关会对 X-Ca-的Header做特殊处理，请不要在您的业务中使用 X-Ca-开头的头，否则会导致头被过滤，或产生未预期的行为。HeaderName 请求处理方式 应答...
- 产品推荐
- 这些文档可能帮助您