ListComponentInstances - E-MapReduce: Central de Documentação do Alibaba Cloud

Obtém a lista de instâncias de componentes.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

emr:ListComponentInstances

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar a API ListRegions.	cn-hangzhou
ClusterId	string	Sim	O ID do cluster.	C-8CFEBCCFFEF5****
NextToken	string	Não	O token de paginação que é usado na próxima solicitação para obter uma nova página de resultados. Se você deixar este parâmetro vazio, a consulta começará do início.	“”
MaxResults	integer	Não	O número máximo de entradas retornadas.	10
ApplicationNames	array	Não	A lista de nomes de componentes.	c-b933c5aac8fe****
	string	Não	O nome da aplicação.	KNOX
NodeIds	array	Não	A lista de IDs de instâncias.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
	string	Não	O ID da instância.	i-bp17yy050pxo01m2****
NodeNames	array	Não	Os IDs das instâncias.	20
	string	Não	O nome da instância.	emr-worker-1
ComponentNames	array	Não	A lista de nomes de componentes.	["HDFS"]
	string	Não	O nome do componente.	KNOX
ComponentStates	array	Não	A lista de status de componentes.	null
	string	Não	O status do componente.	INSTALLED
ZoneId	string	Não	O ID da zona.	cn-hangzhou-i

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
ComponentInstances	array<object>	A lista de informações de instalação de componentes da instância.
	object	As informações de instalação do componente da instância.
ComponentName	string	O nome do componente.	KNOX
ApplicationName	string	O nome da aplicação.	KNOX
ComponentInstanceState	string	O status do componente. Valores válidos: WAITING INSTALLING INSTALLED INSTALL_FAILED STARTING STARTED START_FAILED STOPPING STOPPED STOP_FAILED	STARTED
NodeId	string	O ID da instância.	i-bp17yy050pxo01m2****
NodeName	string	O nome da instância.	emr-worker-1
CommissionState	string	O status do comissionamento. Valores válidos: COMMISSIONED COMMISSIONING DECOMMISSIONED DECOMMISSIONINPROGRESS DECOMMISSIONFAILED INSERVICE UNKNOWN	INSERVICE
BizState	string	O status do serviço do componente. Valores válidos: active: o serviço principal. standby: o serviço em espera.	active
CreateTime	integer	O timestamp da instalação.	1628248947000
DesiredState	string	Valores válidos: WAITING INSTALLING INSTALLED INSTALL_FAILED STARTING STARTED START_FAILED STOPPING STOPPED STOP_FAILED	STARTED
ZoneId	string	O ID da zona.	cn-hangzhou-i
RequestId	string	O ID da solicitação.	7345241A-014C-17D2-A3AC-C72771188F46
NextToken	string	O token de paginação que é usado na próxima solicitação para obter uma nova página de resultados. Se você deixar este parâmetro vazio, a consulta começará do início.	“”
MaxResults	integer	O número máximo de entradas retornadas.	2
TotalCount	integer	O número total de entradas retornadas.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "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
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.