名词解释

API定义 API服务方创建API时,设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时,支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则,由网关根据规则...

SetApisAuthorities-给多个API添加APP访问权限

接口说明 此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己 API 给任意应用(app)调用 API 使用者可以将已购买 API 授权给自己的应用(app)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

CORS 配置

请求参数 名称 类型 是否必填 示例 描述 api_id_list ARRAY[STRING]否-绑定 API ID 列表 cors_id STRING 否 cors_id1 CORS 标识 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 ...

如何指定调用环境?

调用API时,默认是调用线上环境的API。如果要调用测试环境,请在header中增加参数:X-Ca-Stage:TEST。如果要调用预发环境,请在header中增加参数:X-Ca-Stage:PRE。

管理外部授权 API

绑定 API:列出了该外部授权 API 绑定的所有 API 及其基本信息,包括 API 名称、API 分组、发布状态、前端协议类型、创建时间等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 API 的具体信息及监控数据等。配置信息:...

Path是什么?

Path 是您 API 调用时展示给客户的固定路径,也是 API 的标识,在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中,一般表示为资源,格式为资源/子资源,如:instance/disk。Path 中支持动态参数,用[param]表示,如:...

DDoS防护接入配置

什么是DDoS 分布式拒绝服务(Distributed Denial of Service,简称DDoS)将多台计算机联合起来作为攻击平台,通过远程连接,利用恶意程序对一个或多个目标发起DDoS攻击,消耗目标服务器性能或网络带宽,从而造成服务器无法正常地提供服务。...

DescribeDeployedApis-查询已发布 API 列表

查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK...

DeleteApiGroup-删除 API 分组

接口说明 此功能面向 API 提供者 分组下存在 API 时,分组不可删除,须先删除分组下 API 删除分组后,系统分配给此分组的二级域名自动生效 删除不存在的分组时,会返回删除成功 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您...

BatchAbolishApis-批量下线API

批量下线已经发布到环境的API。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action ...

DescribeApisByBackend-根据后端查询 API 列表

查询使用该后端服务创建的草稿态API,或已发布在某个环境上的API。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息...

通过云控制API实现资源管理

为什么要用云控制API管理云资源 随着云计算服务业务越来越丰富,很多云厂商为客户提供的相关的API数量也多达上万个。而在云服务被集成过程中,客户/伙伴面对上万单点API往往无从下手。从“找到正确API”到“了解使用方式”再到“弄清楚上...

功能总览

网关主要功能模块如下:API 全生命周期管理 快速构建多种协议类型 API 支持按需导入导出 API 多版本管理满足企业迭代需求 统一接入 支持多种方式创建路由规则 通过参数映射实现多部门参数统一规范 支持创建多种参数类型的外部授权 API ...

多级API网关

用户在API网关创建的API除了能被客户端调用,还能被API网关本身调用。API网关自调用允许跨Region调用,如果同Region,可以走内网调用。API网关自调同时支持跨账号调用,使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件,API网关...

常见问题

本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取?CreateResource和...根据对应的API文档中的requestPath说明和产品code、资源code进行拼接。若自行拼接麻烦,可前往 在线调试API门户 查看对应的requestPath。

创建 API

密钥认证:表示订阅应用访问授权 API 时使用密钥进行身份认证。无需认证:表示订阅应用访问授权 API 时不需要身份认证。请求参数:可选,详见 API 属性说明>请求参数。响应参数:可选,详见 API 属性说明>响应参数。单击 下一步,进入 ...

新功能发布记录

每次允许导入的API上限个数为100 全部 导入标准OAS定义 第三方鉴权插件支持获取请求的Path信息 支持将请求侧的Path作为参数传递给鉴权服务 全部 第三方鉴权插件 新增API的操作历史日志 API网关记录了API所有相关操作日志,包括:创建、编辑...

DescribeTrafficControlsByApi-查询API绑定的流控策略

请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询 Api 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...

ApiGateway服务关联角色

本文为您介绍ApiGateway服务关联角色(AliyunServiceRoleForApiGateway)的应用场景以及如何删除服务关联角色。背景信息 ApiGateway服务关联角色(AliyunServiceRoleForApiGateway)是用户需要配置API后端为函数计算的情况下,为获取访问...

RemoveTrafficControlApis-解除API与流控策略的绑定

接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系,支持 API 批量,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。...

