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

公共响应参数
API接口中使用了公共响应头(Http Response Headers),这些公共响应头可以被所有的短信服务请求使用。返回示例除业务参数之外,短信服务还会返回以下公共参数: { 'ctyun-eop-request-id': '87cee26a-a8b6-4e26-816c-8530182e2312', } 返回参数名称类型描述 ctyun-eop-request-id String 请求流水号。无论调用接口成功与否,都会返回,与请求流水号对应。

来自：
帮助文档
云通信-短信（文档停止维护）
API参考
公共参数
公共响应参数
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
智能视图服务
API参考
如何调用API
构造请求
构造请求
本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。请求示例POST https://iam-xxx.ctapi.ctyun.cn/v3/auth/tokens?

来自：
帮助文档
密钥管理
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
服务器安全卫士（原生版）
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
对象存储
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
天翼云电脑（政企版）
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
弹性伸缩服务
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
云防火墙（原生版）
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
云容灾
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
轻量型云主机
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
一体化计算加速平台·异构计算
API参考
如何调用API
构造请求
构造请求
从具体API的URI模块获取,例如"根据regionID查询用户资源"API的resource-path为“/v4/region/customerResources” query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?

来自：
帮助文档
证书管理服务
API参考
如何调用API
构造请求
模型服务最佳实践
关于开发者通过对话工具(比如Chatbox、CherryStudio等)以OpenAI-API-compatible的方式快速添加使用模型的实践,请参考DeepSeek模型调用-快捷版。关于开发者以OpenAI-API-compatible接口方式集成调用模型的实践,请参考DeepSeek模型调用-专业版。

来自：
帮助文档
AI Store
最佳实践
模型服务最佳实践
终端节点
终端节点(Endpoint)即调用API的请求域名,不同服务的终端节点不同。本产品使用全局请求地址,终端节点为: kms-global.ctapi.ctyun.cn 不同区域服务的调用,通过调用API时的请求头中的regionId来标识,例如南京3的regionId:60a39fca876e11ea91cf0242ac110002

来自：
帮助文档
密钥管理
API参考
调用前必知
终端节点
Java调用示例
java api原子能力调用需要引入公共jar包:ai-api-sign-sdk-1.0.2.zip 人脸检测: FaceDetect.zip 人脸属性识别: DetectAgeGender.zip 人脸比对:FaceCompare.zip 人脸活体检测: DetectFasFrom.zip 是否戴口罩识别: DetectFaceMask.zip 人脸实名认证:FaceAuth.zip 动作活体识别: FaceActionFas.zip

来自：
帮助文档
人脸识别
API参考
如何调用API
Java调用示例
应用总览
您可以查看前端应用访问、错误、API 请求及性能数据总览。功能入口1. 选择目标资源池,并登录 FMS 组件控制台2. 在左侧导航栏中选择“总览”功能详情以下图表数据可以通过点击右上方的“导出”按钮保存为数据表格。访问数据总览错误总览API 请求总览访问速度

来自：
帮助文档
应用性能监控
用户指南
前端监控
控制台操作指南
应用总览
安全
身份认证 SMS服务包含:控制台、Agent、API供您使用。控制台使用天翼云统一账户进行登录,Agent、API本质上都是REST风格的API接口调用。所有的API接口调用均需要经过认证的请求才可以访问成功,经过认证的请求需要包含一个签名值,该签名值以请求者的访问密钥(AK/SK)作为加密因子,结合请求体携带的特定信息计算而成。

来自：
帮助文档
主机迁移服务SMS
产品介绍
安全
如何删除文件碎片
API(OpenAPI)1.调用获取分片上传任务列表接口,列出存储桶中已经初始化但未complete的分片上传任务。2.调用终止分片上传接口,取消分片上传任务并删除碎片。目前OpenAPI仅支持西藏资源池调用,如其他区域需通过API访问调用,请联系媒体存储技术团队。API(原生接口)1.调用获取分片上传任务列表接口,列出存储桶中已经初始化但未complete的分片上传任务。2.调用终止分片上传接口,取消分片上传任务并删除碎片。XstorBrowser可参考:碎片管理。

来自：
帮助文档
媒体存储
常见问题
文件碎片
如何删除文件碎片
修改数据目录的容量配额
本节主要介绍如何使用API修改数据目录的容量配额。此操作用来修改指定服务器数据目录的容量配额。

来自：
帮助文档
存储资源盘活系统
API参考
服务器管理
修改数据目录的容量配额
云主机安全性
AccessKey 防泄密:AccessKey 是访问天翼云 API 的重要密钥,需妥善保管,避免嵌入代码、公开暴露。同时,要定期轮换 AccessKey,及时吊销不再使用的 AccessKey,还可通过配置限制公网 IP 网段访问及强制使用 HTTPS 方式访问,进一步降低泄露风险。账号与密码管理:管理员账号必须开启 MFA 认证,实施账号分级权限设置,遵循最小权限授权原则。禁用 root 账号访问 API 或常用请求方法,建议使用服务目录进行集中身份管理。

来自：
帮助文档
弹性云主机
安全合规
云主机安全性
修改一致性快照
本节主要介绍如何使用API修改一致性快照。此操作用来修改一致性快照信息。

