ListNodeGroups によるノードグループのクエリ - E-MapReduce

EMR クラスターのノードグループをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr:ListNodeGroups

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
ClusterId	string	必須	クラスター ID。	c-b933c5aac8fe****
NextToken	string	任意	クエリの開始位置を示すトークンです。先頭からクエリを開始する場合は、このパラメーターを空のままにします。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	任意	1 回のリクエストで返すレコードの最大数。有効値：1～100。	20
NodeGroupIds	array	任意	ノードグループ ID のリスト。配列要素 N の数は 1～100 です。	c-b933c5aac8fe****
	string	任意	ノードグループ ID。	ng-869471354ecd****
NodeGroupNames	array	任意	ノードグループ名のリスト。配列要素 N の数は 1～100 です。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
	string	任意	ノードグループ名。	core-1
NodeGroupTypes	array	任意	ノードグループタイプのリスト。配列要素 N の数は 1～100 です。	20
	string	任意	ノードグループのタイプ。有効値： MASTER：マスターノードグループ。 CORE：コアノードグループ。 TASK：タスクノードグループ。	CORE
NodeGroupStates	array	任意	ノードグループの状態。配列要素 N の数は 1～100 です。	["CORE"]
	string	任意	ノードグループの状態。有効値： PROVISIONING：ノードグループは初期化中です。 INCREASING：ノードグループはスケールアウト中です。 DECREASING：ノードグループはスケールイン中です。 SUSPENDED：ノードグループは一時停止しています。 RUNNING：ノードグループは実行中です。 RECONFIGURING：ノードグループは再設定中です。 TERMINATING：ノードグループは終了処理中です。 TERMINATED：ノードグループは終了済みです。	RUNNING
ZoneId	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
NodeGroups	array	ノードグループの配列。
	NodeGroup	ノードグループ。
RequestId	string	リクエスト ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	次の結果ページを取得するためのトークンです。空の値は、すべての結果が返されたことを示します。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	リクエストに対して返されるエントリの最大数。	20
TotalCount	integer	クエリ条件に一致するエントリの総数。	200

例

成功レスポンス

JSONJSON

{
  "NodeGroups": [
    {
      "ZoneId": "cn-beijing-h",
      "NodeGroupId": "ng-869471354ecd****",
      "NodeGroupName": "core-1",
      "NodeGroupType": "CORE",
      "RunningNodeCount": 3,
      "InstanceTypes": [
        ""
      ],
      "PaymentType": "PayAsYouGo",
      "DataDisks": [
        {
          "Category": "cloud_essd",
          "Size": 80,
          "PerformanceLevel": "PL1",
          "Count": 5
        }
      ],
      "SystemDisk": {
        "Category": "cloud_essd",
        "Size": 60,
        "PerformanceLevel": "PL1",
        "Count": 1
      },
      "NodeGroupState": "CREATED",
      "AdditionalSecurityGroupIds": [
        ""
      ],
      "WithPublicIp": false,
      "VSwitchIds": [
        ""
      ],
      "SpotStrategy": "NoSpot",
      "SpotBidPrices": [
        {
          "InstanceType": "ecs.g7.2xlarge",
          "BidPrice": 1000
        }
      ],
      "StateChangeReason": {
        "Code": "MissingParameter",
        "Message": "The instance type is required."
      },
      "MinimalNodeCount": 0,
      "MaximalNodeCount": 200,
      "GracefulShutdown": false,
      "SpotInstanceRemedy": true,
      "CompensateWithOnDemand": true,
      "NodeResizeStrategy": "PRIORITY",
      "CostOptimizedConfig": {
        "OnDemandBaseCapacity": 80,
        "OnDemandPercentageAboveBaseCapacity": 80,
        "SpotInstancePools": 2
      },
      "DeploymentSetStrategy": "NONE",
      "AutoCompensateState": true,
      "ExtraAttributes": {
        "key": ""
      },
      "AckConfig": {
        "AckInstanceId": "",
        "NodeSelectors": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "Tolerations": [
          {
            "Key": "",
            "Value": "",
            "Operator": "",
            "Effect": ""
          }
        ],
        "Namespace": "",
        "RequestCpu": 0,
        "RequestMemory": 0,
        "LimitCpu": 0,
        "LimitMemory": 0,
        "DataDiskStorageClass": "",
        "DataDiskSize": 0,
        "CustomLabels": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "CustomAnnotations": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "MountHostCgroup": true,
        "NodeAffinity": "",
        "PodAntiAffinity": "",
        "PodAffinity": "",
        "PreStartCommand": [
          ""
        ],
        "Pvcs": [
          {
            "DataDiskStorageClass": "",
            "DataDiskSize": 0,
            "Path": "",
            "Name": ""
          }
        ],
        "Volumes": [
          {
            "Name": "",
            "Path": "",
            "Type": ""
          }
        ],
        "VolumeMounts": [
          {
            "Name": "",
            "Path": ""
          }
        ]
      },
      "IaaSType": "",
      "PrivatePoolOptions": {
        "PrivatePoolIds": [
          ""
        ],
        "MatchCriteria": "Open"
      },
      "Status": "CREATED"
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。