文档中心

ListApplications - 集群列表

最近更新时间：2024.01.22 15:55:27

首次发布时间：2024.01.22 15:55:27

集群列表查询

使用说明

调用 ListApplications，获取一个 E-MapReduce（EMR）集群应用列表信息。

注意事项

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Version=2023-08-15&Action=ListApplications

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListApplications	要执行的操作，取值：ListApplications
Version	String	是	2023-08-15	API的版本，取值：2023-08-15
ClusterId	String	是	emr-xxx	集群ID
ApplicationNames	Array of String	否	["HDFS"]	应用名称列表
MaxResults	Integer	否	10	返回的最大记录数
NextToken	String	否	xxx	分页查询的下一页token

返回参数

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

参数	类型	示例值	描述
ApplicationName	String	HDFS	应用名
ApplicationVersion	String	3.3.4	应用版本
User	String	hdfs	应用用户
Group	String	hadoop	应用用户组
ApplicationConfigHome	String	/etc/emr/${name}/conf	应用配置路径
ApplicationHome	String	/usr/lib/emr/current/${name}	应用安装路径
SupportClient	Boolean	false	是否支持客户端
ApplicationState	String	NORMAL, //正常 WARNING, //告警 STOPPED, //已停止 INIT, //初始化中 INSTALLING, //安装中 INSTALLED, //已安装 STARTING, //启动中 STARTED, //已启动 STOPPING, //停止中 UNINSTALLING, //卸载中 UNINSTALLED, //已卸载 EXCEPTION; //异常	服务状态

请求示例

{
   "ClusterId":"emr-xxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202312051929157D73231DC5Cxxx",
        "Action": "ListApplications",
        "Version": "2023-08-15",
        "Service": "emr",
        "Region": "cn-beijing",
        "Error": null,
        "Deprecated": false
    },
    "Result": {
        "Items": [
            {
                "ApplicationName": "PROMETHEUS",
                "ApplicationVersion": "1.1.0",
                "User": "prometheus",
                "Group": "prometheus",
                "ApplicationConfigHome": "/etc/emr/${name}/conf",
                "ApplicationHome": "/usr/lib/emr/current/${name}",
                "SupportClient": false
            },
            {
                "ApplicationName": "KNOX",
                "ApplicationVersion": "1.5.0",
                "User": "knox",
                "Group": "knox",
                "ApplicationConfigHome": "/etc/emr/${name}/conf",
                "ApplicationHome": "/usr/lib/emr/current/${name}",
                "SupportClient": false
            },...
        ],
        "TotalCount": 17,
        "MaxResults": 10,
        "NextToken": "IcKlh2bKXei9E5Uv/3XjOA=="
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	说明
400	InvalidClusterId	cluster id {clusterId} not found	集群不存在
400	InvalidRequest	Access Denied {clusterId}	对该集群没有权限