ListTasks - CloudSSO: Central de Documentação do Alibaba Cloud

Consulta uma lista de tarefas assíncronas.

Descrição da operação

Por padrão, esta operação consulta a lista de tarefas criadas nas últimas 24 horas. Você pode consultar tarefas criadas no máximo nos últimos 7 dias. Você pode usar o parâmetro Filter para especificar a hora de início da consulta. Este tópico fornece um exemplo de como consultar a lista de tarefas criadas nas últimas 24 horas.

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

cloudsso:ListTasks

list

*Diretório.

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DirectoryId	string	Sim	O ID do diretório.	d-00fc2p61****
AccessConfigurationId	string	Não	O ID da configuração de acesso. Este parâmetro é usado como uma condição de filtro para a consulta.	ac-00jhtfl8thteu6uj****
TargetType	string	Não	O tipo do destino da tarefa. Este parâmetro é usado como uma condição de filtro para a consulta. Valores válidos: RD-Account: O destino da tarefa é uma conta em um diretório de recursos. Nota TargetId e TargetType devem ser especificados ao mesmo tempo para servir como uma condição de filtro válida.	RD-Account
TargetId	string	Não	O ID do destino da tarefa. Este parâmetro é usado como uma condição de filtro para a consulta. Nota TargetId e TargetType devem ser especificados ao mesmo tempo para servir como uma condição de filtro válida.	114240524784****
PrincipalType	string	Não	O tipo de identidade do CloudSSO. Este parâmetro é usado como uma condição de filtro para a consulta. Valores válidos: User: O usuário do CloudSSO. Group: O grupo do CloudSSO. Nota PrincipalId e PrincipalType devem ser especificados ao mesmo tempo para servir como uma condição de filtro válida.	User
PrincipalId	string	Não	O ID da identidade do CloudSSO. Este parâmetro é usado como uma condição de filtro para a consulta. Detalhes: Se PrincipalType estiver definido como User, PrincipalId será o ID do usuário do CloudSSO. Se PrincipalType estiver definido como Group, PrincipalId será o ID do grupo do CloudSSO. Nota PrincipalId e PrincipalType devem ser especificados ao mesmo tempo para servir como uma condição de filtro válida.	u-00q8wbq42wiltcrk****
TaskType	string	Não	O tipo do nó. Este parâmetro é usado como uma condição de filtro para a consulta. Valores válidos: ProvisionAccessConfiguration: Implantação da configuração de acesso. DeprovisionAccessConfiguration: Remove o provisionamento da configuração de acesso. CreateAccessAssignment: Concede autorização a uma conta em um diretório de recursos. DeleteAccessAssignment: Remove a autorização de uma conta em um diretório de recursos.	CreateAccessAssignment
Status	string	Não	O status da tarefa. Este parâmetro é usado como uma condição de filtro para a consulta. Valores válidos: InProgress: A tarefa está em execução. Success: A tarefa foi bem-sucedida. Failed: A tarefa falhou.	Success
NextToken	string	Não	O token usado para retornar a próxima página dos resultados da consulta. Você não precisa especificar NextToken ao chamar esta operação pela primeira vez. Ao chamar esta operação pela primeira vez, se o número total de entradas retornadas exceder o valor de MaxResults, os dados retornados serão truncados. Apenas o número de entradas especificado por MaxResults é retornado, o parâmetro de resposta IsTruncated é definido como true e um valor NextToken é retornado. Você pode usar o valor NextToken retornado para chamar esta operação novamente, mantendo os outros parâmetros de solicitação inalterados, para consultar os dados truncados. Você pode repetir esse processo até que IsTruncated seja definido como false, o que indica que todos os dados foram retornados.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em cada página. Valores válidos: 1 a 20. Valor padrão: 10.	10
Filter	string	Não	A condição de filtro. Formato: . O formato não diferencia maiúsculas de minúsculas. suporta apenas StartTime. suporta apenas ge (maior ou igual a). deve estar no formato YYYY-MM-DDTHH:mm:ssZ e pode ser apenas um horário dentro dos últimos 7 dias. Exemplo: Filter = "StartTime ge 2021-03-15T01:12:23Z". Este exemplo consulta a lista de tarefas a partir de 2021-03-15T01:12:23Z. Nota Se você não especificar este parâmetro, a lista de tarefas criadas nas últimas 24 horas será retornada por padrão.	StartTime ge 2021-03-15T01:12:23Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
Tasks	array<object>	A lista de tarefas.
	object	A lista de tarefas.
