All Products
Search
Document Center

E-MapReduce:ListScripts

Last Updated:Oct 17, 2024

Queries the bootstrap actions or common scripts of an E-MapReduce (EMR) cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Scriptsarray<object>

The scripts.

Scriptobject

The script.

Actionstring

The name of the API operation.

ListScripts
RegionIdstring

The region ID.

cn-hangzhou
ScriptIdstring

The script ID.

cs-bf25219d103043a0820613e32781****
ScriptNamestring

The name of the script.

check_env
ScriptPathstring

The path in which the script is stored.

oss://bucket1/check_evn.sh
ScriptArgsstring

The runtime parameters of the script.

--mode=client -h -p
LastUpdateTimelong

The time when the script was last modified.

1639714634819
ExecutionFailStrategystring

The policy that is used to handle execution failures of the script. Valid values:

  • FAILED_CONTINUE
  • FAILED_BLOCK
FAILED_CONTINUE
ExecutionMomentstring

The time based on which the system runs the script. Valid values:

  • BEFORE_INSTALL
  • AFTER_STARTED
BEFORE_INSTALL
NodeSelectorNodeSelector

The node selector.

StartTimelong

The time when the system starts to run the script. This parameter is returned only if the ScriptType parameter is set to NORMAL.

1639714634000
EndTimelong

The time when the system finishes the running of the script. This parameter is returned only if the ScriptType parameter is set to NORMAL.

1639715635819
ExecutionStatestring

The status of the script. This parameter is returned only if the ScriptType parameter is set to NORMAL. Valid values:

  • SCRIPT_COMPLETED
  • SCRIPT_SUBMISSION_FAILED
  • SCRIPT_RUNNING
SCRIPT_COMPLETED

Examples

Sample success responses

JSONformat

{
  "Scripts": [
    {
      "Action": "ListScripts",
      "RegionId": "cn-hangzhou",
      "ScriptId": "cs-bf25219d103043a0820613e32781****",
      "ScriptName": "check_env",
      "ScriptPath": "oss://bucket1/check_evn.sh",
      "ScriptArgs": "--mode=client -h -p",
      "LastUpdateTime": 1639714634819,
      "ExecutionFailStrategy": "FAILED_CONTINUE",
      "ExecutionMoment": "BEFORE_INSTALL",
      "NodeSelector": {
        "NodeSelectType": "CLUSTER",
        "NodeNames": [
          ""
        ],
        "NodeGroupId": "ng-869471354ecd****",
        "NodeGroupIds": [
          "ng-869471354ecd****"
        ],
        "NodeGroupTypes": [
          ""
        ],
        "NodeGroupName": "master-1",
        "NodeGroupNames": [
          "master-1"
        ]
      },
      "StartTime": 1639714634000,
      "EndTime": 1639715635819,
      "ExecutionState": "SCRIPT_COMPLETED"
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "dd6b1b2a-5837-5237-abe4-ff0c89568982",
  "MaxResults": 10,
  "TotalCount": 200
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-18The internal configuration of the API is changed, but the call is not affectedView Change Details