この API では、クラスターにインストールされたサービスの詳細をクエリします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 必須 DescribeClusterService

実行する操作。 値を DescribeClusterService に設定します。
ClusterId String 必須 C-F32FB31D8295****

クエリするタスクの ID 。
RegionId String 必須 cn-hangzhou

クラスターが属するリージョンの ID。
ServiceName String 必須 HDFS

クエリするサービスの名前 (例：HDFS 、 YARN)。
AccessKeyId String 任意 LTAI8ljWyu7y****

Alibaba Cloud から提供された AccessKey ID。 このパラメーターはユーザーを識別します。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String EBB4D49C-4064-4818-B3AE-4C6BE5FC8264

リクエストの ID。
ServiceInfo

クラスター内のサービスの情報。
ClusterServiceSummaryList

サービスのコンポーネントに関する情報。
ClusterServiceSummary

サービスのコンポーネントに関する情報。
AlertInfo String ""

コンポーネントの警告メッセージ。
Category String MASTER

コンポーネントのタイプ。 有効値：Client、MASTER、SLAVE。
DesiredStoppedValue Integer 1

インストールされたコンポーネントの停止が予想されるホストの数。
DisplayName String NodeManager

コンポーネントの表示名。
Key String NodeManager

コンポーネントキー。 コンポーネントの名前を指定します。
Status String OK

コンポーネントのステータス。
Type String COMPONENT

コンポーネントのタイプ。
Value String 20/20 Started

コンポーネントがインストールされているホスト上のコンポーネントのステータス。
NeedRestartComponentNameList ["NodeManager","ResourceManager"]

再起動するコンポーネントの名前。
Service

再起動するコンポーネントの名前。
NeedRestartHostIdList ["HostId1"]

再起動するコンポーネントが配置されているクラスター内のホストの ID。
Service

再起動するコンポーネントが配置されているクラスター内のホストの ID。
NeedRestartInfo String ""

現在のサービスで再起動するコンポーネントの情報。
NeedRestartNum Integer 0

現在のサービスで再起動するコンポーネントの数。
ServiceActionList

サービスがサポートしている操作のリスト。
ServiceAction

サービスがサポートしている操作。
ActionName String CUSTOM_COMMAND

操作名。
Command String refreshQueues

ActionName パラメーターが CUSTOM_COMMAND に設定されている場合にのみ、Command パラメーターを指定できます。 異なるサービスで異なるコマンドがサポートされています。 YARN は refreshQueues 、 enableCGroups 、 disableCGroups コマンドをサポートしています。

ComponentName String NodeManager

操作を実行するコンポーネントの名前。
DisplayName String RESTART NodeManager

操作の表示名。
ServiceName String YARN

サービスの名前。
ServiceName String YARN

サービスの名前。
ServiceStatus String INSTALLED

サービスのステータス。
ServiceVersion String 2.7.2

サービスのバージョンです。

例

リクエストの例


