API网关_API网关文档介绍内容-天翼云

节点管理快速配置
示例: sudo wget https://cms.ctyun.cn/db/api-proxy/api/v1/ctyun/download/cmp_compose_x.x.x_x86_64.tar.gz 安装节点。 (1)解压解压下载完成的安装包,进行后续步骤。示例: sudo tar -xzvf cmp_compose_x.x.x_x86_64.tar.gz (2)授权授权解压完成的文件,进行后续步骤。

来自：
帮助文档
云迁移服务CMS
快速入门
数据库迁移服务模块
节点管理快速配置
Web 接入场景
API请求,静态资源上报数据量可能较大。可根据实际情况选择开启

来自：
帮助文档
应用性能监控
用户指南
前端监控
应用接入指南
Web 接入场景
什么是前端监控？
全场景数据可视化洞察实时统计首屏时间、API 成功率等核心指标,多维数据采集、关联,用户体验可视化,量化页面性能表现,快速定位业务转化瓶颈。

来自：
帮助文档
应用性能监控
用户指南
前端监控
产品概述
什么是前端监控？
查询指定Region的可用区
错误信息描述Internal error occurredreturnObjObject返回信息returnObj表 returnObj参数...api/v1/region 请求头header

来自：
帮助文档
弹性容器实例
API参考
API
2023-12-25
地域
查询指定Region的可用区
天翼云短信服务文档使用指引
短信接口配置查看API文档。更多信息,请参见API概览。发送短信常见问题发送短信时,存在模板审核,签名审核等问题,您可以参考常见问题进行解决。详细信息,请参见发送短信常见问题。

来自：
帮助文档
云通信-短信（文档停止维护）
快速入门
天翼云短信服务文档使用指引
修改QoS策略
本节主要介绍如何使用API修改QoS策略。此操作用来修改QoS策略。

来自：
帮助文档
存储资源盘活系统
API参考
QoS策略
修改QoS策略
设置卷的主备优先级或自动切换（集群版适用）
本节主要介绍如何使用API设置卷的主备优先级或自动切换。此操作用来批量修改卷的配置。说明卷处于“删除中”、“回滚中”,不能修改卷的配置。

来自：
帮助文档
存储资源盘活系统
API参考
卷管理
设置卷的主备优先级或自动切换（集群版适用）
采集常见错误类型
LTS_1440上报日志网关中出现错误Error occurred in the log gateway during reportingtoken失效或者到日志网关的网络不通。如果是token失效需确认AK/SK是否有getToken权限。LTS_1441上报日志网关后返回错误The log gateway returned an error after reporting查看详细报错,根据具体错误信息进一步排查。

来自：
帮助文档
云日志服务
用户指南
日志接入
主机管理
采集常见错误类型
后端主机
如果作为后端主机的云主机没有绑定弹性IP或使用NAT网关,那么该云主机并不能主动访问公网。如果想实现作为后端主机的云主机能主动访问公网的需求,需要给后端主机绑定弹性IP或使用NAT网关。配置转发策略时, 能否选择已有的后端主机组? 不能。HTTP/HTTPS支持配置基于域名和路径的转发策略,可以将来自不同域名或者不同URL路径的请求转发到不同的后端主机组来处理。每个转发策略都要新建自己的后端主机组,不能多个转发策略共同使用一个后端主机组。转发策略配置请参考添加转发策略。

来自：
帮助文档
弹性负载均衡
常见问题
后端主机
管理类
用户主密钥:是用户通过控制台或 API 来创建的用户主密钥。您可以对用户密钥进行创建/设置别名/上传自带密钥材料/启用/禁用/轮转/版本管理/删除等操作。用户主密钥按照标准资费进行计费。默认主密钥:是用户首次通过云服务调用KMS实现加密时,由系统自动生成的主密钥,别名以云产品命名,如“alias/ecs”。不支持禁用/删除/轮转/上传自带密钥材料等操作。默认主密钥免费提供密钥管理服务,API调用费与用户主密钥一同统计收费。如果用户主密钥被禁用/删除,用户数据是否还可以解密? 不可以。

