DescribeDBClusterAttribute - - Centre de documentation Alibaba Cloud

Consulte les détails d'un cluster AnalyticDB for MySQL spécifié.

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

get

DBCluster

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 AnalyticDB for MySQL Data Warehouse Edition (V3.0).	am-bp111m2cfrdl1****
RegionId	string	Non	L'identifiant de la région du cluster.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les détails de la réponse.
RequestId	string	L'identifiant de la requête.	2895BB82-B2C1-408E-AA73-DB8D59******
Items	object
DBCluster	array<object>	Une liste d'informations sur le cluster.
	array<object>	Les détails du cluster.
CreationTime	string	The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-04-01T09:50:18Z
EnableSpark	boolean	Indicates whether a Spark cluster is created. Valid values: true: A Spark cluster is created. false: No Spark cluster is created.	false
DtsJobId	string	The ID of the DTS synchronization task. This parameter is returned only for analytic instances for MySQL.	dtsb1hp3790****
DBNodeCount	integer	The number of node groups.	1
Expired	string	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.	false
MaintainTime	string	The maintenance window of the cluster. The time is in the HH:mmZ-HH:mmZ format. For example, 04:00Z-05:00Z indicates that the maintenance window is from 04:00 to 05:00. Remarque For more information about maintenance windows, see Set a maintenance window.	04:00Z-05:00Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DiskType	string	The disk type of the cluster. Valid values: local_ssd: local SSD. cloud: basic disk. cloud_ssd: standard SSD. cloud_efficiency: ultra disk. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Remarque For more information about ESSDs, see ESSDs.	cloud_essd
Tags	object
Tag	array<object>	A list of tag information.
	object	The details of the tag.
Key	string	The tag key. Remarque Call the TagResources operation to create tags for the cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The mode of the cluster. Valid values: flexible: Flexible mode. reserver: Reserved mode. Remarque For more information about cluster modes, see Editions.	flexible
Port	integer	The port number of the cluster.	3306
LockMode	string	The lock mode of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked after it expires. LockByRestoration: The cluster is automatically locked before a rollback. LockByDiskQuota: The cluster is automatically locked after the storage space is full. The data storage usage has reached 90% of the total storage.	Unlock
EngineVersion	string	The database engine version of the cluster.	3.1.1.9
EnableAirflow	boolean	Indicates whether an Airflow cluster is created. Valid values: true: An Airflow cluster is created. false: No Airflow cluster is created.	true
ExecutorCount	string	The number of compute nodes used in the cluster that is in flexible mode.	1
StorageResource	string	The specifications of storage resources used in the cluster that is in flexible mode. These resources are used for data reads and writes. You can increase the storage resources to improve the read and write performance of the cluster.	8Core32GB
DBClusterId	string	The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.	am-bp111m2cfrdl1****
ConnectionString	string	The VPC endpoint of the cluster.	am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceId	string	The ID of the source RDS instance. This parameter is returned only for analytic instances for MySQL.	rm-bp837jsdp2****
DBClusterType	string	The type of the cluster. Valid values: Common: a regular cluster. RDS_ANALYSIS: an analytic instance for MySQL.	Common
CommodityCode	string	The billing method of the product. Valid values: ads: pay-as-you-go ads_pre: subscription	ads
ExpireTime	string	The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. An example is 2999-09-08T16:00:00Z. Remarque If the cluster is a subscription cluster, the actual expiration time is returned. If the cluster is a pay-as-you-go cluster, a fixed value of 2999-09-08T16:00:00Z is returned.	2999-09-08T16:00:00Z
DBNodeStorage	integer	The storage capacity of the cluster. Unit: GB.	300
DBNodeClass	string	The node specifications.	E8
LockReason	string	The reason the cluster is locked. Remarque This parameter is returned only when the cluster is locked. Its value is always instance_expire.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID.	vpc-bp13h7uzhulpuxvnp****
ComputeResource	string	The specifications of computing resources used in the cluster that is in flexible mode. These resources are used for data computing. You can increase the computing resources to accelerate queries. You can scale the resources based on the actual performance of the cluster.	8Core32GB
RegionId	string	The region ID of the cluster.	cn-hangzhou
ElasticIOResource	integer	The number of elastic I/O resources.	2
VSwitchId	string	The vSwitch ID.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	The database version. Only version 3.0 is supported.	3.0
VPCCloudInstanceId	string	The VPC instance ID.	am-bp111m2cfrdl1****-controller
DBClusterStatus	string	The status of the cluster. For more information, see Cluster states.	Running
ResourceGroupId	string	The resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. Only VPC is supported.	vpc
DBClusterDescription	string	The description of the cluster.	adb_test
UserENIStatus	boolean	Indicates whether the Elastic Network Interface (ENI) is enabled. Valid values: true: Enabled. false: Disabled.	true
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-h
Category	string	The edition of the cluster. Valid values: BASIC: Basic Edition for reserved mode CLUSTER: Cluster Edition for reserved mode MIXED_STORAGE: Cluster Edition for flexible mode (new) Remarque For more information about cluster editions, see Editions.	MIXED_STORAGE
Engine	string	The database engine of the cluster. The value is fixed as AnalyticDB.	AnalyticDB
KmsId	string	The ID of the key that is used to encrypt disk data. Remarque This parameter is returned only when disk encryption is enabled for the AnalyticDB for MySQL cluster.	e1935511-cf88-1123-a0f8-1be8d251****
InnerIp	string	The public IP address.	10.1.XX.XX
InnerPort	string	The public port number.	3306
DiskPerformanceLevel	string	The performance level of the disk.	PL1
ElasticIOResourceSize	string	The specifications of a single elastic resource node. Valid values: 8Core64GB: If the specifications of a single node are 8-core 64 GB, the specifications of an elastic I/O resource group are 24-core 192 GB. 12Core96GB: If the specifications of a single node are 12-core 96 GB, the specifications of an elastic I/O resource group are 36-core 288 GB.	8Core64GB
DiskEncryption	boolean	Indicates whether disk encryption is enabled. Valid values: true: yes. false: no.	false
TaskInfo	object	The task information.
Name	string	The task name.	analyticDBFlexibleScaleOut
Status	string	The task status. Valid values: NOT_RUN: Pending. RUNNING: Running. SUCCEED: Succeeded.	RUNNING
Progress	string	The task progress. Unit: %.	10
StepList	object
StepList	array<object>	The task steps.
	object	The task step.
