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

Consulta a lista de detalhes dos trabalhos de sincronização.

Descrição da operação

Os dois métodos a seguir são suportados para visualizar os dados retornados:

Método 1: Ao consultar a primeira página, você só precisa definir MaxResults para limitar o número de entradas retornadas. O NextToken na resposta serve como credencial para consultar as páginas subsequentes. Ao consultar as páginas subsequentes, defina o parâmetro NextToken com o valor de NextToken obtido na resposta anterior como credencial de consulta e defina MaxResults para limitar o número de entradas retornadas. Se não houver mais páginas, o NextToken não será mais retornado. O valor máximo de MaxResults é 100.
Método 2: Defina o número de entradas retornadas por página usando PageSize e defina o número da página usando PageNumber.

Você pode escolher apenas um dos dois métodos acima. Quando um grande número de entradas for retornado, o Método 1 é recomendado. Se o parâmetro MaxResults ou NextToken for definido, 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, começando em 1.	1
PageSize	integer	Não	O tamanho da página. Valor máximo: 100.	10
NextToken	string	Não	O token para consultar a próxima página. Este parâmetro não é retornado quando não há mais páginas.	NTxxxxxexample
MaxResults	integer	Não	O número de linhas por página para consultas paginadas. Valor máximo: 100.	20
TargetType	string	Não	O tipo de destino da sincronização. Valores válidos: identity_provider: provedor de identidade application: aplicação	identity_provider
TargetIds	array	Não	A lista de IDs de destino da sincronização. [idp_111XXXX,idp_222XXXX]	target_001
	string	Não	O ID do destino da sincronização.	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	Não	A hora de início da sincronização no formato de timestamp Unix, em milissegundos.	1649830226000
EndTime	integer	Não	A hora de término da sincronização no formato de timestamp Unix, em milissegundos.	1649830226000
Direction	string	Não	A direção do trabalho de sincronização. Valores válidos: ingress: entrada egress: saída	ingress
Status	string	Não	O status do trabalho 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	Os valores do parâmetro dinâmico.
	string	Não	Os valores do parâmetro dinâmico.	[]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	O número total de entradas.	100
NextToken	string	O valor do token de consulta retornado por esta solicitação.	NTxxxexample
SynchronizationJobs	array<object>	A lista de trabalhos de sincronização.
	array<object>	Os detalhes do trabalho de sincronização.
SynchronizationJobId	string	O ID do trabalho de sincronização.	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	O tipo de destino da sincronização. Valores válidos: identity_provider: provedor de identidade application: aplicação	identity_provider
TargetId	string	O ID do destino da sincronização.	idp_my664lwkhpicbyzirog3xxxxx
Direction	string	A direção do trabalho de sincronização. Valores válidos: ingress: entrada egress: saída	ingress
StartTime	integer	A hora de início da sincronização no formato de timestamp Unix, em milissegundos.	1649830226000
EndTime	integer	A hora de término da sincronização no formato de timestamp Unix, em milissegundos.	1649830226000
TriggerType	string	O tipo de gatilho da sincronização. Valores válidos: auto: acionado automaticamente manual: acionado manualmente	auto
Status	string	O status do trabalho 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
Result	object	O resultado do trabalho de sincronização.
UserStatistics	object	User synchronization result statistics
Created	object	Creation result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Updated	object	Update result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Binded	object	Binding result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Deleted	object	Deletion result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Same	object	Unchanged result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Pushed	object	Push result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Exported	object	Export result statistics
Total	integer	Total count	5
Success	integer	Success count	2
Failed	integer	Failure count	2
Skipped	integer	Skipped count	1
OrganizationalUnitStatistics	object	Organizational unit synchronization result statistics
Created	object	Creation result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Updated	object	Update result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Binded	object	Binding result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Deleted	object	Deletion result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Same	object	Unchanged result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Pushed	object	Push result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
GroupStatistics	object	Group synchronization result statistics
Created	object	Creation result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Updated	object	Update result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Binded	object	Binding result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Deleted	object	Deletion result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Same	object	Unchanged result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Pushed	object	Push result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
GroupMemberStatistics	object	Group member synchronization result statistics
Created	object	Creation result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Updated	object	Update result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Binded	object	Binding result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Deleted	object	Deletion result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Same	object	Unchanged result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
Pushed	object	Push result statistics
Total	integer	Total count	3
Success	integer	Success count	1
Failed	integer	Failure count	1
Skipped	integer	Skipped count	1
ErrorMessage	string	Synchronization result error message	The specified parameter Username is required!
ErrorCode	string	Synchronization result error code	MissingParameter.Username
Description	string	A descrição do trabalho de sincronização.	Description

Exemplos

Resposta de sucesso

JSON formato

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

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.