华为云用户手册

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 CSS.0001 参数错误。 参数错误。 根据具体提示信息修改参数。 400 CSS.0006 请求为空，请输入请求参数。 请求为空，请输入请求参数。 根据错误信息，输入请求参数。 400 CSS.0017 参数大小写错误。 参数大小写错误。 请根据命名规则重新填写。 400 CSS.0021 帐户冻结。 帐户冻结。 请联系技术支持。 400 CSS.0026 日志内容过大。 日志内容过大。 请联系技术支持。 400 CSS.0036 内部错误。 内部错误。 请稍后重试或联系技术支持。 400 CSS.0047 集群不存在或已删除。 集群不存在或已删除。 集群已经不存在，无法进行操作。 400 CSS.0048 OBS桶不存在。 OBS桶不存在。 请检查OBS桶是否还存在或有访问该桶权限。 400 CSS.0050 集群管理员密码不合法。 集群管理员密码不合法。 请根据接口参考描述，重新设置密码。 400 CSS.0051 当前策略不允许#actionName#执行。 当前策略不允许#actionName#执行。 请为帐户配置相关权限。 400 CSS.0052 CPU资源不足。 CPU资源不足。 建议释放掉不用的集群、减少创建CPU个数、扩充配额。 400 CSS.0053 节点资源不足。 节点资源不足。 建议释放不用的集群、减小新节点个数、扩充配额。 400 CSS.0054 内存资源不足。 内存资源不足。 建议释放掉不用的集群、减少需要修改的内存大小、扩充配额。 400 CSS.0055 磁盘数量资源不足。 磁盘数量资源不足。 建议释放掉不用的集群、减少创建磁盘大小、扩充配额。 400 CSS.0060 磁盘容量资源不足。 磁盘容量资源不足。 建议释放不用的资源、减小所需磁盘容量大小、扩充配额。 400 CSS.0061 弹性IP资源不足。 弹性IP资源不足。 建议释放不用的资源、扩充配额。 400 CSS.0062 弹性负载均衡资源不足。 弹性负载均衡资源不足。 建议释放不用的资源、扩充配额。 400 CSS.0063 终端节点资源不足。 终端节点资源不足。 建议释放不用的资源、扩充配额。 400 CSS.0064 子网ip地址不足。 子网ip地址不足。 建议释放不用的资源、扩充配额。 400 CSS.0065 磁盘已售罄。 磁盘已售罄。 请联系技术支持。 400 CSS.0066 密码不合法。 密码不合法。 请根据接口参考描述，重新设置密码。 400 CSS.0068 规格已售罄。 规格已售罄。 请释放不用的资源。 400 CSS.0069 磁盘已售罄。 磁盘已售罄。 请释放资源，或扩充配额。 400 CSS.0070 不支持对接企业项目。 不支持对接企业项目。 该局点不支持企业项目。 400 CSS.0071 带宽大小不合法。 带宽大小不合法。 请根据错误信息修改带宽大小。 400 CSS.0072 创建SMN委托失败,请查看账号是否有创建SMN委托的权限。 创建SMN委托失败,请查看账号是否有创建SMN委托的权限。 为帐户授权。 400 CSS.0074 数据节点(包括冷节点)个数应大于等于3个。 数据节点(包括冷节点)个数应大于等于3个。 为集群扩容，或取消副本校验。 400 CSS.0075 不能变更为目标规格。 不能变更为目标规格。 目标规格需要小于原规格。 400 CSS.0076 节点角色type非法。 节点角色type非法。 请根据接口参数描述，确认type类型。 400 CSS.0077 集群处于扩容或缩容状态。 集群处于扩容或缩容状态。 等待集群状态正常后再进行其他操作。 400 CSS.0078 目标集群状态不满足升级要求。 目标集群状态不满足升级要求。 保证当前集群状态正常。 400 CSS.0080 默认委托已经存在，确保权限无误后，可以正常使用。 默认委托已经存在，确保权限无误后，可以正常使用。 请确保帐户拥有相关权限。 400 CSS.0081 创建委托失败,请查看账号是否有创建委托的权限。 创建委托失败,请查看账号是否有创建委托的权限。 为帐户授相关权限。 400 CSS.0082 记录不存在。 记录不存在。 请联系技术支持。 400 CSS.0083 存在未备份的索引，请到集群快照模块进行全量索引备份。 存在未备份的索引，请到集群快照模块进行全量索引备份。 请到集群快照模块进行全量索引备份。 400 CSS.1111 扩容参数不合法。 扩容参数不合法。 检查扩容参数。 400 CSS.1119 kibana公网访问已经存在。 kibana公网访问已经存在。 请勿重复绑定kibana公网访问。 400 CSS.1120 kibana公网访问不存在。 kibana公网访问不存在。 请绑定Kibana公网访问。 400 CSS.1122 安全模式转换,需要先关闭公网访问再重试。 安全模式转换,需要先关闭公网访问再重试。 根据错误信息关闭公网访问。 400 CSS.1123 安全模式转换,请先关闭kibana公网访问再重试。 安全模式转换,请先关闭kibana公网访问再重试。 根据错误信息关闭Kibana公网访问。 400 CSS.2026 这是一个弱密码，请输入一个强度大一些的密码。 这是一个弱密码，请输入一个强度大一些的密码。 请根据错误信息，增强密码强度。 400 CSS.3011 保留天数不合法。 保留天数不合法。 保留天数在1到90天的正整数。 400 CSS.3016 备份文件正在删除中，请您稍后再进行操作。 备份文件正在删除中，请您稍后再进行操作。 等待备份文件删除结束后再进行操作。 400 CSS.3026 备份文件不存在。 备份文件不存在。 内部错误，请联系技术支持。 400 CSS.3030 新实例卷大小不得小于旧实例卷大小。 新实例卷大小不得小于旧实例卷大小。 根据提示信息修改参数值。 400 CSS.5002 数据库类型不合法。 数据库类型不合法。 暂时只支持ElasticSearch类型。 400 CSS.5003 数据库版本不合法。 数据库版本不合法。 Elasticsearch搜索引擎和Kibana目前支持7.6.2和7.10.2版本。 400 CSS.5004 datastore字段为空。 datastore字段为空。 请补充datastore字段信息。 400 CSS.5005 不支持的数据库类型或版本。 不支持的数据库类型或版本。 Elasticsearch搜索引擎和Kibana目前支持7.6.2和7.10.2版本。 400 CSS.5006 所选规格不合法。 所选规格不合法。 请根据接口参数描述，查看所需要的规格。 400 CSS.5007 所选规格不存在。 所选规格不存在。 请根据接口参数描述，查看所需要的规格。 400 CSS.5008 卷类型不合法。 卷类型不合法。 请输入正确的卷类型。 400 CSS.5009 卷大小超出允许范围。 卷大小超出允许范围。 请输入正确的范围。 400 CSS.5011 可用区不合法。 可用区不合法。 请输入正确的可用区。 400 CSS.5017 自动备份保留天数无效。 自动备份保留天数无效。 自动备份保留天数为1到90天。 400 CSS.5018 自动备份周期无效。 自动备份周期无效。 只支持整点，后面需加上时区，格式为“HH:mm z” 400 CSS.5020 自动备份开始时间不合法。 自动备份开始时间不合法。 请根据接口参数描述，设置合法备份时间。 400 CSS.5033 卷大小不是10的整数倍。 卷大小不是10的整数倍。 扩容是volume必须是4和10的倍数。 400 CSS.5036 Datastore不存在。 Datastore不存在。 暂只支持Elasticsearch类型。 400 CSS.5037 参数不存在。 参数不存在。 根据对应的api参考确认参数范围。 400 CSS.5038 参数值超出范围。 参数值超出范围。 根据提示信息修改参数值。 400 CSS.5039 参数重复。 参数重复。 请删除重复的参数。 400 CSS.5044 备份前缀名称设置不合法。 备份前缀名称设置不合法。 请根据接口参数描述，重新设置备份前缀。 400 CSS.5046 NICS为空。 NICS为空。 补充NICS（VPC、子网相关信息）。 400 CSS.5047 实例个数不合法。 实例个数不合法。 请根据接口参数描述，确认合法参数范围。 400 CSS.5048 扩展参数不合法。 扩展参数不合法。 内部错误，请联系技术支持。 400 CSS.5049 集群名不合法。 集群名不合法。 请重新修改集群名称。 400 CSS.5050 集群名已经存在。 集群名已经存在。 请重新修改集群名称。 400 CSS.5051 IP取值不合法。 IP取值不合法。 检查并输入正确的IP。 400 CSS.5052 可用区取值不合法。 可用区取值不合法。 检查并输入正确的可用区。 400 CSS.5055 所选规格ID取值不合法。 所选规格ID取值不合法。 请根据接口参数描述，重新修改规格ID。 400 CSS.5056 字符串长度不合法。 字符串长度不合法。 请根据具体提示信息判断字符长度范围。 400 CSS.5057 集群名称含不合法字符或长度不合法。 集群名称含不合法字符或长度不合法。 请重新修改集群名称。 400 CSS.5059 数据库用户名不合法。 数据库用户名不合法。 当前仅支持elasticsearech。 400 CSS.5061 Volume 类型违规。 Volume 类型违规。 请根据API参考确认volume类型是否合规。 400 CSS.5063 Specific 字段无效。 Specific 字段无效。 内部错误，请联系技术支持。 400 CSS.5068 硬盘参数不合法。 硬盘参数不合法。 请联系技术支持。 400 CSS.5069 节点个数不合法。 节点个数不合法。 请根据接口参数描述，重新配置节点个数。 400 CSS.5073 该类型的实例不允许单独重启。 该类型的实例不允许单独重启。 请勿选自资源中不包含的类型。 400 CSS.5074 子网不属于vpc 子网不属于vpc 请确认并输入正确的子网参数。 400 CSS.5077 集群名不合法。 集群名不合法。 请重新修改集群名称。 400 CSS.5078 磁盘大小违规。 磁盘大小违规。 请根据接口参数描述，确认磁盘大小范围。 400 CSS.5087 同一实例类型不满足磁盘一致性。 同一实例类型不满足磁盘一致性。 内部错误，请联系技术支持。 400 CSS.5088 SSL非全局一致。 SSL非全局一致。 内部错误，请联系技术支持。 400 CSS.5090 此状态下不允许当前操作。 此状态下不允许当前操作。 请根据错误信息，处理之后再进行操作。 400 CSS.5091 节点个数达到最大值，请联系管理员处理。 节点个数达到最大值，请联系管理员处理。 请重新调整节点个数。 400 CSS.5092 硬盘信息不合法。 硬盘信息不合法。 内部错误，请联系技术支持。 400 CSS.5093 节点规格信息不合法。 节点规格信息不合法。 请根据获取实例规格列表接口获取对应的节点规格。 400 CSS.5094 节点扩容类型不合法。 节点扩容类型不合法。 请检查并输入合规的节点类型。 400 CSS.5095 当前实例类型不支持此操作。 当前实例类型不支持此操作。 本地磁盘不支持该操作。 400 CSS.5098 EIP绑定类型不合法。 EIP绑定类型不合法。 请根据接口参数描述，确认EIP绑定类型。 400 CSS.5106 实例类型不合法。 实例类型不合法。 请输入正确实例类型。 400 CSS.5107 集群模式不合法。 集群模式不合法。 内部错误，请联系技术支持。 400 CSS.5110 同类型实例参数组不一致。 同类型实例参数组不一致。 内部错误，请联系技术支持。 400 CSS.5111 备份文件ID不存在。 备份文件ID不存在。 请联系技术支持。 400 CSS.5130 委托名称不合法。 委托名称不合法。 请根据错误信息，判断具体操作。 400 CSS.5134 master总节点个数需要为奇数。 master总节点个数需要为奇数。 请根据错误信息修改参数。 400 CSS.5135 磁盘大小需要为20的倍数。 磁盘大小需要为20的倍数。 请根据错误信息修改参数。 400 CSS.5137 标签key不合法。 标签key不合法。 请根据错误信息，修改该参数。 400 CSS.5138 标签value不合法。 标签value不合法。 请根据错误信息，修改该参数。 400 CSS.5140 该集群不支持此操作。 该集群不支持此操作。 当前集群不支持该操作，待集群状态正常后再进行操作。 400 CSS.5141 标签不存在。 标签不存在。 请确保请求体中的标签属于该集群。 400 CSS.5158 公网访问只有在绑定状态下才能进行解绑操作。 公网访问只有在绑定状态下才能进行解绑操作。 请确认公网访问绑定状态。 400 CSS.5159 公网访问只有在解绑状态下才能进行绑定操作。 公网访问只有在解绑状态下才能进行绑定操作。 请确认公网访问绑定状态。 400 CSS.5160 公网IP绑定出错,请重试。 公网IP绑定出错,请重试。 请稍后重试或联系技术支持。 400 CSS.5164 更新公网访问白名单出错,请重试。 更新公网访问白名单出错,请重试。 请稍后重试或联系技术支持。 400 CSS.5167 没有选择数据节点。 没有选择数据节点。 请至少选择一个数据节点。 400 CSS.5169 所选版本不支持安全模式。 所选版本不支持安全模式。 详情参考安全模式的用户指南。 400 CSS.5170 本地盘规格不需要配置volume参数。 本地盘规格不需要配置volume参数。 根据错误信息删除volume参数。 400 CSS.5171 httpsEnable设置为true的情况下authorityEnable不能设置为false。 httpsEnable设置为true的情况下authorityEnable不能设置为false。 httpsEnable设置为true的情况下authorityEnable不能设置为false。 400 CSS.5172 实例个数需要大于等于可用区个数。 实例个数需要大于等于可用区个数。 请增加实例个数。 400 CSS.5174 Vpc信息获取失败，请稍后重试。 Vpc信息获取失败，请稍后重试。 请确保VPC存在，且网络正常。 400 CSS.5177 缺少https enable。 缺少https enable。 httpsEnable为必选参数。 400 CSS.5178 时区不合法。 时区不合法。 请根据接口参数描述，重新修改时区格式。 400 CSS.5180 没有开启Kibana公网访问。 没有开启Kibana公网访问。 打开Kibana公网访问。 400 CSS.5181 白名单不存在。 白名单不存在。 当前白名单为空，请添加后再进行相关操作。 400 CSS.5182 终端节点服务没有开启。 终端节点服务没有开启。 请开启终端节点服务后再进行相关操作。 400 CSS.5300 包年/包月集群不允许此操作。 包年/包月集群不允许此操作。 禁止该操作。 400 CSS.5301 集群已冻结，禁止此操作。 集群已冻结，禁止此操作。 如果因欠费冻结，续费即可。因其他原因冻结，请联系技术支持。 400 CSS.5302 订购周期类型不合法。 订购周期类型不合法。 请根据接口参数描述，修改订购周期类型参数。 400 CSS.5303 订购周期数不合法。 订购周期数不合法。 请根据接口参数描述，修改订购周期参数。 400 CSS.5304 自动续费参数不合法。 自动续费参数不合法。 请根据接口参数描述，修改续费参数。 400 CSS.5305 自动支付参数不合法。 自动支付参数不合法。 请根据接口参数描述，修改自动支付参数。 400 CSS.5306 存在未支付的订单。 存在未支付的订单。 支付该订单，或取消该订单。 400 CSS.5307 存在处理中的订单。 存在处理中的订单。 等待订单处理完成。 400 CSS.5308 带宽超过限额。 带宽超过限额。 缩小带宽大小。 400 CSS.5310 httpsEnable为false，无法开启公网访问，authorityEnable为false无法开启kibana公网访问。 httpsEnable为false，无法开启公网访问，authorityEnable为false无法开启kibana公网访问。 根据错误信息开启相关功能。 400 CSS.5312 包周期集群不支持节点和磁盘同时扩容。 包周期集群不支持节点和磁盘同时扩容。 不支持该操作。 400 CSS.5313 终端节点权限不足，请检查用户是否有VPCEndpoint Administrator角色。 终端节点权限不足，请检查用户是否有VPCEndpoint Administrator角色。 根据错误信息，检查相关权限。 400 CSS.6000 创建集群失败，请联系技术支持或者稍后重试。 创建集群失败，请联系技术支持或者稍后重试。 请稍后重试，如果仍然失败，请联系技术支持。 400 CSS.6001 扩容集群失败，请联系技术支持或者稍后重试。 扩容集群失败，请联系技术支持或者稍后重试。 请稍后重试，如果仍然失败，请联系技术支持。 400 CSS.6003 恢复集群失败，请联系技术支持或者稍后重试。 恢复集群失败，请联系技术支持或者稍后重试。 请稍后重试，如果仍然失败，请联系技术支持。 400 CSS.6004 创建节点失败，原因：ECS异常，错误码#failedReason#! 请联系技术支持或稍后重试。 创建节点失败，原因：ECS异常，错误码#failedReason#! 请联系技术支持或稍后重试。 请稍后重试，如果仍然失败，请联系技术支持。 400 CSS.6009 快照创建失败，请联系技术支持或者稍后重试。 快照创建失败，请联系技术支持或者稍后重试。 请稍后重试，如果仍然失败，请联系技术支持。 400 CSS.6012 恢复快照失败，因为OBS对象不存在或已被删除。 恢复快照失败，因为OBS对象不存在或已被删除。 请检查OBS桶否存在。 400 CSS.6013 集群正在进行其它操作，无法修改参数。 集群正在进行其它操作，无法修改参数。 请确保集群处于可用状态时，再进行修改参数操作。 400 CSS.6014 设置的参数中包含不可修改的参数。 设置的参数中包含不可修改的参数。 请检查提交的修改参数请求中，是否含有不可修改的参数值，将对应参数删除后重试操作。 400 CSS.6015 设置的参数不满足YAML格式。 设置的参数不满足YAML格式。 请修改参数格式后重试操作。 403 CSS.0010 实例ID和用户ID可能为空，或者操作越权。 实例ID和用户ID可能为空，或者操作越权。 请检查账号权限。 403 CSS.0015 访问资源不存在，或者无访问权限。 访问资源不存在，或者无访问权限。 权限不足，添加权限后再操作。 403 CSS.5045 当前租户不允许操作。 当前租户不允许操作。 确认租户是否冻结或是否有相关权限。 404 CSS.0002 CSS不存在。 CSS不存在。 检查权限以及资源是否存在。 404 CSS.0007 请检查数据库，确认实例的虚拟机信息，找不到该实例的虚拟机信息。 请检查数据库，确认实例的虚拟机信息，找不到该实例的虚拟机信息。 请稍后重试或联系技术支持。 404 CSS.0016 未找到资源。 未找到资源。 根据提示信息判断资源是否存在。 404 CSS.0022 实例不存在或已删除。 实例不存在或已删除。 请确保资源是否存在。 404 CSS.0028 对象不存在。 对象不存在。 根据具体提示信息判断，当前资源是否存在。 404 CSS.1103 该实例不存在！ 该实例不存在！ 请确认集群是否存在。 404 CSS.3027 集群不存在！ 集群不存在！ 集群不存在，请勿对该集群进行任何操作。 404 CSS.5012 Region或可用区不存在。 Region或可用区不存在。 请输入正确的Region或可用区。 404 CSS.5021 Vpc不存在，或不属于该用户。 Vpc不存在，或不属于该用户。 确保VPC存在，且属于该用户。 404 CSS.5022 子网不存在，或不属于该vpc。 子网不存在，或不属于该vpc。 检查并属于属于VPC下的子网。 404 CSS.5023 安全组不存在，或不属于该vpc。 安全组不存在，或不属于该vpc。 检查并输入属于VPC下的安全组。 404 CSS.5042 源实例不存在。 源实例不存在。 请求体中包含集群中不存在的实例。 409 CSS.0011 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 操作冲突，等待集群状态恢复后再操作。 409 CSS.0012 该实例有备机，不能进行该操作。 该实例有备机，不能进行该操作。 等待集群备份结束后进行操作 409 CSS.0029 对象正在创建中，请稍等。 对象正在创建中，请稍等。 集群或快照正在创建，请勿进行其他操作。 409 CSS.0031 对象已存在。 对象已存在。 请重新修改对象名称。 409 CSS.0043 快照名已存在。 快照名已存在。 请重新修改快照名称。 409 CSS.1102 实例名称已存在。 实例名称已存在。 请重新修改实例名称。 409 CSS.3004 正在备份中，请稍等。 正在备份中，请稍等。 根据错误信息，等待集群状态成功后，再进行操作。 413 CSS.0030 快照数量达到配额。 快照数量达到配额。 建议释放掉无需备份的资源。 413 CSS.1112 实例数量达到配额。 实例数量达到配额。 请联系技术支持。 415 CSS.0004 操作不合法。 操作不合法。 根据错误信息，修改该参数。 415 CSS.5108 不支持该操作。 不支持该操作。 不支持该操作。 419 CSS.0023 资源不足。 资源不足。 请联系技术支持。 422 CSS.0040 参数无法处理。 参数无法处理。 请稍后重试或联系技术支持。 500 CSS.0005 服务器错误。 服务器错误。 内部错误，请联系技术支持。 500 CSS.1004 数据库服务异常。 数据库服务异常。 请稍后重试或联系技术支持。 500 CSS.9999 请求处理失败。 请求处理失败。 根据提示信息检查请求路径以及请求体的正确性。 202 CSS.0011 This operation cannot be performed because another operation is being performed on the instance or the instance is faulty. Please try again later. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 稍后重试。 400 CSS.0001 The parameter is incorrect. 参数错误。 根据返回信息检查参数。 400 CSS.0006 The request body is empty. Enter a request parameter. 请求体为空，请输入请求参数。 输入请求参数。 400 CSS.1112 The number of instances has reached the quota. 实例数量达到配额。 删除部分集群或申请扩大配额。 400 CSS.3011 Invalid retention duration of the backup. 备份保留天数非法。 修改保留天数。 400 CSS.5007 The selected flavor does not exist. 所选规格不存在。 检查规格是否正确。 400 CSS.5009 The hard disk size is beyond the valid range. 硬盘大小超出范围。 修改硬盘大小。 400 CSS.5021 The VPC does not exist or does not belong to the user. VPC不存在，或不属于该用户。 检查VPC是否正确。 400 CSS.5023 The security group does not exist or does not belong to the VPC. 安全组不存在，或不属于该VPC。 检查安全组是否正确。 400 CSS.5036 The engine does not exist. 引擎不存在。 检查“datastore”参数值是否正确。 400 CSS.5047 The number of instances is beyond the valid range. 实例数量非法。 检查实例数量是否在取值范围内。 400 CSS.5052 Invalid value of the AZ. 可用区取值非法。 修改可用区。 400 CSS.5055 Invalid flavor. 所选规格名称非法。 修改规格。 400 CSS.5061 The hard disk type is invalid. 硬盘类型违规。 修改硬盘类型。 400 CSS.5074 The subnet does not belong to the VPC. 子网ID不属于VPC。 修改子网ID。 400 CSS.5077 Invalid cluster name. 集群名称非法。 修改集群名称。 400 CSS.5078 The hard disk size is beyond the valid range. 硬盘大小违规。 修改硬盘大小。 400 CSS.5092 Invalid hard disk information. 硬盘信息无效。 修改硬盘信息。 400 CSS.5093 Invalid specification information. 规格信息无效。 修改规格信息。 403 CSS.0015 Resource not found or permission denied. 访问资源不存在，或者无访问权限。 修改资源ID或者检查访问权限。 404 CSS.0022 The instance does not exist or has been deleted. 实例不存在或已删除。 修改实例ID。 404 CSS.3027 The cluster does not exist. 集群不存在。 检查集群ID是否正确。 409 CSS.5050 The cluster name already exists. 集群名称已经存在。 修改集群名称。 412 CSS.5130 The agency name is invalid. 代理名称不合法。 修改代理名称。 500 CSS.0005 Server error. 服务器错误。 联系客服。 500 CSS.9999 Request processing failed. 请求处理失败。 联系客服。 NA CSS.6000 Failed to create the cluster. 创建集群失败。 请联系客服或者稍后重试。 NA CSS.6001 Failed to expand the cluster. 扩容集群失败。 请联系客服或者稍后重试。 NA CSS.6003 Failed to restore the cluster. 恢复集群失败。 请联系客服或者稍后重试。 NA CSS.6004 Failed to create the node. 创建节点失败。 请联系客服或者稍后重试。 NA CSS.6009 Failed to create the snapshot. 快照创建失败。 请联系客服或者稍后重试。 NA CSS.6012 Failed to restore the snapshot because the OBS object does not exist or has been deleted. 恢复快照失败，因为OBS对象不存在或已被删除。 请检查OBS桶否存在。 NA CSS.6013 Failed to modify parameters because other operations are being performed on the cluster. 集群正在进行其它操作，无法修改参数。 建议集群处于可用状态时再进行修改参数操作。 NA CSS.6014 The set parameters contain parameters that cannot be modified. 设置的参数中包含不可修改的参数。 建议用户检查提交的修改参数请求中，是否含有不可修改的参数值，将对应参数删除后重试操作。 NA CSS.6015 The parameter does not comply with the YAML format. 设置的参数不满足YAML格式。 建议修改参数格式后重试操作。 父主题： 公共参数

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxx",...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001"} 其中，error_code表示错误码，error_msg表示错误描述信息。

