この操作では、クラスターの指定したサービスで指定した操作を実行します。
デバッグ
リクエストパラメーター
パラメーター | データ型 | 必須項目 | 例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | RunClusterServiceAction |
実行する操作です。 RunClusterServiceAction に値を設定します。 |
ClusterId | String | 必須 | C-F32FB31D82954C64 |
クラスターの ID です。 |
RegionId | String | 必須 | cn-hangzhou |
クラスターが属するリージョンの ID です。 |
ServiceActionName | String | 必須 | STOP |
サービスで実行される操作の名前です。 |
ServiceName | String | 任意 | TEZ |
サービスの名前です。 |
Comment | String | 任意 | test run action |
操作のコメントです。 |
ComponentNameList | String | 任意 | Tomcat |
サービスのコンポーネント名リストです。 各名前はコンマ (,) で区切る必要があります。 |
CustomCommand | String | 任意 | "" |
カスタム操作のコマンドです。 Action フィールドを CUSTOM_COMMAND に設定する場合は、refreshQueues などのカスタム操作を指定する必要があります。 |
CustomParams | String | 任意 | "" |
カスタム操作を実行するためのパラメーターです。 innode_disks_balance 操作は、Kafka クラスターでのみ実行することができます。 |
ExecuteStrategy | String | 任意 | FAILED_BLOCK |
タスクを実行するためのポリシーです。 有効値:
|
HostGroupIdList.N | RepeatList | 任意 | 1 |
ホストグループの ID です。 |
HostIdList | String | 任意 | "" |
ホストの ID です。 各 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 |
Alibaba Cloud から提供された AccessKey ID です。 このパラメーターはユーザーを識別します。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
RequestId | String | 9AEDC439-1F63-491D-B8C6-9737C372BF3A |
リクエストの ID です。 |
例
リクエストの例
http(s)://[Endpoint]/? Action=RunClusterServiceAction
&ClusterId=C-F32FB31D82954C64
&RegionId=cn-hangzhou
&ServiceActionName=STOP
&<Common request parameters>
通常のレスポンス例
XML
形式
<RunClusterServiceActionResponse>
<requestId> 9AEDC439-1F63-491D-B8C6-9737C372BF3A </ requestId>
</ RunClusterServiceActionResponse>
JSON
形式
{
"requestId":"9AEDC439-1F63-491D-B8C6-9737C372BF3A"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
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]! | ジョブがクラスターが存在するリージョンにない場合に返されるエラーメッセージ。 有効な値を指定します。 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部エラーのためにリクエスト処理が失敗した場合に返されるエラーメッセージ。 チケットを起票し、サポートセンターへお問い合わせください。 |
エラーコード一覧については、『API エラーセンター』をご参照ください。