ListSynchronizationJobs - Identity as a Service: Central de Documentação do Alibaba Cloud

Lista os detalhes das tarefas de sincronização.

Descrição da operação

Você pode visualizar os dados retornados de uma das seguintes maneiras:

Método 1: Ao realizar uma consulta paginada para a primeira página, especifique apenas MaxResults para limitar o número de entradas a serem retornadas. O valor NextToken na resposta é usado como o token para consultar a próxima página. Ao consultar as páginas subsequentes, defina o parâmetro NextToken com o valor obtido da resposta anterior e especifique MaxResults para limitar o número de entradas a serem retornadas. Se não existirem mais páginas, NextToken não será retornado. O valor máximo de MaxResults é 100.
Método 2: Use PageSize para especificar o número de entradas a serem retornadas por página e use PageNumber para especificar o número da página.

Você pode usar apenas um dos métodos anteriores. O Método 1 é recomendado quando um grande número de entradas é retornado. Se você especificar MaxResults ou NextToken, os parâmetros de solicitação PageSize e PageNumber se tornarão inválidos.

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

eiam:ListSynchronizationJobs

list

*SynchronizationJob

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	Não	O número da página. As páginas começam em 1.	1
PageSize	integer	Não	O número de entradas por página. Valor máximo: 100.	10
NextToken	string	Não	O token usado para consultar a próxima página. Se não existirem mais páginas, este parâmetro não será retornado.	NTxxxxxexample
MaxResults	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100.	20
TargetType	string	Não	O tipo do destino de sincronização. Valores válidos: identity_provider: provedor de identidade application: aplicação	identity_provider
TargetIds	array	Não	A lista de IDs do destino de sincronização. Exemplo: [idp_111XXXX,idp_222XXXX].	target_001
	string	Não	O ID do destino de sincronização.	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	Não	A hora de início da sincronização. O tempo é um timestamp UNIX em milissegundos.	1649830226000
EndTime	integer	Não	A hora de término da sincronização. O tempo é um timestamp UNIX em milissegundos.	1649830226000
Direction	string	Não	A direção da tarefa de sincronização. Valores válidos: ingress: entrada egress: saída	ingress
Status	string	Não	O status da tarefa de sincronização. Valores válidos: pending: estado inicial running: em execução failed: com falha partial_success: parcialmente bem-sucedido success: bem-sucedido	running
Filters	array<object>	Não	Os parâmetros de filtro.
	object	Não	Os parâmetros de filtro.
Key	string	Não	O nome do parâmetro dinâmico.	qps
Values	array	Não	O valor do parâmetro dinâmico.
	string	Não	O valor do parâmetro dinâmico.	[]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de consulta retornado por esta chamada.	NTxxxexample
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJobs	array<object>	A lista de trabalhos de sincronização.
	array<object>	Os detalhes do trabalho de sincronização.