http(s)://[Endpoint]/? Action=DescribeClusterService
&ClusterId=C-F32FB31D8295****
&RegionId=cn-hangzhou
&ServiceName=HDFS
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<DescribeClusterServiceResponse>
	  <data>
		    <RequestId>7A23195A-BC03-4D82-BED5-90ED0D36F002</RequestId>
		    <ServiceInfo>
			      <NeedRestartHostIdList></NeedRestartHostIdList>
			      <ServiceActionList>
				        <ServiceAction>
					          <ActionName>CONFIGURE</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>CONFIGURE All Components</DisplayName>
					          <ComponentName>ALL COMPONENTS</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>START</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>START All Components</DisplayName>
					          <ComponentName>ALL COMPONENTS</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>STOP</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>STOP All Components</DisplayName>
					          <ComponentName>ALL COMPONENTS</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>RESTART</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>RESTART All Components</DisplayName>
					          <ComponentName>ALL COMPONENTS</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>RESTART</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>RESTART NodeManager</DisplayName>
					          <ComponentName>NodeManager</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>RESTART</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>RESTART WebAppProxyServer</DisplayName>
					          <ComponentName>WebAppProxyServer</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>RESTART</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>RESTART JobHistory</DisplayName>
					          <ComponentName>JobHistory</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName> RESTART</ActionName>
					          <serviceName>YARN</serviceName>
					          <DisplayName>RESTART ResourceManager</DisplayName>
					          <ComponentName>ResourceManager</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <ActionName>RESTART</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>RESTART App Timeline Server</DisplayName>
					          <ComponentName>TimeLineServer</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <Command>refreshQueues</Command>
					          <ActionName>CUSTOM_COMMAND</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>Refresh Queues</DisplayName>
					          <ComponentName>ResourceManager</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <Command>enableCGroups</Command>
					          <ActionName>CUSTOM_COMMAND</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>Enable CGroups</DisplayName>
					          <ComponentName>NodeManager</ComponentName>
				        </ServiceAction>
				        <ServiceAction>
					          <Command>disableCGroups</Command>
					          <ActionName>CUSTOM_COMMAND</ActionName>
					          <ServiceName>YARN</ServiceName>
					          <DisplayName>Disable CGroups</DisplayName>
					          <ComponentName>NodeManager</ComponentName>
				        </ServiceAction>
			      </ServiceActionList>
			      <serviceName>YARN</serviceName>
			      <NeedRestartInfo></NeedRestartInfo>
			      <NeedRestartNum>0</NeedRestartNum>
			      <ClusterServiceSummaryList>
				        <ClusterServiceSummary>
					          <Status>OK</Status>
					          <Value>20/20 Started</Value>
					          <Key>NodeManager</Key>
					          <Type>COMPONENT</Type>
					          <DisplayName>NodeManager</DisplayName>
					          <AlertInfo></AlertInfo>
				        </ClusterServiceSummary>
				        <ClusterServiceSummary>
					          <Status>OK</Status>
					          <Value>1/1 Started</Value>
					          <Key>JobHistory</Key>
					          <Type>COMPONENT</Type>
					          <DisplayName>JobHistory</DisplayName>
					          <AlertInfo></AlertInfo>
				        </ClusterServiceSummary>
				        <ClusterServiceSummary>
					          <Status>OK</Status>
					          <Value>22/22 Installed</Value>
					          <Key>YarnInit</Key>
					          <Type>COMPONENT</Type>
					          <DisplayName>Yarn Client</DisplayName>
					          <AlertInfo></AlertInfo>
				        </ClusterServiceSummary>
				        <ClusterServiceSummary>
					          <Status>OK</Status>
					          <Value>1/1 Started</Value>
					          <Key>TimeLineServer</Key>
					          <Type>COMPONENT</Type>
					          <DisplayName>App Timeline Server</DisplayName>
					          <AlertInfo></AlertInfo>
				        </ClusterServiceSummary>
				        <ClusterServiceSummary>
					          <Status>OK</Status>
					          <Status>OK</Status>
					          <Key>WebAppProxyServer</Key>
					          <Type>COMPONENT</Type>
					          <DisplayName>WebAppProxyServer</DisplayName>
					          <AlertInfo></AlertInfo>
				        </ClusterServiceSummary>
				        <ClusterServiceSummary>
					          <Status>OK</Status>
					          <Value>2/2 Started</Value>
					          <Key>ResourceManager</Key>
					          <Type>COMPONENT</Type>
					          <DisplayName>ResourceManager</DisplayName>
					          <AlertInfo></AlertInfo>
				        </ClusterServiceSummary>
			      </ClusterServiceSummaryList>
			      <ServiceVersion>2.7.2-1.3.1</ServiceVersion>
			      <NeedRestartComponentNameList></NeedRestartComponentNameList>
			      <ServiceStatus>INSTALLING</ServiceStatus>
		    </ServiceInfo>
	  </data>
	  <requestId>7A23195A-BC03-4D82-BED5-90ED0D36F002</requestId>
</DescribeClusterServiceResponse>

JSON 形式 

