接口说明
本产品提供了云主机功能的API接口，接口采用REST风格，接口请求通过HTTPS安全通道发送。
更新记录
|
日期 |
变更接口 |
变更说明 |
兼容性说明 |
|---|---|---|---|
|
2025-10-14 |
openapi2.0升级试点上线 |
OpenAPI 2.0在专有名词规范性、接口设计规范性、用户友好性、响应效率、服务稳定性等方面全方位提升。 |
2.0与1.0版本独立，且sdk独立 |
|
2025-10-9 |
openapi1.0迭代完成 | 包含生命周期管理、状态管理、密码密钥管理、网络管理等。 | 2.0与1.0版本独立，且sdk独立 |
相关概念
API
API（Application Programming Interface，应用编程接口）是软件（应用）中的一系列特性和规则，这些特性和规则允许其他软件与之交互（与用户界面相对）。API 可被视为提供它的应用与其他软硬件之间的一个简单的合约（接口）。在 Web 开发中，API 通常是开发者能用在应用（app）中的一系列代码特性（如方法、属性、事件和URL），这些特性被用于与用户的 web 浏览器中的组件、用户电脑上的其他软硬件或者第三方软件与服务交互。
REST与RESTful
REST（Representational State Transfer，表述性状态转移）是Roy Fielding博士于2000年在其博士论文中提出的一种软件架构风格，具备“客户-服务器”、“无状态”、“缓存”、“统一接口”、“分层系统”、“按需代码”等架构特征。基于REST理念设计的软件接口，我们称之为RESTful（REST风格的）接口。
URI与HTTP方法
REST架构核心理念是将信息抽象为资源，URI（Universal Resource Identifier，统一资源标识符）即用于表述资源，通常由名词组成。HTTP方法表示对资源的操作，常用的有GET、 POST、 PUT、DELETE等操作。
阅读指引
|
章节名称 |
阅读指引 |
|---|---|
|
使用前必读 |
使用API接口前请充分了解API所在的地域和接入地址、鉴权方式、构造请求的方式、使用前提和约束，这些内容将直接影响接口调用是否成功。 |
|
API概览 |
通过浏览API概览您可以快速定位到所需接口，对于有经验的使用者可以通过本页直接调用接口。 |
|
接口分类介绍 |
详细描述接口的请求参数和响应参数，提供调用代码demo，初学者可以通过本章了解接口的所有细节。 |
|
应用示例 |
提供基于实际场景的，多种接口组合应用的使用案例。 |