創建定時計劃。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
gpdb:CreateDBInstancePlan | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 說明
您可以調用 DescribeDBInstances 接口查看目標地域下所有的 AnalyticDB PostgreSQL 實例的實例 ID。
| gp-bp12ga6v69h86**** |
PlanName | string | 是 | 計劃名稱。 | test-plan |
PlanDesc | string | 否 | 計劃描述。 | this is a test plan |
PlanType | string | 是 | 計劃類型,取值如下:
說明
| PauseResume |
PlanScheduleType | string | 是 | 計劃執行方式,取值如下:
| Regular |
PlanStartDate | string | 否 | 計劃的開始時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
| 2022-04-17T23:00:00Z |
PlanEndDate | string | 否 | 計劃的結束時間,需要大于查詢開始時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
| 2023-04-17T23:00:00Z |
PlanConfig | string | 是 | 執行計劃具體信息,JSON 格式,內容需根據 PlanType 參數和 PlanScheduleType 參數的值進行調整,具體說明請參見以下補充說明。 | {"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}} |
PlanConfig 參數補充說明
PlanType 為 PauseResume 時:
- PlanScheduleType 為 Postpone 時,只需要指定啟動或暫停的具體時間,其中 pause 為暫停實例;resume 為啟動實例;executeTime 為啟停的時間(UTC 時間),示例如下:
- 暫停實例:
{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}
- 啟動實例:
{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}
- 暫停實例:
- PlanScheduleType 為 Regular 時,需要指定周期啟動和暫停的時間,其中 pause 為暫停實例;resume 為啟動實例;planCronTime 為周期啟停的時間,Cron 格式(UTC 時間),示例如下:
{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}
。
PlanType 為 Resize 時:
- PlanScheduleType 為 Postpone 時,需要指定擴容或縮容的時間和目標節點數,其中 scaleOut 為擴容實例;scaleIn 為縮容實例;executeTime 為擴縮容的時間(UTC 時間);segmentNodeNum 為目標節點數,示例如下:
- 擴容實例:
{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}
- 縮容實例:
{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}
- 擴容實例:
- PlanScheduleType 為 Regular 時,需要指定周期擴縮容的時間和目標節點數,其中 scaleOut 為擴容實例;scaleIn 為縮容實例;planCronTime 為周期擴縮容的時間,Cron 格式(UTC 時間);segmentNodeNum 為目標節點數,示例如下:
{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}
。
PlanType 為 ModifySpec 時:
- PlanScheduleType 為 Postpone 時,需要指定升配或降配的時間和目標規格,其中 scaleUp 為實例升配;scaleDown 為實例降配;executeTime 為擴縮容的時間(UTC 時間);instanceSpec 為目標規格,示例如下:
- 實例升配:
{"scaleUp":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"4C32G"}}
- 實例降配:
{"scaleDown":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"2C16G"}}
- 實例升配:
- PlanScheduleType 為 Regular 時,需要指定周期升降配的時間和目標規格,其中 scaleUp 為實例升配;scaleDown 為實例降配;planCronTime 為周期擴縮容的時間,Cron 格式(UTC 時間);instanceSpec 為目標規格,示例如下:
{"scaleUp":{"instanceSpec":"4C32G","planCronTime":"0 0 12 1/1 * ? "},"scaleDown":{"instanceSpec":"2C16G","planCronTime":"0 0 0 1/1 * ? "}}
。
說明
Cron 表達式的說明和相關使用方法,請參見 Cron 表達式。
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad",
"Status": "success",
"ErrorMessage": "****",
"DBInstanceId": "gp-bp12ga6v69h86****",
"PlanId": "1234"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-08-25 | 新增 OpenAPI | 查看變更詳情 |