Track MapRun Execution Status with DescribeMapRun - CloudFlow

Retrieves the details of a MapRun.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RequestId	string	No	The request ID.	3A44E113-9962-5B0B-AB92-14060EFE3164
FlowName	string	Yes	The name of the flow.	my_flow_name
ExecutionName	string	Yes	The name of the execution.	my_exec_name
MapRunName	string	Yes	The name of the MapRun. When an execution starts a MapRun, a MapRunStarted event is generated. The MapRunName can be obtained from the output of this event.	c39142f1345b196d678333c41f113200

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the execution. Valid values: Pending Running Failed Succeeded Aborted	Succeeded
StoppedTime	string	The time when the execution stopped.	2025-10-24T14:11:28+08:00
RequestId	string	The request ID.	3A44E113-9962-5B0B-AB92-14060EFE3164
StartedTime	string	The time when the execution started.	2025-10-24T14:11:26+08:00
Concurrency	integer	The concurrency limit for the MapRun at runtime.	1
ToleratedFailedCount	integer	The maximum number of failed items that are allowed.	100
ToleratedFailedPercentage	number	The maximum percentage of failed items that are allowed.	20
ExecutionName	string	The name of the execution.	my_exec_name
MapRunName	string	The name of the MapRun.	c39142f1345b196d678333c41f113000
ItemCounts	object	A summary of the number of items in different processing states in the MapRun task.
Pending	integer	The number of pending items.	100
Running	integer	The number of running items.	100
Succeed	integer	The number of succeeded items.	100
Failed	integer	The number of failed items.	100
Aborted	integer	The number of aborted items.	100
Total	integer	The total number of items.	500

Examples

Success response

JSON format

{
  "Status": "Succeeded",
  "StoppedTime": "2025-10-24T14:11:28+08:00",
  "RequestId": "3A44E113-9962-5B0B-AB92-14060EFE3164",
  "StartedTime": "2025-10-24T14:11:26+08:00",
  "Concurrency": 1,
  "ToleratedFailedCount": 100,
  "ToleratedFailedPercentage": 20,
  "ExecutionName": "my_exec_name",
  "MapRunName": "c39142f1345b196d678333c41f113000",
  "ItemCounts": {
    "Pending": 100,
    "Running": 100,
    "Succeed": 100,
    "Failed": 100,
    "Aborted": 100,
    "Total": 500
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.
400	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).	The payload size exceeds maximum allowed size (%s bytes).
412	PreconditionFailed	The resource to be modified has been changed.	The resource to be modified has been changed. Please try again later.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.	The difference between the request time %s and the current time %s is too large.
403	SignatureNotMatch	The request signature we calculated does not match the signature you provided. Check your access key and signing method.	The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
403	AccessDenied	The resources doesn't belong to you.
404	ExecutionNotExists	Execution %s for flow %s does not exist.	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.	The request is throttled. Please try again later.