Status	string	O status da tarefa. Valores válidos: InProgress: A tarefa está em execução. Success: A tarefa foi bem-sucedida. Failed: A tarefa falhou.	Success
TaskId	string	O ID da tarefa.	t-sh5k4gesm6twlrqb****
EndTime	string	A hora de término da tarefa. A hora é exibida em UTC e segue o padrão RFC 3339 no formato YYYY-MM-DDTHH:mm:ssZ.	2021-11-09T05:50:50Z
PrincipalId	string	O ID da identidade do CloudSSO.	u-00q8wbq42wiltcrk****
TargetPath	string	O ID do caminho do destino da tarefa no diretório de recursos.	rd-3G**/r-Wm/114240524784**
StartTime	string	A hora de início da tarefa. A hora é exibida em UTC e segue o padrão RFC 3339 no formato YYYY-MM-DDTHH:mm:ssZ.	2021-11-09T05:50:50Z
PrincipalName	string	O nome da identidade do CloudSSO.	Alice
TargetName	string	O nome do destino da tarefa.	dev-test
TargetId	string	O ID do destino da tarefa.	114240524784****
AccessConfigurationName	string	O nome da configuração de acesso.	ECS-Admin
TargetPathName	string	O nome do caminho do destino da tarefa no diretório de recursos.	rd-3G****/root/dev-test
TaskType	string	O tipo do nó. Valores válidos: ProvisionAccessConfiguration: Implantação da configuração de acesso. DeprovisionAccessConfiguration: Remove o provisionamento da configuração de acesso. CreateAccessAssignment: Concede autorização a uma conta em um diretório de recursos. DeleteAccessAssignment: Remove a autorização de uma conta em um diretório de recursos.	CreateAccessAssignment
FailureReason	string	O motivo pelo qual a tarefa falhou. Nota Este parâmetro é retornado apenas se Status estiver definido como Failed.	No Permission.
TargetType	string	O tipo do destino da tarefa. Valores válidos: RD-Account: O destino da tarefa é uma conta em um diretório de recursos.	RD-Account
AccessConfigurationId	string	O ID da configuração de acesso.	ac-00jhtfl8thteu6uj****
PrincipalType	string	O tipo de identidade do CloudSSO. Valores válidos: User: O usuário do CloudSSO. Group: O grupo do CloudSSO.	User
OriginTargetId	string	O ID da conta Alibaba Cloud à qual o destino da autorização pertence.	114240524784****
NextToken	string	O token usado para retornar a próxima página dos resultados da consulta. Nota Este parâmetro é retornado apenas se IsTruncated estiver definido como true.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	O ID da solicitação.	C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3
MaxResults	integer	O número máximo de entradas retornadas em cada página.	10
TotalCounts	integer	O número total de entradas que atendem ao parâmetro de solicitação condicional.	1
IsTruncated	boolean	Indica se os resultados retornados estão truncados. Valores válidos: true: Os resultados retornados estão truncados. false: Os resultados retornados não estão truncados.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "Tasks": [
    {
      "Status": "Success",
      "TaskId": "t-sh5k4gesm6twlrqb****",
      "EndTime": "2021-11-09T05:50:50Z",
      "PrincipalId": "u-00q8wbq42wiltcrk****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "StartTime": "2021-11-09T05:50:50Z",
      "PrincipalName": "Alice",
      "TargetName": "dev-test",
      "TargetId": "114240524784****",
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "TaskType": "CreateAccessAssignment",
      "FailureReason": "No Permission.",
      "TargetType": "RD-Account",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
      "PrincipalType": "User",
      "OriginTargetId": "114240524784****"
    }
  ],
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3",
  "MaxResults": 10,
  "TotalCounts": 1,
  "IsTruncated": false
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.