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

Consulta uma lista de grupos de recursos de um tipo especificado.

Descrição da operação

Antes de começar: o DataWorks deve estar ativado e um workspace do DataWorks deve ser criado na região de destino. Caso contrário, um erro 403 Forbidden.Access pode ser retornado.

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

get

TenantResourceGroup

acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceGroupType	integer	Não	O ID do tipo de grupo de recursos a ser consultado. Valores válidos:\n- 0: DataWorks.\n- 1: Agendamento.\n- 2: MaxCompute.\n- 3: PAI.\n- 4: Data Integration.\n- 7: O ID do recurso de compra gerado quando você adquire um grupo de recursos de agendamento exclusivo.\n- 9: dataService.\nValor padrão: 1.\nSe o valor representar um motor, a lista retornada conterá os grupos de recursos criados quando você adquire o motor.	3
Keyword	string	Não	A palavra-chave usada para correspondência aproximada de nomes e identificadores de grupos de recursos.	abc
BizExtKey	string	Não	A categoria do grupo de recursos. Valores válidos:\n- default: Grupo de recursos público. Este é o valor padrão.\n- single: Grupo de recursos exclusivo.	default
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmzbn7pti3zfa
Tags	array<object>	Não	A lista de tags.
	object	Não	As informações da tag.
Key	string	Não	A chave da tag.	Env
Value	string	Não	O valor da tag.	Test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	0bc1411515937635973****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	array<object>	A lista de grupos de recursos.
	array<object>	Os detalhes do grupo de recursos.
Status	integer	O status do grupo de recursos. Valores válidos:\n- NORMAL(0): O grupo de recursos está normal e em execução ou em serviço.\n- STOP(1): O grupo de recursos expirou e está congelado.\n- DELETED(2): O grupo de recursos foi liberado ou destruído.\n- CREATING(3): O grupo de recursos está sendo criado ou iniciado.\n- CREATE_FAILED(4): Falha ao criar ou iniciar o grupo de recursos.\n- UPDATING(5): O grupo de recursos está sendo expandido ou atualizado.\n- UPDATE_FAILED(6): Falha ao expandir ou atualizar o grupo de recursos.\n- DELETING(7): O grupo de recursos está sendo liberado ou destruído.\n- DELETE_FAILED(8): Falha ao liberar ou destruir o grupo de recursos.\n- TIMEOUT(9): A operação no grupo de recursos expirou. Todas as operações de modificação podem expirar. Este valor é fornecido temporariamente apenas para o Data Service.	0
UpdateTime	string	A hora da última atualização do grupo de recursos. O formato é `MMM d, yyyy h:mm:ss a`, como `Jul 9, 2018 2:43:37 PM`.	Jul 9, 2018 2:43:37 PM
IsDefault	boolean	Indica se o grupo de recursos é o grupo de recursos padrão. Valores válidos:\n- true: O grupo de recursos é o grupo de recursos padrão.\n- false: O grupo de recursos não é o grupo de recursos padrão.	true
Cluster	string	O nome do cluster. Este parâmetro entra em vigor apenas para grupos de recursos do MaxCompute e PAI.	AY18G
EnableKp	boolean	Indica se o acesso Key Person (KP) é utilizado. Valores válidos:\n- true: O motor do MaxCompute utiliza o UID da conta Alibaba Cloud como nome de exibição da conta de acesso.\n- false: O motor do MaxCompute utiliza o nome da conta Alibaba Cloud como nome de exibição da conta de acesso.\nEste parâmetro não tem significado para outros tipos e entra em vigor apenas para o motor do MaxCompute.	false
ResourceGroupType	string	O tipo do grupo de recursos. Valores válidos:\n- 0: DataWorks.\n- 2: MaxCompute.\n- 3: PAI.\n- 4: Data Integration.\n- 7: Agendamento.\n- 9: dataService.	3
CreateTime	string	A hora em que o cluster foi criado. Formato de exemplo: `Jul 9, 2018 2:43:37 PM`.	Jul 9, 2018 2:43:37 PM
Identifier	string	O identificador do grupo de recursos.	e1815577-2f4e-4c5e-b29****
Mode	string	O modo do grupo de recursos. Valores válidos:\n- ISOLATE: Grupo de recursos exclusivo por assinatura.\n- SHARE: Grupo de recursos público pós-pago.\n- DEVELOP: Edição de desenvolvedor.	SHARE
BizExtKey	string	A categoria do grupo de recursos. Valores válidos:\n- default: Grupo de recursos público.\n- single: Grupo de recursos exclusivo.	default
Sequence	integer	O campo de sequência. Este campo é usado para classificar os grupos de recursos criados em ordem crescente com base em seus números de sequência de criação.	300
Specs	object	As informações detalhadas do grupo de recursos. O conteúdo em {} indica as informações detalhadas do grupo de recursos.	{}
Name	string	O nome do grupo de recursos.	abc
Id	integer	O ID do grupo de recursos.	1234567
TenantId	integer	O ID do tenant.	1234567
ResourceManagerResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzbn7pti3zfa
Tags	array<object>	A lista de tags.
	object	As informações da tag.
Key	string	A chave da tag.	Env
Value	string	O valor da tag.	Test

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true,
  "Data": [
    {
      "Status": 0,
      "UpdateTime": "Jul 9, 2018 2:43:37 PM",
      "IsDefault": true,
      "Cluster": "AY18G",
      "EnableKp": false,
      "ResourceGroupType": "3",
      "CreateTime": "Jul 9, 2018 2:43:37 PM",
      "Identifier": "e1815577-2f4e-4c5e-b29****",
      "Mode": "SHARE",
      "BizExtKey": "default",
      "Sequence": 300,
      "Specs": {},
      "Name": "abc",
      "Id": 1234567,
      "TenantId": 1234567,
      "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
      "Tags": [
        {
          "Key": "Env",
          "Value": "Test"
        }
      ]
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	A origem de dados não existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	O projeto não existe.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	O usuário não existe no projeto.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	O usuário não é o proprietário nem o administrador do projeto.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	O membro a ser adicionado não existe no locatário.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.