|

公有云

Console 用户指南

控制台

API 文档

计算

云服务器镜像 SSH 密钥设备网卡

AppCenter

AppCenter 控制台应用开发平台

大数据服务

ELK 服务 OpenSearch 服务

用户服务

费用中心消息中心资源管理企业空间

存储

云硬盘备份对象存储文件存储 vNAS

容器服务

容器引擎 QKE Harbor 镜像仓库

访问与授权

访问鉴权管理 IAM 账户安全账户中心 API 密钥

网络

VPC 网络安全组网络访问控制负载均衡器私有网络路由表弹性公网 EIP NAT 网关边界路由器

数据库与缓存

关系型数据库 MySQL Plus 关系型数据库 PostgreSQL 文档数据库 MongoDB 键值数据库 Redis Standalone 键值数据库 Redis Cluster 时序数据库 ClickHouse

运维与监控

云监控 CloudSat 自动伸缩定时器标签操作日志回收站 VMware 纳管

安全服务

安全资源池

消息队列与中间件

Kafka 服务 RabbitMQ 服务 Etcd 服务 ZooKeeper 服务

开发者文档

API 文档

概述
使用规范

公共参数
计算签名
错误码

代码示例

Python3 Get 请求签名示例
Python3 Post 请求签名示例

API 列表

计算

云服务器

获取云服务器信息
创建云服务器
销毁云服务器
启动云服务器
关闭云服务器
重启云服务器
重置云服务器系统盘
修改云服务器配置
修改云服务器的名称和描述
获取支持的云服务器类型
创建远程桌面代理
删除远程桌面代理
创建云服务器组
删除云服务器组
云服务器加入指定的云服务器组
云服务器离开云服务器组
获云服务器组信息
克隆云服务器
销毁云服务器

镜像

修改镜像的名称和描述
克隆镜像
共享镜像给指定的用户
删除自有镜像
制作自有镜像
将指定备份导出为镜像
撤销共享给用户
查询镜像分享的用户列表
DescribeImages

SSH 密钥

集群关联
修改密钥对的名称和描述
创建密钥对
删除密钥对
加载密钥对
卸载密钥对
获取密钥对信息

设备

网卡

创建网卡
删除网卡
加载网卡至云服务器
将网卡从云服务器中卸载
获取网卡配置
负载均衡器的监听器添加后端服务

网络

VPC 网络

创建 SPAN
创建 VPC 网络
创建私有网络
创建路由表
获取内网域名标记和域名名称
获取 SPAN 配置
获取 VPC 网络
获取私有网络列表
获取路由表的配置信息
修改路由表配置
加入到私有网络
离开私有网络
修改 SPAN 属性
修改 VPC 网络配置
取内网域名别名列表
资源绑定路由表
SPAN 添加成员
将路由表和资源解绑
获取私有网络中的云服务器
删除 SPAN 成员
更新 VPC 网络配置
获取路由表以及资源的对应关系
修改私有网络的名称和描述
关闭 VPC 网络
启动 VPC 网络
删除私有网络
受管私有网络加入 VPC 网络
更新 SPAN 变更至云服务器
更新路由表的配置
绑定内网域名别名到资源
受管私有网络离开 VPC 网络
删除 SPAN
获取 VPC 网络管理的私有网络列表
内网域名与资源上解绑
删除 VPC 网络
删除路由表
增加 VPC 网络规则
创建路由表规则
增加 VPC 网络规则条目
获取路由表的配置信息
复制 VPC 网络规则
修改路由表规则
获取 VPC 网络规则
删除路由表规则
获取 VPC 网络规则的条目
修改 VPC 网络规则
修改 VPC 网络规则属性
删除 VPC 网络规则
删除 VPC 网络规则条目

负载均衡器

创建服务器证书
创建负载均衡器
创建负载均衡转发策略
给负载均衡器添加监听器
负载均衡器的监听器添加后端服务
获取负载均衡器信息
获取负载均衡器后端服务列表
转发策略添加规则
修改服务器证书属性
修改负载均衡器后端服务属性
更新负载转发策略
删除服务器证书
删除负载均衡器后端服务
获取负载均衡器的监听器
获取负载均衡器的转发策略
负载均衡器绑定公网 IP
将公网 IP 从负载均衡器解绑
获取转发策略规则列表
修改负载均衡监听器属性
修改负载均衡器转发策略的属性
将负载均衡器集群加入到私有网络
负载均衡监听器绑定服务器证书
修改负载均衡器转发策略规则的属性
解绑监听器上的服务器证书
负载均衡器集群离开私有网络
修改负载均衡器名称及描述
删除负载均衡器的监听器
删除负载均衡转发策略
修改负载均衡器最大连接数配置
删除负载均衡转发策略规则
更新负载均衡器
启动负载均衡器
关闭负载均衡器
删除负载均衡器