状态码 状态码如表1所示。 表1 状态码说明 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如，切换到HTTPS的高版本协议。 200 OK 请求已成功。 201 Created 创建类的请求已成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求已成功，同时HTTPS响应不包含响应体。 在响应OPTIONS方法的HTTPS请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTPS状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。 父主题： 公共参数

API概览 CSS提供的接口为符合RESTful API设计规范的自研接口。通过CSS的自研接口，您可以使用CSS的如表1所示的功能。 表1 接口说明 类型 说明 集群管理接口 可以通过接口创建集群、扩容集群、查看集群详情、获取实例规格列表等。 词库管理接口 云搜索服务提供自定义词库功能，可以通过接口加载自定义库、查询词库状态或删除自定义词库。 Kibana公网访问接口 Kibana公网访问功能支持通过接口进行开启、关闭、修改等操作。 日志管理接口 可以通过日志管理接口进行开启、关闭、修改、查询等操作。 公网访问接口 可以通过公网访问接口进行开启、关闭、修改等操作。 快照管理接口 快照功能可应用于数据备份与恢复，可以通过接口创建快照、恢复快照或者删除快照等。 终端节点接口 可以通过终端节点接口进行开启、关闭、获取连接、更新连接等操作。 参数配置接口 可以通过参数配置接口修改集群的参数配置。 表2 集群管理接口 API 说明 创建集群 该接口用于创建集群。 查询集群列表 该接口用于查询并显示集群列表以及集群的状态。 查询集群详情 该接口用于查询并显示单个集群详情。 删除集群 此接口用于删除集群。 按需集群转包周期 该接口用于按需集群转包周期集群。 修改集群名称 该接口用于修改集群名称。 修改密码 该接口用于修改集群密码。 重启集群 此接口用于重启集群，重启集群将导致业务中断。 扩容集群 该接口用于集群扩容实例（仅支持扩容elasticsearch实例）。 扩容实例的数量和存储容量 该接口用于集群扩容不同类型实例的个数以及存储容量。 变更规格 该接口用于变更集群规格。 获取实例规格列表 该接口用于查询并显示支持的实例规格对应的ID。 查询所有标签 该接口用于查询指定region下的所有标签集合。 查询指定集群的标签 该接口用于查询指定集群的标签信息。 添加指定集群标签 该接口用于给指定集群添加标签。 删除集群标签 此接口用于删除集群标签 批量添加或删除集群标签 该接口用于对集群批量添加或删除标签。 指定节点类型规格变更 修改集群规格。支持修改ess， ess-cold， ess-client， ess-master节点类型。 指定节点缩容 该接口可以对集群现有节点中指定节点进行缩容。 指定节点类型缩容 该接口用于集群缩容不同类型实例的个数以及存储容量。 节点替换 该接口用于替换失败节点。 切换安全组 该接口可以在集群创建成功后，修改安全组。 安全模式修改 该接口用于切换集群的安全模式。 添加独立master、client 该接口用于添加master或者client节点。 下载安全证书 该接口用于下载安全证书。 创建集群V2 该接口用于创建拥有多种不同节点类型（ess，ess-cold，ess-client，ess-master）组合的集群。 重启集群V2 该接口可以用于重启当前集群拥有的全部节点类型，或部分节点类型组合的节点。 滚动重启 该接口会一个一个重启节点，在索引数量比较多的情况下耗时较长 表3 词库管理接口 API 说明 加载自定义词库 该接口用于加载存放于OBS的自定义词库。 查询自定义词库状态 该接口用于查询自定义词库的加载状态。 删除自定义词库 该接口用于删除自定义词库。 表4 Kibana公网访问接口 API 说明 开启Kibana公网访问 该接口用于开启Kibana公网访问。 关闭Kibana公网访问 该接口用于关闭Kibana公网访问。 修改Kibana公网带宽 该接口用于修改Kibana公网带宽。 修改Kibana公网访问控制 该接口通过修改kibana白名单，修改kibana的访问权限。 关闭Kibana公网访问控制 该接口用于关闭Kibana公网访问控制。 表5 日志管理接口 API 说明 开启日志功能 该接口用于开启日志管理功能。 关闭日志功能 该接口用于关闭日志管理功能。 查询作业列表 该接口用于查询具体某个集群的日志任务记录列表。 查询日志基础配置 该接口用于日志基础配置查询。 修改日志基础配置 该接口用于修改日志基础配置。 开启日志自动备份策略 该接口用于日志自动备份策略开启。 关闭日志自动备份策略 该接口用于日志自动备份策略关闭。 备份日志 该接口用于备份日志。 查询日志 该接口用于查询日志信息。 表6 公网访问接口 API 说明 开启公网访问 该接口用于开启公网访问。 关闭公网访问 该接口用于关闭公网访问。 修改公网访问带宽 该接口用于修改公网访问带宽。 开启公网访问控制白名单 该接口用于开启公网访问控制白名单。 关闭公网访问控制白名单 该接口用于关闭公网访问控制白名单。 表7 快照管理接口 API 说明 自动设置集群快照的基础配置（不推荐使用） 该接口用于自动设置集群快照的基础配置，包括配置OBS桶和IAM委托。 修改集群快照的基础配置 该接口用于修改集群快照的基础配置，可修改OBS桶和IAM委托。 手动创建快照 该接口用于手动创建一个快照。 恢复快照 该接口用于手动恢复一个快照。 删除快照 该接口用于删除快照。 设置自动创建快照策略 该接口用于设置自动创建快照，默认一天创建一个快照。 查询自动创建快照的策略 该接口用于查询集群自动创建快照的策略。 查询快照列表 该接口用于查询指定集群的快照列表。 停用快照功能 该接口用于停用快照功能。 开启自动创建快照功能 该接口用于打开自动备份功能。 关闭自动创建快照功能 该接口用于关闭自动备份功能 表8 终端节点接口 API 说明 开启终端节点服务 该接口用于开启终端节点服务。 关闭终端节点服务 该接口用于关闭终端节点服务。 获取终端节点连接 该接口用于获取终端节点连接。 更新终端节点连接 该接口用于更新终端节点连接。 修改终端节点服务白名单 该接口用于修改终端节点服务访问控制。 表9 参数配置接口 API 说明 修改参数配置 该接口用于修改参数配置。 获取参数配置任务列表 该接口可获取参数配置的任务列表。 获取参数配置列表 该接口用于获取当前集群现有的参数配置列表。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（即消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于“获取用户Token”接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，********为用户的登录密码，domainname为用户所属的帐号名称，如果是帐号本身获取token，username和domainname填为一致，xxxxxxxxxxxxxxxxxx为project的ID，获取方法请参见获取项目ID和名称。 scope参数定义了Token的作用范围，表示获取的Token仅能访问指定project下的资源，scope参数的详细说明请参见：获取用户Token。 POST https://iam.xxx.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名 "password": "********", //登录密码 "domain": { "name": "domainname " //用户所属的帐号名称 } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" //项目ID } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于“获取用户Token”接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 表1 请求URL 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域，Endpoint不同，可以参考终端节点获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

