Run application Action

Use cases #

Call RunApplicationAction to perform operations such as restarting various applications in an EMR on VKE virtual cluster.

Important notes #

The account has already logged in to Volcano Engine.

Note #

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

Request parameters #

The table below lists only the unique request parameters for 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 value', 
    dataIndex: 'Example', 
  }, 
  { 
    width: '55%', 
title: 'Description', 
    dataIndex: 'Description', 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"RunApplicationAction"} />, 
Description: <RenderMd content={"The operation to be performed. Value: RunApplicationAction"} />, 
    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: '->ClusterId', 
    Name: 'ClusterId', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"emr-xxx"} />, 
Description: <RenderMd content={"Cluster ID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ActionName', 
    Name: 'ActionName', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"start"} />, 
Description: <RenderMd content={"Operation name"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ActionParams', 
    Name: 'ActionParams', 
    DataType: 'Param', 
IsRequired: 'No', 
    Example: <RenderMd content={"[]"} />, 
Description: <RenderMd content={"Operation parameters"} />, 
    children: [ 
        { 
          rowKey: '->ActionParams->Key', 
          Name: 'Key', 
          DataType: 'String', 
IsRequired: 'Yes', 
          Example: <RenderMd content={"xxx"} />, 
Description: <RenderMd content={"Key"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: '->ActionParams->Value', 
          Name: 'Value', 
          DataType: 'String', 
IsRequired: 'No', 
          Example: <RenderMd content={"xxx"} />, 
Description: <RenderMd content={"Value"} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
  { 
    rowKey: '->ActionScope', 
    Name: 'ActionScope', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"COMPONENT"} />, 
Description: <RenderMd content={"Operation scope"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Components', 
    Name: 'Components', 
    DataType: 'Component', 
IsRequired: 'No', 
    Example: <RenderMd content={"[]"} />, 
Description: <RenderMd content={"Component list"} />, 
    children: [ 
        { 
          rowKey: '->Components->ApplicationName', 
          Name: 'ApplicationName', 
          DataType: 'String', 
IsRequired: 'Yes', 
          Example: <RenderMd content={"Ray"} />, 
Description: <RenderMd content={"Service name"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: '->Components->ComponentNames', 
          Name: 'ComponentNames', 
          DataType: 'Array of String', 
IsRequired: 'No', 
          Example: <RenderMd content={"["RayCluster"]"} />, 
Description: <RenderMd content={"Component name"} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
  
]; 

return (<Table 
  rowKey="rowKey" 
  className="openapi-doc-parameter-table" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  pagination={false} 
/>);

Response parameters #

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

Sample request #

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

Sample response #

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

Error codes #

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