DsgUserGroupQueryList - DataWorks: Central de Documentação do Alibaba Cloud

Chama DsgUserGroupQueryList para consultar grupos de usuários no Data Security Guard (DSG).

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

dataworks:DsgUserGroupQueryList

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Sim	O número da página a ser retornada.	1
PageSize	integer	Sim	O número de entradas por página. Valor máximo: 100.	10
Name	string	Não	A palavra-chave para o nome do grupo de usuários. O serviço realiza uma pesquisa aproximada para encontrar grupos de usuários correspondentes.	yun_group
Owner	string	Não	O proprietário do grupo de usuários.	user1
ProjectName	string	Não	O nome do projeto MaxCompute para consultar grupos de usuários.	dev_project
userGroupType	integer	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos:\n\n- true: A solicitação foi bem-sucedida.\n\n- false: A solicitação falhou.	true
ErrorCode	string	O código de erro.	1029030003
ErrorMessage	string	A mensagem de erro.	param error
HttpStatusCode	integer	O código de status HTTP.	400
PageData	object	Os resultados da consulta paginada.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página. Valor máximo: 100.	10
TotalCount	integer	O número total de grupos de usuários.	100
Data	array<object>	A lista de grupos de usuários.	{ "accounts": [ "role_project_scheduler" ], "gmtCreate": "2024-05-10 15:22:18", "gmtModified": "2024-05-10 15:22:18", "id": 1955, "name": "dsg_fin_test-copy", "owner": "UAT" }
	object	Os detalhes do grupo de usuários.
Accounts	array	A list of usernames in the user group.
	string	A username.	user1
Id	integer	The ID of the user group.	123
GmtCreate	string	The time when the user group was created.	2024-05-10 17:14:44
GmtModified	string	The time when the user group was last modified.	2024-05-10 17:14:44
Name	string	The name of the user group.	test_group
Owner	string	The owner of the user group.	user1
mcAggregationInfo	string
RequestId	string	O ID da solicitação.	102400001

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Accounts": [
          "user1"
        ],
        "Id": 123,
        "GmtCreate": "2024-05-10 17:14:44",
        "GmtModified": "2024-05-10 17:14:44",
        "Name": "test_group",
        "Owner": "user1",
        "mcAggregationInfo": ""
      }
    ]
  },
  "RequestId": "102400001"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	PARAMS.ERROR	param error.
400	USERGROUP.ACCOUNTLISTSIZE.ERROR	The number of account exceeds the limit.	The number of users exceeds the limit
400	USERGROUP.ID.ERROR	The user group ID does not match the tenant or does not exist.	The user group ID does not exist or does not belong to the tenant.
400	USERGROUP.LISTSIZE.ERROR	The number of user groups exceeds the limit.	The number of user groups exceeds the limit
400	USERGROUP.PAGESIZE.ERROR	Page size is too large, maximum of 100.	Page size limit, up to 100
400	USERACCOUNT.OWNER.ERROR	User list or owner user does not exist.	User list or responsible user does not exist
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.