Queries the information about one or more backup plans that meet the specified conditions.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 99. Default value: 10. | 10 |
| SourceType | string | Yes | The type of the data source. Valid values:
| ECS_FILE |
| Filters | object [] | No | The filter. | |
| Key | string | No | The keys in the filter. Valid values:
| vaultId |
| Values | array | No | The values that you want to match in the filter. | |
| string | No | The value that you want to match in the filter. | v-********************* |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 8,
"BackupPlans": {
"BackupPlan": [
{
"VaultId": "v-*********************",
"BackupType": "COMPLETE",
"CreateTime": 1554347313,
"DataSourceId": "ds-000ht6o9*****w61",
"SourceType": "ECS_FILE",
"Disabled": false,
"Prefix": "oss-prefix",
"Options": "{\"UseVSS\":false}",
"ClientId": "c-000ge4w*****1qb",
"Exclude": "[\"/var\", \"/proc\"]\t",
"Retention": 7,
"CreatedTime": 1554347313,
"ClusterId": "cl-000ht6o9******h",
"Bucket": "hbr-backup-oss",
"Detail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
"Schedule": "I|1602673264|P1D",
"SpeedLimit": "0:24:5120",
"InstanceId": "i-*********************",
"PlanId": "plan-*********************",
"BackupSourceGroupId": "System-Database",
"FileSystemId": "00594",
"OtsDetail": {
"TableNames": {
"TableName": [
"test2_HBR_RESTORED"
]
}
},
"InstanceName": "instancename",
"UpdatedTime": 1554347313,
"PlanName": "planname",
"Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
"Rules": {
"Rule": [
{
"DestinationRetention": 90,
"Schedule": "I|1631685600|P1D",
"Retention": 90,
"Disabled": true,
"DoCopy": false,
"DestinationRegionId": "cn-shanghai",
"RuleId": "rule-0008i52rf0ulpni6kn6m",
"RuleName": "Disk Golden Rule",
"BackupType": "COMPLETE"
}
]
},
"Resources": {
"Resource": [
{
"SourceType": "UDMDISK",
"ResourceId": "d-j6cgioir6m******lu4",
"Extra": "{\\\"doBackup\\\":false,\\\"diskName\\\":\\\"data_disk\\\",\\\"size\\\":100,\\\"type\\\":\\\"data\\\",\\\"category\\\":\\\"cloud_essd\\\",\\\"imageId\\\":\\\"\\\",\\\"device\\\":\\\"/dev/xvdb\\\",\\\"encrypted\\\":false}"
}
]
},
"Paths": {
"Path": [
"[\"/home\"]"
]
},
"TrialInfo": {
"TrialStartTime": 1579413159,
"TrialVaultReleaseTime": 1594965600,
"TrialExpireTime": 1584597600,
"KeepAfterTrialExpiration": true
},
"InstanceGroupId": "i-**",
"CrossAccountType": "CROSS_ACCOUNT",
"CrossAccountUserId": 0,
"CrossAccountRoleName": "BackupRole",
"KeepLatestSnapshots": 0,
"DestSourceType": "OSS",
"DestDataSourceId": "ds-*********************",
"DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
"ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
"LatestExecuteJobId": "job-12345678"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-09-21 | The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2023-09-08 | The request parameters of the API has changed | see changesets | ||||||
| ||||||||
| 2023-07-31 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2022-02-21 | The response structure of the API has changed | see changesets | ||||||
|