弹性公网 EIP

申请公网 IP
获取公网 IP 信息
绑定公网 IP
解绑公网 IP
变更公网 IP 带宽
变更公网 IP 计费模式
修改公网 IP 名称及描述
释放公网 IP

NAT 网关

创建 NFV
获取 NFV 信息
NFV 解绑公网 IP
NFV 绑定公网 IP
更新 NFV
调整 NFV 规格类型
启动 NFV
关闭 NFV
升级 NFV
NFV 绑定私有网络
NFV 解绑私有网络
修改 NFV 属性
修改 NFV 的安全组
删除 NFV
新增 SNAT 规则
获取 NFV 的监控数据
新增 DNAT 规则
查询 SNAT 规则
查询 DNAT 规则
更新 SNAT 规则
更新 DNAT 规则
删除 SNAT 规则
删除 DNAT 规则

边界路由器

创建边界路由器
添加边界路由器静态路由
查询边界路由器
查询边界路由器静态路由规则
配置边界路由器
修改静态路由属性
修改边界路由器属性
撤销静态路由的修改
VPC 网络关联边界路由器
删除静态路由
解除边界路由器关联的 VPC 网络
私有网络加入边界路由器
查询边界路由器关联的私有网络
私有网络离开边界路由器
删除边界路由器

存储

云硬盘

修改硬盘的名称和描述
创建硬盘
删除硬盘
加载硬盘至云服务器
卸载硬盘
硬盘扩容
获取硬盘信息

备份

修改备份的相关属性
创建备份
删除备份
回滚至指定备份点
导出备份为硬盘
导出指定备份为镜像
获取指定资源的备份

文件存储 vNAS

为共享存储目标添加硬盘
从共享存储目标卸载硬盘
修改共享存储服务器的属性
修改共享存储服务器的属性
修改共享存储服务器的类型
修改共享存储目标属性
修改权限组属性
修改用户账户属性
关闭共享存储服务器
创建 vNAS 服务访问共享目标的权限组
创建 vNAS 服务访问资源账号
创建新的共享存储服务器
删除共享存储服务器
删除共享存储目标
删除权限组
删除用户账号
启动共享存储服务器
启用共享存储目标
将访问 NFS 和 SMB 资源的用户账户和权限组进行关联
将访问 NFS 和 SMB 资源的用户账户和权限组进行解除关联
新建共享存储目标
更新共享存储服务器的配置信息
禁用共享存储目标
获取共享存储服务器
获取共享存储权限组列表
获取共享存储用户访问账号
获取共享存储目标
获取共享存储目标缺省参数

对象存储

公共字段
错误信息
签名验证
Bucket API

基础操作

PUT Bucket
HEAD Bucket
GET Bucket
DELETE Bucket
Delete Multiple Objects
GET Bucket Statistics
List Multipart Uploads

Bucket 策略（Policy）

DELETE Bucket Policy
GET Bucket Policy
PUT Bucket Policy

WORM

Put Bucket Retention
POST Bucket Retention
Get Bucket Retention

事件通知（Notification）

Delete Bucket Notification
Get Bucket Notification
Put Bucket Notification

外部镜像（External Mirror）

Delete Bucket External Mirror
Get Bucket External Mirror
Put Bucket External Mirror

存储空间访问控制控制（ACL）

GET Bucket ACL
PUT Bucket ACL

日志管理（Logging）

Delete Bucket Logging
Get Bucket Logging
Put Bucket Logging

版本管理（Versioning）

Get Bucket Version
List Object Version
Put Bucket Version

生命周期（Lifecycle）

Delete Bucket Lifecycle
Get Bucket Lifecycle
Put Bucket Lifecycle

自定义域名（CNAME）

Delete Bucket CNAME
Get Bucket CNAME
Put Bucket CNAME

跨区域复制（Replication）

Delete Bucket Replication
Get Bucket Replication
Put Bucket Replication

跨源资源共享（CORS）

Delete CORS
Get CORS
PUT CORS

对象元数据
Object API

基础操作

Copy Object
Delete Object
Fetch Object
Get Object
Head Object
Move Object
Options Object
Put Object

对象版本锁

