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

查询HBlock版本
本节主要介绍如何使用API查询HBlock版本。此操作用来查询HBlock版本信息。请求语法GET /rest/v1/system/version HTTP/1.1 Date: date Host: ip:port Authorization: authorization响应结果名称类型描述versionStringHBlock的版本号。typeStringHBlock的版本类型:Stand-alone:单机版。Cluster:集群版本。请求示例查询HBlock的版本信息。

来自：
帮助文档
存储资源盘活系统
API参考
查询HBlock版本
操作类
调用内容审核的API接口失败时怎么办? 请确认当前账号所购买的资源包是否过期、用完、欠费情况。如果存在,请购买相对应的资源包,详情查看产品购买。根据API调用返回结果和错误码查找失败原因,具体请参见API-状态码。检查AccessKey、SecurityKey、AppKey是否输入正确和获取成功,获取方式请参见认证鉴权。检查API调用方法是否正确,具体操作请参见API调用指南。调用API接口请求超时怎么办?

来自：
帮助文档
内容审核（文档停止维护）
常见问题
操作类
启用卷
本节主要介绍如何使用API启用卷。此操作用来启用卷。说明仅3.9之前版本支持。请求语法PUT /rest/v1/block/lun/lunName/enable HTTP/1.1 Date: date Host: ip:port Authorization: authorization请求参数参数类型描述是否必须lunNameString要启用的卷名称。取值:长度范围是1~16,只能由字母、数字和短横线(-)组成,字母区分大小写,且仅支持以字母或数字开头。是请求示例启用卷lun02a。

来自：
帮助文档
存储资源盘活系统
API参考
卷管理
启用卷
创建专享版集群
设置API分配配额专享版集群创建成功后,需要设置API分配配额,当分配配额之后,才能创建相应的API,配额设置参考如下步骤。在“空间管理”页签中,单击工作空间操作列“编辑”链接。详见下图: 编辑空间管理在“空间信息”中,单击“设置”按钮对已分配配额进行配置。详见下图: 设置已分配配额说明数据服务已创建的API属于计费项,当前操作正在增加API配额,这会使工作空间下可以创建更多的API,同时可能使收费增加,请确认。设置专享版API已分配配额。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
准备工作
创建专享版集群
热链保护
相关参考运行时API:addEventListener 运行时API:FetchEvent 运行时API:Web Standards 运行时API:Response 运行时API:Fetch

来自：
帮助文档
全站加速
用户指南
BosonFaaS边缘函数
示例代码
防盗链
热链保护
热链保护
相关参考运行时API:addEventListener 运行时API:Response 运行时API:FetchEvent 运行时API:Web Standard 运行时API:Fetch

来自：
帮助文档
CDN加速
用户指南
BosonFaaS边缘函数
示例代码
防盗链
热链保护
热链保护
相关参考运行时API:addEventListener 运行时API:FetchEvent 运行时API:Web Standards 运行时API:Fetch 运行时API:Response

来自：
帮助文档
边缘安全加速平台
开发者平台
示例代码
防盗链
热链保护
施压配置
参数说明最大并发量当前场景所有API的最大虚拟用户数,当达到最大并发量时,并发量就不再增加。 TPS值设定所有API每秒执行事务的数量。压测总时长压测执行的时间,压测时长达到后会自动停止压测。 3)摸高模式。参数说明起始并发数执行测试的起始虚拟用户数。最大并发量当前场景所有API的最大虚拟用户数,当达到最大并发量时,并发量就不再增加。爬坡时间虚拟用户数从起始并发数线性递增到最大并发数的时长。

来自：
帮助文档
性能测试PTS
操作指南
施压配置
功能特性
绑定解绑支持跟各类云主机、NAT网关、负载均衡等云资源进行绑定和解绑。调整带宽弹性IP支持带宽变配,可以向上、向下调整网络带宽,灵活匹配用户不同业务场景需求,同时支持不同计费模式的互转。带宽监控您可以监控弹性IP出入带宽、出入流量的实际情况,即时发现网络瓶颈,根据业务场景需要,随时调整带宽,保证业务的可持续性。共享带宽天翼云支持多个弹性IP使用共享带宽。

来自：
帮助文档
弹性IP
产品介绍
功能特性
查看SSL客户端的连接信息
单击控制中心左上角的,选择VPN网关实例所在地域。在网络产品中选择“VPN连接”,进入VPN连接页面。在左侧网络控制台,选择“SSL VPN”,进入SSL VPN列表页面。在SSL VPN页面,单击“SSL客户端”,进入SSL客户端列表页面。在SSL客户端列表,找到目标SSL客户端,可以查看该SSL客户端绑定的SSL服务端、创建时间、连接状态等信息。当SSL客户端的连接状态为“在线”时,单击旁边的“断开”按钮,可以将客户端强制离线。