Token认证 Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，如下所示。 {"auth": {"identity": {"methods": ["password"],"password": {"user": {"name": "username", //用户名"password": "********", //登录密码"domain": {"name": "domainname" //用户所属的帐号名称}}}},"scope": {"project": {"name": "xxxxxxxx" //项目名称}}}} 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://{endpoint}/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.xxx.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表2。 表2 公共请求消息头 参数 是否必选 描述 Content-Type 是 消息体的类型（格式）。推荐用户使用默认值application/json。 X-Auth-Token 否（使用Token认证时必选） 用户Token。 调用“获取用户Token”接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头（Header）中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 请求语言。 对于“获取用户Token”接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.xxx.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，CSS服务管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 表1 API授权项列表 权限 对应API接口 授权项 （Action） IAM项目 (Project) 企业项目 (Enterprise Project) 创建集群 POST /v1.0/{project_id}/clusters css:cluster:create √ √ 查询集群列表 GET /v1.0/{project_id}/clusters css:cluster:list √ √ 查询集群详情 GET /v1.0/{project_id}/clusters/{cluster_id} css:cluster:get √ √ 删除集群 DELETE /v1.0/{project_id}/clusters/{cluster_id} css:cluster:delete √ √ 重启集群 POST /v1.0/{project_id}/clusters/{cluster_id}/restart css:cluster:restart √ √ 扩容集群 POST /v1.0/{project_id}/clusters/{cluster_id}/extend css:cluster:scaleOut √ √ 扩容实例的数量和存储容量 POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend css:cluster:expand √ √ 查询指定集群的标签 GET /v1.0/{project_id}/css-cluster/{cluster_id}/tags css:tag:get √ √ 加载自定义词库 POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurus css:IKThesaurus:load √ √ 查询自定义词库状态 GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurus css:IKThesaurus:get √ √ 删除自定义词库 DELETE /v1.0/{project_id}/clusters/{cluster_id}/thesaurus css:IKThesaurus:delete √ √ 自动设置集群快照的基础配置 POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting css:snapshot:enableAtomaticSnapsot √ √ 修改集群快照的基础配置 POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting css:snapshot:setSnapshotContiguration √ √ 设置自动创建快照策略 POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy css:snapshot:setSnapshotPolicy √ √ 查询集群的自动创建快照策略 GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy css:snapshot:getSnapshotPolicy √ √ 手动创建快照 POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot css:snapshot:create √ √ 查询快照列表 GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots css:snapshot:list √ √ 恢复快照 POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore css:snapshot:restore √ √ 删除快照 DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id} css:snapshot:delete √ √ 停用快照功能 DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots css:snapshot:disableSnapshotFuction √ √

修订记录 发布日期 修订记录 2023-06-21 更新请求参数：设置自动创建快照策略 更新响应示例：重启集群 2023-06-15 优化availability_zone参数描述： 创建集群 创建集群V2 2023-04-27 更新错误码：错误码 2023-02-16 新增接口：切换安全组 2023-02-01 更新云搜索服务相关概念参考链接：概述 2023-01-18 优化参数描述： 开启日志功能 修改日志基础配置 恢复快照 新增API Explorer调试跳转链接。 2022-12-29 优化响应参数： 查询集群详情 查询集群列表 2022-12-16 优化请求参数的名称：创建集群和创建集群V2 优化响应参数的名称：创建集群V2 2022-12-02 优化接口： 节点替换 安全模式修改 添加独立master、client 开启终端节点服务 创建集群V2 2022-10-14 优化接口： 指定节点缩容 指定节点类型缩容 2022-09-14 优化接口： 创建集群 关闭Kibana公网访问 查询集群详情 创建集群V2 新增接口： 节点替换 安全模式修改 添加独立master、client 2022-08-17 优化接口的参数描述： 查询集群列表 查询集群详情 指定节点类型规格变更 开启Kibana公网访问 开启公网访问 获取参数配置任务列表 2022-07-20 新增支持Elasticsearch 7.10.2版本，下线Elasticsearch 7.9.3版本：支持的集群版本 2022-07-05 新增接口： Kibana公网访问接口 日志管理接口 公网访问接口 终端节点接口 参数配置接口 2022-06-22 更新认证方式：认证鉴权 2022-05-24 更新优化公共章节： 支持的集群版本 如何调用API 快速入门 获取项目ID和名称 2022-05-14 修改API响应参数：扩容集群 2021-05-17 删除泊松分词的接口 2021-01-30 新增支持Elasticsearch 7.9.3版本：支持的集群版本 2020-08-25 支持细粒度授权：权限策略和授权项 2020-08-05 支持创建安全模式集群：创建集群 2019-09-04 新增管理标签类接口。 2019-01-31 增加企业项目特性：创建集群 2018-08-21 增加各个错误码的处理措施：错误码 2018-04-10 服务名称修改为“云搜索服务” 新增接口：快照管理接口 2018-03-23 新增自定义词库相关的接口：词库管理接口 2018-01-19 第一次正式发布。

请求示例 更新终端节点连接。 POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/connections{ "action" : "receive", "endpointIdList" : [ "f132bb14-e1d5-4f25-9f7c-a29e4c8effd4" ]}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 eip 否 UnBindPublicReqEipReq object 弹性IP信息。 表3 UnBindPublicReqEipReq 参数 是否必选 参数类型 描述 bandWidth 否 BindPublicReqEipBandWidth object 公网带宽信息。 表4 BindPublicReqEipBandWidth 参数 是否必选 参数类型 描述 size 是 Integer 带宽大小。单位：Mbit/s

请求示例 开启并配置词库信息。 POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/thesaurus{ "bucketName" : "test-bucket", "mainObject" : "word/main.txt", "stopObject" : "word/stop.txt", "synonymObject" : "word/synonym.txt"}

请求示例 开启快照功能。 POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/setting{ "bucket" : "test-bucket", "agency" : "usearch", "basePath" : "css_repository/Es-name"}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bucketName 是 String 词库文件存放的OBS桶（桶类型必须为标准存储或者低频存储，不支持归档存储）。 mainObject 否 String 主词库文件对象，必须为UTF-8无BOM编码的文本文件，一行一个分词，文件大小最大支持100M。 mainObject, stopObject, synonymObject三个参数至少要填写一个。 说明： 一次只能加载一个主词库，不支持同时加载多个主词库。 stopObject 否 String 停词词库文件对象，必须为UTF-8无BOM编码的文本文件，一行一个分词，文件大小最大支持20M。 mainObject, stopObject, synonymObject三个参数至少要填写一个。 synonymObject 否 String 同义词词库文件，必须为UTF-8无BOM编码的文本文件，一行一组分词，文件大小最大支持20M。 mainObject, stopObject, synonymObject三个参数至少要填写一个。

URI POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID和名称。 cluster_id 是 String 指定待添加标签的集群ID。 resource_type 是 String 资源类型，当前固定值为“css-cluster”，表示是集群类型。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 eip 是 BindPublicReqEip object 弹性IP信息。 isAutoPay 否 Integer 是否自动支付。下单订购后，是否自动从客户的华为云账户中支付，而不需要客户手动去进行支付。该参数适用于包周期集群。 1: 是（会自动选择折扣和优惠券进行优惠，然后自动从客户华为云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券)。 0: 否（需要客户手动去支付，客户可以选择折扣和优惠券）。默认值为“0”。 表3 BindPublicReqEip 参数 是否必选 参数类型 描述 bandWidth 是 BindPublicReqEipBandWidth object 公网带宽信息。 表4 BindPublicReqEipBandWidth 参数 是否必选 参数类型 描述 size 是 Integer 带宽大小。单位：Mbit/s

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 indices 否 String 需要备份的索引名。*代表所有索引。 prefix 否 String 自动创建快照的名称前缀，需要用户自己手动输入。 只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。 说明： 当enable为true时该字段为必选字段 period 否 String 每天创建快照的时刻，只支持整点，后面需加上时区，格式为“HH:mm z”，“HH:mm”表示整点时间，“z”表示时区。 比如“00:00 GMT+08:00”、“01:00 GMT+08:00”等。 说明： 当enable为true时该字段为必选字段 keepday 否 Integer 自定义设置快照保留的天数，范围是1～90。系统在半点时刻会自动删除超过保留天数的快照。 说明： 当enable为true时该字段为必选字段 enable 是 String 是否开启自动创建快照策略。 true：表示开启自动创建快照策略。 false：表示关闭自动创建快照策略。 deleteAuto 否 String 表示关闭自动创建快照策略时，是否需要清除所有自动创建的快照。 默认为“false”，表示不会删除之前已自动创建的快照。 设置为true，表示在关闭自动创建快照策略的同时，删除所有已创建的快照。

请求示例 设置自动创建快照策略。 POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy{ "prefix" : "snapshot", "period" : "16:00 GMT+08:00", "keepday" : 7, "enable" : "true", "deleteAuto" : "false"}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 shrink 是 Array of ShrinkNodeReq objects 需要缩容的节点类型和数量集合。 表3 ShrinkNodeReq 参数 是否必选 参数类型 描述 reducedNodeNum 是 Integer 需要缩容的节点数量。 对节点缩容后，请确保每个节点类型在每个AZ中的数量至少为1。 关于跨AZ的集群，在不同AZ中同类型节点个数的差值要小于等于1。 关于没有Master节点的集群，每次缩容的数据节点个数(包含冷数据节点和其他类型节点)要小于当前数据节点总数的一半，缩容后的数据节点个数要大于索引的最大副本个数。 关于有Master节点的集群，每次缩容的Master节点个数要小于当前Master节点总数的一半，缩容后的Master节点个数必须是奇数且不小于3。 type 是 String 指定节点类型。 ess：数据节点。 ess-cold：冷数据节点。 ess-client：Client节点。 ess-master：Master节点。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 type 是 IndependentBodyReq object 独立master或client请求体参数。 表3 IndependentBodyReq 参数 是否必选 参数类型 描述 flavor_ref 是 String 规格id，该参数通过获取实例规格列表接口获取，根据集群版本选择所需要的规格id node_size 是 Integer 要独立节点个数。 如果路径参数type取值为“ess-master”即新增独立master节点，节点个数必须为大于等于三且小于等于10的奇数。 如果路径参数type取值为“ess-client”即新增独立client节点，节点个数要求大于等于1小于等于32。 volume_type 是 String 节点存储类型：取值为ULTRAHIGH，COMMON，HIGH。

URI POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID和名称。 cluster_id 是 String 指定需要独立master或client的集群ID。 type 是 String 指定待新增独立节点类型。 ess-master：Master节点。 ess-client：Client节点。

请求示例 添加独立master、client。 POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent{ "type" : { "flavor_ref" : "d9dc06ae-b9c4-4ef4-acd8-953ef4205e27", "node_size" : 3, "volume_type" : "COMMON" }}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 authorityEnable 是 Boolean 是否开启安全模式。 true: 开启安全模式。 false: 关闭安全模式。 默认为：true。 adminPwd 否 String 安全模式下集群密码。 httpsEnable 是 Boolean 是否开启HTTPS。 true: 开启HTTPS。 false: 关闭HTTPS。 默认为：true。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 grow 是 Array of RoleExtendGrowReq objects 集群扩容请求详细描述。 isAutoPay 否 Integer 是否自动支付。下单订购后，是否自动从客户的华为云账户中支付，而不需要客户手动去进行支付。该参数适用于包周期集群。 1:是（会自动选择折扣和优惠券进行优惠，然后自动从客户华为云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券)。 0: 否（需要客户手动去支付，客户可以选择折扣和优惠券）。默认值为“0”。 表3 RoleExtendGrowReq 参数 是否必选 参数类型 描述 type 是 String 扩容实例类型。取值为ess、ess-master或ess-client，可以选择其中一个或多个之间的组合但不可以重复选择。 ess-master、ess-client节点只支持增加实例个数。 nodesize 是 Integer 扩容实例个数。集群已有实例个数和增加实例个数总和不能超过32。若无需扩容该参数将该参数设置为0即可。 disksize 是 Integer 扩容实例存储容量。集群原实例存储容量和扩容实例存储容量之和不能超过创建集群时对应默认实例存储容量上限。若无需扩容该参数将该参数设置为0即可。 单位：GB。 ess节点、ess-cold节点扩容步长为20。 ess-master节点、ess-client节点不允许扩容存储。

请求示例 修改当前集群的实例个数与存储容量。 POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role_extend{ "grow" : [ { "type" : "ess-master", "nodesize" : 2, "disksize" : 0 }, { "type" : "ess", "nodesize" : 0, "disksize" : 40 }, { "type" : "ess-client", "nodesize" : 1, "disksize" : 0 } ], "isAutoPay" : 1}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 periodType 是 Integer 订购周期类型。 2: 包月。 3: 包年。 periodNum 是 Integer 订购周期数。 若选择包月（参数范围：1-9）。 若选择包年（参数范围：1-3）。 isAutoRenew 否 Integer 是否自动续订，为空时表示不自动续订 1: 自动续订。 0: 不自动续订（默认）。 isAutoPay 否 Integer 是否自动支付。下单订购后，是否自动从客户的华为云账户中支付，而不需要客户手动去进行支付。该参数适用于包周期集群。 1: 是（会自动选择折扣和优惠券进行优惠，然后自动从客户华为云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券)。 0: 否（需要客户手动去支付，客户可以选择折扣和优惠券）。默认值为“0”。 consoleURL 否 String 云服务ConsoleURL。 订购订单支付完成后，客户可以通过此URL跳转到云服务Console页面查看信息。（仅手动支付时涉及）。

请求示例 修改集群的计费模式，由按需计费模式转为包周期计费模式。 { "periodType" : 2, "periodNum" : 1, "isAutoRenew" : 1, "isAutoPay" : 0, "consoleURL" : "https://console.xxx.huawei.com/elasticsearch-pre/?locale=zh-cn®ion=xxx#/es/management/elasticsearch"}

请求示例 修改日志基础配置。 PSOT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings{ "agency" : "css_obs_agency", "logBasePath" : "css/log", "logBucket" : "000-words"}