PUT ObjectLockConfiguration
PUT Object-Lock
Get/Head Object-Lock
Initiate Multipart Upload-Lock
Delete Object-Lock

Append Object
Multipart 分段

Abort Multipart Upload
Complete Multipart Upload
Copy Object Part
Initiate Multipart Upload
List Multipart Parts
Upload Object Part

Post Object
图片处理

图片信息
图片另存
图片旋转
图片格式转换
图片水印
图片缩放
图片裁剪
文字水印

数据加密

Service API

GET Service
List Locations

安全

安全组

使用安全组备份回滚
修改安全组 IP/ 端口集合的名称和描述
修改安全组的名称和描述
修改安全组规则的优先级
创建安全组
创建安全组 IP/端口集合
创建安全组规则备份
删除安全组
删除安全组 IP/端口集合
删除安全组备份
删除安全组规则
复制 IP/端口集合
应用安全组规则
添加安全组规则
获取一个或多个IP/端口集合信息
获取一个或多个安全组信息
获取安全组的备份信息
获取某个安全组的规则信息

监控与告警

云监控

清理监控数据
清理监控数据
获取云监控数据
通过监控数据获取云服务器列表
获取监控数据
导出监控数据
获取监控数据
获取云监控数据
获取监控数据
从 Cloudsat 获取监控数据
获取监控数据
获取监控数据
获取监控数据
获取监控数据
获取监控数据
获取负载均衡器的监控信息
获取监控数据
批量获取监控数据
获取指定数据库实例的监控信息
获取监控数据
获取监控数据
获取监控数据
获取资源监控指标
通过监控数据获取云服务器列表
获取监控数据
获取监控数据
获取监控数据

告警

添加告警行为
获取告警历史信息
添加告警规则
获取告警信息
应用告警策略
获取告警服务状态
绑定告警策略
停止告警策略
创建告警策略
删除告警策略
删除告警行为
删除告警规则
获取告警策略列表
获取告警行为
查询告警策略规则信息
解绑告警策略
获取集群告警指标
获取隧道告警指标
修改告警行为
修改告警策略属性
修改告警规则
恢复删除的告警策略
重新开始告警策略
暂停告警策略

消息中心及通知列表

创建接收人联系方式
创建消息设置
发送告警通知
绑定资源通知列表
获取消息中心的消息列表
获取用户通知列表
获取通知方式对应关系信息
修改通知方式对应关系信息
创建通知联系人
删除消息设置
删除通知接收方式
发送通用通知到通知列表
授权通知列表给其他用户
删除消息接收人
发送通知
废除用户通知列表
注册通知方式对应关系
获取消息设置
获取用户联系方式
修改消息设置
取消注册通知方式对应关系
获取微信二维码
获取通知列表
发送通知列表项验证码
获取资源绑定的通知列表
解绑资源通知列表
验证通知列表项
修改通知列表属性

运维与管理

自动伸缩

启用自动伸缩策略
增加自动伸缩策略规则
创建自动伸缩策略
删除自动伸缩策略
删除自动伸缩策略规则
查询自动伸缩策略执行历史
查询自动伸缩策略
查询自动伸缩策略规则
禁用自动伸缩策略
修改自动伸缩策略

定时器

激活定时器任务
添加定时器任务
创建定时器
删除定时器任务
删除定时器
查询定时器历史
获取定时器任务列表
获取定时器列表
执行定时器任务
禁用定时器任务
修改定时器属性
修改定时器任务属性

回收站

彻底销毁资源
将资源从回收站清理掉
查询回收资源
从回收站恢复资源
同步采集可回收资源

标签

创建资源目录
绑定资源标签
创建标签
创建标签
查询资源目录
删除标签
查询资源目录
查询标签
查询资源目录
修改资源目录属性
解绑资源标签
修改标签属性
移动资源到指定目录

操作日志

创建短信任务
发送邮件通知
查询发送到用户的邮件
获取短信任务
修改短信任务
获取邮件任务
获取邮件模板
获取异步任务信息

AppCenter

云应用

从回收站恢复集群
关闭集群
切换集群网络
删除集群
删除集群节点
启动集群
彻底删除集群
纵向扩容集群
获取集群操作日志
获取集群的信息
获取集群的节点信息
获取集群节点的环境变量
获取集群节点的监控数据
重启集群服务

应用中心