DescribeSignaturesByApi-查询API绑定的后端签名密钥

请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询 API 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...

DryRunSwagger-预检查swagger

调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action 元素中使用,用来给RAM用户或RAM...

使用外部授权 API

后续如需解绑,直接在 外部授权 API 详情>绑定 API 中,选择需要解绑 API,单击其右侧的 解除绑定 按钮,然后确定即可。说明 一个业务 API 只能绑定一个外部授权 API。外部授权 API 只能绑定相同前端协议的业务 API。

DescribeApiDoc-查询API说明文档

接口说明 此功能面向调用 API 的用户,指定 API 必须是发布到运行环境,且 Visibility=PUBLIC API 或者被授权的 Visibility=PRIVATE API 若您是调用 API 的用户,该接口返回您指定 API 的服务信息及参数定义等详情信息。...

账单和用量查询

您可以在阿里云 用户中心 查看 共享流量 的账单和流量使用情况。查询账单 登录 阿里云用户中心的账单详情 页面。在 账单详情 页面,根据需要单击相应的页签,查看 共享流量 消费情况。账单流水 页签:可查看在阿里云上的消费账单流水...

修改VPC授权信息,并且更新关联的API的元信息

修改VPC授权信息并更新关联的API元信息。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的...

DescribeAuthorizedApis-查询已授权的API列表

查询指定 APP 已授权的API列表,即指定 APP 的API列表。接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以...

API网关-事件总线服务关联角色

应用场景 用户在创建事件总线类型的后端服务时,API网关会提示用户创建事件总线服务关联角色,在后续操作中,用户在API网关创建后端为事件总线的API并调用,API网关在上传事件到用户的事件总线时需要使用服务关联角色...

API调试及自助排错

2.调试信息获取错误信息 所有的API请求只要到达网关,网关就会返回请求结果信息。用户可以查看返回结果的头部,即Header部分,来获取API网关返回的信息。其中X-Ca开头的属性均为API网关返回,其中您需要重点关注的信息为:X-Ca-Error-Code...

SetAppsAuthorities-给多个APP添加API访问权限

接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己 API 给任意应用(app)调用 API 使用者可以将已购买 API 授权给自己的应用(app)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

管理参数映射

绑定 API:列出了绑定了该映射规则的所有 API 及其基本信息,包括 API 名称,API 分组、发布状态、前端协议类型、创建时间等。在此列表,您还可以单击任一 API 名称,进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情:...

IP访问控制插件

IP访问控制插件 是 API网关 提供 API 安全防护组件之一,负责控制 API 的调用来源 IP(支持IP段)。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。1.概述 支持白名单或黑名单方式:白名单:支持配置 IP 或者...

SetIpControlApis-绑定IP访问控制与API关系

接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...

绑定/解绑授权对象

绑定授权对象 进入 API 发布>API 管理 页面,找到待授权 API,单击进入其详情页。在 授权对象 标签页下,单击 绑定授权对象,进入 添加授权应用 窗口。对于已添加为授权对象的订阅方应用,您可以直接在授权对象列表中搜索找到。对于暂未...

DescribeHistoryApis-查询API发布版本定义列表

RELEASE:线上 TEST:测试 RELEASE ApiId string 否 指定要查询 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称(模糊匹配)getPersonInfo PageSize string 否 分页参数:每页显示条数。10 PageNumber string 否...

DescribePurchasedApis-获取购买 API 列表

获取在云市场购买 API 列表。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action ...

InputCodeLocation

可以使用两种方式提供代码:直接将代码的内容包含在请求中,此时 zipFile 必须设置。将代码上传到 OSS,在请求中包含 OSS 文件的地址,此时 ossBucketName 和 ossObjectName 必须设置。checksum string 函数代码的 CRC-64 值。如果...

DeleteApi-删除 API 定义

删除指定的API定义。接口说明 此功能面向开放 API 的用户,此操作不可逆 API 在运行环境中运行,则不允许删除,需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...

DescribeApiLatencyData-查询API监控数据中对响应时间...

接口说明 查询指定 API 的监控信息:Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境 API 做统计,不包括测试环境 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI...

DescribePurchasedApiGroups-获取购买的API分组列表

获取云市场购买 API 分组列表。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 Action...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 共享流量包 对象存储 短信服务 弹性公网IP 人工智能平台 PAI
新人特惠 爆款特惠 最新活动 免费试用