文档中心

DescribeInstances - 查询实例列表

最近更新时间：2024.04.09 15:04:00

首次发布时间：2023.11.30 14:19:26

调用 DescribeInstances 接口，查询云搜索实例列表，以及实例配置详情

请求说明

请求方式：POST
请求地址：/?Action=DescribeInstances&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeInstances`	接口名称。当前 API 的名称为 `DescribeInstances`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Filters	Array of InstanceListFilter	否	[ { "Name": "InstanceName", "Values": [ "doc" ] } ]	过滤条件，将根据条件返回符合要求的实例列表。
PageSize	Integer	否	`10`	每页展示数量，默认为 10。
PageNumber	Integer	否	`1`	第几页，默认为 1。

Filters

Array of InstanceListFilter

否

[
{
"Name": "InstanceName",
"Values": [
"doc"
]
}
]

过滤条件，将根据条件返回符合要求的实例列表。

PageSize Integer 否 10 每页展示数量，默认为 10。

PageNumber Integer 否 1 第几页，默认为 1。

InstanceListFilter

参数	类型	是否必选	示例值	描述
Name	String	否	`InstanceName`	过滤条件名称。支持的查询条件如下： InstanceId：实例 ID InstanceName：实例名称 ZoneId：可用区 ID Status：实例状态 Version：实例版本 ChargeType：计费类型
Values	Array of String	否	`doc`	过滤条件值。

返回参数

参数	类型	示例值	描述
Instances	Array of ESInstanceInfoDTO		实例列表和配置信息。
TotalCount	Long	`2`	返回的实例总数。

ESInstanceInfoDTO

参数	类型	示例值	描述
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。
TotalNodes	Integer	`12`	实例的总节点数。
KibanaEipId	String	`eip-mij5ztefl98**`	Kibana 所绑定的 EIP 的 ID。
KibanaConfig	Object of ESKibanaConfig		Kibana 参数配置。
ResourceTags	Array of TagInfo		实例的标签信息。
SubInstances	Array of ESSubInstanceDTO		企业级 SQL 分析实例配置信息。
TransferInfo	Object of TransferInfo		数据迁移任务信息。
ChargeEnabled	Boolean	`true`	实例是否开启了计费。取值说明如下： true：已开启计费。 false：未开启计费。
CerebroEnabled	Boolean	`true`	是否开启 cerebro。 true：开启 cerebro。 false：不开启 cerebro。
MaintenanceDay	Array of String	`["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]`	实例的可维护日期。
MaintenanceTime	String	`03:00-06:00`	实例的可维护时间段。
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 of EsInstanceConfigurationInfoDTO		实例配置详情信息。
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：未开启公网解析。

ESKibanaConfig

参数	类型	示例值	描述
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。

TagInfo

参数类型示例值描述

参数	类型	示例值	描述
Type	String	`CUSTOM`	标签类型： CUSTOM：自定义设置的标签。 SYSTEM：系统标签。
TagKvs	JSON Map	`user`	标签建。
TagKeys	Array of String	`tom`	标签值。

Type

String

CUSTOM

标签类型：

CUSTOM：自定义设置的标签。
SYSTEM：系统标签。

TagKvs JSON Map user 标签建。

TagKeys Array of String tom 标签值。

ESSubInstanceDTO

参数	类型	示例值	描述
SubInstanceId	String	`k-00g0oh**`	企业级 SQL 分析实例 ID。
SubInstanceType	String	`sql`	实例类型。
SubInstanceStatus	String	`AVAILABLE`	实例状态。

TransferInfo

参数	类型	示例值	描述
TransferStatus	String	`FINISH`	数据迁移任务状态。
TransferTaskId	String	`88dbdf2431b44f36**`	数据迁移任务 ID。
ReduceSpecConfig	Object of ReduceSpecConfig		资源信息。
TransferProgress	Double	`100`	数据迁移任务进度，百分制。

EsInstanceConfigurationInfoDTO

参数	类型	示例值	描述
VPC	Object of VpcInfo		设置实例的私有网络 VPC 信息。
Subnet	Object of SubnetInfo		设置实例的子网信息。
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：包年包月。
MainZoneId	String	`cn-beijing-a`	主可用区。
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 of StorageSpecs		数据节点的存储规格配置详情。
ColdNodeStorageSpec	Object of StorageSpecs		冷节点的存储规格配置详情。
HotNodeResourceSpec	Object of ResourceSpecs		数据节点的节点规格配置详情。
WarmNodeStorageSpec	Object of StorageSpecs		温节点的存储规格配置详情。
ColdNodeResourceSpec	Object of ResourceSpecs		冷节点的节点规格配置详情。
WarmNodeResourceSpec	Object of ResourceSpecs		温节点的节点规格配置详情。
CoordinatorNodeNumber	Integer	`3`	协调节点数量。
MasterNodeStorageSpec	Object of StorageSpecs		Master 节点的存储规格配置详情。
KibanaNodeResourceSpec	Object of ResourceSpecs		Kibana 节点的节点规格配置详情。
MasterNodeResourceSpec	Object of ResourceSpecs		Master 节点的节点规格配置详情。
CoordinatorNodeStorageSpec	Object of StorageSpecs		协调节点的存储规格配置详情。
CoordinatorNodeResourceSpec	Object of ResourceSpecs		协调节点的节点规格配置详情。

ReduceSpecConfig

参数	类型	示例值	描述
ColdNodeNum	Integer	`0`	冷节点数量。
DataNodeNum	Integer	`3`	数据节点数量。
WarmNodeNum	Integer	`3`	温节点数量。
MasterNodeNum	Integer	`3`	Master 节点数量。
EnablePureMaster	Boolean	`false`	Master 节点是否独立。 true：Master 节点独立。 false：Master 节点与数据节点重合，即用 Hot 来声明。

VpcInfo

参数	类型	示例值	描述
VpcId	String	`vpc-274uhjap8u72****`	VPC ID。
VpcName	String	`vpc_nameA`	VPC 名称。

SubnetInfo

参数	类型	示例值	描述
SubnetId	String	`subnet-1323sdda****`	Subnet ID。
SubnetName	String	`subnet_nameA`	Subnet 名称。

StorageSpecs

参数	类型	示例值	描述
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`	存储规格的显示名称。

ResourceSpecs

参数	类型	示例值	描述
CPU	Integer	`2`	节点规格的 CPU 资源，单位为核（Core）。
Name	String	`es.x2.medium`	节点规格。如需了解节点规格类型和详情，请参见V2 实例规格。
Memory	Integer	`4`	节点规格的内存容量，单位 GiB。
Description	String	`标准版-2C4G节点`	节点规格的描述信息。
DisplayName	String	`2核4GiB`	节点规格的显示名称。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeInstances&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "Filters": [
        {
            "Name": "InstanceName",
            "Values": ["doc"]
        }
    ],
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240403104205ED2FC7144E0E34***",
        "Action": "DescribeInstances",
        "Version": "2023-01-01",
        "Service": "escloud",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "Instances": [
            {
                "ChargeEnabled": true,
                "CreateTime": "2024-04-01T18:07:11+08:00",
                "DeletionProtection": false,
                "KibanaPrivateIpWhitelist": "",
                "KibanaPublicIpWhitelist": "",
                "EnableESPrivateNetwork": true,
                "EnableESPublicNetwork": false,
                "EnableKibanaPrivateNetwork": true,
                "EnableKibanaPublicNetwork": false,
                "EnableESPrivateDomainPublic": false,
                "EnableKibanaPrivateDomainPublic": false,
                "KibanaEipId": "",
                "KibanaEip": "",
                "ExpireDate": "",
                "InstanceConfiguration": {
                    "AdminUserName": "admin",
                    "ChargeType": "PostPaid",
                    "EnableHttps": true,
                    "EnablePureMaster": false,
                    "ProjectName": "default",
                    "RegionId": "cn-guangzhou",
                    "ZoneId": "cn-guangzhou-a",
                    "ZoneNumber": 1,
                    "Subnet": {
                        "SubnetId": "subnet-36sv2ng1dbzeo3**",
                        "SubnetName": "sub-a-200"
                    },
                    "Version": "V7_10",
                    "ColdNodeNumber": 0,
                    "HotNodeNumber": 0,
                    "HotNodeResourceSpec": {
                        "Name": "es.x2.medium",
                        "DisplayName": "2核4GiB",
                        "Description": "标准版-2C4G节点",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "HotNodeStorageSpec": {
                        "Name": "es.volume.essd.pl0",
                        "DisplayName": "ESSD-PL0",
                        "Description": "标准版-高性能云盘-pl0",
                        "MaxSize": 15000,
                        "MinSize": 20,
                        "Size": 20,
                        "Type": ""
                    },
                    "CoordinatorNodeNumber": 0,
                    "InstanceName": "doc-test",
                    "KibanaNodeNumber": 1,
                    "KibanaNodeResourceSpec": {
                        "Name": "kibana.x2.small",
                        "DisplayName": "1核2GiB",
                        "Description": "Kibana专用-1C2G节点",
                        "Memory": 2,
                        "CPU": 1
                    },
                    "MasterNodeNumber": 3,
                    "MasterNodeResourceSpec": {
                        "Name": "es.x2.medium",
                        "DisplayName": "2核4GiB",
                        "Description": "标准版-2C4G节点",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "MasterNodeStorageSpec": {
                        "Name": "es.volume.essd.pl0",
                        "DisplayName": "ESSD-PL0",
                        "Description": "标准版-高性能云盘-pl0",
                        "MaxSize": 15000,
                        "MinSize": 20,
                        "Size": 20,
                        "Type": ""
                    },
                    "WarmNodeNumber": 0,
                    "VPC": {
                        "VpcId": "vpc-36t5aiv9lvv****",
                        "VpcName": "vpc-172"
                    }
                },
                "MetricsVersion": "2.0.0",
                "InstanceId": "o-00k04hanhbm9",
                "KibanaPrivateDomain": "https://visual-o-00k0***.escloud.ivolces.com:5601",
                "KibanaPublicDomain": "",
                "KibanaConfig": {
                    "CookieTTL": 3600000,
                    "SessionTTL": 3600000,
                    "SessionKeepAlive": true,
                    "RequestTimeout": 30000
                },
                "MaintenanceDay": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "THURSDAY",
                    "FRIDAY",
                    "SATURDAY",
                    "SUNDAY"
                ],
                "MaintenanceTime": "02:00-06:00",
                "Status": "Running",
                "TransferInfo": {},
                "ResourceTags": [
                    {
                        "Type": "SYSTEM",
                        "TagKvs": {}
                    },
                    {
                        "Type": "CUSTOM",
                        "TagKvs": {}
                    }
                ],
                "TotalNodes": 4,
                "UserId": "2100140734",
                "SubInstances": [],
                "Encrypted": false,
                "CerebroEnabled": false,
                "CerebroPrivateDomain": "",
                "CerebroPublicDomain": "",
                "ESInnerEndpoint": "",
                "ESPrivateDomain": "",
                "ESPrivateEndpoint": "https://elasticsearch-o-00k0***.escloud.ivolces.com:9200",
                "ESPublicDomain": "",
                "ESPublicEndpoint": "",
                "ESPrivateIpWhitelist": "",
                "ESPublicIpWhitelist": "",
                "ESEipId": "",
                "ESEip": ""
            }
        ]
    }
}

请求说明

请求参数

Query

Body

InstanceListFilter

返回参数

ESInstanceInfoDTO

ESKibanaConfig

TagInfo

ESSubInstanceDTO

TransferInfo

EsInstanceConfigurationInfoDTO

ReduceSpecConfig

VpcInfo

SubnetInfo

StorageSpecs

ResourceSpecs

请求示例

返回示例

云搜索服务

DescribeInstances - 查询实例列表

请求说明

请求参数

Query

Body

InstanceListFilter

返回参数

ESInstanceInfoDTO

ESKibanaConfig

TagInfo

ESSubInstanceDTO

TransferInfo

EsInstanceConfigurationInfoDTO

ReduceSpecConfig

VpcInfo

SubnetInfo

StorageSpecs

ResourceSpecs

请求示例

返回示例