来自：
帮助文档
存储资源盘活系统
API参考
一致性快照管理
修改一致性快照
批量查询快照
本节主要介绍如何使用API批量查询快照。此操作用来批量查询快照。请求语法GET /rest/v1/block/snapshot?filter=filter&range=i-j HTTP/1.1 Date:date Host: ip:port Authorization: authorization请求参数参数类型描述是否必须filterString查询的过滤条件。可以选择多个查询,如果是或的关系,使用“or”将查询条件分隔开;如果是与的关系,使用“and”将查询条件分隔开。

来自：
帮助文档
存储资源盘活系统
API参考
快照管理
批量查询快照
下载文件
操作场景您可以通过以对象存储(简称ZOS)控制台、API、SDK等多种方式下载ZOS中的文件。下载文件方式访问方式下载文件方法控制台通过控制台下载文件 SDK 具体可参考开发者文档 API 对象临时下载链接

来自：
帮助文档
对象存储
快速入门
下载文件
查询专属云中的云主机列表
的云主机信息 { "regionID": "a39b0db2989140c79e6de8c21d50f132", "instanceName...api-test01" } 示例4:筛选云主机状态查询云主机列表查看专属云内中开机的云主机 { "regionID": "a39b0db2989140c79e6de8c21d50f132", "state": "api-test01" } 示例5:查看指定云主机ID的多个云主机查看专属云内查找ID为c5a7966a-88e7-362b-6e11-c2d8fbfc07ca

来自：
帮助文档
专属云（计算独享型）
API参考
API
2022-11-30
新版
信息查询管理
查询专属云中的云主机列表
添加数据目录
本节主要介绍如何使用API添加数据目录。此操作用来添加指定服务器的数据目录至HBlock。一次可以添加多个数据目录。说明对于新增的数据目录,建议设置开机自动挂载,或使用已设置自动挂载的目录或子目录。注意每台服务器最多只能添加100个数据目录。

来自：
帮助文档
存储资源盘活系统
API参考
服务器管理
添加数据目录
删除Vhost
方式三:调用API删除步骤 1 在Linux中,连接RabbitMQ实例。步骤 2 执行以下命令,删除Vhost。 curl -i -X DELETE http://${USERNAME}:${PASSWORD}@${HOST}:${PORT}/api/vhosts/${VHOST_NAME} 参数说明如下: USERNAME:创建RabbitMQ实例时,设置的用户名。在实例详情页的“连接信息”区域,查看用户名。 PASSWORD:创建RabbitMQ实例时,设置的密码。

来自：
帮助文档
分布式消息服务RabbitMQ
用户指南
Vhost管理
删除Vhost
如何处理管理控制台异常提示信息
如果在调用弹性云主机相关API接口时出错,可以根据调用的API接口文档里的错误码描述表查看错误的详细信息,并对参数进行相应的调整。

来自：
帮助文档
弹性云主机
常见问题
使用故障类
如何处理管理控制台异常提示信息
配置管理
与kube-apiserver通信的qps默认:100kube-api-burst与kube-apiserver通信的burst默认:100kube-schedulerkube-api-qps与kube-apiserver通信的qps默认:100kube-api-burst与kube-apiserver通信的burst默认:100步骤 4 单击“确定”,完成配置操作。

来自：
帮助文档
云容器引擎
用户指南
旧版UI
集群管理
管理集群
配置管理
应用场景
这种场景具有以下优势: 性能高效每个网关节点可支持百万级会话。简化操作资源秒级创建,快速生效,操作简单。具体示例请参考: 配置跨VPC通信的终端节点(同一帐号) 配置跨VPC通信的终端节点(不同帐号)

来自：
帮助文档
VPC终端节点
产品简介
应用场景
欠费说明
若在冻结期内未进行充值,系统将在冻结期结束时释放虚拟机、裸金属、边缘存储实例、弹性IP、NAT网关、负载均衡等资源。VPC、专线、路由表、SSL证书等资源或配置会被保留。欠费通知您的账号若发生欠费,系统会以邮件或短信的形式提醒您,需要尽快支付账单,请留意来自天翼云的提醒邮件、短信,避免影响业务正常使用。续费说明请在欠费15天内,完成账号充值补足欠款,确保账号中的余额充足,资源实例将自动解冻。欠费仅影响按需计费资源的使用,对已购买的包年包月资源无影响。

来自：
帮助文档
智能边缘云
计费说明
欠费说明
状态码
状态码正常状态码描述 200 服务器返回成功,该操作是幂等的 400 用户请求错误,该操作是幂等的 401 用户无...网关错误 503 服务不可用错误码 errorCode 说明订单状态相关性说明 http status code description message openapi.implementation.error

来自：
帮助文档
VPN连接
API参考
调用前必知
状态码
VPN用户服务创建
路径参数无 Query参数无请求参数请求header参数无请求body参数参数是否必填参数类型说明示例下级对象...网关

来自：
帮助文档
VPN连接
API参考
API
集群模式资源池VPN用户服务功能
VPN用户服务创建

天翼云最新活动

12.12年度钜惠

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

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

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

云上钜惠

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

算力套餐

让算力触手可及

天翼云AI产品特惠

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

中小企业服务商合作专区

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

出海产品促销专区

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

天翼云电脑专场

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

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

镜像服务

轻量型云主机

弹性高性能计算

天翼云CTyunOS系统

训推服务

一站式智算服务平台

知识库问答

是否戴口罩识别

人脸比对

推荐文档

错误日志

上传资料常见问题

分布式消息服务相关术语解释