{
	"requestId":"7A23195A-BC03-4D82-BED5-90ED0D36F002",
	"data":{
		"RequestId":"7A23195A-BC03-4D82-BED5-90ED0D36F002",
		"ServiceInfo":{
			"NeedRestartHostIdList":{
				"Service":[]
			},
			"ServiceActionList":{
				"ServiceAction":[
					{
						"ActionName":"CONFIGURE",
						"ServiceName":"YARN",
						"DisplayName":"CONFIGURE All Components",
						"ComponentName":"ALL COMPONENTS"
					},
					{
						"ActionName":"START",
						"ServiceName":"YARN",
						"DisplayName":"START All Components",
						"ComponentName":"ALL COMPONENTS"
					},
					{
						"ActionName":"STOP",
						"ServiceName":"YARN",
						"DisplayName":"STOP All Components",
						"ComponentName":"ALL COMPONENTS"
					},
					{
						"ActionName":"RESTART",
						"ServiceName":"YARN",
						"DisplayName":"RESTART All Components",
						"ComponentName":"ALL COMPONENTS"
					},
					{
						"ActionName":"RESTART",
						"ServiceName":"YARN",
						"DisplayName":"RESTART NodeManager",
						"ComponentName":"NodeManager"
					},
					{
						"ActionName":"RESTART",
						"ServiceName":"YARN",
						"DisplayName":"RESTART WebAppProxyServer",
						"ComponentName":"WebAppProxyServer"
					},
					{
						"ActionName":"RESTART",
						"ServiceName":"YARN",
						"DisplayName":"RESTART JobHistory",
						"ComponentName":"JobHistory"
					},
					{
						"ActionName":"RESTART",
						"ServiceName":"YARN",
						"DisplayName":"RESTART ResourceManager",
						"ComponentName":"ResourceManager"
					},
					{
						"ActionName":"RESTART",
						"ServiceName":"YARN",
						"DisplayName":"RESTART App Timeline Server",
						"ComponentName":"TimeLineServer"
					},
					{
						"Command":"refreshQueues",
						"ActionName":"CUSTOM_COMMAND",
						"ServiceName":"YARN",
						"DisplayName":"Refresh Queues",
						"ComponentName":"ResourceManager"
					},
					{
						"Command":"enableCGroups",
						"ActionName":"CUSTOM_COMMAND",
						"ServiceName":"YARN",
						"DisplayName":"Enable CGroups",
						"ComponentName":"NodeManager"
					},
					{
						"Command":"disableCGroups",
						"ActionName":"CUSTOM_COMMAND",
						"ServiceName":"YARN",
						"DisplayName":"Disable CGroups",
						"ComponentName":"NodeManager"
					}
				]
			},
			"ServiceName":"YARN",
			"NeedRestartInfo":"",
			"ClusterServiceSummaryList":{
				"ClusterServiceSummary":[
					{
						"Status":"OK",
						"Value":"20/20 Started",
						"Key":"NodeManager",
						"Type":"COMPONENT",
						"DisplayName":"NodeManager",
						"AlertInfo":""
					},
					{
						"Status":"OK",
						"Value":"1/1 Started",
						"Key":"JobHistory",
						"Type":"COMPONENT",
						"DisplayName":"JobHistory",
						"AlertInfo":""
					},
					{
						"Status":"OK",
						"Value":"22/22 Installed",
						"Key":"YarnInit",
						"Type":"COMPONENT",
						"DisplayName":"Yarn Client",
						"AlertInfo":""
					},
					{
						"Status":"OK",
						"Value":"1/1 Started",
						"Key":"TimeLineServer",
						"Type":"COMPONENT",
						"DisplayName":"App Timeline Server",
						"AlertInfo":""
					},
					{
						"Status":"OK",
						"Value":"1/1 Started",
						"Key":"WebAppProxyServer",
						"Type":"COMPONENT",
						"DisplayName":"WebAppProxyServer",
						"AlertInfo":""
					},
					{
						"Status":"OK",
						"Value":"2/2 Started",
						"Key":"ResourceManager",
						"Type":"COMPONENT",
						"DisplayName":"ResourceManager",
						"AlertInfo":""
					}
				]
			},
			"NeedRestartNum":0,
			"ServiceVersion":"2.7.2-1.3.1",
			"NeedRestartComponentNameList":{
				"Service":[]
			},
			"ServiceStatus":"INSTALLING"
		}
	}
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 操作
400 InvalidServiceName The cluster doesn't have this service. 指定されたサービスがクラスターに存在しない場合に返されるエラーメッセージ。
403 Params.Illegal The specified parameters are wrongly formed. 指定されたパラメーターが無効な場合に返されるエラーメッセージ。
404 ClusterId.NotFound ClusterId [%s] does not exist. 指定された ClusterId パラメーターが存在しない場合に返されるエラーメッセージ。 クラスターの ID が有効であるか確認してください。
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource. 他のユーザーのリソースを管理する権限が付与されていない場合に返されるエラーメッセージ。
500 InternalError The request processing has failed due to some unknown error. 内部エラーのためにリクエスト処理が失敗した場合に返されるエラーメッセージ。 チケットを起票してください。

エラーコードについては、「API エラーセンター」をご参照ください。