DescribeDBResourceGroup - AnalyticDB: Central de Documentação do Alibaba Cloud

Consulta as informações do grupo de recursos de um cluster.

Descrição da operação

Para o registro deste serviço, consulte Endpoint.

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

adb:DescribeDBResourceGroup

list

*DBClusterLakeVersion.

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster da Data Lakehouse Edition.	amv-bp11q28kvl688****
GroupName	string	Não	O nome do grupo de recursos. Nota Se você não especificar este parâmetro, as informações sobre todos os grupos de recursos no cluster especificado serão retornadas.	test_group
GroupType	string	Não	O tipo do grupo de recursos. Valores válidos: Interactive Job Nota Para mais informações sobre grupos de recursos na Data Lakehouse Edition, consulte Introdução aos grupos de recursos.	Job
RegionId	string	Não	O ID da região. Nota Você pode chamar a operação DescribeRegions para consultar o ID da região do cluster.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo	array<object>	A lista de informações dos grupos de recursos.
	array<object>	A lista de informações dos grupos de recursos.
GroupType	string	O tipo de grupo de recursos. Valores válidos: Interactive Job Nota Para obter mais informações sobre os grupos de recursos da Data Lakehouse Edition, consulte Introdução aos grupos de recursos (Data Lakehouse Edition).	Job
GroupName	string	O nome do grupo de recursos.	test1
MinComputeResource	string	Os recursos de computação reservados mínimos, em ACUs.	0ACU
MaxComputeResource	string	Os recursos de computação reservados máximos, em ACUs.	512ACU
ClusterSizeResource	string	Um parâmetro reservado. Não aplicável.	Parâmetro reservado
MinClusterCount	integer	Um parâmetro reservado. Não aplicável.	Parâmetro reservado
MaxClusterCount	integer	Um parâmetro reservado. Não aplicável.	Parâmetro reservado
RunningClusterCount	integer	Um parâmetro reservado. Não aplicável.	Parâmetro reservado
ClusterMode	string	Um parâmetro reservado. Não aplicável.	Parâmetro reservado
ElasticMinComputeResource	string	Os recursos de computação elásticos mínimos, em ACUs.	16ACU
EnableSpot	string	Indica se o recurso de instância spot está ativado para o grupo de recursos. Após a ativação do recurso de instância spot, o preço unitário dos recursos é reduzido, mas os recursos podem ser liberados. Valores válidos: True: O recurso de instância spot está ativado. False: O recurso de instância spot está desativado. Apenas grupos de recursos do tipo Job podem ser definidos como True.	True
GroupUsers	string	Os usuários do Resource Access Management (RAM) associados ao grupo de recursos.	testb,testc
CreateTime	string	A hora em que o grupo de recursos foi criado, em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.	2022-08-29T03:34:30Z
UpdateTime	string	A hora em que o grupo de recursos foi atualizado pela última vez, em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.	2022-08-31T03:34:30Z
Status	string	O status do grupo de recursos. Valores válidos: Pending: sendo criado. Running: em execução. Scaling: sendo dimensionado. Deleting: sendo excluído. Deleted: excluído.	Running
Rules	array<object>	As regras de roteamento de jobs.
	object	A lista de informações das regras.
GroupName	string	O nome do grupo de recursos.	user_default
QueryTime	string	O limite de tempo de execução da consulta, em milissegundos (ms).	180000
TargetGroupName	string	O nome do grupo de recursos de destino.	job
Engine	string	O tipo de mecanismo.	AnalyticDB
Message	string	A mensagem da regra de roteamento de jobs.	SUCCESS
AutoStopInterval	string	O intervalo de parada automática, no formato de um número seguido por m (minutos). O valor varia de 0m ou 5m até 10080m. Um valor de 0m indica que a parada automática está desativada.	0m
SpecName	string	O nome da especificação.	ADB.MLLarge.2
TargetResourceGroupName	string	O nome do grupo de recursos de destino.	test
MinGpuQuantity	integer	O número mínimo de GPUs.	1
MaxGpuQuantity	integer	O número máximo de GPUs.	2
RayConfig	object	As informações de configuração do Ray.
EnableUserEni	boolean	Indica se a ENI está ativada.
HeadSpecType	string	O tipo de recurso do nó principal.	cpu
HeadSpec	string	As especificações do nó principal.	ADB.MLLarge.2
HeadAllocateUnit	string	A unidade de alocação do nó principal.	1
HeadDiskCapacity	string	A capacidade de disco do nó principal.	100Gi
Category	string	O tipo de cluster Ray. Valores válidos: BASIC: tipo básico, sem alta disponibilidade. HIGH_AVAILABILITY: tipo de alta disponibilidade.	BASIC
WorkerGroups	array<object>	A lista de grupos de workers do Ray.
	object	A lista de grupos de workers do Ray.
