DescribePerformanceViewAttribute - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about a monitoring view.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribePerformanceViewAttribute	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.	amv-bp11q28kvl688****
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ViewName	string	Yes	The name of the view.	Basic

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	E031AABF-BD56-5966-A063-4283EF18DB45
ViewName	string	The name of the view.	Basic
CreateFromViewType	string	The type of the view.	Basic
ViewDetail	object	The information about the monitoring view.
ChartsPerLine	integer	The number of charts to display in each row.	2
ChartLinked	boolean	Specifies whether to enable the filter interaction feature. Valid values: true false	true
Categories	array<object>	The metric category.
categories	object	The metric category.
Category	string	The name of the metric category. Valid values: Node DiskData WorkLoad ResourceGroup	Node
Keys	array<object>	The metrics.
keys	object	The metrics.
KeyName	string	The name of the metric.	AnalyticDB_CPU
Selected	boolean	Specifies whether to select the metric. Valid values: true false	true
GroupType	array	The type of the resource group. Valid values: Interactive Job Note For more information about resource groups, see Resource group overview.
groupTypes	string	The type of the resource group.	Interactive
Engine	array	The database engine of the cluster. Valid values: AnalyticDB
engine	string	The database engine of the cluster.	AnalyticDB
EnableAutoMc	boolean	Indicates whether the multi-cluster feature is enabled. Valid values: true false	true
AccessDeniedDetail	string	The details about the access denial. Note This parameter is returned only if Resource Access Management (RAM) permission verification failed.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "1***************7", "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "2*************9", "NoPermissionType": "ImplicitDeny", "AuthAction": "adb:DescribeExcessivePrimaryKeys" }
DBClusterId	string	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	amv-bp198m028ih55xxxx
FillOriginViewKeys	boolean	Specifies whether to populate the names of the metrics in the original monitoring view when you view the monitoring view. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "E031AABF-BD56-5966-A063-4283EF18DB45",
  "ViewName": "Basic",
  "CreateFromViewType": "Basic",
  "ViewDetail": {
    "ChartsPerLine": 2,
    "ChartLinked": true,
    "Categories": [
      {
        "Category": "Node",
        "Keys": [
          {
            "KeyName": "AnalyticDB_CPU",
            "Selected": true,
            "GroupType": [
              "Interactive"
            ],
            "Engine": [
              "AnalyticDB"
            ],
            "EnableAutoMc": true
          }
        ]
      }
    ]
  },
  "AccessDeniedDetail": {
    "PolicyType": "AccountLevelIdentityBasedPolicy",
    "AuthPrincipalOwnerId": "1*****************7",
    "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",
    "AuthPrincipalType": "SubUser",
    "AuthPrincipalDisplayName": "2***************9",
    "NoPermissionType": "ImplicitDeny",
    "AuthAction": "adb:DescribeExcessivePrimaryKeys"
  },
  "DBClusterId": "amv-bp198m028ih55xxxx",
  "FillOriginViewKeys": true
}

Error codes

HTTP status code	Error code	Error message	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.
404	PerformanceViewNotFound	Performance view not found.	Specified monitoring view name not found

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-16	The Error code has changed. The response structure of the API has changed	View Change Details