来自：
帮助文档
密钥管理
常见问题
管理类
产品定义
天翼云针对OBS提供的REST API进行了二次开发,为您提供了控制台、SDK和各类工具,方便您在不同的场景下轻松访问OBS桶以及桶中的对象。当然您也可以利用OBS提供的SDK和OBS API,根据您业务的实际情况自行开发,以满足不同场景的海量数据存储诉求。

来自：
帮助文档
对象存储
产品简介
产品定义
产品简介
API:控制台上的所有操作都可以通过API实现。

来自：
帮助文档
关系数据库SQL Server版
产品介绍
产品简介
获取AKSK
本文简述如何调用API获取AKSK。一、获取AKSK 登录CDN+ IAM,地址:vip.ctcdn.cn 。在个人中心AccessKey管理页面,点击新增按钮。选择对应的工作区并确定,此时你可以查看到AccessKey已生成。选中密钥,点击查看。为保障安全,需要填写手机验证码。验证通过后,点击显示SK,即可查看详情,并支持复制和发送邮箱操作。

来自：
帮助文档
视频直播
API参考
如何调用API
获取AKSK
签名&鉴权
本文介绍调用API如何鉴权一、获取ak、sk1.登录CDN+ IAM,地址:vip.ctcdn.cn 。2.在个人中心AccessKey管理页面,点击新增按钮。3.选择对应的工作区并确定,此时你可以查看到AccessKey已生成。4.选中密钥,点击查看。为保障安全,需要填写手机验证码。验证通过后,点击显示SK,即可查看详情,并支持复制和发送邮箱操作。

来自：
帮助文档
安全加速（文档停止维护）
API参考
如何调用API
签名&鉴权
科研助手解锁 OWL 智能体，启动任务 “开挂” 模式
【注意】不同模型需要依赖不同的 API Key,需要先切换到【环境变量配置】页面设置后,方可使用。页面右侧为运行详情页,包括运行结果、运行日志、聊天历史。【补充说明】目前聊天历史由于开源代码问题,还不支持查看历史聊条内容。后续社区修复后,科研助手平台会第一时间进行更新升级。 (2)环境变量配置页面该页面是使用 OWL 前,配置各类大模型 API Key 的页面。如下图所示: OWL 支持配置的大模型 API Key,都有对应的说明以及获取方式。

来自：
帮助文档
科研助手
最佳实践
科研助手解锁 OWL 智能体，启动任务 “开挂” 模式
Serverless集群使用快速入门
部分配置说明如下: 配置项描述实例名称填写集群的实例名称企业项目按需选择企业项目计费模式默认使用按需计费...API Server访问 API Server的访问需要依赖ELB实例,您可根据需要选择合适的ELB规格,系统将根据该规格创建一个私网ELB实例。

来自：
帮助文档
云容器引擎 Serverless版
快速入门
Serverless集群使用快速入门
基于Dify和OpenSearch快速搭建知识库问答RAG应用
推荐安装“OpenAI-API-compatible”,可以用此配置大部分的模型。配置Embedding模型,填写模型名称,如:bge-m3。配置API endpoint URL和API Key,模型上下文长度设置为512。和Embedding模型类似,配置Rerank模型,如:Rerank。填写模型名称、API endpoint URL和API Key,模型上下文长度设置为512。大语言模型同上,可以根据实际情况配置,如:DeepSeek-R1。

来自：
帮助文档
云搜索服务
最佳实践
基于Dify和OpenSearch快速搭建知识库问答RAG应用
查看一分钟发布消息量
错误信息statusCodeString800-成功其他失败returnObjObject返回数据returnObjerrorString...api/getPubTpm?

来自：
帮助文档
分布式消息服务MQTT
API参考
API
2022-04-13
查看一分钟发布消息量
查看一分钟消费消息量
错误信息statusCodeString800-成功其他失败returnObjObject返回数据returnObjerrorString...api/getSubTpm?