GroupName	string	O nome do grupo de workers do Ray.	g01
AllocateUnit	string	A unidade de alocação.	1
MaxWorkerQuantity	integer	O número máximo de workers.	1
MinWorkerQuantity	integer	O número mínimo de workers.	1
WorkerDiskCapacity	string	A capacidade de disco por worker.	100G
WorkerSpecName	string	O nome da especificação do worker.	large
WorkerSpecType	string	O tipo de recurso do worker do Ray.	CPU
RayClusterAddress	string	O endereço do cluster Ray.	http://ray-cluster-address.example.com
RayDashboardAddress	string	O endereço do dashboard do Ray.	http://ray-dashboard-address.example.com
RayGrafanaAddress	string	O endereço do Grafana do Ray.	http://ray-grafana-address.example.com
RayServePublicAddress	string	O endereço público do Ray Serve.	1.2.3.4:8100
AppConfig	object	A configuração do aplicativo Ray.
AppName	string	O nome do aplicativo Ray.	app01
AppType	string	O tipo de aplicativo Ray.	IsaacLab
ImageSelector	object	A configuração de imagem.
Image	string	A imagem.	lab2.10.0-ray2.43.0
InferenceEngine	string	O mecanismo de inferência.	vLLM
LlmModel	string	O modelo LLM.	Deepseek-R1
StorageMounts	array<object>	A lista de montagens de armazenamento.
	object	A montagem de armazenamento.
StorageId	integer	O ID do armazenamento.	1
MountPath	string	O caminho de montagem.	/mnt/data01
StorageName	string
UserDefinedRequirements	string
GpuElasticPlan	object	O plano elástico de compartilhamento de tempo de GPU.
Enabled	boolean	Indica se o plano está ativado.	false
Rules	array<object>	A lista de regras.
	object	A regra.
