DescribePerformanceViewAttribute - 查看监控视图详情

更新时间: 2024-12-05 13:58:14

查看监控视图详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribePerformanceViewAttributeget
*DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

企业版、基础版或湖仓版集群 ID。

说明 调用 DescribeDBClusters 接口可以查看集群的集群 ID。
amv-bp11q28kvl688****
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看支持的地域和可用区信息,包括地域 ID。
cn-hangzhou
ViewNamestring

监控视图名称。

自定义-全部指标-2列-联动

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

E031AABF-BD56-5966-A063-4283EF18DB45
ViewNamestring

监控视图名称。

自定义-全部指标-2列-联动
CreateFromViewTypestring

原始图表来源的类型,取值:

  • Basic:基础视图
  • Advanced:高级视图
Basic
ViewDetailobject

监控视图详情。

ChartsPerLineinteger

每一行展示的图表数。

2
ChartLinkedboolean

是否联动图表。取值:

  • true
  • false
true
Categoriesarray<object>

指标分类列表。

categoriesobject

指标分类。

Categorystring

指标分类名,取值:

  • Node:节点资源指标
  • DiskData:磁盘指标
  • WorkLoad:负载指标
  • ResourceGroup:资源组指标
Node
Keysarray<object>

指标列表。

keysobject

单个指标配置。

KeyNamestring

指标 Key。

AnalyticDB_CPU
Selectedboolean

是否选中。取值:

  • true
  • false
true
AccessDeniedDetailstring

访问被拒绝详细信息;只有 Ram 校验失败才会返回此字段。

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "1*****************7", "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "2***************9", "NoPermissionType": "ImplicitDeny", "AuthAction": "adb:DescribeExcessivePrimaryKeys" }
DBClusterIdstring

集群 ID。

amv-bp198m028ih55xxxx
FillOriginViewKeysboolean

查看监控视图时,是否填充原始监控视图完成的 Key。取值:

  • true
  • false
true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。
404PerformanceViewNotFoundPerformance view not found.没有找到指定的监控视图名

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇: ModifyPerformanceView - 修改自定义监控视图 下一篇: DeletePerformanceView - 删除监控视图