Call the ListComponentInstances API to retrieve component instances - E-MapReduce - Alibaba Cloud - E-MapReduce

Retrieves the list of component instances.

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:ListComponentInstances

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the ListRegions operation to query available regions.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	C-8CFEBCCFFEF5****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If you leave this parameter empty, the query starts from the beginning.	“”
MaxResults	integer	No	The maximum number of entries returned.	10
ApplicationNames	array	No	The list of component names.	c-b933c5aac8fe****
	string	No	The application name.	KNOX
NodeIds	array	No	The list of instance IDs.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
	string	No	The instance ID.	i-bp17yy050pxo01m2****
NodeNames	array	No	The instance IDs.	20
	string	No	The instance name.	emr-worker-1
ComponentNames	array	No	The list of component names.	["HDFS"]
	string	No	The component name.	KNOX
ComponentStates	array	No	The list of component statuses.	null
	string	No	The status of the component.	INSTALLED
ZoneId	string	No	The zone ID.	cn-hangzhou-i

Response elements

Element	Type	Description	Example
	object	The response parameters.
ComponentInstances	array<object>	The component instances.
	object	The component instance details.
ComponentName	string	The component name.	KNOX
ApplicationName	string	The application name.	KNOX
ComponentInstanceState	string	The status of the component. Valid values: WAITING INSTALLING INSTALLED INSTALL_FAILED STARTING STARTED START_FAILED STOPPING STOPPED STOP_FAILED	STARTED
NodeId	string	The instance ID.	i-bp17yy050pxo01m2****
NodeName	string	The instance name.	emr-worker-1
CommissionState	string	The commissioning state. Valid values: COMMISSIONED COMMISSIONING DECOMMISSIONED DECOMMISSIONINPROGRESS DECOMMISSIONFAILED INSERVICE UNKNOWN	INSERVICE
BizState	string	The status of the component service. Valid values: active: the primary service. standby: the standby service.	active
CreateTime	integer	The timestamp of the installation.	1628248947000
DesiredState	string	The desired state of the component. Valid values: WAITING INSTALLING INSTALLED INSTALL_FAILED STARTING STARTED START_FAILED STOPPING STOPPED STOP_FAILED	STARTED
ZoneId	string	The zone ID.	cn-hangzhou-i
RequestId	string	The request ID.	7345241A-014C-17D2-A3AC-C72771188F46
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If you leave this parameter empty, the query starts from the beginning.	“”
MaxResults	integer	The maximum number of entries returned.	2
TotalCount	integer	The total number of entries returned.	2

Examples

Success response

JSON format

{
  "ComponentInstances": [
    {
      "ComponentName": "KNOX",
      "ApplicationName": "KNOX",
      "ComponentInstanceState": "STARTED",
      "NodeId": "i-bp17yy050pxo01m2****",
      "NodeName": "emr-worker-1",
      "CommissionState": "INSERVICE",
      "BizState": "active",
      "CreateTime": 1628248947000,
      "DesiredState": "STARTED",
      "ZoneId": "cn-hangzhou-i"
    }
  ],
  "RequestId": "7345241A-014C-17D2-A3AC-C72771188F46",
  "NextToken": "“”",
  "MaxResults": 2,
  "TotalCount": 2
}

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.