本文汇总云搜索服务提供的 V2 实例的 API 接口。
接口名称 | 说明 |
---|---|
调用 DescribeZones 接口,查询云搜索服务在指定 Region 下开放的可用区列表。 | |
调用 DescribeInstance 接口,查询指定实例的配置详情。 | |
调用 DescribeInstances 接口,查询云搜索实例列表,以及实例配置详情。 | |
调用 DescribeInstanceNodes 接口,查询实例的成员节点详情,包括节点类型、运行状态、资源配置等信息。 | |
调用 DescribeInstancePlugins 接口,查询实例中已经安装的插件列表。 | |
调用 DescribeNodeAvailableSpecs 接口,查询可用的节点类型、节点规格和存储规格列表,并会返回计费配置码。 |
接口名称 | 说明 |
---|---|
调用 CreateInstance 接口,创建实例,但需要额外在浏览器中确认火山订单信息,实例才会开始创建。 | |
调用 CreateInstanceInOneStep 接口,可以直接一步创建实例。 | |
调用 RenameInstance 接口,修改目标实例名称。 | |
调用 ReleaseInstance 接口,删除(释放)目标实例。 | |
调用 RestartInstance 接口,重启实例中的所有成员节点。 | |
调用 RestartNode 接口,重启实例的特定成员节点。 | |
调用 ResetAdminPassword 接口,重置实例管理员账号(admin)的密码。 | |
调用 ModifyMaintenanceSetting 接口,修改实例的可维护时间。 | |
调用 ModifyDeletionProtection 接口,启停实例的删除保护功能。 | |
调用 ModifyNodeSpecInOneStep 接口,可以直接一步修改实例节点配置,即进行实例的升配或降配操作。 | |
调用 ModifyIpWhitelist 接口,配置实例或 Kibana 的访问白名单。 | |
调用 ModifyChargeCode 接口,将实例由按量付费转换为包年包月付费类型。 |