简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
功能概览
支持通过泛域名调用API；请求转发 支持参数清洗，包括参数类型、参数值（范围、枚举、正则）校验，无效校验会被 API 网关直接拒绝；支持参数映射，实现前端、后端请求信息映射；安全防护支持多种认证方式 支持 HMAC(SHA-1，SHA-256)算法...
WAF接入配置
2 前提条件 开通Web应用防火墙 在API网关上已经发布了API 3 操作步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。绑定成功后如下图所示：重要 由于后续步骤中还需配置WAF，建议当前阶段绑定域名时使用TXT解析。...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
DDoS防护接入配置
前提条件 已 购买DDoS高防实例 在API网关上已经发布了API 配置步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。重要 由于后续步骤中还需接入DDoS防护，建议当前阶段绑定域名时使用TXT解析。步骤2：参考 防护...
DomainItem
描述"class="reference-link">描述 API的调用域名信息 节点名"class="reference-link">节点名 DomainItem 子节点"class="reference-link">子节点 名称 类型 描述 DomainName String API的调用域名
API调用统计
API调用统计 在 API调用统计 页面，您可以查看 开放API 或 数据服务 API的 今日概况、API近90天调用统计、API单日调用排行榜 和 API调用明细。今日概况 概况信息包含 API个数统计、当日调用次数总计、平均响应时间 三部分。API近90天调用...
小程序权限控制
为了对 App 中小程序的可访问范围进行权限控制，您可在 mPaaS 控制台中为小程序添加 服务器域名白名单、API 调用白名单 以及 内嵌 WebView 域名白名单。开启了下图中的 小程序权限控制开关 后，只有加入白名单里的资源才可被当前小程序访问...
API概览
域名管理 API 描述 AddLiveDomain 调用AddLiveDomain添加直播域名，一次只能提交一个域名。AddLiveDomainPlayMapping 调用AddLiveDomainPlayMapping添加主播流域名和子播流域名映射。DeleteLiveDomainPlayMapping 调用...
查看及管理运维监控API
为了保障应用能够正常调用API，同时能够保护系统，数据服务支持监控API的运行情况，包括查看异常影响分析、访问趋势分析、应用调用情况、查看API运行详情、API影响分析、配置API限流和API告警。本文为您介绍如何查看API调用情况及配置API限...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
API调用
未授权的API调用告警 告警ID sls_app_audit_cis_at_unauth_apicall 告警名称 未授权的API调用告警 版本号 1 类别 云平台、阿里云、CIS、API调用 作用 监控未授权的API调用行为。未授权API调用次数小于等于规则参数配置中设定的 未授权调用...
API概览
自定义域名 API 描述 CreateCustomDomain 调用 CreateCustomDomain 接口创建自定义域名。DeleteCustomDomain 调用 DeleteCustomDomain 接口删除自定义域名。UpdateCustomDomain 调用 UpdateCustomDomain 接口更新自定义域名配置。...
API概览
集群 API 描述 创建集群 调用CreateClusterV2接口，创建一个E-MapReduce集群。说明 如果您在2022年12月19日17点（UTC+8）以后第一次创建EMR集群，无法使用该接口创建集群，请使用 CreateCluster-创建集群。修改集群名称 调用...
云产品事件触发器概述
域名和网站 域名事件 域名事件类型包括阿里云平台对资源执行的操作事件、API调用和控制台的操作事件。物联网 阿里云物联网平台事件 阿里云物联网平台事件类型包括阿里云平台对资源执行的操作事件、API调用和控制台的操作事件等。企业应用与...
概述
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API-如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档 使用JWT认证方式调用API 还可...
运维监控概述
在运维监控页面，您可以查看运维总览数据、调用API的情况及为API配置限流和告警：查看异常影响分析：以指标卡的形式直观清晰的展现了特定时间段内，特定服务项目下发布API数、在线API数、调用API数、在线API调用率、API的调用总次数、异常...
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发布并授权之后，您可以通过简单身份认证（在请求头中添加AppCode）或加密签名身份认证（在请求头中添加AppKey和AppSecret）的方式调用API。本文为您介绍如何获取认证信息以及调用API的具体流程。前提条件 您需要首先发布API至API网关...
环境管理
本文档介绍如何在API网关上进行...使用绑定好的测试域名进行调用，如下图所示：注意：绑定环境的域名优先级大于 X-Ca-Stage，即在调用绑定环境的域名中，仍然在header中添加 X-Ca-Stage 信息，API网关会以域名的环境配置为准，如下图所示：
调用API
调用方式 调用方式 适用场景 说明 安全级别 加密签名身份认证 应用程序开发、数据采集等。该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作，请参见 使用SDK调用API。高 简单身份认证 一般用于可视化场景，如DataV调用。该...
SetDomain-给指定分组绑定自定义域名
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
API概览
集群管理 API 标题 API概述 CreateDBInstance 创建集群 调用CreateDBInstance接口创建ClickHouse企业版集群。DeleteDBInstance 释放集群 调用DeleteDBInstance接口释放云数据库ClickHouse企业版集群。StartDBInstance 启动集群 调用...
使用简单认证（AppCode）方式调用API
API调用者到API网关控制台的”应用管理“找到AppCode/AppSecret进行签名认证的调用或者AppCode进行简单认证的API调用。2.创建支持简单认证方式API API提供者在创建API安全认证方式时需要选择”阿里云APP”；AppCode认证选项选择允许AppCode...
API概览（2014-08-28）
本文列出了弹性伸缩 2014-08-28 版涉及的所有可调用API接口及相关描述，供您查阅。伸缩组 API 描述 CreateScalingGroup 调用CreateScalingGroup创建一个伸缩组。ModifyScalingGroup 调用ModifyScalingGroup修改一个伸缩组。...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
DescribeDomain-查询自定义域名详情信息
自定义域名 api.demo.com 返回参数 名称 类型 描述 示例值 object CertificatePrivateKey string 证书私钥 xxx DomainName string 自定义域名 api.demo.com DomainBindingStatus string 自定义域名绑定状态，取值：BINDING：正常 BOUND：未...
调用服务
本文介绍API消费方应用调用API的多种方式。背景信息 API消费方应用调用API有多种方式，例如HTTP API、HSF API、WebService API等。其中HSF API的消费调用沿用HSF原有的服务调用方式，无需任何专用SDK，如有必要可以指定CSB的服务IP进行HSF...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
使用SDK调用API
本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考...
点播CDN
接口调用说明 接口的参数解释和返回字段的详细说明请访问 阿里云OpenAPI门户，在各接口右侧的 文档 页签查看。SDK代码示例，可以通过阿里云OpenAPI门户获取。访问 阿里云OpenAPI门户，在接口的左侧 参数配置 页签，填写需要的参数信息并...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
点播CDN
接口调用说明 接口的参数解释和返回字段的详细说明请访问 阿里云OpenAPI门户，在各接口右侧的 文档 页签查看。SDK代码示例，可以通过阿里云OpenAPI门户获取。访问 阿里云OpenAPI门户，在接口的左侧 参数配置 页签，填写需要的参数信息并...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
- 产品推荐
- 这些文档可能帮助您