ListScripts - E-MapReduce - Alibaba Cloud Documentation Center

Queries the bootstrap or normal scripts of an EMR cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:ListScripts

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	c-b933c5aac8fe****
NextToken	string	No	The token that marks the position from which to start reading.	dd6b1b2a-5837-5237-abe4-ff0c89568980
MaxResults	integer	No	The maximum number of entries to return on each page.	10
ScriptType	string	Yes	The type of the cluster script. Valid values: BOOTSTRAP: a bootstrap script. NORMAL: a normal cluster script.	BOOTSTRAP
ScriptName	string	No	The name of the cluster script. This parameter is valid only for NORMAL scripts and supports fuzzy search.
ScriptId	string	No	The ID of the cluster script. This parameter is valid only for NORMAL scripts.
Statuses	array	No	The list of script statuses.
	string	No	The script status. This parameter is valid only for NORMAL scripts.

Response elements

Element	Type	Description	Example
	object	The data returned.
Scripts	array<object>	The list of scripts.
	object	The script.
Action	string	The name of the API.	ListScripts
RegionId	string	The region ID.	cn-hangzhou
ScriptId	string	The script ID.	cs-bf25219d103043a0820613e32781****
ScriptName	string	The script name.	check_env
ScriptPath	string	The script path.	oss://bucket1/check_evn.sh
ScriptArgs	string	The runtime parameters of the script.	--mode=client -h -p
LastUpdateTime	integer	The time when the script was last updated.	1639714634819
ExecutionFailStrategy	string	The policy used to handle an execution failure. Valid values: FAILED_CONTINUE: Continue the execution. FAILED_BLOCK: Block the execution.	FAILED_CONTINUE
ExecutionMoment	string	The time to execute the script. Valid values: BEFORE_INSTALL: before application installation. AFTER_STARTED: after application startup.	BEFORE_INSTALL
NodeSelector	NodeSelector	The node selector.
StartTime	integer	The time when the execution started. This parameter is returned only when ScriptType is set to NORMAL.	1639714634000
EndTime	integer	The time when the execution ended. This parameter is returned only when ScriptType is set to NORMAL.	1639715635819
ExecutionState	string	The execution status of the script. This parameter is returned only when `ScriptType` is set to `NORMAL`. Valid values: SCRIPT_COMPLETED: The script is successfully executed. SCRIPT_SUBMISSION_FAILED: The script fails to be executed. SCRIPT_RUNNING: The script is being executed.	SCRIPT_COMPLETED
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	The token that is used to start the next query.	dd6b1b2a-5837-5237-abe4-ff0c89568982
MaxResults	integer	The maximum number of entries returned in the request.	10
TotalCount	integer	The total number of entries that meet the request conditions.	200

Examples

Success response

JSON format

{
  "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": [
          "master-1-1"
        ],
        "NodeGroupId": "ng-869471354ecd****",
        "NodeGroupIds": [
          "ng-869471354ecd****"
        ],
        "NodeGroupTypes": [
          "MASTER"
        ],
        "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 code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.