Todos os produtos
Search
Central de documentação

DataWorks:ListResourceGroups

Última atualização: Oct 09, 2026

Obtém uma lista de grupos de recursos.

Descrição da operação

  1. É necessário o DataWorks Basic Edition ou superior.

  2. Certifique-se de que a função vinculada ao serviço AliyunServiceRoleForDataWorks foi criada antes de chamar esta operação de API.

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

list

*DwResourceGroup

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

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Name

string

Não

O nome do grupo de recursos para correspondência aproximada.

Resource

ProjectId

integer

Não

O ID do espaço de trabalho ao qual o grupo de recursos pertence.

1000

Statuses

array

Não

Os status dos grupos de recursos a serem consultados.

string

Não

O status do grupo de recursos a ser consultado. Valores válidos:

  • Normal: O grupo de recursos está em execução ou em serviço.

  • Stop: O grupo de recursos está congelado porque expirou.

  • Deleted: O grupo de recursos foi liberado ou destruído.

  • Creating: O grupo de recursos está sendo criado.

  • CreateFailed: O grupo de recursos falhou ao ser criado.

  • Updating: O grupo de recursos está sendo atualizado, expandido, reduzido ou reconfigurado.

  • UpdateFailed: O grupo de recursos falhou ao ser atualizado, redimensionado ou passar por upgrade.

  • Deleting: O grupo de recursos está sendo liberado ou destruído.

  • DeleteFailed: O grupo de recursos falhou ao ser liberado ou destruído.

  • Timeout: A operação atingiu o tempo limite.

  • Freezed: O grupo de recursos está congelado.

  • Starting: O grupo de recursos está sendo iniciado.

Normal

ResourceGroupTypes

array

Não

Os tipos dos grupos de recursos a serem consultados. Se este parâmetro for deixado em branco, os grupos de recursos de uso geral serão consultados por padrão.

string

Não

O tipo do grupo de recursos. Valores válidos:

  • CommonV2: Novo grupo de recursos de uso geral.

  • ExclusiveDataIntegration: Grupo de recursos de integração de dados exclusivo.

  • ExclusiveScheduler: Grupo de recursos de agendamento exclusivo.

  • ExclusiveDataService: Grupo de recursos de EPS de dados exclusivo.

CommonV2

PaymentType

string

Não

O método de cobrança do grupo de recursos. Valores válidos:

  • PrePaid: Assinatura.

  • PostPaid: Pay-as-you-go.

PrePaid

AliyunResourceGroupId

string

Não

O ID do grupo de recursos do Alibaba Cloud.

rg-aek2kqofrgXXXXX

AliyunResourceTags

array<object>

Não

As tags do Alibaba Cloud.

object

Não

A tag do Alibaba Cloud.

Key

string

Não

A chave da tag.

key

Value

string

Não

O valor da tag.

value

PageSize

integer

Não

O número de entradas por página.

100

PageNumber

integer

Não

O número da página.

1

SortBy

string

Não

Os campos pelos quais ordenar os resultados. Você pode ordenar os resultados por campos como hora agendada e hora de início. O formato é 'Campo de ordenação+Ordem de ordenação (Desc/Asc)'. Asc pode ser omitido. Valores válidos para o campo de ordenação:

  • Id (Desc/Asc): O ID do grupo de recursos.

  • Name (Desc/Asc): O nome do grupo de recursos.

  • Remark (Desc/Asc): A descrição do grupo de recursos.

  • Type (Desc/Asc): O tipo do grupo de recursos.

  • Status (Desc/Asc): O status do grupo de recursos.

  • Spec (Desc/Asc): As especificações do grupo de recursos.

  • CreateUser (Desc/Asc): O criador do grupo de recursos.

  • CreateTime (Desc/Asc): A hora em que o grupo de recursos foi criado.

Valor padrão: CreateTime Asc.

CreateTime Asc

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

PagingInfo

object

As informações de paginação.

ResourceGroupList

array<object>

A lista de grupos de recursos.

