You can call this operation to query 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 DescribeElasticPlan

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

DBClusterId String Yes am-bpxxxxxxxx47

The ID of the cluster.

ElasticPlanEnable Boolean Yes true

Specifies whether to enable the elastic plan.

ElasticPlanName String Yes realtime

The name of the elastic plan.

ResourcePoolName String Yes test

The name of the resource pool.

Response parameters

Parameter Type Example Description
ElasticPlanList Array of ElasticPlanInfo

The list of elastic plans.

ElasticNodeNum Integer 1

The number of nodes in the elastic plan.

Enable Boolean true

Indicates whether the elastic plan is enabled.

EndDay String 2020-11-16

The end date of the elastic plan. Responses are returned only after you specify this parameter in the request.

EndTime String 16:00:00

The end time of the elastic plan.

PlanName String realtime

The name of the elastic plan.

ResourcePoolName String test

The name of the resource pool.

StartDay String 2020-10-30

The start date of the elastic plan. The end date of the elastic plan. Responses are returned only after you specify this parameter in the request.

StartTime String 15:00:00

The start time of the elastic plan.

WeeklyRepeat String 3,4,5,6

The days of the week when the elastic plan is executed. Valid values: 0, 1, 2, 3, 4, 5, and 6. 0 to 6 indicate Sunday to Saturday. Separate multiple days with commas (,).

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeElasticPlan
&DBClusterId=am-bpxxxxxxxx47
&ElasticPlanEnable=true
&ElasticPlanName=realtime
&ResourcePoolName=test
&<Common request parameters>

Sample success responses

XML format

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<ElasticPlanList>
    <WeeklyRepeat>3,4,5,6</WeeklyRepeat>
    <EndTime>16:00:00</EndTime>
    <StartTime>15:00:00</StartTime>
    <ElasticNodeNum>1</ElasticNodeNum>
    <Enable>true</Enable>
    <ResourcePoolName>test</ResourcePoolName>
    <EndDay>2020-11-16</EndDay>
    <StartDay>2020-10-30</StartDay>
    <PlanName>realtime</PlanName>
</ElasticPlanList>

JSON format

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "ElasticPlanList": {
        "WeeklyRepeat": "3,4,5,6",
        "EndTime": "16:00:00",
        "StartTime": "15:00:00",
        "ElasticNodeNum": 1,
        "Enable": true,
        "ResourcePoolName": "test",
        "EndDay": "2020-11-16",
        "StartDay": "2020-10-30",
        "PlanName": "realtime"
    }
}

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.