DescribeDBResourceGroup - AnalyticDB - Centre de documentation Alibaba Cloud

Consulte les informations sur les groupes de ressources d'un cluster.

Description de l'opération

Pour l'enregistrement de ce service, consultez Point de terminaison.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

adb:DescribeDBResourceGroup

list

*DBClusterLakeVersion.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBClusterId	string	Oui	L'identifiant du cluster Data Lakehouse Edition.	amv-bp11q28kvl688****
GroupName	string	Non	Le nom du groupe de ressources. Remarque Si vous ne spécifiez pas ce paramètre, les informations sur tous les groupes de ressources du cluster spécifié sont renvoyées.	test_group
GroupType	string	Non	Le type du groupe de ressources. Valeurs valides : Interactive Job Remarque Pour plus d'informations sur les groupes de ressources dans Data Lakehouse Edition, consultez Présentation des groupes de ressources.	Job
RegionId	string	Non	L'identifiant de la région. Remarque Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région du cluster.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo	array<object>	La liste des informations sur les groupes de ressources.
	array<object>	La liste des informations sur les groupes de ressources.
GroupType	string	Le type de groupe de ressources. Valeurs valides : Interactive Job Remarque Pour plus d'informations sur les groupes de ressources de l'édition Data Lakehouse, consultez Présentation des groupes de ressources (édition Data Lakehouse).	Job
GroupName	string	Le nom du groupe de ressources.	test1
MinComputeResource	string	Les ressources de calcul réservées minimales, en ACU.	0ACU
MaxComputeResource	string	Les ressources de calcul réservées maximales, en ACU.	512ACU
ClusterSizeResource	string	Un paramètre réservé. Non applicable.	Paramètre réservé
MinClusterCount	integer	Un paramètre réservé. Non applicable.	Paramètre réservé
MaxClusterCount	integer	Un paramètre réservé. Non applicable.	Paramètre réservé
RunningClusterCount	integer	Un paramètre réservé. Non applicable.	Paramètre réservé
ClusterMode	string	Un paramètre réservé. Non applicable.	Paramètre réservé
ElasticMinComputeResource	string	Les ressources de calcul élastiques minimales, en ACU.	16ACU
EnableSpot	string	Indique si la fonctionnalité d'instance spot est activée pour le groupe de ressources. Une fois la fonctionnalité d'instance spot activée, le prix unitaire des ressources est réduit, mais les ressources peuvent être libérées. Valeurs valides : True : la fonctionnalité d'instance spot est activée. False : la fonctionnalité d'instance spot est désactivée. Seuls les groupes de ressources de type Job peuvent être définis sur True.	True
GroupUsers	string	Les utilisateurs Resource Access Management (RAM) associés au groupe de ressources.	testb,testc
CreateTime	string	L'heure de création du groupe de ressources, en UTC. Format : yyyy-MM-ddTHH:mm:ssZ.	2022-08-29T03:34:30Z
UpdateTime	string	L'heure de la dernière mise à jour du groupe de ressources, en UTC. Format : yyyy-MM-ddTHH:mm:ssZ.	2022-08-31T03:34:30Z
Status	string	L'état du groupe de ressources. Valeurs valides : Pending : en cours de création. Running : en cours d'exécution. Scaling : en cours de mise à l'échelle. Deleting : en cours de suppression. Deleted : supprimé.	Running
Rules	array<object>	Les règles de routage des tâches.
	object	La liste des informations sur les règles.
GroupName	string	Le nom du groupe de ressources.	user_default
QueryTime	string	Le seuil de temps d'exécution de la requête, en millisecondes (ms).	180000
TargetGroupName	string	Le nom du groupe de ressources cible.	job
Engine	string	Le type de moteur.	AnalyticDB
Message	string	Le message de la règle de routage des tâches.	SUCCESS
AutoStopInterval	string	L'intervalle d'arrêt automatique, au format d'un nombre suivi de m (minutes). La valeur varie de 0m ou 5m à 10080m. Une valeur de 0m indique que l'arrêt automatique est désactivé.	0m
SpecName	string	Le nom de la spécification.	ADB.MLLarge.2
TargetResourceGroupName	string	Le nom du groupe de ressources cible.	test
MinGpuQuantity	integer	Le nombre minimal de GPU.	1
MaxGpuQuantity	integer	Le nombre maximal de GPU.	2
RayConfig	object	Les informations de configuration Ray.
EnableUserEni	boolean	Indique si l'ENI est activée.
HeadSpecType	string	Le type de ressource du nœud principal.	cpu
HeadSpec	string	Les spécifications de nœud du nœud principal.	ADB.MLLarge.2
HeadAllocateUnit	string	L'unité d'allocation du nœud principal.	1
HeadDiskCapacity	string	La capacité de disque du nœud principal.	100Gi
Category	string	Le type de cluster Ray. Valeurs valides : BASIC : type de base, non haute disponibilité. HIGH_AVAILABILITY : type haute disponibilité.	BASIC
WorkerGroups	array<object>	La liste des groupes de workers Ray.
	object	La liste des groupes de workers Ray.
