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

Descrição da operação

Você pode chamar a operação GetTaskStatus para consultar o status de uma tarefa assíncrona. Se quiser consultar mais informações sobre uma tarefa assíncrona, chame a operação GetTask.

Este tópico fornece um exemplo de como consultar as informações sobre a tarefa cujo ID é t-shfqw1u1edszvxw5****.

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

get

*Directory

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****
TaskId	string	Sim	O ID da tarefa.	t-shfqw1u1edszvxw5****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os resultados retornados.
RequestId	string	O ID da solicitação.	005F4623-AE53-504D-830F-44825F7DC211
TaskStatus	object	As informações de status da tarefa.
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-shfqw1u1edszvxw5****
EndTime	string	A hora de término da tarefa.	2021-11-05T02:58:08Z
TaskType	string	O tipo de tarefa. Valores válidos: ProvisionAccessConfiguration: Uma configuração de acesso é provisionada. DeprovisionAccessConfiguration: Uma configuração de acesso é desprovisionada. CreateAccessAssignment: As permissões de acesso em uma conta no diretório de recursos são atribuídas. DeleteAccessAssignment: As permissões de acesso em uma conta no diretório de recursos são removidas.	DeleteAccessAssignment
FailureReason	string	A causa da falha da tarefa. Nota Este parâmetro é retornado apenas quando o valor de Status é Failed.	No Permission.
StartTime	string	A hora de início da tarefa.	2021-11-05T02:58:07Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "005F4623-AE53-504D-830F-44825F7DC211",
  "TaskStatus": {
    "Status": "Success",
    "TaskId": "t-shfqw1u1edszvxw5****",
    "EndTime": "2021-11-05T02:58:08Z",
    "TaskType": "DeleteAccessAssignment",
    "FailureReason": "No Permission.",
    "StartTime": "2021-11-05T02:58:07Z"
  }
}

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.