StepName	string	The step name.	ApplyResource
StepDesc	string	The step description.	Apply resource
StepStatus	string	The step status. Valid values: NOT_RUN: Pending. RUNNING: Running. SUCCEED: Succeeded.	SUCCEED
StepProgress	string	The step progress. Unit: %.	50
StartTime	string	The start time of the step. The time is in the YYYY-MM-DDThh:mm:ssZ format.	2024-03-10T09:28:34Z
EndTime	string	The end time of the step. The time is in the YYYY-MM-DDThh:mm:ssZ format.	2024-03-10T10:28:34Z
ProductVersion	string	The product version. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	BasicVersion
SecondaryZoneId	string	The ID of the secondary zone. Remarque The value of this parameter cannot be the same as the value of the ZoneId parameter.	cn-hangzhou-i
SecondaryVSwitchId	string	The ID of the secondary vSwitch. Remarque The value of this parameter cannot be the same as the value of the VSwitchId parameter.	vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize	string	The specifications of the reserved node. Unit: AnalyticDB Compute Unit (ACU).	8ACU
ReservedNodeCount	integer	The number of reserved resource nodes.	3
ProductForm	string	The product form. Valid values: LegacyForm: Legacy form. IntegrationForm: Integrated form.	IntegrationForm

Exemples

JSON format

{
  "RequestId": "2895BB82-B2C1-408E-AA73-DB8D59******",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2021-04-01T09:50:18Z",
        "EnableSpark": false,
        "DtsJobId": "dtsb1hp3790****",
        "DBNodeCount": 1,
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "Unlock",
        "EngineVersion": "3.1.1.9",
        "EnableAirflow": true,
        "ExecutorCount": "1",
        "StorageResource": "8Core32GB",
        "DBClusterId": "am-bp111m2cfrdl1****",
        "ConnectionString": "am-bp111m2cfrdl1****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp837jsdp2****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "ComputeResource": "8Core32GB",
        "RegionId": "cn-hangzhou",
        "ElasticIOResource": 2,
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp111m2cfrdl1****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": true,
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "InnerIp": "10.1.XX.XX",
        "InnerPort": "3306",
        "DiskPerformanceLevel": "PL1",
        "ElasticIOResourceSize": "8Core64GB",
        "DiskEncryption": false,
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "BasicVersion",
        "SecondaryZoneId": "cn-hangzhou-i",
        "SecondaryVSwitchId": "vsw-0jlxwqt4531fsb3jdzx6h",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 3,
        "ProductForm": "IntegrationForm"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Notes de version

Consultez Notes de version pour la liste complète.