RunApplicationAction - 运行应用Action--E-MapReduce-火山引擎

文档中心

立即注册

导航

E-MapReduce

RunApplicationAction - 运行应用Action

最近更新时间：2024.08.06 10:47:43首次发布时间：2024.03.21 15:18:00

运行应用Action

使用场景

调用RunApplicationAction，对一个 EMR on VKE 虚拟集群中的各类应用进行重启等操作。

注意事项

已使用账号登录火山引擎。

请求说明

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

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	RunApplicationAction	要执行的操作，取值：RunApplicationAction
Version	String	是	2023-12-30	API的版本，取值：2023-12-30
ClusterId	String	是	emr-xxx	集群ID
ActionName	String	是	start	操作名称
ActionParams	Param	否	[]	操作参数
ActionScope	String	是	COMPONENT	操作范围
Components	Component	否	[]	组件列表

返回参数

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

参数	类型	示例值	描述
ClusterId	String	emr-xxx	集群ID
OperationId	String	xxx	操作记录ID

请求示例

{
            "ClusterId": "emr-xxx",
            "ActionName": "restart",
            "ActionScope": "COMPONENT",
            "Components": [{
                "ApplicationName": "RAY",
                "ComponentNames": ["RayCluster"]
            }],
            "ActionParams": [{
                "Key": "xxx",
                "Value": "xxx"
            },
            {
                    "Key": "applicationConfigs",
                    "Value": "[{\"configFileName\":\"xxx\",\"configItemKey\":\"xxx\",\"configItemValue\":\"xxx\"}]"
           }]
}

如果待重启的组件有多个实例名称，比如RayCluster，则ActionParams需要传入对应参数，如下所示：

{
            "ClusterId": "emr-xxx",
            "ActionName": "restart",
            "ActionScope": "COMPONENT",
            "Components": [{
                "ApplicationName": "RAY",
                "ComponentNames": ["RayCluster"]
            }],
            "ActionParams": [{
                "Key": "releaseName",
                "Value": "组件release名称 可以通过EMR组件列表页面查看得到"
            },
            {
                    "Key": "applicationConfigs",
                    "Value": "[{\"configFileName\":\"xxx\",\"configItemKey\":\"xxx\",\"configItemValue\":\"xxx\"}]"
           }]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "xxx",
        "Action": "RunApplicationAction",
        "Version": "2023-12-30",
        "Service": "emr",
        "Region": "cn-beijing",
        "Error": null,
        "Deprecated": false
    },
    "Result": {
        "ClusterId": "emr-xxx",
        "OperationId": "op-xxx"
    }
}

错误码

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