使用前必读
概述
欢迎使用云搜索服务（Cloud Search Service，简称CSS）。云搜索服务为您提供托管的分布式搜索引擎服务，完全兼容开源Elasticsearch搜索引擎，支持结构化、非结构化文本的多条件检索、统计、报表。
本文档提供了云搜索服务API的描述、语法、参数说明及样例等内容。云搜索服务提供了集群管理接口、词库管理接口和快照管理接口，通过配合使用这些接口，您可以轻松地对云搜索服务进行相关操作，如创建、查询、删除、重启、扩容集群等。
在调用云搜索服务的API之前，请确保已经充分了解云搜索服务相关概念，详细信息请参见什么是云搜索服务。
支持的版本
云搜索服务中Elasticsearch搜索引擎目前支持7.6.2和7.10.2版本，OpenSearch搜索引擎目前支持1.3.6版本，Logstash目前支持7.10.0版本。
约束与限制
- 您能创建的CSS集群数量与配额有关系，如果您想查看服务配额、扩大配额，具体请参见服务配额。
- 更详细的限制请参见具体API说明。
基本概念
- 账号
用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。
- 用户
由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。
在API凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。
- 区域
指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。
- 可用区
一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。
- 项目
区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。
图1 项目隔离模型
- Checkpoint：消费检查点。应用程序消费数据时，记录已消费数据的最新序列号作为检查点。当重新消费数据时，可根据此检查点继续消费。
- APP：应用程序标识符。当多个应用程序分别消费同一通道的数据时，为区分不同应用程序的消费检查点，使用APP作为标识。
- 企业项目
企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。
