Node group list

Use cases #

Call CreateCluster to obtain a list of node groups for an E-MapReduce (EMR) cluster.

Important notes #

You must have a Volcano Engine account and have enabled EMR permissions.

Request description #

Request method: POST
Request URL: https://emr.cn-beijing.volcengineapi.com/?Version=2023-08-15&Action=ListNodeGroups

Debug #

Request parameters #

The following table lists only the unique request parameters for this API and some common parameters. For more information, see common parameters.

const columns = [ 
  { 
title: 'Parameter', 
    dataIndex: 'Name', 
  }, 
  { 
    width: '9%', 
title: 'Type', 
    dataIndex: 'DataType', 
  }, 
  { 
    width: '9%', 
title: 'Required', 
    dataIndex: 'IsRequired', 
  }, 
  { 
    width: '18%', 
title: 'Example value', 
    dataIndex: 'Example', 
  }, 
  { 
    width: '55%', 
title: 'Description', 
    dataIndex: 'Description', 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"ListNodeGroups"} />, 
Description: <RenderMd content={"Operation to be performed. Value: ListNodeGroups"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Version', 
    Name: 'Version', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"2023-08-15"} />, 
Description: <RenderMd content={"API version. Value: 2023-08-15"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterId', 
    Name: 'ClusterId', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"emr-xxx"} />, 
Description: <RenderMd content={"Cluster ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NodeGroupIds', 
    Name: 'NodeGroupIds', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["core-1.emr-xxx"]"} />, 
Description: <RenderMd content={"List of node group IDs"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NodeGroupNames', 
    Name: 'NodeGroupNames', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["CoreGroup"]"} />, 
Description: <RenderMd content={"List of node group names"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NodeGroupTypes', 
    Name: 'NodeGroupTypes', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["CORE"]"} />, 
Description: <RenderMd content={"List of node group types: MASTER, CORE, TASK"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->MaxResults', 
    Name: 'MaxResults', 
    DataType: 'Integer', 
IsRequired: 'No', 
    Example: <RenderMd content={"10"} />, 
Description: <RenderMd content={"Maximum number of records returned"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NextToken', 
    Name: 'NextToken', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"xxx"} />, 
Description: <RenderMd content={"Token for the next page in paginated queries"} />, 
    children: [ 
    ] 
  }, 
  
]; 

return (<Table 
  rowKey="rowKey" 
  className="openapi-doc-parameter-table" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  pagination={false} 
/>);

Response parameters #

The following table lists only the unique response parameters for this API. For more information, see response structure

const columns = [ 
  { 
title: 'Parameter', 
    dataIndex: 'Name', 
  }, 
  { 
title: 'Type', 
    dataIndex: 'DataType', 
    width: '10%', 
  }, 
  { 
title: 'Example value', 
    dataIndex: 'Example', 
    width: '20%', 
  }, 
  { 
title: 'Description', 
    dataIndex: 'Description', 
    width: '60%', 
  }, 
]; 
    
const data = [ 
  { 
    rowKey: "->ZoneId", 
    Name: "ZoneId", 
    DataType: "String", 
    Example: <RenderMd content={"cn-beijing-b\n\n"} />, 
    Description: <RenderMd content={"zoneID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->NodeGroupId", 
    Name: "NodeGroupId", 
    DataType: "String", 
    Example: <RenderMd content={"core-1.emr-xxx"} />, 
Description: <RenderMd content={"Node group ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->NodeGroupName", 
    Name: "NodeGroupName", 
    DataType: "String", 
    Example: <RenderMd content={"CoreGroup"} />, 
Description: <RenderMd content={"Node group name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->NodeGroupType", 
    Name: "NodeGroupType", 
    DataType: "String", 
    Example: <RenderMd content={"CORE"} />, 
Description: <RenderMd content={"Node group type"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->WithPublicIp", 
    Name: "WithPublicIp", 
    DataType: "String", 
    Example: <RenderMd content={"false"} />, 
Description: <RenderMd content={"Whether public network is enabled"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ChargeType", 
    Name: "ChargeType", 
    DataType: "String", 
    Example: <RenderMd content={"PRE,POST"} />, 
Description: <RenderMd content={"Billing type"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->EcsInstanceTypes", 
    Name: "EcsInstanceTypes", 
    DataType: "Array of String", 
    Example: <RenderMd content={"["ecs.r3i.xlarge"]"} />, 
Description: <RenderMd content={"List of ECS instance types"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->SubnetIds", 
    Name: "SubnetIds", 
    DataType: "Array of String", 
    Example: <RenderMd content={"["subnet-xxx"]"} />, 
Description: <RenderMd content={"List of subnet IDs"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->LayoutComponentNames", 
    Name: "LayoutComponentNames", 
    DataType: "Array of String", 
    Example: <RenderMd content={"["NAMENODE","DATANODE"]"} />, 
Description: <RenderMd content={"List of deployed component names"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->CreateTime", 
    Name: "CreateTime", 
    DataType: "Long", 
    Example: <RenderMd content={"7564423"} />, 
Description: <RenderMd content={"Creation time"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->TerminateTime", 
    Name: "TerminateTime", 
    DataType: "Long", 
    Example: <RenderMd content={"7564423"} />, 
Description: <RenderMd content={"Cluster termination time"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->SystemDisk", 
    Name: "SystemDisk", 
    DataType: "SystemDisk", 
    Example: <RenderMd content={"{\n                    "Category": "cloud_essd",\n                    "Size": 80,\n                    "PerformanceLevel": "ESSD_FlexPL"\n                }"} />, 
Description: <RenderMd content={"System disk information"} />, 
    children: [ 
        { 
          rowKey: "->SystemDisk->PerformanceLevel", 
          Name: "PerformanceLevel", 
          DataType: "String", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Disk performance type"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->SystemDisk->VolumeType", 
          Name: "VolumeType", 
          DataType: "String", 
Example: <RenderMd content={"ESSD_PL0 //Ultra-fast SSD_PL0\nESSD_PL1 //Ultra-fast SSD_PL1\nESSD_PL2 //Ultra-fast SSD_PL2\nESSD_PL3 //Ultra-fast SSD_PL3\nESSD_FLEXPL //Ultra-fast SSD_FlexPL\nULTRA_DISK //High-efficiency cloud disk\nPTSSD //Performance SSD\nSSD //General SSD\nEHDD //High-efficiency cloud disk\nZENYA_SSD //Zenya\nLOCAL_HDD //Big data HDD\nLOCAL_SSD //Local SSD\nLOCAL_SSD_SRIOV //Local SSD SRIOV"} />, 
Description: <RenderMd content={"Disk type"} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
  { 
    rowKey: "->DataDisks", 
    Name: "DataDisks", 
    DataType: "Array of DataDisk", 
    Example: <RenderMd content={"[\n                    {\n                        "Category": "cloud_essd",\n                        "Size": 80,\n                        "PerformanceLevel": "ESSD_FlexPL",\n                        "Count": 1\n                    }\n                ]"} />, 
Description: <RenderMd content={"Data disk information"} />, 
    children: [ 
        { 
          rowKey: "->DataDisks->Size", 
          Name: "Size", 
          DataType: "Integer", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Disk size. Default value: 80 GB; minimum: 60 GB; maximum: 2048 GB; unit: GB"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->DataDisks->Count", 
          Name: "Count", 
          DataType: "Integer", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Number of disk blocks. Default value: 4; maximum: 15; minimum: 1"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->DataDisks->VolumeType", 
          Name: "VolumeType", 
          DataType: "String", 
Example: <RenderMd content={"ESSD_PL0 //Ultra-fast SSD_PL0\nESSD_PL1 //Ultra-fast SSD_PL1\nESSD_PL2 //Ultra-fast SSD_PL2\nESSD_PL3 //Ultra-fast SSD_PL3\nESSD_FLEXPL //Ultra-fast SSD_FlexPL\nULTRA_DISK //High-efficiency cloud disk\nPTSSD //Performance SSD\nSSD //General SSD\nEHDD //High-efficiency cloud disk\nZENYA_SSD //Zenya\nLOCAL_HDD //Big data HDD\nLOCAL_SSD //Local SSD\nLOCAL_SSD_SRIOV //Local SSD SRIOV"} />, 
Description: <RenderMd content={"Disk type"} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
  { 
    rowKey: "->NodeGroupState", 
    Name: "NodeGroupState", 
    DataType: "String", 
Example: <RenderMd content={"RUNNING, //Running\nEXTENDING, //Scaling out\nREDUCING, //Scaling in\nDISK_EXTENDING, //Disk scaling out\nMODIFYING; //Configuration change"} />, 
Description: <RenderMd content={"Node group state"} />, 
    children: [ 
    ] 
  }, 
]; 

return (<Table 
  rowKey="rowKey" 
  className="openapi-doc-parameter-table" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  pagination={false} 
/>);

Sample request #

{ 
    "RequestId":null, 
    "RegionId":"cn-beijing", 
    "UserId":510xxx, 
    "AccountId":2100xxx, 
    "ClusterId":"emr-xxx" 
}

Sample response #

{ 
    "ResponseMetadata": { 
        "RequestId": "20231205164557BD00623CC2xxx", 
        "Action": "ListNodeGroups", 
        "Version": "2023-08-15", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "Items": [ 
            { 
                "ZoneId": null, 
                "NodeGroupId": "task-1.emr-xxx", 
                "NodeGroupName": "aa11", 
                "NodeGroupType": "TASK", 
                "WithPublicIp": "false", 
                "ChargeType": "POST", 
                "EcsInstanceTypes": [ 
                    "ecs.r2i.xlarge" 
                ], 
                "SubnetIds": null, 
                "LayoutComponentNames": [], 
                "CreateTime": null, 
                "TerminateTime": null, 
                "SystemDisk": { 
                    "Size": 80, 
                    "VolumeType": "ESSD_PL0" 
                }, 
                "DataDisks": [ 
                    { 
                        "Size": 80, 
                        "VolumeType": "ESSD_PL0", 
                        "Count": 1 
                    } 
                ], 
                "NodeGroupState": "RUNNING" 
            }, 
            { 
                "ZoneId": null, 
                "NodeGroupId": "core-1.emr-xxx", 
                "NodeGroupName": "CoreGroup", 
                "NodeGroupType": "CORE", 
                "WithPublicIp": "false", 
                "ChargeType": "POST", 
                "EcsInstanceTypes": [ 
                    "ecs.r3i.xlarge" 
                ], 
                "SubnetIds": null, 
                "LayoutComponentNames": [], 
                "CreateTime": null, 
                "TerminateTime": null, 
                "SystemDisk": { 
                    "Size": 80, 
                    "VolumeType": "ESSD_PL0" 
                }, 
                "DataDisks": [ 
                    { 
                        "Size": 80, 
                        "VolumeType": "ESSD_PL0", 
                        "Count": 1 
                    } 
                ], 
                "NodeGroupState": "RUNNING" 
            },... 
        ], 
        "TotalCount": 3, 
        "MaxResults": 10, 
        "NextToken": "lnXl1C2wTNK9iCZYl6gbVA==" 
    } 
}

Error codes #

The following table lists the error codes related to the business logic of this API. For common error codes, see the common error codes documentation.