来自：
帮助文档
VPN连接
用户指南
配置SSL VPN
查看SSL客户端的连接信息
删除SNAT规则v3
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx请求参数请求头header参数无请求体body参数参数是否必填参数类型说明...网关IDsnatOid是StringSNAT规则ID响应参数参数参数类型说明示例下级对象statusCodeInteger状态码。可能值:- 800:请求成功。- 900:请求失败。800errorString错误码。ECPC_1000messageString提示信息。

来自：
帮助文档
天翼云电脑（政企版）
API参考
API
2023-10-30
NAT网关
删除SNAT规则v3
删除DNAT规则v3
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx请求参数请求头header参数无请求体body参数参数是否必填参数类型说明...网关IDdnatOid是StringDNAT规则ID响应参数参数参数类型说明示例下级对象statusCodeInteger状态码。可能值:- 800:请求成功。- 900:请求失败。800errorString错误码。ECPC_1000messageString提示信息。

来自：
帮助文档
天翼云电脑（政企版）
API参考
API
2023-10-30
NAT网关
删除DNAT规则v3
虚拟私有云
网关子网的网关地址。已用/可用数量显示该子网下已用和可用的地址数量。关联实例数量可浮窗查看查看该子网关联的实例类型和实例名称。状态当子网可用时其状态为“启用”。创建时间创建该子网的时间。添加子网登录通用计算控制台。单击左侧导航栏的【网络&存储>网络>虚拟私有云】,选择所要创建子网的虚拟私有云,点击其操作栏的【添加子网】,在添加子网的页面,填入相关的参数。添加子网的相关参数。参数说明虚拟私有云名称显示创建该子网所属的虚拟私有云名称。资源池显示创建该子网所属的虚拟私有云所在的资源池。

来自：
帮助文档
算力互联调度平台
用户指南
通用计算
网络
虚拟私有云
状态码
1、请求状态码正常状态码描述200请求成功3**请求转移4**客户端错误5**服务端错误 2、全局请求返回错误码错误码描述10002生成...API授权50000服务内部错误50001服务未注册50002应用未开通50003API中无效的URL请求51001购买服务已过期51002收费API未购买51003API可用次数已不足

来自：
帮助文档
人脸识别
API参考
调用前必知
状态码
状态码
1、请求状态码正常状态码描述200请求成功3**请求转移4**客户端错误5**服务端错误 2、全局请求返回错误码错误码描述10002生成签名...API授权50000服务内部错误50001服务未注册50002应用未开通50003API中无效的URL请求51001购买服务已过期51002收费API未购买51003API可用次数已不足

来自：
帮助文档
内容审核（文档停止维护）
API参考
调用前必知
状态码
删除iSCSI target
本节主要介绍如何使用API删除iSCSI target。此操作用来删除iSCSI target。注意只有未关联任何卷的iSCSI target才能被删除。请求语法DELETE /rest/v1/block/target/targetName HTTP/1.1 Date: date Host: ip:port Authorization: authorization请求参数参数类型描述是否必须targetNameStringiSCSI target名称。

来自：
帮助文档
存储资源盘活系统
API参考
iSCSI target管理
删除iSCSI target
删除所有的采集日志
本节主要介绍如何使用API删除所有的采集日志。此操作用来删除所有的采集日志。请求语法DELETE /rest/v1/system/logcollect HTTP/1.1 Date: date Host: ip:port Authorization: authorization请求示例删除所有的采集日志。

来自：
帮助文档
存储资源盘活系统
API参考
事件和日志管理
删除所有的采集日志
查设备轨迹
本文为您介绍分布式消息服务MQTT的API-设备客户端-查设备轨迹。

来自：
帮助文档
分布式消息服务MQTT
API参考
API
设备客户端
查设备轨迹
使用方式
方式二:通过API管理 ZOS提供了RESTful API,便于您进行创建、列举、查看、删除桶等操作。关于API详细信息,请参见API概览。方式三:通过SDK管理 SDK是对ZOS提供的RESTful API进行封装的工具包,旨在简化用户的开发工作。用户通过使用SDK提供的接口函数,可以直接调用并实现对ZOS的各项业务能力的使用,同时保持原有功能基本不变。天翼云支持多种SDK开发方式,例如JAVA、C#、C++、Python、Go等。详情请参见开发者文档。

来自：
帮助文档
对象存储
用户指南
使用方式
删除向智维平台推送告警的配置
/stor config rm -i ctyuncms --url https://ctyuncms:9527/blackhole/api/v1/issue Removed ctyuncms https://ctyuncms:9527/blackhole/api/v1/issue successfully.