来自：
帮助文档
分布式消息服务MQTT
API参考
API
2022-04-13
查看一分钟消费消息量
查看弹性IP信息
错误信息statusCodeString800-成功其他失败returnObjObject返回数据returnObjerrorString...api/getEip?

来自：
帮助文档
分布式消息服务MQTT
API参考
API
2022-04-13
查看弹性IP信息
订阅主题
接口功能介绍订阅主题接口约束无URIPOST /v3/api/subscribe路径参数无Query参数无请求参数请求头header参数参数是否必填参数类型说明示例下级对象regionId是String资源池bb9fdb42056f11eda1610242ac110002 华东1请求体body参数参数是否必填参数类型说明示例下级对象prodInstId是String实例ID445d30ce3d5d40a2a79dc444a8c83859topics是String订阅的topic列表,支持多个

来自：
帮助文档
分布式消息服务MQTT
API参考
API
2022-04-13
订阅主题
查设备轨迹
接口功能介绍查设备轨迹接口约束无URIGET /v3/api/getClientTrack路径参数无Query参数参数是否必填参数类型说明示例下级对象prodInstId是String实例IdclientId是String设备IDstartTime是String起始时间,时间格式'yyyyMMddHHmmss'endTime是String截止时间,时间格式'yyyyMMddHHmmss'请求参数请求头header参数参数是否必填参数类型说明示例下级对象regionId是String资源池id请求体

来自：
帮助文档
分布式消息服务MQTT
API参考
API
2022-04-13
4.0版本接口
设备管理
查设备轨迹
查询卷关联的QoS
本节主要介绍如何使用API查询卷关联的QoS。此操作用来查询卷关联的QoS信息。请求语法GET /rest/v1/block/lun/lunName/qos HTTP/1.1 Date: date Host: ip:port Authorization: authorization请求参数参数类型描述是否必须lunNameString卷名称。

来自：
帮助文档
存储资源盘活系统
API参考
卷管理
查询卷关联的QoS
产品定义
图 ECS产品架构访问方式公有云提供了Web化的服务管理平台,即管理控制台和基于HTTPS请求的API(Application programming interface)管理方式。 API方式如果用户需要将公有云平台上的弹性云主机集成到第三方系统,用于二次开发,请使用API方式访问弹性云主机,如有需求,请联系天翼云客户经理。控制台方式其他相关操作,请使用管理控制台方式访问弹性云主机。如果用户已注册公有云,可直接登录管理控制台,从主页选择“弹性云主机”。

来自：
帮助文档
弹性云主机
产品介绍
产品定义
使用限制
API接口频率设置天翼云全站加速API接口,针对操作类API接口,单用户一分钟限制调用10次。针对查询类API接口,单个用户一分钟限制调用10000次,并发不超过100。操作类接口,是指例如新增域名、删除/停用/启用域名等需对域名状态进行变更类的操作。

来自：
帮助文档
全站加速
产品介绍
使用限制
查询升级进度
本节主要介绍如何使用API查询升级进度。此操作用来升级进度。请求语法GET /rest/v1/system/upgrade HTTP/1.1 Date: date Host: ip:port Authorization: authorization响应结果名称类型描述statusStringHBlock服务升级状态:NotUpgrated:未进行过升级。Preparation:正在准备升级。Processing:正在升级。Succeeded:升级成功。Failed:升级失败。

来自：
帮助文档
存储资源盘活系统
API参考
升级HBlock
查询升级进度
创建一致性快照
本节主要介绍如何使用API创建一致性快照。此操作用来创建一致性快照。一致性快照是指在某一时刻,对选中的所有卷同时创建快照,以确保数据一致性。通过一致性快照创建的卷快照,默认命名为:卷名称-snap创建快照的时间戳(秒级),例如:lun01-snap20240601120000。用户无法在创建时自定义名称,但可以通过修改快照操作修改快照名称。说明一致性快照添加的最大卷个数是512。

