ListVirtualClusters - 集群列表--E-MapReduce-火山引擎

文档中心

立即注册

导航

E-MapReduce

ListVirtualClusters - 集群列表

最近更新时间：2024.03.21 16:15:59首次发布时间：2024.03.21 15:17:35

EMROnVKE集群列表

使用场景

调用 ListVirtualClusters，查询该账号下所有 EMR on VKE 虚拟集群。

注意事项

请求方式：POST
请求地址：https://open.volcengineapi.com/?Version=2023-12-30&Action=ListVirtualClusters

请求说明

已拥有火山引擎账号并开通 EMR 权限。

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListVirtualClusters	要执行的操作，取值：ListVirtualClusters
Version	String	是	2023-12-30	API的版本，取值：2023-12-30
ClusterIds	String	否	[]	集群ID列表
ClusterName	String	否	xxx	集群名称
ClusterStates	String	否	["RUNNING"]	集群状态列表： INIT 初始化中 INIT_FAILED 初始化失败 RUNNING 运行中 DELETING 删除中 DELETED 已删除
ProjectName	String	否	default	火山引擎项目名称
MaxResults	Integer	否	10	单页最大返回结果，1-100，默认为10
NextToken	Integer	否	0	分页查询下一页token，默认0

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数	类型	示例值	描述
Items	Array of VirtualCluster	[]	虚拟集群列表
TotalCount	Integer	1	结果总数
NextToken	Integer	1	当前页数
MaxResults	Integer	10	单页最大结果数，1-100，默认10

请求示例

{}

返回示例

{
        "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
    }

错误码

您可访问公共错误码，获取更多错误码信息。