GroupName	string	Le nom du groupe de workers Ray.	g01
AllocateUnit	string	L'unité d'allocation.	1
MaxWorkerQuantity	integer	Le nombre maximal de workers.	1
MinWorkerQuantity	integer	Le nombre minimal de workers.	1
WorkerDiskCapacity	string	La capacité de disque par worker.	100G
WorkerSpecName	string	Le nom de la spécification du worker.	large
WorkerSpecType	string	Le type de ressource du worker Ray.	CPU
RayClusterAddress	string	L'adresse du cluster Ray.	http://ray-cluster-address.example.com
RayDashboardAddress	string	L'adresse du tableau de bord Ray.	http://ray-dashboard-address.example.com
RayGrafanaAddress	string	L'adresse Grafana Ray.	http://ray-grafana-address.example.com
RayServePublicAddress	string	L'adresse publique Ray Serve.	1.2.3.4:8100
AppConfig	object	La configuration de l'application Ray.
AppName	string	Le nom de l'application Ray.	app01
AppType	string	Le type d'application Ray.	IsaacLab
ImageSelector	object	La configuration de l'image.
Image	string	L'image.	lab2.10.0-ray2.43.0
InferenceEngine	string	Le moteur d'inférence.	vLLM
LlmModel	string	Le modèle LLM.	Deepseek-R1
StorageMounts	array<object>	La liste des points de montage de stockage.
	object	Le point de montage de stockage.
StorageId	integer	L'identifiant de stockage.	1
MountPath	string	Le chemin de montage.	/mnt/data01
StorageName	string
UserDefinedRequirements	string
GpuElasticPlan	object	Le plan élastique de partage de temps GPU.
Enabled	boolean	Indique si le plan est activé.	false
Rules	array<object>	La liste des règles.
	object	La règle.
StartCronExpression	string	L'heure de début au format d'expression cron. L'intervalle doit être d'au moins 1 heure.	0 0 2 * * ?
EndCronExpression	string	L'heure de fin au format d'expression cron. L'intervalle doit être d'au moins 1 heure.	0 0 3 * * ?
ScalePolicy	string	La stratégie de mise à l'échelle du groupe de ressources. Valeurs valides : AutoScaling : active la stratégie de mise à l'échelle automatique AutoScaling. Disable : désactive la mise à l'échelle automatique. MultiCluster : active la stratégie de mise à l'échelle automatique MultiCluster.	AutoScaling
Classification	string	La classification du groupe de ressources. Valeurs valides : SQL SparkSQL MultiCluster AI	SQL
EngineParams	object	Les paramètres du moteur.
	any	Les paramètres du moteur.	{"spark.adb.version":"3.5"}
AtmConfig	object	La configuration du groupe de ressources PromQL.
InsertNodeSpec	string	Les spécifications des nœuds d'écriture.	8ACU
InsertNodeNum	string	Le nombre de nœuds d'écriture.	1
SelectNodeSpec	string	Les spécifications des nœuds de requête.	8ACU
SelectNodeNum	string	Le nombre de nœuds de requête.	1
SelectNodeCacheSize	string	La taille du cache des nœuds de requête.	10
StorageNodeSpec	string	Les spécifications des nœuds de stockage.	8ACU
StorageNodeNum	string	Le nombre de nœuds de stockage.	2
StorageNodeDiskSize	string	La taille du disque des nœuds de stockage.	100
StorageNodeDiskType	string	Le type de disque des nœuds de stockage.	essd_pl1
AuthNodeSpec	string	Les spécifications des nœuds d'authentification.	8ACU
AuthNodeNum	string	Le nombre de nœuds d'authentification.	2

Exemples

JSON format

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "Paramètre réservé",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "Paramètre réservé",
      "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"
      }
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidPoolName.Malformed	The specified parameter PoolName is not valid.	Le paramètre PoolName n'est pas valide. Vérifiez que la valeur du paramètre répond aux exigences.
400	InvalidPoolUser.Malformed	The specified parameter PoolUser is not valid.	Le paramètre PoolUser n'est pas valide. Vérifiez que la valeur du paramètre répond aux exigences.
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	Le DBClusterId spécifié n'existe pas. Vérifiez que la valeur de DBClusterId est correcte.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	Le paramètre DBClusterId n'est pas valide. Vérifiez que la valeur du paramètre répond aux exigences.
400	InvalidPoolType.Malformed	The specified parameter PoolType is not valid.	Le paramètre PoolType n'est pas valide. Vérifiez que la valeur du paramètre répond aux exigences.
400	InvalidMinComputeResource.Malformed	The specified parameter MinComputeResource is not valid.	Le paramètre MinComputeResource n'est pas valide. Vérifiez que la valeur du paramètre répond aux exigences.
400	InvalidMaxComputeResource.Malformed	The specified parameter MaxComputeResource is not valid.	Le paramètre MaxComputeResource n'est pas valide. Vérifiez que la valeur du paramètre répond aux exigences.
408	AcsServerTimeOut	The request has failed due to Adb Cloud Service time out.	Le service backend a dépassé le délai d'attente. Réessayez plus tard.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.