CheckAgentConfigSupported - 检查组件配置支持-Alibaba Cloud Linux(Alinux)-阿里云帮助中心

接口说明

当前接口获取的实例列表是已经被 SysOM 纳管的机器列表，如果某个 ECS 实例存在但是没有被 SysOM 纳管，则不会出现在列表当中。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/am/agent/checkAgentConfigSupported HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
agentId	string	是	要更新的组件 ID （从 ListAgents 中获取组件 ID）	74a86327-3170-412c-8e67-da3389ec56a9
configId	string	是	要安装的组件配置 ID	4d5ecf02-3d01-11f0-8c90-00163e1029a
checkType	string	否	需要检测的配置维度（集群，节点）	instance
instances	string	否	实例列表，不同实例使用','间隔	i-bp10ktsji8vsbd8gco5i,i-bp1163pp7k7njfggvuqp,i-bp12ytprghv6rwzfgypm
clusters	string	否	集群 id	c726e7497b7d246d09d8644ed62effacc
content	string	否	配置内容	{'code': 'BABA', 'changeRate': '-1.434%', 'exchange': 'NYSE', 'price': '112.690', 'changePrice': '-$1.640', 'currency': 'USD', 'date': '2026-06-11T20:01 EDT'}

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success Fail
data	array<object>	返回结果。
	object	返回数据。
cluster	string	集群 id	a36a284e-fc8a-4c8a-abad-03d441e6ebcf
instance	string	ECS 实例 ID	i-wz9d00ut2ska3mlyhn6j
reason	string	当 success 为 false 时，该值不为空，表示不支持被纳管的原因	instance not found in ecs
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	server error
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822
total	integer	查询结果总数。	42

示例

正常返回示例

JSON格式

{
  "code": "Success  Fail",
  "data": [
    {
      "cluster": "a36a284e-fc8a-4c8a-abad-03d441e6ebcf",
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "reason": "instance not found in ecs"
    }
  ],
  "message": "server error",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n",
  "total": 42
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。