All Products
Search

This Product

    AnalyticDB for MySQL:DescribeDBResourceGroup

    Document Center

    AnalyticDB for MySQL:DescribeDBResourceGroup

    Last Updated:May 20, 2024

    Queries the information about resource groups for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

    Operation description

    For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

    		amv-bp11q28kvl688****
    GroupNamestringNo

    The name of the resource group.

    Note If you do not specify this parameter, the information about all resource groups in the cluster is returned.
    		test_group
    GroupTypestringNo

    The type of the resource group. Valid values:

    • Interactive
    • Job
    Note For information about resource groups of Data Lakehouse Edition, see Resource groups.
    		Job
    RegionIdstringNo

    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.

    RequestIdstring

    The request ID.

    		A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
    GroupsInfoobject []

    The queried resource group.

    GroupTypestring

    The type of the resource group. Valid values:

    • Interactive
    • Job
    Note For more information about resource groups, see Resource groups.
    		Job
    GroupNamestring

    The name of the resource group.

    		test1
    MinComputeResourcestring

    The minimum amount of reserved computing resources. Unit: AnalyticDB compute units (ACUs).

    		0ACU
    MaxComputeResourcestring

    The maximum amount of reserved computing resources. Unit: ACUs.

    		512ACU
    ClusterSizeResourcestring

    A reserved parameter.

    		N/A
    MinClusterCountinteger

    A reserved parameter.

    		N/A
    MaxClusterCountinteger

    A reserved parameter.

    		N/A
    RunningClusterCountinteger

    A reserved parameter.

    		N/A
    ClusterModestring

    A reserved parameter.

    		N/A
    ElasticMinComputeResourcestring

    The minimum amount of elastic computing resources. Unit: ACUs.

    		16ACU
    EnableSpotstring

    Indicates whether the preemptible instance feature is enabled for the resource group. After the preemptible instance feature is enabled, you are charged for resources at a lower unit price but the resources are probably released. Valid values:

    • True
    • False

    The True value is returned only for job resource groups.

    		True
    GroupUsersstring

    The Resource Access Management (RAM) user that is associated with the resource group.

    		testb,testc
    CreateTimestring

    The time when the resource group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2022-08-29T03:34:30Z
    UpdateTimestring

    The time when the resource group was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2022-08-31T03:34:30Z
    Statusstring

    The status of the resource group. Valid values:

    • creating: The resource group is being created.
    • ok: The resource group is created.
    • pendingdelete: The resource group is pending to be deleted.
    		ok
    Rulesobject []

    The job resubmission rules.

    GroupNamestring

    The name of the resource group.

    		user_default
    QueryTimestring

    The execution duration of the query. Unit: milliseconds.

    		180000
    TargetGroupNamestring

    The name of the destination resource group.

    		job

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "N/A\n",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "N/A\n",
      "ElasticMinComputeResource": "16ACU",
      "EnableSpot": "True",
      "GroupUsers": "testb,testc",
      "CreateTime": "2022-08-29T03:34:30Z",
      "UpdateTime": "2022-08-31T03:34:30Z",
      "Status": "ok",
      "Rules": [
        {
          "GroupName": "user_default",
          "QueryTime": "180000",
          "TargetGroupName": "job"
        }
      ]
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidPoolName.MalformedThe specified parameter PoolName is not valid.The PoolName parameter is invalid. Check the parameter.
    400InvalidPoolUser.MalformedThe specified parameter PoolUser is not valid.The PoolUser parameter is invalid. Check the parameter.
    400InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
    400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The DBClusterId parameter is invalid. Check the parameter.
    400InvalidPoolType.MalformedThe specified parameter PoolType is not valid.The PoolType parameter is invalid. Check the parameter.
    400InvalidMinComputeResource.MalformedThe specified parameter MinComputeResource is not valid.The MinComputeResource parameter is invalid. Check the parameter.
    400InvalidMaxComputeResource.MalformedThe specified parameter MaxComputeResource is not valid.The MaxComputeResource parameter is invalid. Check the parameter.
    408AcsServerTimeOutThe request has failed due to Adb Cloud Service time out.The backend service timed out. Please try again later.

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

    Change history

    Change timeSummary of changesOperation
    2024-03-25The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 408
    Output ParametersThe response structure of the API has changed.
    2024-03-01The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 408
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: RegionId
    2024-01-26The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 408
    Output ParametersThe response structure of the API has changed.
    2023-09-25The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 408
    Output ParametersThe response structure of the API has changed.
    2023-03-31The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 408
      Added Error Codes: 400