You can call this operation to query the daily plan of an elastic plan. This operation can be used only for AnalyticDB for MySQL elastic clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeElasticDailyPlan

The operation that you want to perform. Set the value to

DescribeElasticDailyPlan.

DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.

ElasticDailyPlanDay String Yes 2020-10-16

The execution date of the daily plan. Specify the time in the YYYY-MM-DD format.

ElasticDailyPlanStatusList String Yes 1,2,3,4

The list of execution status of the daily plan. Valid values:

  • 1: The daily plan is not executed.
  • 2: The daily plan is being executed.
  • 3: The daily plan is executed.
  • 4: The daily plan fails to be executed.

    Separate multiple values with commas (,).

ElasticPlanName String Yes realtimeplan

The name of the elastic plan.

ResourcePoolName String Yes test

The name of the resource pool on which you want to execute the daily plan.

Response parameters

Parameter Type Example Description
ElasticDailyPlanList Array of ElasticDailyPlanInfo

The list of daily plans of the elastic plan.

Day String 2020-10-16

The date of the daily plan.

ElasticNodeNum Integer 1

The number of the time-specific elastic nodes.

EndTs String 2020-10-16 16:00:00

The end time.

PlanEndTs String 2020-10-16 16:00:00

The end time of the elastic plan.

PlanName String realtimeplan

The name of the elastic plan.

PlanStartTs String 2020-10-16 15:00:00

The start time of the elastic plan.

ResourcePoolName String test

The name of the resource pool on which the daily plan is executed.

StartTs String 2020-10-16 16:00:00

The start time.

Status Integer 4

The status of the daily plan. Valid values:

  • 1: The daily plan is not executed.
  • 2: The daily plan is being executed.
  • 3: The daily plan is executed.
  • 4: The daily plan fails to be executed.
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeElasticDailyPlan
&DBClusterId=am-bp1xxxxxxxx47
&ElasticDailyPlanDay=2020-10-16
&ElasticDailyPlanStatusList=1,2,3,4
&ElasticPlanName=realtimeplan
&ResourcePoolName=test
&<Common request parameters>

Sample success responses

XML format

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<ElasticDailyPlanList>
    <Status>4</Status>
    <StartTs>2020-10-16 16:00:00</StartTs>
    <PlanEndTs>2020-10-16 16:00:00</PlanEndTs>
    <EndTs>2020-10-16 16:00:00</EndTs>
    <ElasticNodeNum>1</ElasticNodeNum>
    <ResourcePoolName>test</ResourcePoolName>
    <PlanName>realtimeplan</PlanName>
    <Day>2020-10-16</Day>
    <PlanStartTs>2020-10-16 15:00:00</PlanStartTs>
</ElasticDailyPlanList>

JSON format

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "ElasticDailyPlanList": {
        "Status": 4,
        "StartTs": "2020-10-16 16:00:00",
        "PlanEndTs": "2020-10-16 16:00:00",
        "EndTs": "2020-10-16 16:00:00",
        "ElasticNodeNum": 1,
        "ResourcePoolName": "test",
        "PlanName": "realtimeplan",
        "Day": "2020-10-16",
        "PlanStartTs": "2020-10-16 15:00:00"
    }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly.

For a list of error codes, visit the API Error Center.