ListScripts - E-MapReduce - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query EMR cluster bootstrap scripts or regular scripts.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
emr:ListScripts	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID.	cn-hangzhou
ClusterId	string	Yes	Cluster ID.	c-b933c5aac8fe****
NextToken	string	No	Marks the current position to start reading from.	dd6b1b2a-5837-5237-abe4-ff0c89568980
MaxResults	integer	No	The maximum number of records to retrieve at once.	10
ScriptType	string	Yes	Type of cluster script. Possible values: BOOTSTRAP: Bootstrap script. NORMAL: Regular cluster script.	BOOTSTRAP

Response parameters

Parameter	Type	Description	Example
	object	Returned data
Scripts	array<object>	List of scripts.
Script	object	Script.
Action	string	API name.	ListScripts
RegionId	string	Region ID.	cn-hangzhou
ScriptId	string	Script ID.	cs-bf25219d103043a0820613e32781****
ScriptName	string	Script name.	check_env
ScriptPath	string	Script path.	oss://bucket1/check_evn.sh
ScriptArgs	string	Script execution parameters.	--mode=client -h -p
LastUpdateTime	long	Time of the last update.	1639714634819
ExecutionFailStrategy	string	Execution failure strategy. Possible values: FAILED_CONTINUE: Continue after failure. FAILED_BLOCK: Block after failure.	FAILED_CONTINUE
ExecutionMoment	string	Execution timing. Possible values: BEFORE_INSTALL: Before application installation. AFTER_STARTED: After application startup.	BEFORE_INSTALL
NodeSelector	NodeSelector	Node selector.
StartTime	long	Start execution time. This value is returned only when `ScriptType` is `NORMAL`.	1639714634000
EndTime	long	End execution time. This value is returned only when `ScriptType` is `NORMAL`.	1639715635819
ExecutionState	string	Script execution state. This value is returned only when `ScriptType` is `NORMAL`. Possible values: SCRIPT_COMPLETED: Script executed successfully. SCRIPT_SUBMISSION_FAILED: Script execution failed. SCRIPT_RUNNING: Script is running.	SCRIPT_COMPLETED
RequestId	string	Request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	The position of the data read.	dd6b1b2a-5837-5237-abe4-ff0c89568982
MaxResults	integer	The maximum number of records returned in this request.	10
TotalCount	integer	The total amount of data under the conditions of this request.	200

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": [
          "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
404	ResourceNotFound	The resource not found by %s.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
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.

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

Change history

Change time	Summary of changes	Operation
2024-06-18	The internal configuration of the API is changed, but the call is not affected	View Change Details