ListCollectors_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:ListCollectors
Get
全部资源
*

请求语法

GET /openapi/collectors HTTP/1.1

请求参数

字段名称字段详情
resIdstring

采集器 ID。

示例值:ct-cn-77uqof2s7rg5c****
namestring

采集器名称。

示例值:collectorName1
instanceIdstring

采集器关联的实例 ID。

示例值:es-cn-nif1q8auz0003****参考取值来源:
    ListInstance
    UpdateInstance
    DescribeInstance
    DiagnoseInstance
    RestartInstance
pageinteger<int32>

返回结果的分页数。默认值:1,最小值:1,最大值:200。

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

每页的结果数。默认值:20,最小值:1,最大值:500。

示例值:10取值 <= 500
sourceTypestring

指定采集器部署机器的类型,不填返回全部类型。可选值:展开详情

示例值:ECS参考取值来源:
    MoveResourceGroup

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

返回头信息。

Resultarray<object>

返回结果。

返回说明

extendConfigs 中包括 3 种 configType,分别为 collectorTargetInstance、collectorElasticsearchForKibana、collectorDeployMachine,部署机器不同,返回的参数不同,具体组合方式如下:

  • collectorTargetInstance

    • ECS configType、instanceId、instanceType、hosts、userName、password、protocol、enableMonitoring
    • ACK configType、instanceId、instanceType、userName、password、protocol、enableMonitoring
  • collectorElasticsearchForKibana

    • ECS configType、instanceId、host、kibanaHost、userName、password、protocol
    • ACK configType
  • collectorDeployMachine

    • ECS configType、type、machines、groupId
    • ACK configType、type、instanceId、totalPodsCount、successPodsCount

返回示例

错误码

全局错误码
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

相关示例