StartCronExpression	string	A hora de início no formato de expressão cron. O intervalo deve ser de pelo menos 1 hora.	0 0 2 * * ?
EndCronExpression	string	A hora de término no formato de expressão cron. O intervalo deve ser de pelo menos 1 hora.	0 0 3 * * ?
ScalePolicy	string	A política de dimensionamento do grupo de recursos. Valores válidos:\n\n- AutoScaling: ativa a política de dimensionamento automático AutoScaling.\n- Disable: desativa o dimensionamento automático.\n- MultiCluster: ativa a política de dimensionamento automático MultiCluster.	AutoScaling
Classification	string	A classificação do grupo de recursos. Valores válidos:\n\n- SQL\n- SparkSQL\n- MultiCluster\n- AI.	SQL
EngineParams	object	Os parâmetros do mecanismo.
	any	Os parâmetros do mecanismo.	{\"spark.adb.version\":\"3.5\"}
AtmConfig	object	A configuração do grupo de recursos PromQL.
InsertNodeSpec	string	As especificações dos nós de gravação.	8ACU
InsertNodeNum	string	O número de nós de gravação.	1
SelectNodeSpec	string	As especificações dos nós de consulta.	8ACU
SelectNodeNum	string	O número de nós de consulta.	1
SelectNodeCacheSize	string	O tamanho do cache dos nós de consulta.	10
StorageNodeSpec	string	As especificações dos nós de armazenamento.	8ACU
StorageNodeNum	string	O número de nós de armazenamento.	2
StorageNodeDiskSize	string	O tamanho do disco dos nós de armazenamento.	100
StorageNodeDiskType	string	O tipo de disco dos nós de armazenamento.	essd_pl1
AuthNodeSpec	string	As especificações dos nós de autenticação.	8ACU
AuthNodeNum	string	O número de nós de autenticação.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "Parâmetro reservado",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "Parâmetro reservado",
      "ElasticMinComputeResource": "16ACU",
      "EnableSpot": "True",
      "GroupUsers": "testb,testc",
      "CreateTime": "2022-08-29T03:34:30Z",
      "UpdateTime": "2022-08-31T03:34:30Z",
      "Status": "ok",
      "Rules": [
        {
          "GroupName": "user_default",
          "QueryTime": "180000",
          "TargetGroupName": "job"
        }
      ],
      "Engine": "AnalyticDB",
      "Message": "SUCCESS",
      "AutoStopInterval": "0m",
      "SpecName": "ADB.MLLarge.2",
      "TargetResourceGroupName": "test",
      "MinGpuQuantity": 1,
      "MaxGpuQuantity": 2,
      "RayConfig": {
        "EnableUserEni": false,
        "HeadSpecType": "cpu",
        "HeadSpec": "ADB.MLLarge.2",
        "HeadAllocateUnit": "1",
        "HeadDiskCapacity": "100Gi",
        "Category": "BASIC",
        "WorkerGroups": [
          {
            "GroupName": "g01",
            "AllocateUnit": "1",
            "MaxWorkerQuantity": 1,
            "MinWorkerQuantity": 1,
            "WorkerDiskCapacity": "100G",
            "WorkerSpecName": "large",
            "WorkerSpecType": "CPU"
          }
        ],
        "RayClusterAddress": "http://ray-cluster-address.example.com",
        "RayDashboardAddress": "http://ray-dashboard-address.example.com",
        "RayGrafanaAddress": "http://ray-grafana-address.example.com",
        "RayServePublicAddress": "1.2.3.4:8100",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01",
            "StorageName": ""
          }
        ],
        "UserDefinedRequirements": ""
      },
      "GpuElasticPlan": {
        "Enabled": false,
        "Rules": [
          {
            "StartCronExpression": "0 0 2 * * ?",
            "EndCronExpression": "0 0 3 * * ?"
          }
        ]
      },
      "ScalePolicy": "AutoScaling",
      "Classification": "SQL",
      "EngineParams": {
        "key": "{\\\"spark.adb.version\\\":\\\"3.5\\\"}"
      },
      "AtmConfig": {
        "InsertNodeSpec": "8ACU",
        "InsertNodeNum": "1",
        "SelectNodeSpec": "8ACU",
        "SelectNodeNum": "1",
        "SelectNodeCacheSize": "10",
        "StorageNodeSpec": "8ACU",
        "StorageNodeNum": "2",
        "StorageNodeDiskSize": "100",
        "StorageNodeDiskType": "essd_pl1",
        "AuthNodeSpec": "8ACU",
        "AuthNodeNum": "2"
      }
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidPoolName.Malformed	The specified parameter PoolName is not valid.	O parâmetro PoolName é inválido. Verifique se o valor do parâmetro atende aos requisitos.
400	InvalidPoolUser.Malformed	The specified parameter PoolUser is not valid.	O parâmetro PoolUser é inválido. Verifique se o valor do parâmetro atende aos requisitos.
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	O DBClusterId especificado não existe. Verifique se o valor de DBClusterId está correto.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	O parâmetro DBClusterId é inválido. Verifique se o valor do parâmetro atende aos requisitos.
400	InvalidPoolType.Malformed	The specified parameter PoolType is not valid.	O parâmetro PoolType é inválido. Verifique se o valor do parâmetro atende aos requisitos.
400	InvalidMinComputeResource.Malformed	The specified parameter MinComputeResource is not valid.	O parâmetro MinComputeResource é inválido. Verifique se o valor do parâmetro atende aos requisitos.
400	InvalidMaxComputeResource.Malformed	The specified parameter MaxComputeResource is not valid.	O parâmetro MaxComputeResource é inválido. Verifique se o valor do parâmetro atende aos requisitos.
408	AcsServerTimeOut	The request has failed due to Adb Cloud Service time out.	O serviço de backend atingiu o tempo limite. Tente novamente mais tarde.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.