更新集群组件配置
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
PUT /api/v1/am/agent/updateClusterAgentConfig HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body |
|
| agentId |
string |
是 |
要更新配置对应的组件 ID |
74a86327-3170-412c-8e67-da3389ec56a9 |
| clusterId |
string |
是 |
集群 ID (可通过 ListClusters 接口获取) |
c8b90bc1b2ef0436f81213c032b75c5f3 |
| configId |
string |
是 |
要安装到集群的组件配置 ID |
f0078fbb-4213-11f0-a19b-00163e4ae208 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| code |
string |
状态码
|
SysomOpenAPI.ServerError |
| data |
object |
返回数据。 |
|
| taskId |
string |
任务 ID。 可以凭借本任务 ID 调用 GetAgentTask 接口查看任务的执行情况 |
bbe94a98-4192-4172-b856-95777e0a55d7 |
| message |
string |
错误信息
|
success |
| requestId |
string |
Id of the request |
2D693121-C925-5154-8DF6-C09A8B369822 |
示例
正常返回示例
JSON格式
{
"code": "SysomOpenAPI.ServerError",
"data": {
"taskId": "bbe94a98-4192-4172-b856-95777e0a55d7"
},
"message": "success",
"requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Sysom.ServerError | Server error, please correct the code according to the error message. %s. | 服务端错误,请根据错误提示信息修正代码 |
| 400 | SysomOpenAPI.AgentConfigDuplicate | Agent config already exists, please change the name. %s. | 配置名称冲突,不允许创建同名的配置。 |
| 400 | SysomOpenAPI.AgentConfigNotExists | Agent config does not exists. | 组件配置不存在 |
| 400 | SysomOpenAPI.AgentTaskJobNotFinish | Agent Task Job is already running on instances. | 已有安装任务正在运行中 |
| 400 | SysomOpenAPI.ClusterStatusNotRunning | Cluster The cluster status is not Running and may be in operation. Please try again later. | 集群状态不为Running,可能正在操作中,请稍后再试 |
| 400 | SysomOpenAPI.ClusterNotExists | The cluster does not exist. %s. | 集群不存在 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。