該接口用于查看一個(gè)DBS備份計(jì)劃。
接口說明
請(qǐng)?jiān)谑褂帽窘涌谇?，提前開通 OSS 服務(wù)，更多信息請(qǐng)參見對(duì)象存儲(chǔ) OSS。
調(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)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dbs:DescribeBackupPlanList | get |
|
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BackupPlanId | string | 否 | 備份計(jì)劃 ID，支持查詢多個(gè)備份計(jì)劃，英文逗號(hào)（,）分隔。 | dbstooi01exXXXX |
| Region | string | 否 | DBS 地域，可通過調(diào)用 DescribeRegions 接口查看 DBS 支持地域。 | cn-hangzhou |
| PageSize | integer | 否 | 每頁的記錄數(shù)，取值為 1~100。 說明
默認(rèn)為 30。
| 30 |
| PageNum | integer | 否 | 頁碼，大于等于 0 且不超過 Integer 的最大值，默認(rèn)值為：0。 | 1 |
| BackupPlanName | string | 否 | 備份計(jì)劃名稱。 | test123 |
| BackupPlanStatus | string | 否 | 備份計(jì)劃狀態(tài)，取值：
| wait |
| ClientToken | string | 否 | 用于保證請(qǐng)求的冪等性，防止重復(fù)提交請(qǐng)求。 | ASDASDASDSADASFCZXVZ |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-aekzecovzti**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"PageNum": 1,
"RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
"ErrCode": "InvalidParameterValid",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"TotalPages": 4,
"TotalElements": 100,
"PageSize": 30,
"Items": {
"BackupPlanDetail": [
{
"CrossRoleName": "test123",
"SourceEndpointInstanceType": "rds",
"BackupSetDownloadDir": "*/test/test123",
"SourceEndpointIpPort": "100.*.*.10:33204",
"CrossAliyunId": "2xxx7778xxxxxxxxxx",
"DuplicationArchivePeriod": 365,
"BackupPlanId": "dbstooi01eXXXX",
"EndTimestampForRestore": 1554560477000,
"BackupPlanStatus": "init",
"BackupSetDownloadFullDataFormat": "SQL",
"BackupRetentionPeriod": 365,
"OSSBucketRegion": "cn-hangzhou",
"SourceEndpointOracleSID": "test",
"BackupStorageType": "system",
"BackupMethod": "logical",
"SourceEndpointRegion": "cn-hangzhou",
"BackupPeriod": "Monday",
"SourceEndpointDatabaseName": "test",
"BackupSetDownloadGatewayId": 123123,
"BackupPlanCreateTime": 1582527713000,
"InstanceClass": "micro",
"BackupSetDownloadTargetType": "agent",
"DuplicationInfrequentAccessPeriod": 180,
"BackupStartTime": "14:22",
"ErrMessage": " can not connect to oracle instance orcl with user dbs",
"BackupObjects": "[ { \\\"DBName\\\":\\\"待備份庫名\\\", \\\"SchemaName\\\":\\\"待備份 Schema 名\\\", \\\"TableIncludes\\\":[{ \\\"TableName\\\":\\\"待備份表表名\\\" }], \\\"TableExcludes\\\":[{ \\\"TableName\\\":\\\"待備份庫名不需要備份表的表名\\\" }] } ]",
"BeginTimestampForRestore": 1554560477000,
"SourceEndpointInstanceID": "test",
"OpenBackupSetAutoDownload": true,
"BackupPlanName": "dbstooi01e****",
"OSSBucketName": "dbs-backup-1857XXXXX489",
"BackupGatewayId": 827362187368736,
"SourceEndpointUserName": "test",
"BackupSetDownloadIncrementDataFormat": "SQL",
"EnableBackupLog": true,
"ResourceGroupId": "rg-aekzecovzti****",
"DatabaseType": "MySQL"
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 當(dāng)前操作未被授權(quán)，請(qǐng)聯(lián)系主賬號(hào)在RAM控制臺(tái)進(jìn)行授權(quán)后再執(zhí)行操作 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-03-28 | API 內(nèi)部配置變更，不影響調(diào)用 | 查看變更詳情 |