DescribeSparkSQLDiagnosisAttribute - AnalyticDB - Alibaba Cloud Documentation Center

Queries the diagnostic information about a Spark SQL query.

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:DescribeSparkSQLDiagnosisAttribute	get	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	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-2zeq4788qyy7k662
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
AppId	string	Yes	The application ID. Note You can call the ListSparkApps operation to query a list of Spark application IDs.	s202411071444hzdvk486d9d2001****
InnerQueryId	long	Yes	The ID of the query executed within the Spark application.	1
Language	string	Yes	The language in which to return the query results. Valid values: en: English. zh: Chinese.	zh

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
AppId	string	The application ID. Note You can call the ListSparkApps operation to query a list of Spark application IDs.	s202411071444hzdvk486d9d2001****
InnerQueryId	long	The ID of the query executed within the Spark application.	1
ElapsedTime	long	The execution duration of the query. Unit: milliseconds.	100
DiagnosisInfos	array	The queried diagnostic information.
DiagnosisInfoList	Adb4MysqlSparkDiagnosisInfo	The queried diagnostic information.
OperatorListSortedByMetrics	object	The operators sorted by metrics.
OperatorListSortedByMaxMemory	array	The operators sorted by the maximum memory used.
OperatorListSortedByMaxMemorys	SparkOperatorInfo	The information about the Spark operator.
OperatorListSortedByExclusiveTime	array	The operators sorted by the execution duration.
OperatorListSortedByExclusiveTimes	SparkOperatorInfo	The information about the Spark operator.
Root	OperatorNode	The Spark execution plan tree.
AccessDeniedDetail	string	The information about the request denial.	{}

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "AppId": "s202411071444hzdvk486d9d2001****",
  "InnerQueryId": 1,
  "ElapsedTime": 100,
  "DiagnosisInfos": [
    {
      "DiagnosisType": "APPLICATION",
      "DiagnosisCode": "",
      "DiagnosisCodeLabel": "",
      "DiagnosisMsg": ""
    }
  ],
  "OperatorListSortedByMetrics": {
    "OperatorListSortedByMaxMemory": [
      {
        "OperatorName": "",
        "MetricValue": 0
      }
    ],
    "OperatorListSortedByExclusiveTime": [
      {
        "OperatorName": "",
        "MetricValue": 0
      }
    ]
  },
  "Root": {
    "nodeName": "",
    "id": 0,
    "nodeDepth": 0,
    "parentId": 0,
    "levelWidth": 0,
    "nodeWidth": 0,
    "stats": {
      "parameters": "",
      "bytes": 0,
      "outputRows": 0,
      "timeCost": 0,
      "peakMemory": 0
    },
    "children": [
      {
        "nodeName": "",
        "id": 0,
        "nodeDepth": 0,
        "parentId": 0,
        "levelWidth": 0,
        "nodeWidth": 0,
        "stats": {
          "parameters": "",
          "bytes": 0,
          "outputRows": 0,
          "timeCost": 0,
          "peakMemory": 0
        },
        "children": [
          {
            "nodeName": "",
            "id": 0,
            "nodeDepth": 0,
            "parentId": 0,
            "levelWidth": 0,
            "nodeWidth": 0,
            "stats": {
              "parameters": "",
              "bytes": 0,
              "outputRows": 0,
              "timeCost": 0,
              "peakMemory": 0
            },
            "children": []
          }
        ]
      }
    ]
  },
  "AccessDeniedDetail": {}
}

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.

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