简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
如何查询API调用次数？
您可以通过以下方法查询DescribeMetricLast、DescribeMetricList、DescribeMetricData和DescribeMetricTop接口的调用次数。背景信息 查询监控数据API调用次数不包含通过控制台操作产生的调用次数。RAM用户调用API的次数都会记录在阿里云...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
如何处理查询API额度已用尽或即将用尽问题？
问题原因 以下使用场景会消耗查询监控数据API调用次数的额度：使用应用实时监控服务ARMS服务（Prometheus实例for云服务）。直接调用API。调用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 接口的...
如何处理查询API限流问题？
当您调用API DescribeMetricLast 和 DescribeMetricList 时，返回信息 Throttling.User 或 Request was denied due to user flow control，说明API被限流。本文为您介绍API限流的原因和解决方法。限流原因 DescribeMetricLast 和 ...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
DescribeHistoryApis-查询API发布版本定义列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API 分组
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
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",...
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 类型 示例 描述 data ...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
查看API调用汇总
从服务维度统计API的调用汇总情况，分析API与服务之间的紧密程度，包括所有或单个服务以时间范围和统计周期查询API调用信息。本文介绍如何查看API调用汇总。前提条件 工作组管理员账号登录。API已被调用，具体操作，请参见 13调试及调用API...
DescribeApiGroupVpcWhitelist-查询分组VPC白名单
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
查看服务调用汇总信息
从服务维度和应用维度统计API的调用汇总情况，分析API与服务之间的紧密程度，包括所有或单个服务以时间范围和统计周期查询API调用信息。本文介绍如何使用服务调用汇总。前提条件 API已被调用。操作步骤 登录 数据资源平台控制台。在页面...
DescribeAbolishApiTask-查询API下线任务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiMarketAttributes-获取API的属性
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DescribeSignatures-查询后端签名密钥列表
接口说明 此功能面向开放 API 的用户 用于查询某 Region 下的后端签名密钥列表，Region 为系统参数 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 ...
应用管理
本文列出了应用管理相关的所有 OpenAPI 及其请求参数、返回参数。创建应用 sofa.apigateway.app.create 用于创建一个应用。请求参数 名称 类型 是否必填 示例 描述 param AppInfoVO 是 param tenant_id STRING 是 TSCPDICNT 租户标识 ...
查询测试
sql语句召回结果展示：RESTAPI查询 查询测试下拉框选择「RESTAPI查询」,下拉选择索引表，左侧输入框输入查询语句，点击【搜索】。输入 RESTAPI 查询串点击【搜索】，右侧会展示召回结果：{"query":"index_id:12"} 查询语法 SQL查询语句；HA...
DATASOURCE:ApiGateway:Apis
Apis Properties:ApiId:Ref:ApiId Outputs:Apis:Description:The information about ApiGateway apis.Value:Fn:GetAtt:ExtensionDataSource-Apis ApiIds:Description:The list of The ApiGateway api ids.Value:Fn:GetAtt:...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
路由规则
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。创建路由规则 sofa.apigateway.router.create 用于快速创建一个路由规则。请求参数 名称 类型 是否必填 示例 描述 param RouterInfoVO 是-param tenant_id STRING 是 ...
结构体说明
page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...
ListApiDatasource-查询API数据源列表
接口说明 具体的参数说明详见 创建 API 数据源。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
DescribeApiGroup-查询 API 分组详情
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
授权应用
本文列出了授权应用相关的 API 及其请求参数、返回参数。创建授权应用 sofa.apigateway.authapp.create 用于创建一个授权应用。请求参数 名称 类型 是否必填 示例 描述 param AuthAppInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
查询服务契约
您无需在应用中引入依赖，直接部署后，便可以通过服务契约在线查看微服务接口、路径等API信息，不但能查询提供的服务，还能方便的使用服务测试等功能。背景信息 服务契约包含了以下3个主要功能：API查询 查看服务提供者或消费者的重要API...
API说明
API类型 API详情 账号相关 Admin API 仪表盘相关 Dashboard API 仪表盘权限相关 Dashboard Permissions API 仪表盘版本相关 Dashboard Versions API 告警相关 Alerting API(unstable)告警配置相关 Alerting Provisioning API 注释相关 ...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
查看API操作历史
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API上线并查看详情
本文介绍如何上线API，并查看其详情。前提条件 工作组管理员账号登录。新建API成功，具体操作，请参见 新建API-向导模式、新建API-SQL模式。操作步骤 登录 数据资源平台控制台。在页面左上角，单击 图标，选择 协同。在顶部菜单栏，单击 ...
DescribeSignaturesByApi-查询API绑定的后端签名密钥
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...
- 产品推荐
- 这些文档可能帮助您