Component instance list

Note #

Call ListComponentInstances to obtain a list of E-MapReduce (EMR) cluster component instances.

important notes #

Ensure that you have a Volcano Engine account and EMR permissions enabled.

Note #

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

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: '20%', 
title: 'Parameters', 
    dataIndex: 'Name', 
    className: 'openapi-doc-parameter-table-name' 
  }, 
  { 
    width: 130, 
title: 'Types', 
    dataIndex: 'DataType', 
    className: 'openapi-doc-parameter-table-type' 
  }, 
  { 
    width: 90, 
title: 'Required', 
    dataIndex: 'IsRequired', 
    className: 'openapi-doc-parameter-table-required' 
  }, 
  { 
    width: '20%', 
title: 'Example values', 
    dataIndex: 'Example', 
    className: 'openapi-doc-parameter-table-example' 
  }, 
  { 
title: 'Note', 
    dataIndex: 'Description', 
    className: 'openapi-doc-parameter-table-description' 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"ListComponentInstances"} />, 
Description: <RenderMd content={"The operation to perform. Value: ListComponentInstances."} />, 
    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: '->ApplicationNames', 
    Name: 'ApplicationNames', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["HDFS"]"} />, 
Description: <RenderMd content={"List of service names"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NodeIds', 
    Name: 'NodeIds', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["master-1.emr-xxx"]"} />, 
Description: <RenderMd content={"List of node IDs"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NodeNames', 
    Name: 'NodeNames', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["OpenApi-MasterGroup"]"} />, 
Description: <RenderMd content={"List of node names"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ComponentStates', 
    Name: 'ComponentStates', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["STARTED"]"} />, 
Description: <RenderMd content={"List of component states"} />, 
    children: [ 
    ] 
  }, 

]; 

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

response parameters #

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

sample request #

{ 
    "RequestId":null, 
    "RegionId":"cn-beijing", 
    "UserId":5100160, 
    "AccountId":2100075559, 
    "ClusterId":"emr-xxx", 
    "ApplicationNames": ["HDFS"] 
}

sample response #

{ 
    "ResponseMetadata": { 
        "RequestId": "2023120416015023718BD7E1xxx", 
        "Action": "ListComponentInstances", 
        "Version": "2023-08-15", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "Items": [ 
            { 
                "ClusterId": "emr-xxx", 
                "NodeId": "master-1-2.emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "ZKFC", 
                "InstanceState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "NodeId": "master-1-1.emr-xxx", 
                "ApplicationName": "HDFS", 
                "ComponentName": "ZKFC", 
                "InstanceState": "STARTED", 
                "CreateTime": null, 
                "StartTime": null 
            },... 
        ], 
        "TotalCount": 14, 
        "MaxResults": 10, 
        "NextToken": null 
    } 
}

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.