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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
ServiceName String TEZ

服务名称。

Action String RunClusterServiceAction

系统规定参数。取值:RunClusterServiceAction。

ClusterId String C-F32FB31D8295****

集群ID。

RegionId String cn-hangzhou

地域ID。

ServiceActionName String STOP

Action名。

Comment String test run action

本次操作的备注信息。

ComponentNameList String Tomcat

组件名称列表,用英文半角逗号(,)分割。

CustomCommand String ""

在Action为CUSTOM_COMMAND时,需要指定,例如,refreshQueues

CustomParams String ""

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

ExecuteStrategy String FAILED_BLOCK

任务执行策略,枚举值:

  • FAILED_BLOCK
  • FAILED_CONTINUE
HostGroupIdList.N RepeatList 1

机器组的ID。

HostIdList String ""

主机ID列表,以英文半角逗号(,)分割。

Interval Long 60

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

IsRolling Boolean true

是否滚动操作。

NodeCountPerBatch Integer 2

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

OnlyRestartStaleConfigNodes Boolean true

true时,只对修改了配置项的主机执行命令。

TotlerateFailCount Integer 5

预留字段。

TurnOnMaintenanceMode Boolean false

开启维护模式。

AccessKeyId String 111

阿里云AccessKey ID信息,用于标识访问者身份。

返回数据

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

请求ID。

示例

请求示例


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

正常返回示例

XML 格式

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

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
403 Params.Illegal The specified parameters are wrongly formed.. 指定参数格式错误
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource 不能操作其它用户的资源
403 User.Account.Abnormal The User Account maybe is out of service! 用户帐号已经停止服务
403 JobId.Not.Exist Job [%s] does not exist or is deleted! 指定作业ID不存在请填写正确的参数
403 Job.RegionId.Not.Match Specified job does not exist in this region[%s]! 指定作业不在此Region中,请填写正确的参数
500 InternalError The request processing has failed due to some unknown error. 内部错误,请提工单

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