黑石物理服务器1.0 简介 - API 文档

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

欢迎使用腾讯云黑石服务器（Cloud Physical Machine）。

腾讯云黑石服务器（Cloud Physical Machine，以下又称CPM）运行在腾讯数据中心，它提供了可以弹性伸缩的计算服务，可以根据业务需要来构建和托管软件系统。

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

请确保在使用这些接口前，已充分了解了黑石物理服务器。

1. 术语表

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

输入参数与返回参数释义

• limit 和 offset

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

  举例来说，参数 offset=0&limit=20 返回第0到20项，offset=20&limit=20 返回第20到40项，offset=40&limit=20 返回第40到60项；以此类推。

• id.n

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

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

  以此类推（以下标0开始）。

2. API快速入门

CPM API的使用方式这里针对几个典型的使用场景来说明：

1. 通过使用 购买服务器 API，提供可用区ID、OS类型、服务器机型等一些必要的信息，即可立刻创建一个按量计费的黑石服务器。
2. 如需关闭服务器，可以使用 关闭服务器 API。关闭后，服务器将不再运行。

3. 使用限制

• CPM API 调用配额为：1000次/分钟；且单一API不超过100次/分钟。

• 更具体的限制请参考每个API接口文档或是产品文档。