文档中心

ListNodeGroups - 节点组列表

最近更新时间：2024.03.20 16:29:49

首次发布时间：2024.01.22 15:49:19

节点组列表

使用场景

调用 CreateCluster，获取一个 E-MapReduce（EMR）集群节点组列表。

注意事项

已拥有火山引擎账号并开通 EMR 权限。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Version=2023-08-15&Action=ListNodeGroups

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListNodeGroups	要执行的操作，取值：ListNodeGroups
Version	String	是	2023-08-15	API的版本，取值：2023-08-15
ClusterId	String	是	emr-xxx	集群ID
NodeGroupIds	Array of String	否	["core-1.emr-xxx"]	节点组ID列表
NodeGroupNames	Array of String	否	["CoreGroup"]	节点组名称列表
NodeGroupTypes	Array of String	否	["CORE"]	节点组类型列表，MASTER、CORE、TASK
MaxResults	Integer	否	10	返回的最大记录数
NextToken	String	否	xxx	分页查询的下一页token

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数	类型	示例值	描述
ZoneId	String	cn-beijing-b	zoneID
NodeGroupId	String	core-1.emr-xxx	节点组ID
NodeGroupName	String	CoreGroup	节点组名称
NodeGroupType	String	CORE	节点组类型
WithPublicIp	String	false	是否开启公网
ChargeType	String	PRE,POST	付费类型
EcsInstanceTypes	Array of String	["ecs.r3i.xlarge"]	ecs实例规格列表
SubnetIds	Array of String	["subnet-xxx"]	子网ID列表
LayoutComponentNames	Array of String	["NAMENODE","DATANODE"]	部署的组件名称列表
CreateTime	Long	7564423	创建时间
TerminateTime	Long	7564423	集群终止时间
SystemDisk	SystemDisk	{ "Category": "cloud_essd", "Size": 80, "PerformanceLevel": "ESSD_FlexPL" }	系统盘信息
DataDisks	Array of DataDisk	[ { "Category": "cloud_essd", "Size": 80, "PerformanceLevel": "ESSD_FlexPL", "Count": 1 } ]	数据盘信息
NodeGroupState	String	RUNNING, //运行中 EXTENDING, //扩容中 REDUCING, //缩容中 DISK_EXTENDING, //磁盘扩容中 MODIFYING; //变配中	节点组状态

请求示例

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

返回示例

{
    "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=="
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidClusterId	cluster id {clusterId} not found	集群不存在
400	InvalidRequest	Access Denied {clusterId}	对该集群没有权限