来自：
帮助文档
存储资源盘活系统
API参考
一致性快照管理
创建一致性快照
控制台说明
API文档:可查看平台已支持客户调用的API功能及相关语法说明。流量/带宽: 展示客户所有域名的今日或者本月的总流量、峰值带宽。近七天趋势: 展示客户所有域名的近七天总流量趋势和带宽趋势图。证书统计: 统计客户证书总数和即将过期的证书数量。域名统计: 统计客户的域名总数,并且可以管理、添加域名,进入刷新预取的页面。产品计费: 展示客户使用的每个产品的计费方式,并且可以快捷进入流量包订购和计费变更的页面。信息中心: 该区域分为公告、域名信息、常见问题、使用手册四部分。

来自：
帮助文档
CDN加速
用户指南
控制台说明
什么是全站加速
最佳实践 API调用介绍全站加速可以调用的API,包括域名管理、证书管理、刷新预热、统计分析、屏蔽解封、日志下载、账单服务、辅助工具、标签管理、报表管理、边缘脚本等。 API概览

来自：
帮助文档
全站加速
产品介绍
什么是全站加速
身份管理
控制台用户使用账号密码访问云产品控制台,API用户使用访问密钥AK(AccessKey)调用API访问云资源。建议您将两个不同的使用场景分离,避免误操作导致服务受到影响。对于通过控制台访问的用户,推荐为其开启MFA多因素认证。按需为IAM用户分配最小权限。最小权限是指授予用户执行某项任务所需的权限,不授予其他无需用到的权限。最小授权可以避免用户操作权限过大,提高数据安全性,减少因权限滥用导致的安全风险。

来自：
帮助文档
函数计算
安全与合规
IAM访问控制
身份管理
集成简介
云工作流支持与天翼云多个云服务集成,允许您在流程中调用这些服务的API,操作相关资源。本文介绍云工作流的服务集成类型和集成模式。集成类型云工作流支持两种集成类型:普通集成和优化集成。普通集成定义:云工作流直接调用云产品的OpenAPI服务接口,未经任何包装或优化处理。特点:可访问多达上千条API服务接口,灵活性高。适用场景:需要直接调用原始API,定制化需求较强的场景。优化集成定义:对高频使用的云服务接口进行包装和优化,快速上手。

来自：
帮助文档
函数计算
用户指南
云工作流
工作流集成
集成简介
控制台说明
API文档:可查看平台已支持客户调用的API功能及相关语法说明。流量/带宽: 展示客户所有域名的今日或者本月的总流量、峰值带宽。近七天趋势: 展示客户所有域名的近七天总流量趋势和带宽趋势图。证书统计: 统计客户证书总数和即将过期的证书数量。域名统计: 分别统计全部产品的额度、已配域名、授权域名和各个产品的额度、已配域名、授权域名。并且可以管理、添加域名,进入刷新预取的页面。产品计费: 展示客户使用的每个产品的计费方式,并且可以快捷进入订购全站加速资源包页面。

来自：
帮助文档
全站加速
用户指南
控制台说明

天翼云最新活动

12.12年度钜惠

爆款云主机2核2G仅需28.8元/年，X实例35.1元/半年起！ 8代机+XSSD新客专享2.5折！

免费体验DeepSeek，上天翼云息壤

新老用户均可免费体验2500万Tokens，限时两周

云上钜惠

爆款云主机全场特惠，更有万元锦鲤券等你来领！

算力套餐

让算力触手可及

天翼云AI产品特惠

人脸识别+文字识别焕新，新用户免费试用

中小企业服务商合作专区

国家云助力中小企业腾飞，高额上云补贴重磅上线

出海产品促销专区

爆款云主机低至2折，高性价比，不限新老速来抢购！

天翼云电脑专场

移动办公新选择，爆款4核8G畅享1年3.5折起，快来抢购！

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

弹性云主机

多活容灾服务

GPU云主机

镜像服务

轻量型云主机

弹性伸缩服务

天翼云CTyunOS系统

训推服务

AI Store

推荐文档

法律法规

恢复备份

概念

启动会议