调用DescribeElasticPlan接口查询弹性计划。该接口仅适用于ADB弹性模式集群版(新版)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeElasticPlan

系统规定参数,取值:DescribeElasticPlan。

DBClusterId String am-bpxxxxxxxx47

集群ID。

ElasticPlanEnable Boolean true

弹性计划生效开关。

ElasticPlanName String realtime

弹性计划名称。

ResourcePoolName String test

资源池名称。

返回数据

名称 类型 示例值 描述
ElasticPlanList Array of ElasticPlanInfo

弹性计划列表。

ElasticNodeNum Integer 1

弹性计划节点数量。

Enable Boolean true

弹性计划是否生效。

EndDay String 2020-11-16

计划结束日期,设置该字段值时才会有对应返回字段信息。

EndTime String 16:00:00

计划结束时间。

PlanName String realtime

计划名称。

ResourcePoolName String test

资源池名称。

StartDay String 2020-10-30

计划开始日期,设置该字段值时才会有对应返回字段信息。

StartTime String 15:00:00

计划开始时间。

WeeklyRepeat String 3,4,5,6

弹性计划按周执行的周期。0~6表示周日到周六,多个日期间用,分割。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeElasticPlan
&DBClusterId=am-bpxxxxxxxx47
&ElasticPlanEnable=true
&ElasticPlanName=realtime
&ResourcePoolName=test
&<公共请求参数>

正常返回示例

XML 格式

<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 格式

{
    "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"
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。