Description	string	A descrição do trabalho de sincronização.	Description
Direction	string	A direção da tarefa de sincronização. Valores válidos: ingress: entrada egress: saída	ingress
EndTime	integer	A hora de término da sincronização. O tempo é um timestamp UNIX em milissegundos.	1649830226000
Result	object	O resultado da tarefa do nó de sincronização.
ErrorCode	string	O código de erro do resultado da sincronização.	MissingParameter.Username
ErrorMessage	string	A mensagem de erro do resultado da sincronização.	The specified parameter Username is required!
GroupMemberStatistics	object	As estatísticas do resultado da sincronização de membros do grupo.
Binded	object	As estatísticas do resultado de vinculação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Created	object	As estatísticas do resultado de criação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Deleted	object	As estatísticas do resultado de exclusão.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Pushed	object	As estatísticas do resultado de push.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Same	object	As estatísticas de resultados idênticos.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Updated	object	As estatísticas do resultado de atualização.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
GroupStatistics	object	As estatísticas de resultado da sincronização de grupos.
Binded	object	As estatísticas do resultado de vinculação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Created	object	As estatísticas do resultado de criação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Deleted	object	As estatísticas do resultado de exclusão.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Pushed	object	As estatísticas do resultado de push.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Same	object	As estatísticas de resultados idênticos.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Updated	object	As estatísticas do resultado de atualização.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
OrganizationalUnitStatistics	object	As estatísticas de resultado da sincronização de unidades organizacionais.
Binded	object	As estatísticas do resultado de vinculação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Created	object	As estatísticas do resultado de criação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Deleted	object	As estatísticas do resultado de exclusão.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Exported	object	As estatísticas do resultado da exportação.
Failed	integer	O número de falhas.	0
Skipped	integer	O número de itens ignorados.	0
Success	integer	O número de sucessos.	0
Total	integer	A contagem total.	0
Pushed	object	As estatísticas do resultado de push.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Same	object	As estatísticas de resultados idênticos.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Updated	object	As estatísticas do resultado de atualização.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
UserStatistics	object	As estatísticas do resultado da sincronização de usuários.
Binded	object	As estatísticas do resultado de vinculação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Created	object	As estatísticas do resultado de criação.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Deleted	object	As estatísticas do resultado de exclusão.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Exported	object	As estatísticas do resultado da exportação.
Failed	integer	O número de falhas.	2
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	2
Total	integer	A contagem total.	5
Pushed	object	As estatísticas do resultado de push.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Same	object	As estatísticas de resultados idênticos.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
Updated	object	As estatísticas do resultado de atualização.
Failed	integer	O número de falhas.	1
Skipped	integer	O número de itens ignorados.	1
Success	integer	O número de sucessos.	1
Total	integer	A contagem total.	3
StartTime	integer	A hora de início da sincronização. O tempo é um timestamp UNIX em milissegundos.	1649830226000
Status	string	O status da tarefa de sincronização. Valores válidos: pending: estado inicial running: em execução failed: com falha partial_success: parcialmente bem-sucedido success: bem-sucedido	success
SynchronizationJobId	string	O ID da tarefa de sincronização.	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetId	string	O ID do destino de sincronização.	idp_my664lwkhpicbyzirog3xxxxx
TargetType	string	O tipo do destino de sincronização. Valores válidos: identity_provider: provedor de identidade application: aplicação	identity_provider
TriggerType	string	O tipo de gatilho da tarefa de sincronização. Valores válidos:\n\n- auto: Acionado automaticamente.\n\n- manual: Acionado manualmente.	auto
TotalCount	integer	O número total de entradas na lista.	100

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "NTxxxexample",
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "SynchronizationJobs": [
    {
      "Description": " Description",
      "Direction": "ingress",
      "EndTime": 1649830226000,
      "Result": {
        "ErrorCode": "MissingParameter.Username",
        "ErrorMessage": "The specified parameter Username is required!",
        "GroupMemberStatistics": {
          "Binded": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Created": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Deleted": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Pushed": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Same": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Updated": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          }
        },
        "GroupStatistics": {
          "Binded": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Created": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Deleted": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Pushed": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Same": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Updated": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          }
        },
        "OrganizationalUnitStatistics": {
          "Binded": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Created": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Deleted": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Exported": {
            "Failed": 0,
            "Skipped": 0,
            "Success": 0,
            "Total": 0
          },
          "Pushed": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Same": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Updated": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          }
        },
        "UserStatistics": {
          "Binded": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Created": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Deleted": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Exported": {
            "Failed": 2,
            "Skipped": 1,
            "Success": 2,
            "Total": 5
          },
          "Pushed": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Same": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          },
          "Updated": {
            "Failed": 1,
            "Skipped": 1,
            "Success": 1,
            "Total": 3
          }
        }
      },
      "StartTime": 1649830226000,
      "Status": "success",
      "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx\n",
      "TargetId": "idp_my664lwkhpicbyzirog3xxxxx\n",
      "TargetType": "identity_provider",
      "TriggerType": "auto"
    }
  ],
  "TotalCount": 100
}

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.