调用DescribeDBInstancePlans查询计划详情_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

查看AnalyticDB PostgreSQL版实例的计划详情。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:DescribeDBInstancePlans	get	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp12ga6v69h86****
PlanDesc	string	否	计划描述。	this is a test plan
PlanType	string	否	计划类型，取值如下： PauseResume：自动启停。 Resize：节点扩容。 ModifySpec：规格变更，即变更计算节点规格。	PauseResume
PlanScheduleType	string	否	计划执行方式，取值如下： Postpone：稍后执行。 Regular：周期执行。	Regular
PlanId	string	否	计划 ID。说明您可以调用 DescribeDBInstancePlans 接口查看计划的详细信息，包括计划 ID。	1234
PlanCreateDate	string	否	过滤该日期之前创建的计划，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间），不传入该参数表示返回所有时间的计划。	2022-04-17T23:00Z

返回参数

名称	类型	描述	示例值
	object
Status	string	API 执行状态。执行成功则返回 success；执行失败则不返回该参数。	success
ErrorMessage	string	错误信息。只会在 API 执行失败时返回该参数。	****
RequestId	string	请求 ID。	34b32a0a-08ef-4a87-b6be-cdd988888888
TotalRecordCount	integer	总记录数。	1
PageRecordCount	integer	当前页记录数。	1
PageNumber	integer	当前页码。	1
Items	array<object>	计划列表。
PlanList	object
PlanName	string	计划名称。	test-plan
PlanDesc	string	计划描述。	this is a test plan
PlanId	string	计划 ID。	1234
PlanStatus	string	计划状态，取值如下： active：运行中。 cancel：取消。 deleted：删除。 finished：执行完成。	active
PlanType	string	计划类型，取值如下： PauseResume：自动启停。 Resize：节点扩容，即增加或减少计算节点。 ModifySpec：规格变更，即变更计算节点规格。	PauseResume
PlanScheduleType	string	计划执行方式，取值如下： Postpone：稍后执行。 Regular：周期执行。	Regular
PlanStartDate	string	计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅周期执行的计划返回该参数。不传默为当前时间。	2022-04-17T23:00Z
PlanEndDate	string	计划的结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅周期执行的计划返回该参数。创建计划时该参数不传，则不返回。	2023-04-17T23:00Z
PlanConfig	string	计划的具体信息。	{"pause":{"planCronTime":"0 22 * * 5"},"resume":{"planCronTime":"0 23 * * 5"}}
DBInstanceId	string	实例 ID。	gp-bp12ga6v69h86****

示例

正常返回示例

JSON格式

{
  "Status": "success",
  "ErrorMessage": "****",
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd988888888",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "PlanList": [
      {
        "PlanName": "test-plan",
        "PlanDesc": "this is a test plan",
        "PlanId": "1234",
        "PlanStatus": "active",
        "PlanType": "PauseResume",
        "PlanScheduleType": "Regular",
        "PlanStartDate": "2022-04-17T23:00Z",
        "PlanEndDate": "2023-04-17T23:00Z",
        "PlanConfig": "{\"pause\":{\"planCronTime\":\"0 22 * * 5\"},\"resume\":{\"planCronTime\":\"0 23 * * 5\"}}",
        "DBInstanceId": "gp-bp12ga6v69h86****"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-08-25	新增 OpenAPI	查看变更详情