HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
环境管理
2.2 API后端配置 步骤1：由于本例中的API后端服务类型是VPC，因此需要分别创建两个VPC授权 backend-vpc-release 和 backend-vpc-test，分别对应线上环境和测试环境，如何使用VPC作为API的后端服务的配置过程可详见 创建后端服务为VPC内资源...
服务接入点
华北1（青岛）cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com 华北2（北京）cn-beijing apigateway.cn-beijing.aliyuncs.com apigateway-vpc.cn-beijing.aliyuncs.com 华北3（张家口）...
概述
1 如何创建API 创建API的方式有三种：通过控制台创建API、通过管控API创建API、通过导入Swagger创建API 通过控制台创建API 登录阿里云API网关控制台，左上角选择地域，然后在分组中创建API。具体步骤可参考 创建 API 使用管控API创建API ...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
导入API网关的扩展Swagger定义
现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0，可以创建API实体的Swagger定义，并将Swagger导入API网关用于批量创建或者更新API...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
结构体说明
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...
对象存储
1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 2.创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:RemoveAppsAuthorities Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 否 API 分组 ID，系统生成，全局唯一 523e8dc7bbe04613b5b1d726c2a7889d ApiId ...
SetAppsAuthorities-给多个APP添加API访问权限
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:SetAppsAuthorities Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 否 API 分组 ID，系统生成，全局唯一 523e8dc7bbe04613b5b1d726c2a7889d ApiId ...
自定义 JSAPI
代码注册 jsapi PSDJsApi*jsApi4DemoTest2=[PSDJsApi jsApi:@"demoTest2"handler:^(NSDictionary*data,PSDContext*context,PSDJsApiResponseCallbackBlock responseCallbackBlock){ responseCallbackBlock(@{@"result":@"jsapi-demoTest2...
使用VPC内资源作为API的后端服务
创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式调用API 2.5 安全 API网关通过内网调用VPC内资源的后...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
DeleteWarningConfig-删除预警配置
false/null 表示失败 true 示例 正常返回示例 JSON 格式 {"Code":"200","Message":"successful","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true } 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容...
GetResultCallback-获取结果回调
true 示例 正常返回示例 JSON 格式 {"Code":"200","Message":"successful","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4*\t","Success":true } 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 2023-08-01 ...
DeleteSchemeTaskConfig-删除质检任务
200 示例 正常返回示例 JSON 格式 {"RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true,"Code":"200","Message":"successful","Messages":{"Message":["无"]},"HttpStatusCode":200 } 错误码 访问 错误中心 查看更多错误...
RevertAssignedSession-批量回收（单通会话维度）
200 示例 正常返回示例 JSON 格式 {"RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true,"Code":"200","Message":"successful","Messages":{"Message":[""]},"HttpStatusCode":200 } 错误码 访问 错误中心 查看更多错误码...
CreateWarningConfig-新建预警配置
true 示例 正常返回示例 JSON 格式 {"Code":"200","Message":"successful","Data":"30","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true } 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作...
SubmitComplaint-提交申诉
false/null 表示失败 true 示例 正常返回示例 JSON 格式 {"Code":"200","Message":"successful","Data":"90","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true } 错误码 访问 错误中心 查看更多错误码。变更历史 变更...
RestartAsrTask-对质检失败的文件进行重试
successful RequestId string 请求 ID 82C91484-B2D5-4D2A-A21F-A6D73F4D55C6 Success boolean 请求是否成功，调用方可根据此字段来判断请求是否成功：true 表示成功；false/null 表示失败 true Data object[]详细返回数据。Message string...
UpdateRuleById-新建或更新质检规则
目前该API接口已标记为弃用，推荐使用替代API：Qualitycheck(2019-01-15)-UpdateRuleV4。对应前端功能位置：质检规则配置-新建&更新。专有云URL：ip:port/api/client/UpdateRuleById.json。调试 您可以在OpenAPI Explorer中直接运行该接口...
CreateUser-创建用户
true 示例 正常返回示例 JSON 格式 {"Code":"200","Message":"success","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4*\t","Success":true } 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 2024-01-02 Open...
ListWarningConfig-获取预警配置列表
[5767,5647]示例 正常返回示例 JSON 格式 {"Code":"200","Message":"successful","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true,"Data":{"WarningConfigInfo":[{"Status":1,"ConfigName":"投诉预警","UpdateTime":...
ListRules-获取规则列表
目前该API接口已标记为弃用，推荐使用替代API：Qualitycheck(2019-01-15)-ListRulesV4。获取规则列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试...
DryRunSwagger-预检查swagger
{"ApiImportModelFailed":[{"ErrorMsg":"Not Found","ModelName":"Region","GroupId":"36d4bcfaec1946e1870d90b2d7519710"}]},"ModelSuccess":{"ApiImportModelSuccess":[{"ModelUid":"ec1946e1870d90b2d7519","ModelName":"NewInstance",...
AssignReviewer-分配质检员
false/null 表示失败 true 示例 正常返回示例 JSON 格式 {"Code":"200","Message":"successful","RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6","Success":true } 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容...
在生产环境使用加密服务
privateKeyRSAKEK=Forms.hexStringToByteArray("6B2FB2BCC75604ABF5761FFA1027FF16324E3038B580C9F63AD3B57BD89059D5799974B4E5E9453763D94E682C629C4617C4E5393E9DDBFB0CFA2A4EA0E832F5C6A30F3EE63C327F6E044F3CB630D0C7DD96D93581835AA...
ListQualityCheckScheme-获取质检方案列表
1（触发规则后一次性得分）0 Version long 质检方案版本 1 示例 正常返回示例 JSON 格式 {"RequestId":"82C91484-B2D5-4D2A-A21F-A6D73F4*\t","Success":true,"ResultCountId":"XXX","Code":"200","Message":"successful","PageNumber":1,...
调用RPC API和RESTful API
阿里云云产品的API分为RPC和RESTful两种类型，大部分产品使用的是RPC风格。当您使用阿里云CLI调用接口时，不同风格的API，调用方式不同。在阿里云CLI中，使用的命令行结构如下：...aliyun cs DELETE/clusters/ce2cdc26227e09c864d0ca0b2d5*
ImportSwagger-通过 Swagger 创建 API
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
专享实例
区域 实例规格 按量付费（元/小时）-列表价 预付费（元/月）-列表价 预付费（元/年）-列表价 华东1（杭州）、华东2（上海）、华北1（青岛）、华北2（北京）、华北3（张家口）、华北5（呼和浩特）、华南1（深圳）、西南1（成都）api.s1....
DescribeApiGroups-查询 API 分组列表
GroupName":"Traffic","Description":"TrafficInformations.","IllegalStatus":"NORMAL","HttpsPolicy":"HTTPS2_TLS1_0","SubDomain":"be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",CreatedTime":"2016-08-01T08:45:...
- 产品推荐
- 这些文档可能帮助您