EMROnVKE cluster list

Use cases #

Call ListVirtualClusters to query all EMR on VKE virtual clusters under this account.

Important notes #

Request method: POST
Request URL: https://open.volcengineapi.com/?Version=2023-12-30&Action=ListVirtualClusters

Note #

A Volcano Engine account with EMR permissions enabled is required.

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 = [ 
  { 
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={"ListVirtualClusters"} />, 
Description: <RenderMd content={"The operation to perform. Value: ListVirtualClusters"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Version', 
    Name: 'Version', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"2023-12-30"} />, 
Description: <RenderMd content={"API version. Value: 2023-12-30"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterIds', 
    Name: 'ClusterIds', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"[]"} />, 
Description: <RenderMd content={"Cluster ID list"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterName', 
    Name: 'ClusterName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"xxx"} />, 
Description: <RenderMd content={"Cluster name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ClusterStates', 
    Name: 'ClusterStates', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"["RUNNING"]"} />, 
Description: <RenderMd content={"Cluster state list:\n- INIT        Initializing\n- INIT_FAILED Initialization failed\n- RUNNING     Running\n- DELETING    Deleting\n- DELETED     Deleted"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ProjectName', 
    Name: 'ProjectName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"default"} />, 
Description: <RenderMd content={"Volcano Engine project name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->MaxResults', 
    Name: 'MaxResults', 
    DataType: 'Integer', 
IsRequired: 'No', 
    Example: <RenderMd content={"10"} />, 
Description: <RenderMd content={"Maximum results per page, 1-100, default is 10"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->NextToken', 
    Name: 'NextToken', 
    DataType: 'Integer', 
IsRequired: 'No', 
    Example: <RenderMd content={"0"} />, 
Description: <RenderMd content={"Token for the next page in paginated queries, default is 0"} />, 
    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 response parameters specific to this API. For more information, see response structure

Sample request #

{}

Sample response #

{ 
        "Items": [ 
            { 
                "ClusterId": "emr-xxx", 
                "ClusterName": "clusterxxx", 
                "ReleaseVersion": "EMR-VKE-1.0.0", 
                "ClusterState": "RUNNING", 
                "StateChangeReason": "createCluster", 
                "Region": "cn-beijing", 
                "VpcId": "vpc-xxx", 
                "ProductName": "E-MapReduce-VKE", 
                "ProjectName": "default", 
                "CreateTime": 1710925721692, 
                "ReadyTime": 1710925753702, 
                "UpdateTime": 1710925721692, 
                "DeleteTime": null, 
                "AccountId": xxx, 
                "UserId": xxx, 
                "Creator": null, 
                "VkeClusterId": "xxx" 
            } 
        ], 
        "TotalCount": 1, 
        "NextToken": 0, 
        "MaxResults": 10 
    }

Error codes #

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