All Products
Search

This Product

    AnalyticDB:DescribeElasticPlanJobs

    Document Center

    AnalyticDB:DescribeElasticPlanJobs

    Last Updated:Aug 30, 2024

    Queries a list of scaling plan jobs for an AnalyticDB for MySQL 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

    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:DescribeElasticPlanJobslist
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ElasticPlanNamestringNo

    The name of the scaling plan.

    Note

    • If you do not specify this parameter, all scaling plans of the cluster are queried.

    • You can call the DescribeElasticPlans operation to query the names of scaling plans.

    		test
    ResourceGroupNamestringNo

    The name of the resource group.

    Note

    • If you do not specify this parameter, the scaling plans of all resource groups are queried, including the interactive resource group and elastic I/O unit (EIU) types.

    • You can call the DescribeDBResourceGroup operation to query the resource group name for a cluster.

    		test
    StatusstringNo

    The state of the scaling plan job. Valid values:

    • RUNNING
    • SUCCESSFUL
    • FAILED
    Note If you do not specify this parameter, the scaling plans in all states are queried.
    		SUCCESSFUL
    StartTimestringNo

    The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    		2022-01-01T12:01:00Z
    PageSizeintegerYes

    The number of entries per page.

    		10
    PageNumberintegerYes

    The page number.

    		1
    DBClusterIdstringYes

    The cluster ID.

    Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
    		amv-wz9509beptiz****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.>

    TotalCountinteger

    The total number of scaling plan jobs.

    		15
    PageNumberinteger

    The page number.

    		1
    PageSizeinteger

    The number of entries per page.

    		10
    Jobsarray<object>

    The queried scaling plan jobs.

    object
    ElasticPlanNamestring

    The name of the scaling plan.

    		test
    Statusstring

    The state of the scaling plan job. Valid values:

    • RUNNING
    • SUCCESSFUL
    • FAILED
    		SUCCESSFUL
    Typestring

    The type of the scaling plan job. Valid values:

    • EXECUTOR: the interactive resource group type, which indicates the computing resource type.
    • WORKER: the EIU type.
    		EXECUTOR
    ResourceGroupNamestring

    The name of the resource group.

    		test
    StartTimestring

    The start time of the scaling plan job.

    Note The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.
    		2022-01-01T11:01:00Z
    EndTimestring

    The end time of the scaling plan job.

    Note The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.
    		2022-01-01T12:01:00Z
    TargetSizestring

    The desired specifications of elastic resources after scaling.

    		32ACU
    TotalAcustring

    The total amount of resources.

    Note
    • If Type is set to EXECUTOR, TotalAcu indicates the total amount of computing resources in the current resource group.
    • If Type is set to WORKER, TotalAcu indicates the total amount of storage resources in the cluster.
    		32ACU
    ReserveAcustring

    The amount of reserved resources.

    Note
    • If Type is set to EXECUTOR, ReserveAcu indicates the amount of reserved resources in the current resource group.
    • If Type is set to WORKER, ReserveAcu indicates the total amount of reserved storage resources in the current cluster.
    		16ACU
    ElasticAcustring

    The amount of elastic resources.

    Note
    • If Type is set to EXECUTOR, ElasticAcu indicates the amount of elastic resources in the current resource group.
    • If Type is set to WORKER, ElasticAcu indicates the total amount of elastic storage resources in the current cluster.
    		16ACU
    InstanceSizeinteger

    The number of compute nodes or storage replica sets.

    Note
    • If Type is set to EXECUTOR, InstanceSize indicates the number of compute nodes in the cluster.
    • If Type is set to EXECUTOR, InstanceSize indicates the number of storage replica sets in the cluster.
    		1
    RequestIdstring

    The request ID.

    		A5C433C2-001F-58E3-99F5-3274C14DF8BD

    Examples

    Sample success responses

    JSONformat

    {
  "TotalCount": 15,
  "PageNumber": 1,
  "PageSize": 10,
  "Jobs": [
    {
      "ElasticPlanName": "test",
      "Status": "SUCCESSFUL",
      "Type": "EXECUTOR",
      "ResourceGroupName": "test",
      "StartTime": "2022-01-01T11:01:00Z",
      "EndTime": "2022-01-01T12:01:00Z",
      "TargetSize": "32ACU",
      "TotalAcu": "32ACU",
      "ReserveAcu": "16ACU",
      "ElasticAcu": "16ACU",
      "InstanceSize": 1
    }
  ],
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

    Error codes

    HTTP status codeError codeError messageDescription
    404InvalidDBCluster.NotFoundThe 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.

    Change history

    Change timeSummary of changesOperation
    2023-12-12The Error code has changedView Change Details
    2023-04-13The Error code has changedView Change Details