简介

最近更新时间:2018-08-17 17:02:05

云服务器 API 升级到 3.0 版本,全新的 API 接口文档更加规范和全面,统一的参数风格和公共错误码,统一的 SDK/CLI 版本与 API 文档严格一致,给您带来简单快捷的使用体验;支持全地域就近接入让您更快连接腾讯云产品。

欢迎使用云服务器(Cloud Virtual Machine)。

腾讯云服务器(Cloud Virtual Machine,以下简称 CVM)运行在腾讯数据中心,它提供了可以弹性伸缩的计算服务,可以根据业务需要来构建和托管软件系统。

云服务器向用户提供弹性的计算、存储和网络资源。用户可以使用本文档介绍的 API,并参照相应的示例,对云服务器进行相关操作:如创建、销毁、更改带宽、重启等;支持的全部操作可参见 API 概览

请确保在使用这些接口前,已充分了解了 CVM 概述

注意:

  • 本模块底下的云服务器接口,均为改版后的 API3.0 接口,后续 CVM 相关的所有新增功能都会在此模块底下的接口里面增加。我们 推荐新用户使用改版后的 API3.0 接口。
  • 现有旧接口的功能依然保持,对于使用旧接口的用户详情可参见:云服务器 API(旧版)简介

术语表

本文档涉及的一些常用术语如下:

术语 全称 中文 说明
Instance Instance 实例 指代一台云服务器。
Region Region 地域 表示资源所在的地域,每个地域包含一个或多个可用区。
Zone Zone 可用区 指腾讯云在同一 地域 内电力和网络互相独立的物理数据中心。目标是能够保证可用区之间故障相互隔离,不出现故障扩散,使得用户的业务持续在线服务。
Image Image 镜像 CVM实例上软件环境的拷贝,一般包括操作系统和已安装的软件;我们使用镜像来创建实例。
SecurityGroup Security Group 安全组 一种有状态的包过滤功能的虚拟防火墙,用于控制CVM实例的网络访问, 是一种重要的网络安全隔离手段。
EIP Elastic IP 弹性IP 弹性IP是公网IP的一种。与普通公网IP不同的是,弹性IP归属于用户账户而不是实例;实例与公网IP的映射关系随时可以更改。
包年包月 一种计费模式,参看 计费模式说明
按量计费 一种计费模式,参看 计费模式说明

输入参数与返回参数释义

  • Limit 和 Offset

    用来控制分页的参数;Limit 为单次返回的最多条目数量,Offset 为偏移量。当相应结果是列表形式时,如果数量超过了 Limit 所限定的值,那么只返回 Limit 个值。

    举例来说,参数 Offset=0&Limit=20 返回第 0 到 20 项,Offset=20&Limit=20 返回第 20 到 40 项,Offset=40&Limit=20 返回第 40 到 60 项;以此类推。

  • Ids.N

    同时输入多个参数的格式。当遇到形如这样的格式时,那么该输入参数可以同时传多个。例如:

    Ids.0=10.12.243.21&Ids.1=10.11.243.21&Ids.2=10.12.243.21&Ids.3=10.13.243.21...

    以此类推(以下标 0 开始)。

API 快速入门

这里针对几个典型的使用场景对 CVM API 的使用方式进行说明:

  1. 通过使用 创建实例 API,提供可用区 ID、镜像 ID、机型参数等一些必要的信息,即可立刻创建一个按量计费的实例。

  2. 如需修改配置,可以使用 调整实例配置 API 调整为更高的配置。通过调整实例的机型来实现CPU和内存的变更。

  3. 如需关闭实例,可以使用 关闭实例 API。

  4. 在不使用此实例时使用 退还实例 API 销毁它。退还实例后,将不再收费。

使用限制

  • API 创建的机器遵循 CVM实例购买限制 文档所描述的数量限制,和官网所创建的机器共用配额。

  • 更具体的限制请参考对应 API 接口文档或产品文档。