调用RunClusterServiceAction接口对集群的指定服务，运行指定的操作。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 RunClusterServiceAction

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求，该参数为必选参数。取值：RunClusterServiceAction。
ServiceName String 是 TEZ

服务名称。当前集群已有服务的服务名称。
ClusterId String 是 C-F32FB31D8295****

集群ID。您可以调用ListClusters查看集群的ID。

RegionId String 是 cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ServiceActionName String 是 STOP

Action名：

  • CONFIGURE
  • START
  • STOP
HostGroupIdList.N RepeatList 否 1

机器组的ID。您可以调用ListClusterHostGroup查看机器组ID。

HostIdList String 否 ""

主机ID列表，以英文半角逗号（,）分割。
CustomCommand String 否 ""

在ServiceActionName为CUSTOM_COMMAND时，需要指定。例如refreshQueues。

ComponentNameList String 否 Tomcat

组件名称列表，用英文半角逗号（,）分割。
Comment String 否 test run action

本次操作的备注信息。
IsRolling Boolean 否 true

是否滚动操作。
ExecuteStrategy String 否 FAILED_BLOCK

任务执行策略：

  • FAILED_BLOCK
  • FAILED_CONTINUE
CustomParams String 否 ""

运行自定义Action时的可选配置参数，目前只支持kafka的innode_disks_balance。

Interval Long 否 60

每个任务的执行时间间隔，IsRolling为true时可以指定。

NodeCountPerBatch Integer 否 2

每个批次在多少个主机上执行，IsRolling为true时可以指定。

TotlerateFailCount Integer 否 5

预留字段。
OnlyRestartStaleConfigNodes Boolean 否 true

是否只修改配置项的主机执行命令：

  • true：是
  • false：否
TurnOnMaintenanceMode Boolean 否 false

开启维护模式：

  • true：是
  • false：否

返回数据

名称 类型 示例值 描述
RequestId String 9AEDC439-1F63-491D-B8C6-9737C372BF3A

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=RunClusterServiceAction
&ClusterId=C-F32FB31D8295****
&RegionId=cn-hangzhou
&ServiceActionName=STOP
&<公共请求参数>

正常返回示例

XML 格式 

<requestId>9AEDC439-1F63-491D-B8C6-9737C372BF3A</requestId>

JSON 格式 

{
    "requestId": "9AEDC439-1F63-491D-B8C6-9737C372BF3A"
}