来自：
帮助文档
存储资源盘活系统
命令行参考
HBlock系统设置
智维推送告警配置
删除向智维平台推送告警的配置
构造请求
{query-string} 参数描述是否必选 URI-scheme 用于传输请求的协议,当前所有API均采用HTTPS协议。是 Endpoint 当前资源池或者通用的域名是 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1”。是 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”

来自：
帮助文档
弹性IP
API参考
如何调用API
构造请求
构造请求
{query-string} 参数描述是否必选 URI-scheme 用于传输请求的协议,当前所有API均采用HTTPS协议。是 Endpoint 当前资源池或者通用的域名是 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1”。是 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”

来自：
帮助文档
共享带宽
API参考
如何调用API
构造请求
构造请求
{query-string} 参数描述是否必选 URI-scheme 用于传输请求的协议,当前所有API均采用HTTPS协议。是 Endpoint 当前资源池或者通用的域名是 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1”。是 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”

来自：
帮助文档
VPC终端节点
API参考
如何调用API
构造请求
视图水印
云点播API/SDK水印您可以在云点播【API参考】-【API】-【点播模式API】-【提交转码任务】查看如何在转码同时叠加水印。您可以在云点播【API参考】-【API】-【点播模式API】-【截屏换封面】查看如何在截图同时叠加水印。

来自：
帮助文档
云点播
用户指南
点播模式
视图水印
AnythingLLM 协同 Ollama 启用 DeepSeek 大模型最佳实践
跳转到如下页面,点击获取密钥:按照提示输入api名称,查看api使用协议并按照您的想法选择是否接受:按照提示操作后得到api调用的key。c. 启用 AnythingLLM 的联网搜索功能配置 Google Search Engine :回到 AnythingLLM 联网搜索的页面,填入上述步骤获取的 ID 和 API key,点击右上角保存。

来自：
帮助文档
弹性云主机
DeepSeek专题
实践指南：DeepSeek驱动高效能云生态
GPU云主机/弹性云主机：零基础搭建DeepSeek云端环境指南
AnythingLLM 协同 Ollama 启用 DeepSeek 大模型最佳实践
配置桶生命周期
此API可以设置桶的生命周期配置。接口功能介绍此API可以设置桶的生命周期配置。接口约束每次设置桶的生命周期配置时会覆盖原有的生命周期配置,如果想要保留桶原有的生命周期配置,需要在为桶设置新的生命周期配置时包含原有的生命周期配置。 URI PUT /{bucket}?

来自：
帮助文档
媒体存储
API参考
API（原生接口）
关于桶的操作
生命周期
配置桶生命周期
启用MySQL认证授权
本文为您介绍分布式消息服务MQTT的API-第三方认证授权-启用MySQL认证授权。

来自：
帮助文档
分布式消息服务MQTT
API参考
API
第三方认证授权
启用MySQL认证授权
停用MySQL认证授权
本文为您介绍分布式消息服务MQTT的API-第三方认证授权-停用MySQL认证授权。

来自：
帮助文档
分布式消息服务MQTT
API参考
API
第三方认证授权
停用MySQL认证授权
导出告警
本节主要介绍如何使用API导出告警。此操作用来导出告警信息。请求语法GET /rest/v1/system/alarm/file?alarmStatus=alarmStatus HTTP/1.1 Date: date Host: ip:port Authorization: authorization请求参数名称类型描述是否必须alarmStatusString告警状态。取值:Unresolved:告警中。Resolved:告警已解除。Expired:告警已失效。默认值为Unresolved。

来自：
帮助文档
存储资源盘活系统
API参考
告警
导出告警
时间戳防盗链
相关参考运行时API:addEventListener 运行时API:FetchEvent 运行时API:Web Standards 运行时API:Response 运行时API:Fetch

来自：
帮助文档
全站加速
用户指南
BosonFaaS边缘函数
示例代码
防盗链
时间戳防盗链
构造请求
{query-string} URI-scheme: 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint: 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同。 resource-path:资源路径,也即API访问路径。从具体API的URI模块获取。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
专属云（计算独享型）
API参考
如何调用API
构造请求
时间戳防盗链
相关参考运行时API:addEventListener 运行时API:Response 运行时API:FetchEvent 运行时API:Web Standard 运行时API:Fetch

来自：
帮助文档
CDN加速
用户指南
BosonFaaS边缘函数
示例代码
防盗链
时间戳防盗链

天翼云最新活动

12.12年度钜惠

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

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

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

云上钜惠

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

算力套餐

让算力触手可及

天翼云AI产品特惠

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

中小企业服务商合作专区

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

出海产品促销专区

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

天翼云电脑专场

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

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

弹性云主机

物理机

多活容灾服务

GPU云主机

一体化计算加速平台·异构计算

算力互联调度平台

一站式智算服务平台

人脸检测

人脸属性识别

推荐文档

获取机器码

退订

创建只读实例