使用前必读

概述

欢迎使用弹性云服务器（Elastic Cloud Server ，ECS）。弹性云服务器是由CPU、内存、镜像、云硬盘组成的一种可随时获取、弹性可扩展的计算服务器，同时它结合虚拟私有云、虚拟防火墙、数据多副本保存等能力，为您打造一个高效、可靠、安全的计算环境，确保您的服务持久稳定运行。弹性云服务器创建成功后，您就可以像使用自己的本地PC或物理服务器一样，在云上使用弹性云服务器。

本文档提供了弹性云服务器API的描述、语法、参数说明及示例等内容。支持的全部操作请参见API概览。

在调用ECS API之前，请确保已经充分了解ECS相关概念，详细信息请参见弹性云服务器的“产品介绍”。

调用说明

弹性云服务器提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。

您可以在API Explorer中调用API，查看API请求和返回结果。此外，API Explorer会自动生成相应API调用示例，帮助您使用API。

终端节点

终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询服务的终端节点。

约束与限制

• 您能创建的ECS资源的数量与配额有关系，如果您想查看服务配额、扩大配额，具体请参见“调整资源配额”。
• 更详细的限制请参见具体API的说明。

基本概念

• 账号

  用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。

• 用户

  由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

  在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。

• 区域（Region）

  从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。

  详情请参见区域和可用区。

• 可用区（AZ，Availability Zone）

  一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

• 项目

  区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。

  图1 项目隔离模型
  

  同样在我的凭证下，您可以查看项目ID。

• 企业项目

  企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。

  关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

分页查询

OpenStack API提供分页查询功能，通过在查询列表请求的url中添加limit和marker参数实现分页返回列表信息。参数说明见下表，分页显示的结果以显示对象的创建时间(create_time)升序排序，如果对象信息没有创建时间，则用对象的ID升序排序。

响应消息中的next ref，代表了下一页的url。