ListEcsInstances_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.

接口说明

注意 接口前置需要创建 AliyunElasticsearchAccessingOOSRole 和 AliyunOOSAccessingECS4ESRole 的系统服务角色,用于 Elasticsearch 服务账号获取主账号的 ECS 访问权限等,详细信息请参见采集 ECS 服务日志

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:ListCollectors
Get
全部资源
*

请求语法

GET /openapi/ecs HTTP/1.1

请求参数

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

返回结果页数。最大值 500。

示例值:1取值 <= 200
sizeinteger<int32>

每页包含的结果数。默认值 10,最大值 500。

示例值:10取值 <= 500
ecsInstanceIdsstring

ECS 实例 ID 列表。取值可以由多个实例 ID 组成一个 JSON 数组,最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

示例值:["i-bp13y63575oypr9d****","i-bp1gyhphjaj73jsr****"]
ecsInstanceNamestring

ECS 实例名称。

示例值:test
tagsstring

ECS 实例标签,必须包含:展开详情

示例值:[{ "tagKey":"a","tagValue":"b"}]
vpcIdstring

ECS 实例所在的 VPC ID。

示例值:vpc-bp16k1dvzxtmagcva****

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

返回头信息。

Resultarray<object>

返回结果。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
ComponentCodeValueError
component value is disable诊断
401
UserNotOpen
Aliyun account is not open elasticsearch诊断
401
StsRoleAccountNoPermission
Role account has no permission or expired诊断
401
SubAccountNoPermission
Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM诊断
401
UserUnauthorized
Authentication required诊断

变更历史

变更时间变更内容概要操作
2022-09-26
删除请求参数body

相关示例