Query cluster list

Note #

Call ListClusters to query all E-MapReduce (EMR) clusters under this account.

Important notes #

You have logged in to Volcano Engine with your account.

Request information #

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

Debugging #

Request parameters #

The following table lists only the request parameters specific to this API and some common parameters. For more information, see Common parameters.

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

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"ListClusters"} />, 
Description: <RenderMd content={"The operation to perform. Value: ListClusters"} />, 
    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: '->ClusterName', 
    Name: 'ClusterName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"OpenApiHadoop3.7.0-xxx"} />, 
Description: <RenderMd content={"Cluster name, fuzzy query"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterId', 
    Name: 'ClusterId', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"emr-xxx"} />, 
Description: <RenderMd content={"Cluster ID, fuzzy query"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ReleaseVersion', 
    Name: 'ReleaseVersion', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"3.7.0"} />, 
Description: <RenderMd content={"Cluster version"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ProjectName', 
    Name: 'ProjectName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"default"} />, 
Description: <RenderMd content={"Project name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->CreateTimeBefore', 
    Name: 'CreateTimeBefore', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"1701764286000"} />, 
Description: <RenderMd content={"Start date, timestamp in ms"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->CreateTimeAfter', 
    Name: 'CreateTimeAfter', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"1701764286300"} />, 
Description: <RenderMd content={"End date, timestamp in ms"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterIds', 
    Name: 'ClusterIds', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["emr-xxx]"} />, 
Description: <RenderMd content={"Cluster ID list"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterTypes', 
    Name: 'ClusterTypes', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["Hadoop"]"} />, 
Description: <RenderMd content={"Cluster type list"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterStates', 
    Name: 'ClusterStates', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["RUNNING"]"} />, 
Description: <RenderMd content={"Cluster state list"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ChargeTypes', 
    Name: 'ChargeTypes', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["POST"]"} />, 
Description: <RenderMd content={"Cluster billing type list"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Tags', 
    Name: 'Tags', 
    DataType: 'Array of Tag', 
IsRequired: 'No', 
    Example: <RenderMd content={"xxx"} />, 
Description: <RenderMd content={"Tag list"} />, 
    children: [ 
        { 
          rowKey: '->Tags->Key', 
          Name: 'Key', 
          DataType: 'String', 
IsRequired: 'Yes', 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Tag key"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: '->Tags->Value', 
          Name: 'Value', 
          DataType: 'String', 
IsRequired: 'Yes', 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Tag value"} />, 
          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={"57N8YtDWxxx"} />, 
Description: <RenderMd content={"Next page token for paginated query"} />, 
    children: [ 
    ] 
  }, 
  
]; 

return (<Table 
  rowKey="rowKey" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  pagination={false} 
/>);

Response parameters #

The following table lists only the response parameters specific to this API. For more information, see Response structure

const columns = [ 
  { 
title: 'Parameter', 
    dataIndex: 'Name', 
    width: '10%', 
  }, 
  { 
title: 'Type', 
    dataIndex: 'DataType', 
    width: '10%', 
  }, 
  { 
title: 'Example', 
    dataIndex: 'Example', 
    width: '20%', 
  }, 
  { 
title: 'Description', 
    dataIndex: 'Description', 
    width: '60%', 
  }, 
]; 
    
const data = [ 
  { 
    rowKey: "->RegionId", 
    Name: "RegionId", 
    DataType: "String", 
    Example: <RenderMd content={"cn-beijing"} />, 
Description: <RenderMd content={"Region ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ProjectName", 
    Name: "ProjectName", 
    DataType: "String", 
    Example: <RenderMd content={"default"} />, 
Description: <RenderMd content={"Project name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ClusterId", 
    Name: "ClusterId", 
    DataType: "String", 
    Example: <RenderMd content={"emr-xxx"} />, 
Description: <RenderMd content={"Cluster ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ClusterName", 
    Name: "ClusterName", 
    DataType: "String", 
    Example: <RenderMd content={"OpenApiHadoop3.7.0-xxx"} />, 
Description: <RenderMd content={"Cluster name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ClusterType", 
    Name: "ClusterType", 
    DataType: "String", 
    Example: <RenderMd content={"Hadoop"} />, 
Description: <RenderMd content={"Cluster type"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ReleaseVersion", 
    Name: "ReleaseVersion", 
    DataType: "String", 
    Example: <RenderMd content={"3.7.0"} />, 
Description: <RenderMd content={"Cluster version"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->SecurityGroupId", 
    Name: "SecurityGroupId", 
    DataType: "String", 
    Example: <RenderMd content={"sg-xxx"} />, 
Description: <RenderMd content={"Cluster global security group ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->VpcId", 
    Name: "VpcId", 
    DataType: "String", 
    Example: <RenderMd content={"vpc-xxx"} />, 
Description: <RenderMd content={"Private network"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->Creator", 
    Name: "Creator", 
    DataType: "String", 
    Example: <RenderMd content={"6xxx"} />, 
Description: <RenderMd content={"Creator"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->AccountId", 
    Name: "AccountId", 
    DataType: "String", 
    Example: <RenderMd content={"210xxx"} />, 
Description: <RenderMd content={"Account ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->NodeAttribute", 
    Name: "NodeAttribute", 
    DataType: "NodeAttribute", 
    Example: <RenderMd content={"{\n                    "ZoneId": "cn-beijing-b",\n                    "EcsIamRole": "VEECSforEMRRole"\n                }"} />, 
Description: <RenderMd content={"Global node attributes of the cluster"} />, 
    children: [ 
        { 
          rowKey: "->NodeAttribute->ZoneId", 
          Name: "ZoneId", 
          DataType: "String", 
          Example: <RenderMd content={""} />, 
          Description: <RenderMd content={"zoneId"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->NodeAttribute->EcsIamRole", 
          Name: "EcsIamRole", 
          DataType: "String", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"The IAM role name bound to the ECS."} />, "} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
  { 
    rowKey: "->ClusterState", 
    Name: "ClusterState", 
    DataType: "String", 
    Example: <RenderMd content={"PENDING_FOR_PAYMENT,CREATING,RUNNING,TERMINATING,TERMINATED,TERMINATED_WITH_ERROR,FAILED,SHUTDOWN"} />, 
children: [ 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ChargeType", 
    Name: "ChargeType", 
    DataType: "String", 
    Example: <RenderMd content={"PRE,POST"} />, 
children: [ 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->CreateTime", 
    Name: "CreateTime", 
    DataType: "Long", 
    Example: <RenderMd content={"1701764286214"} />, 
children: [ 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ReadyTime", 
    Name: "ReadyTime", 
    DataType: "Long", 
    Example: <RenderMd content={"1701764779378"} />, 
children: [ 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->ExpireTime", 
    Name: "ExpireTime", 
    DataType: "Long", 
    Example: <RenderMd content={"1701764286214"} />, 
children: [ 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->TerminateTime", 
    Name: "TerminateTime", 
    DataType: "Long", 
    Example: <RenderMd content={"1701764286214"} />, 
children: [ 
    children: [ 
    ] 
  }, 
  { 
    rowKey: "->StateChangeReason", 
    Name: "StateChangeReason", 
    DataType: "StateChangeReason", 
    Example: <RenderMd content={"xxx"} />, 
children: [ 
    children: [ 
        { 
          rowKey: "->StateChangeReason->code", 
          Name: "code", 
          DataType: "String", 
          Example: <RenderMd content={""} />, 
children: [ 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->StateChangeReason->reason", 
          Name: "reason", 
          DataType: "String", 
          Example: <RenderMd content={""} />, 
children: [ 
          children: [ 
          ] 
        }, 
    ] 
  }, 
]; 

return (<Table 
  rowKey="rowKey" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  pagination={false} 
/>);

{ #

{ 
    "ClusterId":"emr-xxx" 
}

{ #

{ 
    "ResponseMetadata": { 
        "RequestId": "20231205174720B3E08B8D2FB8E9xxx", 
        "Action": "ListClusters", 
        "Version": "2023-08-15", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "Items": [ 
            { 
                "RegionId": "cn-beijing", 
                "ProjectName": "default", 
                "ClusterId": "emr-xxx", 
                "ClusterName": "OpenApiHadoop3.7.0-xxx", 
                "ClusterType": "Hadoop", 
                "ReleaseVersion": "3.7.0", 
                "SecurityGroupId": "sg-xxx", 
                "VpcId": "xxx", 
                "Creator": "6xxx", 
                "AccountId": 2100xxx, 
                "NodeAttribute": { 
                    "ZoneId": "cn-beijing-b", 
                    "EcsIamRole": "VEECSforEMRRole", 
                    "LoginUserName": null 
                }, 
                "ClusterState": "RUNNING", 
                "ChargeType": "POST", 
                "CreateTime": 1701764286214, 
                "ReadyTime": 1701764779378, 
                "ExpireTime": null, 
                "TerminateTime": null, 
                "StateChangeReason": null 
            } 
        ], 
        "TotalCount": 1, 
        "MaxResults": 10, 
        "NextToken": "57N8YtDWZ1LbCkWySngtD53oS+eCiHNIpxxx" 
    } 
}

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. const columns = [

const columns = [ 
  { 
    title: 'HttpCode', 
    dataIndex: 'HttpCode', 
    width: '9%', 
  }, 
  { 
dataIndex: 'ErrorCode', 
    dataIndex: 'ErrorCode', 
    width: '13%', 
  }, 
  { 
dataIndex: 'ErrorMessage', 
    dataIndex: 'ErrorMessage', 
    width: '39%', 
  }, 
  { 
dataIndex: 'Description', 
    dataIndex: 'Description', 
    width: '39%', 
  }, 
]; 
    
const data = [ 
  { 
    HttpCode: 400, 
    ErrorCode: 'InvalidRequest', 
    ErrorMessage: "Access Denied {clusterId}", 
}, 
  }, 
]; 

return (<Table 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  pagination={false} 
/>);