Order list

Use cases #

Call ListOrders to obtain the E-MapReduce (EMR) cluster order list.

Important notes #

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

Request note #

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 unique request parameters for 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 value', 
    dataIndex: 'Example', 
  }, 
  { 
    width: '55%', 
title: 'Description', 
    dataIndex: 'Description', 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"ListOrders"} />, 
Description: <RenderMd content={"The operation to perform. Value: ListOrders"} />, 
    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: '->ClusterIds', 
    Name: 'ClusterIds', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["emr-xxx"]"} />, 
Description: <RenderMd content={"Cluster ID list\n"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->OperationIds', 
    Name: 'OperationIds', 
    DataType: 'Array of String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["xxx"]"} />, 
Description: <RenderMd content={"Cluster version\n"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->MaxResults', 
    Name: 'MaxResults', 
    DataType: 'Integer', 
IsRequired: 'No', 
    Example: <RenderMd content={"10"} />, 
Description: <RenderMd content={"Maximum number of records returned. Default: 10"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NextToken', 
    Name: 'NextToken', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"57N8YtDWZ1LbCkWySngtD3Lxxx"} />, 
Description: <RenderMd content={"Token for the next page in paginated queries"} />, 
    children: [ 
    ] 
  }, 
  
]; 

return (<Table 
  rowKey="rowKey" 
  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

Sample request #

{ 
    
}

Sample response #

{ 
    "ResponseMetadata": { 
        "RequestId": "202312051150159D5D21B9F5E94xxx", 
        "Action": "ListOrders", 
        "Version": "2023-08-15", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "Items": [ 
            { 
                "ClusterId": "emr-xxx", 
                "OrderId": "Orderxxx", 
                "OperationId": "xxx", 
                "CreateTime": 1701694821000 
            }, 
            { 
                "ClusterId": "emr-xxx", 
                "OrderId": "Orderxxx", 
                "OperationId": "xxx", 
                "CreateTime": 1701666755000 
            },... 
        ], 
        "TotalCount": 817, 
        "MaxResults": 10, 
        "NextToken": "57N8YtDWZ1LbCkWySngtD3Lyye/WxFnXFH9oUCusA4iGVz2K4HRSKSZoqxPp9/Rm" 
    } 
}

Error codes #

You can visit common error codes for more information about error codes.