云搜索服务
云搜索服务
文档指南
请输入
- 文档首页
云搜索服务API 参考实例查询DescribeInstances - 查询实例列表
复制全文
下载 pdfDescribeInstances - 查询实例列表
文档反馈
问问助手调用 DescribeInstances 接口，查询云搜索实例列表，以及实例配置详情。
请求说明
- 请求方式：POST
- 请求地址：/?Action=DescribeInstance&Version=2023-01-01 HTTP/1.1
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeInstances
要执行的操作，取值：DescribeInstances。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
ProjectName string 可选 示例值：default
填写项目名称，根据实例所属项目进行筛选。
TagFilter object 可选 示例值：--
根据实例的标签筛选。
Tags object[] 可选
标签过滤数组。
Key string 必选 示例值：KeyA
标签筛选键。
Values string[] 必选 示例值：ValueA
标签值列表。
Filters object[] 可选 示例值：--
过滤条件，将根据条件返回符合要求的实例列表。
Name string 可选 示例值：InstanceName
过滤条件名称。支持的查询条件如下：
InstanceId：实例 ID
InstanceName：实例名称
ZoneId：可用区 ID
Status：实例状态
Version：实例版本
ChargeType：计费类型
Values string[] 可选 示例值：doc
过滤条件值。
PageSize integer 可选 示例值：10
每页展示数量，默认为 10。
PageNumber integer 可选 示例值：1
页数，默认为 1。
返回参数
Instances object[] 示例值：--
实例列表和配置信息。
ESEip string 示例值：180.*.*.*
实例所绑定的 EIP。
Status string 示例值：Running``
实例当前状态。
UserId string 示例值：210***34``
实例所有者的用户 ID。
ESEipId string 示例值：eip-mij5ztefl98**
实例所绑定的 EIP 的 ID。
ClusterId string 示例值：16a119e0d***41ae2627b0``
实例所属集群的 ID。
KibanaEip string 示例值：180.*.*.*
Kibana 所绑定的 EIP。
CreateTime string 示例值：2024-03-21T10:32:24+08:00
实例的创建时间。
ExpireDate string 示例值：2023-11-11T15:59:59.000+00:00``
包年包月实例的付费过期时间。
InstanceId string 示例值：o-00k***o718``
实例 ID。
MainZoneId string 示例值：cn-beijing-a
主可用区
TotalNodes integer 示例值：12``
实例的总节点数。
KibanaEipId string 示例值：eip-mij5ztefl98**
Kibana 所绑定的 EIP 的 ID。
KibanaConfig object 示例值：--
Kibana 参数配置。
CookieTTL long 示例值：3600000
Cookie 有效时长。
SessionTTL long 示例值：3600000
Session 有效时长。
KibanaBasePath string 示例值：/kibana/{psm}/{idc}``
Kibana 配置项 server.basePath 值。
RequestTimeout long 示例值：30000
请求超时时长，默认值 30,000，单位毫秒。
SessionKeepAlive boolean 示例值：true
是否延长 Session 有效期，默认 true。
ResourceTags object[] 示例值：--
实例的标签信息。
Type string 示例值：CUSTOM
标签类型：
- CUSTOM：自定义设置的标签。
- SYSTEM：系统标签。
TagKvs object 示例值：user
标签键。
TagKeys string[] 示例值：tom
标签值。
SubInstances object[] 示例值：--
企业级 SQL 分析实例配置信息。
SubInstanceStatus string 示例值：AVAILABLE
实例状态。
SubInstanceId string 示例值：k-00g0oh**
企业级 SQL 分析实例 ID。
SubInstanceType string 示例值：sql
实例类型。
TransferInfo object 示例值：--
数据迁移任务信息。
ForbidStop boolean
是否不允许停止。
TransferStatus string 示例值：FINISH
数据迁移任务状态。
TransferTaskId string 示例值：88dbdf2431b44f36**
数据迁移任务 ID。
ReduceSpecConfig object
资源信息。
ColdNodeNum integer 示例值：0
冷节点数量。
DataNodeNum integer 示例值：3
数据节点数量。
WarmNodeNum integer 示例值：3
温节点数量。
MasterNodeNum integer 示例值：3
Master 节点数量。
EnablePureMaster boolean 示例值：false
Master 节点是否独立。
- true：Master 节点独立。
- false：Master 节点与数据节点重合，即用 Hot 来声明。
TransferProgress double 示例值：100
数据迁移任务进度，百分制。
ChargeEnabled boolean 示例值：true``
实例是否开启了计费。取值说明如下：
true：已开启计费。
false：未开启计费。
CerebroEnabled boolean 示例值：true``
是否开启 cerebro。
true：开启 cerebro。
false：不开启 cerebro。
MaintenanceDay string[] 示例值：["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]
实例的可维护日期。
MaintenanceTime string 示例值：03:00-06:00``
实例的可维护时间段。
SupportColdNode boolean 示例值：true
是否支持冷节点
ESPublicEndpoint string 示例值：https://elasticsearch-o-00k***o718..escloud.volces.com:9200``
实例公网访问地址。
ESPrivateEndpoint string 示例值：https://elasticsearch-o-00k***o718.escloud.ivolces.com:9200``
实例私网访问地址。
DeletionProtection boolean 示例值：true``
实例是否开启删除保护功能。
true：已开启实例删除保护
false：未开启实例删除保护
说明
开启实例删除保护后，您将无法通过控制台或者 API 删除实例。
KibanaPublicDomain string 示例值：https://visual-o-00**.escloud.volces.com:5601
Kibana 公网访问地址。
说明
如果是历史实例，访问地址有可能是http(s)://kibana-***开头。
CerebroPublicDomain string 示例值：https://visual-o-00g**.escloud.volces.com:9000/
cerebro 公网访问地址。
说明
Cerebro 和 Kibana 共享域名。如果是历史实例，访问地址有可能是http(s)://kibana-***开头。
ESPublicIpWhitelist string 示例值：182.*.*.*
实例公网地址访问白名单。
- 支持单个 IP 地址或 IP 网段的形式，格式为 192.168.0.1 或 192.168.0.0/24，多个 IP 地址之间用英文逗号隔开。
- IP 地址和网段数量最多支持 300 个。
KibanaPrivateDomain string 示例值：https://visual-o-00**.escloud.ivolces.com:5601
Kibana 私网访问地址。
说明
如果是历史实例，访问地址有可能是http(s)://kibana-***开头。
CerebroPrivateDomain string 示例值：https://visual-o-**.escloud.ivolces.com:5601``
cerebro 私网访问地址。
说明
Cerebro 和 Kibana 共享域名。如果是历史实例，访问地址有可能是http(s)://kibana-***开头。
ESPrivateIpWhitelist string 示例值：192.168.1.1,192.168.1.2
实例私网地址访问白名单。
- 支持单个 IP 地址或 IP 网段的形式，格式为 192.168.0.1 或 192.168.0.0/24，多个 IP 地址之间用英文逗号隔开。
- IP 地址和网段数量最多支持 300 个。
EnableESPublicNetwork boolean 示例值：true``
实例是否开启了公网访问。
true：已开启公网访问。
false：未开启公网访问。
InstanceConfiguration object 示例值：--
实例配置详情信息。
VPC object 示例值：--
设置实例的私有网络 VPC 信息。
VpcId string 示例值：vpc-274uhjap8u72****``
VPC ID。
VpcName string 示例值：vpc_nameA``
VPC 名称。
Subnet object 示例值：--
设置实例的子网信息。
SubnetId string 示例值：subnet-1323sdda****``
Subnet ID。
SubnetName string 示例值：subnet_nameA``
Subnet 名称。
ZoneId string 示例值：cn-beijing-a``
实例所在可用区。
Version string 示例值：V7_10``
实例版本。
- ES 实例支持的版本包括V6_7和V7_10
- OpenSearch 实例支持的版本OPEN_SEARCH_2_9
RegionId string 示例值：cn-beijing``
实例所在区域。
ChargeType string 示例值：PostPaid``
实例计费类型。
PostPaid：按量计费。
PrePaid：包年包月。
ZoneNumber integer 示例值：1``
实例的可用区数量。
EnableHttps boolean 示例值：true``
是否启用 HTTPS 访问协议。
true：启用 HTTPS 访问。
false：不启用 HTTPS，使用 HTTP 访问。
说明
如果使用 HTTP 访问，将无需安全认证即可访问，并使用 HTTP 明文传输数据。您需要确保访问环境的安全性，且不要将访问接口暴露在公网环境上
ProjectName string 示例值：default``
实例所属的项目。
实例默认属于 default 项目，支持调整实例所属项目。
InstanceName string 示例值：doc-test``
实例名称。
AdminUserName string 示例值：admin``
实例管理员账号，固定为 admin。
HotNodeNumber integer 示例值：3``
数据节点数量。
ColdNodeNumber integer 示例值：3``
冷数据节点数量。
WarmNodeNumber integer 示例值：3``
温数据节点数量。
EnablePureMaster boolean 示例值：true``
Master 节点是否独立。
true：Master 节点独立。
false：Master 节点与数据节点重合，即使用 Hot 声明。
KibanaNodeNumber integer 示例值：1``
kibana 节点数量。
MasterNodeNumber integer 示例值：3``
master 节点数量。
HotNodeStorageSpec object 示例值：--
数据节点的存储规格配置详情。
Name string 示例值：es.volume.essd.pl0``
存储规格，当前支持的规格如下：
- es.volume.essd.pl0：标准版-高性能云盘-pl0。
- es.volume.essd.flexpl-standard：标准版-高性能云盘-flexpl。
Size integer 示例值：20``
配置的可用磁盘空间大小。
MaxSize integer 示例值：10000``
存储规格的最大值，单位为 GiB。
MinSize integer 示例值：20``
存储规格最小值，单位为 GiB。
Description string 示例值：标准版-高性能云盘-pl0``
存储规格的描述信息。
DisplayName string 示例值：ESSD-PL0``
存储规格的显示名称。
ColdNodeStorageSpec object 示例值：--
冷节点的存储规格配置详情。
Name string 示例值：es.volume.essd.pl0
存储规格，当前的规格如下：
es.volume.essd.pl0：标准版-高性能云盘-pl0。
Size integer 示例值：20
当前存储规格值，单位为 GiB。
MaxSize integer 示例值：10000
存储规格的最大值，单位为 GiB。
MinSize integer 示例值：20
存储规格最小值，单位为 GiB。
Description string 示例值：标准版-高性能云盘-pl0
存储规格的描述信息。
DisplayName string 示例值：ESSD-PL0
存储规格的显示名称。
HotNodeResourceSpec object 示例值：--
数据节点的节点规格配置详情。
CPU integer 示例值：2``
节点规格的 CPU 资源，单位为核（Core）。
Name string 示例值：es.x2.medium``
Memory integer 示例值：4``
节点规格的内存容量，单位 GiB。
Description string 示例值：标准版-2C4G节点``
节点规格的描述信息。
DisplayName string 示例值：2核4GiB``
节点规格的显示名称。
WarmNodeStorageSpec object 示例值：--
温节点的存储规格配置详情。
Name string 示例值：es.volume.essd.pl0
存储规格，当前的规格如下：
es.volume.essd.pl0：标准版-高性能云盘-pl0。
Size integer 示例值：20
当前存储规格值，单位为 GiB。
MaxSize integer 示例值：10000
存储规格的最大值，单位为 GiB。
MinSize integer 示例值：20
存储规格最小值，单位为 GiB。
Description string 示例值：标准版-高性能云盘-pl0
存储规格的描述信息。
DisplayName string 示例值：ESSD-PL0
存储规格的显示名称。
ColdNodeResourceSpec object 示例值：--
冷节点的节点规格配置详情。
CPU integer 示例值：2
节点规格的 CPU 资源，单位为核（Core）。
Name string 示例值：es.x2.medium
节点规格。如需了解节点规格类型和详情。
Memory integer 示例值：4
节点规格的内存容量，单位 GiB。
Description string 示例值：标准版-2C4G节点
节点规格的描述信息。
DisplayName string 示例值：2核4GiB
节点规格的显示名称。
WarmNodeResourceSpec object 示例值：--
温节点的节点规格配置详情。
CPU integer 示例值：2
节点规格的 CPU 资源，单位为核（Core）。
Name string 示例值：es.x2.medium
节点规格。如需了解节点规格类型和详情。
Memory integer 示例值：4
节点规格的内存容量，单位 GiB。
Description string 示例值：标准版-2C4G节点
节点规格的描述信息。
DisplayName string 示例值：2核4GiB
节点规格的显示名称。
CoordinatorNodeNumber integer 示例值：3``
协调节点数量。
MasterNodeStorageSpec object 示例值：--
Master 节点的存储规格配置详情。
Name string 示例值：es.volume.essd.pl0
存储规格，当前的规格如下：
es.volume.essd.pl0：标准版-高性能云盘-pl0。
Size integer 示例值：20
当前存储规格值，单位为 GiB。
MaxSize integer 示例值：10000
存储规格的最大值，单位为 GiB。
MinSize integer 示例值：20
存储规格最小值，单位为 GiB。
Description string 示例值：标准版-高性能云盘-pl0
存储规格的描述信息。
DisplayName string 示例值：ESSD-PL0
存储规格的显示名称。
KibanaNodeResourceSpec object 示例值：--
Kibana 节点的节点规格配置详情。
CPU integer 示例值：2
节点规格的 CPU 资源，单位为核（Core）。
Name string 示例值：es.x2.medium
节点规格。如需了解节点规格类型和详情。
Memory integer 示例值：4
节点规格的内存容量，单位 GiB。
Description string 示例值：标准版-2C4G节点
节点规格的描述信息。
DisplayName string 示例值：2核4GiB
节点规格的显示名称。
MasterNodeResourceSpec object 示例值：--
Master 节点的节点规格配置详情。
CPU integer 示例值：2
节点规格的 CPU 资源，单位为核（Core）。
Name string 示例值：es.x2.medium
节点规格。如需了解节点规格类型和详情。
Memory integer 示例值：4
节点规格的内存容量，单位 GiB。
Description string 示例值：标准版-2C4G节点
节点规格的描述信息。
DisplayName string 示例值：2核4GiB
节点规格的显示名称。
CoordinatorNodeStorageSpec object 示例值：--
协调节点的存储规格配置详情。
Name string 示例值：es.volume.essd.pl0
存储规格，当前的规格如下：
es.volume.essd.pl0：标准版-高性能云盘-pl0。
Size integer 示例值：20
当前存储规格值，单位为 GiB。
MaxSize integer 示例值：10000
存储规格的最大值，单位为 GiB。
MinSize integer 示例值：20
存储规格最小值，单位为 GiB。
Description string 示例值：标准版-高性能云盘-pl0
存储规格的描述信息。
DisplayName string 示例值：ESSD-PL0
存储规格的显示名称。
CoordinatorNodeResourceSpec object 示例值：--
协调节点的节点规格配置详情。
CPU integer 示例值：2
节点规格的 CPU 资源，单位为核（Core）。
Name string 示例值：es.x2.medium
节点规格。如需了解节点规格类型和详情。
Memory integer 示例值：4
节点规格的内存容量，单位 GiB。
Description string 示例值：标准版-2C4G节点
节点规格的描述信息。
DisplayName string 示例值：2核4GiB
节点规格的显示名称。
EnableESPrivateNetwork boolean 示例值：true``
实例是否开启了私网访问。
true：默认值，开启私网访问。
false：未开启私网访问。
KibanaPublicIpWhitelist string 示例值：182.*.*.*
Kibana 公网白名单。只有添加到白名单中的 IP 地址才可以访问可视化工具。
说明
Cerebro 和 Kibana 共用一套白名单
KibanaPrivateIpWhitelist string 示例值：192.168.1.1,192.168.1.2
Kibana 私网白名单。只有添加到白名单中的 IP 地址才可以访问可视化工具。
说明
Cerebro 和 Kibana 共用一套白名单。
EnableKibanaPublicNetwork boolean 示例值：true``
Kibana 是否开启公网访问。
true：已开启公网访问。
false：未开启公网访问。
EnableKibanaPrivateNetwork boolean 示例值：true``
Kibana 是否开启私网访问。
true：默认值，已开启私网访问。
false：未开启Kibana私网访问。
EnableESPrivateDomainPublic boolean 示例值：true``
实例是否开启公网解析。
true：已开启公网解析。
false：未开启公网解析。
EnableKibanaPrivateDomainPublic boolean 示例值：true``
Kibana 是否开启公网解析。
true：已开启公网解析。
false：未开启公网解析。
KibanaPublicIpAllowList string 示例值：182.*.*.*
Kibana 公网白名单。只有添加到白名单中的 IP 地址才可以访问可视化工具。同 KibanaPublicIpWhitelist。
KibanaPrivateIpAllowList string 示例值：192.168.1.1,192.168.1.2
Kibana 私网白名单。只有添加到白名单中的 IP 地址才可以访问可视化工具。同 KibanaPrivateIpWhitelist。
ESPublicIpAllowList string 示例值：182.*.*.*
实例公网地址访问白名单。同 ESPublicIpWhitelist。
ESPrivateIpAllowList string 示例值：192.168.1.1,192.168.1.2
实例私网地址访问白名单。同 ESPrivateIpWhitelist。
SubInstanceEnable string 示例值：None
子实例开启情况。
TotalCount long 示例值：2
返回的实例总数。
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | InternalServerError | 服务器内部异常 | 服务由于异常退出，无法完成接口请求操作。 |
200 | IllegalParameter | illegal parameter | 参数非法。原因可能是参数缺失或不符合接口要求。 |
200 | Unauthorized | unauthorized error | 用户无权限调用接口。 |
最近更新时间：2026.03.03 18:51:01
这个页面对您有帮助吗？
有用
有用
无用
无用