Gunakan DescribeDBClusterAttribute untuk melihat atribut kluster - AnalyticDB - Alibaba Cloud - AnalyticDB

Anda dapat memanggil operasi DescribeDBClusterAttribute untuk melihat detail cluster AnalyticDB for MySQL tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeDBClusterAttribute

get

DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID cluster AnalyticDB for MySQL Data Warehouse Edition (V3.0). Catatan Panggil operasi DescribeDBClusters untuk membuat kueri ID semua cluster AnalyticDB for MySQL Data Warehouse Edition (V3.0) di region tertentu.	am-bp111m2cfrdl1****
RegionId	string	No	ID region cluster.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Detail respons.
RequestId	string	ID permintaan.	2895BB82-B2C1-408E-AA73-DB8D59******
Items	object
DBCluster	array<object>	Daftar informasi cluster.
	array<object>	Detail 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 sync task. This parameter is returned only for MySQL analytic instances.	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. Catatan 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. Catatan For more information about ESSDs, see ESSDs.	cloud_essd
Tags	object
Tag	array<object>	A list of tag information.
	object	The details of the list.
Key	string	The tag key. Catatan Invoke the TagResources operation to create tags for the cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The cluster mode. Valid values: flexible: Flexible. reserver: Reserved. Catatan For more information about cluster modes, see Editions.	flexible
Port	integer	The cluster port.	3306
LockMode	string	The lock mode of the cluster. Valid values: Unlock: Normal (unlocked). ManualLock: Locked by manual triggering. LockByExpiration: Locked automatically due to expiration. LockByRestoration: Locked automatically before a rollback. LockByDiskQuota: Locked automatically because the storage space is full (the data storage usage has reached 90% of the upper limit).	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 elastic cluster.	1
StorageResource	string	The storage resource specifications for the elastic cluster. These resources are used for data reads and writes. Increasing these resources can improve the read and write capabilities of the cluster.	8Core32GB
DBClusterId	string	The ID of the AnalyticDB for MySQL 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 for synchronization. This parameter is returned only for MySQL analytic instances.	rm-bp837jsdp2****
DBClusterType	string	The cluster type. Valid values: Common: Regular cluster. RDS_ANALYSIS: MySQL analytic instance.	Common
CommodityCode	string	The commodity code for billing. Valid values: ads: Pay-as-you-go commodity. ads_pre: Subscription commodity.	ads
ExpireTime	string	The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC). For example, 2999-09-08T16:00:00Z. Catatan If the cluster has a subscription billing method, the actual expiration time is returned. If the cluster has a pay-as-you-go billing method, the fixed value 2999-09-08T16:00:00Z is returned.	2999-09-08T16:00:00Z
DBNodeStorage	integer	The storage space of the cluster. Unit: GB.	300
DBNodeClass	string	The node specifications.	E8
LockReason	string	The reason the cluster is locked. Catatan This parameter appears 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 compute resource specifications used in the elastic cluster. These resources are used for data computation. You can increase compute resources to accelerate queries. You can elastically scale these 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 cluster status. 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: The ENI is enabled. false: The ENI is not enabled.	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 elastic mode (new) Catatan For more information about cluster editions, see Editions.	MIXED_STORAGE
Engine	string	The cluster engine. The value is fixed as AnalyticDB.	AnalyticDB
KmsId	string	The ID of the key used to encrypt disk data. Catatan 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.	3306
DiskPerformanceLevel	string	The disk performance level.	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 a group of elastic I/O resources are 24-core 192 GB. 12Core96GB: If the specifications of a single node are 12-core 96 GB, the specifications of a group of elastic I/O resources are 36-core 288 GB.	8Core64GB
DiskEncryption	boolean	Indicates whether disk encryption is enabled. Valid values: true: Disk encryption is enabled. false: Disk encryption is not enabled.	false
TaskInfo	object	The task information.
Name	string	The task name.	analyticDBFlexibleScaleOut
Status	string	The task status. Valid values: NOT_RUN: Waiting. RUNNING: Running. SUCCEED: Succeeded.	RUNNING
Progress	string	The task progress. Unit: %.	10
StepList	object
StepList	array<object>	The task steps.
	object	The task steps.
StepName	string	The step name.	ApplyResource
StepDesc	string	The step description.	Apply resource
StepStatus	string	The step status. Valid values: NOT_RUN: Waiting. 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 secondary zone ID. Catatan The value of this parameter cannot be the same as the value of the ZoneId parameter.	cn-hangzhou-i
SecondaryVSwitchId	string	The secondary vSwitch ID. Catatan The value of this parameter cannot be the same as the value of the VSwitchId parameter.	vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize	string		8ACU
ReservedNodeCount	integer		3
ProductForm	string		IntegrationForm

Contoh

Respons sukses

JSONformat

{
  "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"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.