array<object>

Os detalhes do grupo de recursos.

Id

string

O identificador exclusivo do grupo de recursos.

Serverless_res_group_524257424564736_6831777003XXXXX

Name

string

O nome do grupo de recursos.

common_resource_group

Remark

string

A observação do grupo de recursos.

Create a general-purpose resource group for common tasks

PaymentType

string

O método de cobrança do grupo de recursos. Valores válidos: PrePaid (assinatura) e PostPaid (pago conforme o uso).

PrePaid

Status

string

O status do grupo de recursos a ser consultado. Valores válidos:

  • Normal: O grupo de recursos está em execução ou em serviço.

  • Stop: O grupo de recursos está congelado porque expirou.

  • Deleted: O grupo de recursos foi liberado ou destruído.

  • Creating: O grupo de recursos está sendo criado.

  • CreateFailed: O grupo de recursos falhou ao ser criado.

  • Updating: O grupo de recursos está sendo atualizado, expandido, reduzido ou reconfigurado.

  • UpdateFailed: O grupo de recursos falhou ao ser atualizado, redimensionado ou passar por upgrade.

  • Deleting: O grupo de recursos está sendo liberado ou destruído.

  • DeleteFailed: O grupo de recursos falhou ao ser liberado ou destruído.

  • Timeout: A operação atingiu o tempo limite.

  • Freezed: O grupo de recursos está congelado.

  • Starting: O grupo de recursos está sendo iniciado.

Normal

Spec

object

As especificações do grupo de recursos.

Standard

string

Os detalhes da especificação.

2CU

Amount

integer

A quantidade.

1

ResourceGroupType

string

O tipo do grupo de recursos. Valores válidos:

  • CommonV2: Grupo de recursos de uso geral V2.

  • ExclusiveDataIntegration: Grupo de recursos de integração de dados exclusivo.

  • ExclusiveScheduler: Grupo de recursos de agendamento exclusivo.

  • ExclusiveDataService: Grupo de recursos de serviço de dados exclusivo.

CommonV2

OrderInstanceId

string

O ID da instância do pedido do grupo de recursos.

c442b330-3b10-4584-959e-736e4edXXXXX

CreateUser

string

O ID do usuário que criou o grupo de recursos.

11075500042XXXXX

CreateTime

integer

A hora em que o grupo de recursos foi criado. O valor é um carimbo de data/hora de 64 bits.

1727055811000

DefaultVpcId

string

O ID da VPC padrão associada ao grupo de recursos de uso geral.

vpc-m2et4f3oc8msfbccXXXXX

DefaultVswicthId

string

O ID do vSwitch padrão associado ao grupo de recursos de uso geral.

vsw-uf8usrhs7hjd9amsXXXXX

AliyunResourceGroupId

string

O ID do grupo de recursos do Alibaba Cloud.

rg-aek2kqofrgXXXXX

AliyunResourceTags

array<object>

As tags do Alibaba Cloud.

object

A tag do Alibaba Cloud.

Key

string

A chave da tag.

Key

Value

string

O valor da tag.

Value

PageNumber

integer

O número da página.

1

PageSize

integer

O número de entradas por página.

100

TotalCount

integer

O número total de entradas de dados.

100

RequestId

string

O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "PagingInfo": {
    "ResourceGroupList": [
      {
        "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
        "Name": "common_resource_group",
        "Remark": "创建用于普通任务的通用资源组",
        "PaymentType": "PrePaid",
        "Status": "Normal",
        "Spec": {
          "Standard": "2CU",
          "Amount": 1
        },
        "ResourceGroupType": "CommonV2",
        "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
        "CreateUser": "11075500042XXXXX",
        "CreateTime": 1727055811000,
        "DefaultVpcId": "vpc-m2et4f3oc8msfbccXXXXX",
        "DefaultVswicthId": "vsw-uf8usrhs7hjd9amsXXXXX",
        "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
        "AliyunResourceTags": [
          {
            "Key": "Key",
            "Value": "Value"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

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.