All Products
Search
Document Center

AnalyticDB for MySQL:DescribeAdviceServiceEnabled

Last Updated:Jan 31, 2024

Queries whether the suggestion feature is enabled for an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeAdviceServiceEnabledRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

Note You can call the DescribeDBClusters operation to query the IDs of Data Warehouse Edition (V3.0) clusters.
am-2ze0vp0j6t3to****
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Messagestring

The returned message.

  • If the request was successful, Success is returned.
  • If the request failed, an error message is returned.
[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****
RequestIdstring

The request ID.

E031AABF-BD56-5966-A063-4283EF18DB45
Resultboolean

Indicates whether the suggestion feature is enabled. Valid values:

  • True
  • False
False

Examples

Sample success responses

JSONformat

{
  "Message": "[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****",
  "RequestId": "E031AABF-BD56-5966-A063-4283EF18DB45",
  "Result": true
}

Error codes

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