应用绑定到 Bundle
创建 Bundle
删除应用
解除用户关联应用
查询应用附件信息
查询应用订单
查询用户应用
查询已上架应用列表
查询应用版本配置包/图片
查询所有应用列表
查询导入全局设置
查询待审核应用列表
用户安装部署的应用统计
查询用户安装过的应用
查询应用审核记录
查询用户安装应用统计信息
BOSS 导入应用
用户关联应用安装
修改应用信息
修改已上架应用或版本信息
从 Bundle 删除应用
应用审核非集群应用
保存 Appcenter 配置
保存导入全局配置
License 订单发货
应用提交审核

集群

添加节点
集群绑定安全组
查询集群增加节点费用
集群节点绑定公网
查询集群环境变量
清理集群/节点中间状态
查询版本环境变量配置
查询集群详情页展示
获取集群价格
集群节点解绑公网
更新集群环境变量
查询替换策略
升级集群
注册数据集群到管理集群
集群解绑安全组
设置集群状态为活跃

应用版本

撤回应用版本审核
创建应用版本
删除应用版本镜像
删除应用版本
创建集群
使用备份创建集群
共享模式创建集群
查询应用版本附件
查询应用版本列表上架或未上架
查询应用版本配置包/图片
查询应用版本依赖的镜像
查询应用版本依赖的备份
查询应用版本列表上架
查询应用版本审核记录
查询应用最新上架版本
修改应用版本信息未上架
修改应用版本信息已上架
设置应用系列最新版本
版本审核通过
应用版本重新上架
驳回版本审核
应用版本上架
应用版本提交审核
应用版本下架

应用系列

创建应用系列
删除应用系列
修改应用系列

应用补丁

创建应用补丁
修改应用补丁信息
通过应用补丁审批
驳回应用补丁审批
上架应用补丁
应用补丁提交审核
下架应用补丁

访问与授权

API 密钥

激活 API 密钥
创建 API 密钥
删除 API 密钥
查询 API 密钥
禁用 API 密钥
获取 API 密钥的私钥
禁用 API 密钥
修改 API 密钥的属性
批量创建 API 密钥

访问鉴权管理 IAM

IAM 纳管

添加 IAM 纳管 API 信息
为 IAM 纳管 API 添加标签
批量添加 IAM 纳管 API 绑定标签
添加 IAM 纳管 API 服务信息
添加 IAM 纳管服务下资源
删除 IAM 纳管 API
删除 IAM 纳管 API绑定标签
批量删除 IAM 纳管 API绑定标签
删除 IAM 纳管服务
删除 IAM 纳管服务下资源
查询 IAM 纳管 API标签信息
查询 IAM 纳管 API 信息
通过标签查询 IAM 纳管 API 信息
查询 IAM 操作日志
查询 IAM 纳管服务下资源
查询 IAM 纳管 API 服务信息
查询 IAM 纳管服务与资源的映射关系
修改 IAM 纳管 API 属性
修改 IAM 纳管服务属性
修改 IAM 纳管服务下资源属性
发布 IAM 纳管服务
同步 IAM 纳管服务属性到纳管 API

IAM 身份

为资源绑定 IAM 身份
创建 IAM 身份
删除 IAM 身份
查询 IAM 身份关联资源
查询 IAM 身份绑定的资源
查询 IAM 身份
查询资源绑定的 IAM 身份
查询关联 IAM 身份
为资源解绑 IAM 身份
获取账号下身份 Profile
获取APP单点登录 Token
查询 IAM 身份关联资源
修改 IAM 身份信息
替换资源的 IAM 身份
保存账号下身份 Profile
切换 IAM 身份

IAM 策略

关联 IAM 策略
创建 IAM 策略
删除 IAM 策略
删除 IAM 策略版本
查询 IAM 策略
查询 IAM 策略
查询 IAM 策略版本
查询信任策略
取消关联 IAM 策略
复制 IAM 策略
修改 IAM 策略
应用草稿为默认版本
策略模拟

IAM 用户组

创建 IAM 用户组
新增 IAM 用户组成员
删除 IAM 用户组成员
删除 IAM 用户组
查询 IAM 用户组成员
查询 IAM 用户组
查询账号拥有的 IAM 用户组
修改 IAM 用户组

IAM 用户

创建 IAM 用户
绑定资源到 IAM 用户创建资源
创建 IAM 用户登录会话，获取 SK 登录凭证
删除 IAM 用户资源绑定关系
删除 IAM 用户
查询 IAM 用户创建的资源
查询 IAM 用户
修改 IAM 用户信息
修改 IAM 用户绑定资源状态

主机 IAM 配置

设置主机 IAM 配置区域 ID
刷新主机 IAM 配置

账号服务

用户

