ListInstance_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:ListInstance
Get
Instance
acs:elasticsearch:{#regionId}:{#accountId}:instances/*

请求语法

GET /openapi/instances HTTP/1.1

请求参数

字段名称字段详情
pageinteger<int32>

实例列表的页码。展开详情

示例值:1
sizeinteger<int32>

分页查询时设置的每页条数。最大值:100,默认值:10

示例值:10
descriptionstring

实例名称,支持模糊查询。例如搜索 abc 的所有实例,则可能返回 abcabcdexyabcxabcy 的所有实例。

示例值:aliyunes_test1
instanceIdstring

实例 ID。

示例值:es-cn-v641a0ta3000g****参考取值来源:
    UpdateInstance
    ListEcsInstances
    DescribeInstance
    DiagnoseInstance
    RestartInstance
esVersionstring

实例版本。

示例值:6.7_with_X-Pack参考取值来源:
    DescribeInstance
    RestartInstance
resourceGroupIdstring

实例所在的资源组 ID。

示例值:rg-aekzvowej3i****
tagsstring

实例标签。

示例值:[{"tagKey":"key1","tagValue":"value1"}]
vpcIdstring

实例所在的专有网络 ID。

示例值:vpc-bp16k1dvzxtmagcva****
zoneIdstring

实例所在的可用区 ID。

示例值:cn-hangzhou-i
paymentTypestring

实例的付费类型。可选值:展开详情

示例值:postpaid
instanceCategorystring

实例版本类型。可选值:展开详情

示例值:advanced

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
Headersobject

返回头信息。

Resultarray<object>

返回结果。

返回说明

说明 以下返回示例中,包含响应返回中的大部分参数,具体以实际返回为准,程序中不建议强制依赖获取以上参数。

返回示例

变更历史

变更时间变更内容概要操作
2024-12-10
变更返回参数
2024-06-04
变更返回参数
2024-05-10
删除返回参数
2022-09-27
变更返回参数
2022-09-13
删除请求参数body

相关示例

ElasticSearch OpenAPI 控制台管控SDK示例,阿里云ElasticSearch 实例创建和管控API CodeSample
2022-07-04