use cases

Call GetVirtualCluster to query the details of the EMR on VKE virtual cluster under this account.

important notes

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

request parameters

The table below lists only the unique request parameters for this API and some common parameters. For more information, see common parameters.

Parameter	Type	Required	Example value	Description
Action	String	Yes	GetVirtualCluster	The operation to be performed. Value: GetVirtualCluster
Version	String	Yes	2023-12-30	API version. Value: 2023-12-30
ClusterId	String	Yes	emr-xxx	Cluster ID

response parameters

The table below lists only the unique response parameters for this API. For more information, see response structure

Parameter	Type	Example value	Description
ClusterId	String	emr-xxx	Cluster ID
ClusterName	String	cluster1	Cluster name
ReleaseVersion	String	EMR-VKE-1.2.0	Release version
ClusterState	String	RUNNING	Cluster state
StateChangeReason	String	startCluster	Reason for state change
Region	String	cn-beijing	Volcano Engine region
VpcId	String	vpc-xxx	VPC ID where the cluster is located
ProjectName	String	default	Volcano Engine project name
CreateTime	Long	xxx	Creation time
ReadyTime	Long	xxx	Cluster creation completion time
UpdateTime	Long	xxx	Update time
DeleteTime	Long	xxx	Cluster deletion time
AccountId	Long	xxx	Primary account ID
UserId	Long	xxx	Sub-user ID
Creator	String	xxx	Creator
VkeClusterId	String	xxx	VKE cluster ID where the cluster is located

sample request

{ 
    "ClusterId": "emr-xxx" 
}

sample response

{ 
    "ResponseMetadata": { 
        "RequestId": "xxx", 
        "Action": "GetVirtualCluster", 
        "Version": "2023-12-30", 
        "Service": "emr", 
        "Region": "cn-beijing", 
        "Error": null, 
        "Deprecated": false 
    }, 
    "Result": { 
        "ClusterId": "emr-xxx", 
        "ClusterName": "xxx", 
        "ReleaseVersion": "EMR-VKE-1.0.0", 
        "ClusterState": "DELETED", 
        "StateChangeReason": "ReleaseCluster", 
        "Region": "cn-beijing", 
        "VpcId": "vpc-xxx", 
        "ProjectName": "default", 
        "CreateTime": xxx, 
        "ReadyTime": xxx, 
        "UpdateTime": xxx, 
        "DeleteTime": xxx, 
        "AccountId": xxx, 
        "UserId": xxx, 
        "Creator": xxx, 
        "VkeClusterId":xxx 
    } 
}

error codes

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

Last updated: 2026.06.01 17:05:26

E-MapReduce

use cases #

important notes #

request parameters #

response parameters #

sample request #

sample response #