增加用户登录历史记录
更换登录邮箱
更换登录密码
检查账户绑定状态
检查更换通知邮箱的凭证
检查重置密码的凭证
确认邮箱
确认邮箱验证码
创建子用户
创建子用户会话
创建新用户
删除子用户
删除用户
查询用户 IAM 域名
查看子用户信息
查询用户账户安全设置
查询用户
查询用户登录历史记录
授予用户区域访问权限
初始化密码
初始化用户信息
修改用户 IAM 域名
修改子用户的属性
修改用户属性
修改用户账户安全设置
修改用户区域权限
取消用户区域访问权限
重置密码
恢复子用户
恢复用户
发送更换通知邮箱凭证
发送确认邮件
发送邮箱验证码
发送重置密码的凭证

用户认证

应用用户认证
获取用户认证信息
修改用户认证属性
通过用户认证
拒绝用户认证
回滚用户认证

用户锁

修改账户锁密码
检查账户锁
检查重置账户锁令牌
创建账户锁
获取账户锁
锁定账户
修改账户锁属性
重置账户锁密码
颁发重置账户锁令牌
解锁账户

用户会话

检查用户会话
创建用户会话
创建用户多重认证会话
删除用户会话
查询用户拒绝登录状态
移除拒绝登录限制

单点登录

检查单点登录访问凭证
创建授权码
创建单点登录访问凭证
创建第三方 APP
创建用户授权
删除第三方 APP
删除用户授权
查询第三方 APP
查询用户授权
修改第三方 APP 属性
刷新单点登录访问凭证

Console

创建 Console
创建 Console 密钥
删除 Console
删除 Console 密钥
查看 Console 密钥信息
查看 Console 信息
修改 Console 属性
修改 Console 密钥的属性

第三方登录服务

创建第三方登录账户
创建第三方登录账号关联用户
创建第三方登录服务器
删除第三方登录账号关联用户
删除第三方登录账户
删除第三方登录服务器
查询第三方登录账号关联用户
查询第三方登录账户
查询第三方登录服务器
登录服务器认证
修改第三方登录账户属性
修改第三方登录账号关联用户属性
修改第三方登录服务器属性
解绑第三方登录账户

用户附件

删除用户公共附件
查询用户公共附件
修改用户公共附件属性
上传用户公共附件

账户配额

撤销子帐号的独立配额权限
查询配额
给子账户授权独立配额
获取主账号的配额
获得当前账号的剩余配额
查询账户配额剩余
修改配额

用户偏好

获取用户偏好
修改用户偏好

其他

账号服务巡检

资源

资源共享

检查需要添加共享的用户是否存在
创建共享单元
删除共享单元
查询共享单元
查询共享单元资源
查询共享单元成员
查询共享给我的单元
移除共享成员
移除共享资源
更新共享单元

配额

查询用户配额使用情况
查询用户资源统计
查询用户配额剩余情况

资源协作

修改用户组属性
修改用户组成员属性
修改角色属性
修改角色规则属性
修改资源组属性
创建用户组
创建角色
创建资源组
删除用户组
删除用户组成员
删除角色
删除角色里的规则
删除资源组
取消资源组对用户组的授权
增加角色的规则
将资源从资源组里删除
将资源加入到资源组中
将资源组授权给用户组
查询共享给自己的资源组
查询用户组信息
查询用户组成员信息
查询角色
查询角色的规则
查询资源组与用户组的授权关系
查询资源组信息
查询资源组里面的资源
添加用户组成员

费用中心

激活资源的租赁信息
获取资源的促销记录信息
查询用户是否充值过
初始化用户余额信息
扣除用户的激励金额
查询促销活动每日剩余额度
获取促销产品信息
获取用户的逾期配置信息
获取应付欠款信息
查询用户余额
获取指定租赁合同信息
获取单个资源扣费信息
批量获取扣费信息
查询用户的所有租赁信息
获取资源价格
扣费
加载价格
修改自动续费
修改下个周期计费模式
充值
重新加载扣费信息
恢复用户欠费资源
取消合约
设置续费
终止非弹性计费资源
取消扣费

消息中心

查询消息中心用户 ID
查询用户站内信消息
标记用户站内信所有消息已读
标记用户站内信消息已读

其他

上传压缩包类型的 User Data
获取可访问的区域列表
证书

查询证书
取消证书
注册证书

公共附件

删除一般附件
查询一般附件
修改一般附件属性
上传一般附件

附录

云服务器类型
云硬盘类型
ICMP 类型及代码

API 文档

学习路径

了解

介绍

概述