文档中心

云搜索服务

API 参考

API 概览

API 概览

本文汇总云搜索服务提供实例的 API 接口。

资源管理

接口名称	说明
DescribeZones	调用 DescribeZones 接口，查询云搜索服务在指定 Region 下开放的可用区列表。
ListTagsForResources	调用 ListTagsForResources 接口，根据标签筛选出对应资源。
UntagResources	调用 UntagResources 接口，给多个实例解绑标签。
TagResources	调用 TagResources 接口，给云搜索实例绑定标签。

实例查询

接口名称	说明
DescribeInstance	调用 DescribeInstance 接口，查询指定实例的配置详情。
DescribeInstances	调用 DescribeInstances 接口，查询云搜索实例列表，以及实例配置详情。
DescribeInstanceNodes	调用 DescribeInstanceNodes 接口，查询实例的成员节点详情，包括节点类型、运行状态、资源配置等信息。
DescribeInstancePlugins	调用 DescribeInstancePlugins 接口，查询实例中已经安装的插件列表。
DescribeNodeAvailableSpecs	调用 DescribeNodeAvailableSpecs 接口，查询可用的节点类型、节点规格和存储规格列表，并会返回计费配置码。
DescribeIpAllowList	调用 DescribeIpAllowList 接口，查询实例或可视化工具的访问白名单、白名单分组。

实例管理

接口名称	说明
CreateInstance	调用 CreateInstance 接口，创建实例，但需要额外在浏览器中确认火山订单信息，实例才会开始创建。
CreateInstanceInOneStep	调用 CreateInstanceInOneStep 接口，可以直接一步创建实例。
RenameInstance	调用 RenameInstance 接口，修改目标实例名称。
ReleaseInstance	调用 ReleaseInstance 接口，删除（释放）目标实例。
RestartInstance	调用 RestartInstance 接口，重启实例中的所有成员节点。
RestartNode	调用 RestartNode 接口，重启实例的特定成员节点。
ResetAdminPassword	调用 ResetAdminPassword 接口，重置实例管理员账号（admin）的密码。
ModifyMaintenanceSetting	调用 ModifyMaintenanceSetting 接口，修改实例的可维护时间。
ModifyDeletionProtection	调用 ModifyDeletionProtection 接口，启停实例的删除保护功能。
ModifyNodeSpecInOneStep	调用 ModifyNodeSpecInOneStep 接口，可以直接一步修改实例节点配置，即进行实例的升配或降配操作。
ModifyChargeCode	调用 ModifyChargeCode 接口，将实例由按量付费转换为包年包月付费类型。
ModifyIpAllowListV2	调用 ModifyIpAllowListV2 接口，配置实例或可视化工具的访问白名单、白名单分组。

最近更新时间：2026.03.03 17:07:08

这个页面对您有帮助吗？

有用

有用

无用

无用