查看AnalyticDB PostgreSQL版實(shí)例的計(jì)劃詳情。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀取(Read)或列出(List)。
- 資源類(lèi)型:是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下:
- 對(duì)于必選的資源類(lèi)型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
gpdb:DescribeDBInstancePlans | get |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱(chēng) | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實(shí)例 ID。 說(shuō)明
您可以調(diào)用 DescribeDBInstances 接口查看目標(biāo)地域下所有的 AnalyticDB PostgreSQL 實(shí)例的詳情,包括實(shí)例 ID。
| gp-bp12ga6v69h86**** |
PlanDesc | string | 否 | 計(jì)劃描述。 | this is a test plan |
PlanType | string | 否 | 計(jì)劃類(lèi)型,取值如下:
| PauseResume |
PlanScheduleType | string | 否 | 計(jì)劃執(zhí)行方式,取值如下:
| Regular |
PlanId | string | 否 | 計(jì)劃 ID。 說(shuō)明
您可以調(diào)用 DescribeDBInstancePlans 接口查看計(jì)劃的詳細(xì)信息,包括計(jì)劃 ID。
| 1234 |
PlanCreateDate | string | 否 | 過(guò)濾該日期之前創(chuàng)建的計(jì)劃,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時(shí)間),不傳入該參數(shù)表示返回所有時(shí)間的計(jì)劃。 | 2022-04-17T23:00Z |
返回參數(shù)
示例
正常返回示例
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****"
}
]
}
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2022-08-25 | 新增 OpenAPI | 查看變更詳情 |