擷取備份詳情
介面說明
該介面為非同步介面,執行個體的重啟不是立即完成的,成功調用後,執行個體會先進入重啟中(restarting)狀態,當返回的狀態為運行中(running)時代表重啟成功。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST /webapi/backup/manage/describe HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
執行個體所屬地區 ID。 |
cn-hangzhou |
| InstanceId |
string |
否 |
執行個體 ID。 |
c-b25e21e24388**** |
| BackupTaskId |
string |
否 |
備份任務 Id |
bt-2389hsdui12m |
| Statuses |
string |
否 |
狀態列表。 |
COMPLETED |
| TimePeriodStartTime |
integer |
否 |
備份任務查詢開始時間 |
1747708000 |
| TimePeriodEndTime |
integer |
否 |
備份任務查詢結束時間 |
1747728000 |
| PageNumber |
integer |
否 |
查詢頁碼。 |
1 |
| PageSize |
integer |
否 |
分頁查詢時每頁的條目數。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 要求狀態代碼。 |
200 |
| RequestId |
string |
請求 ID。 |
32A44F0D-BFF6-5664-999A-218BBDE7**** |
| Success |
boolean |
請求是否成功。 |
false |
| ErrCode |
string |
錯誤碼。 |
Success |
| ErrMessage |
string |
錯誤資訊。 |
Invalid params: [instance not exists]. |
| Data |
array<object> |
返回資料。 |
|
|
array<object> |
返回資料。 |
||
| RegionId |
string |
地區 ID。 |
cn-hangzhou |
| InstanceId |
string |
執行個體 ID。 |
c-d4be777ff5e8cXXX |
| Size |
integer |
雲端硬碟大小,單位為 GiB。 |
100 |
| Status |
string |
備份任務狀態。 |
RUNNING |
| Description |
string |
任務描述。 |
任務描述 |
| SubTasks |
array<object> |
備份子任務列表。 |
|
|
object |
|||
| StartTime |
integer |
任務開始日期。 |
1747708190 |
| FinishedTime |
integer |
任務結束時間。 |
1747718190 |
| SnapshotName |
string |
快照名稱。 |
2025-02-10_backup |
| DataBase |
string |
資料庫名稱。 |
test1 |
| Table |
string |
資料表名稱。 |
cdc_ods_t2030_lcpf_api_topic_msg |
| Size |
integer |
資料大小。單位:GiB。 |
1 |
| Status |
string |
備份任務狀態。 |
success |
| Detail |
string |
快照 ID。 |
[] |
| BackupStartTime |
integer |
本次備份開始時間。 |
1742179018000 |
| BackupFinishedTime |
integer |
本次備份結束時間。 |
1742179028000 |
| ExpireTime |
integer |
備份資料到期時間。 |
1742189008000 |
| BackupTaskId |
string |
備份任務 Id。 |
bt-12sui21312dd |
| BackupType |
string |
備份類型:
|
FullBackup |
| InstanceSnapshot |
object |
備份執行個體資訊。 |
|
| InstanceName |
string |
執行個體名稱。 |
c-37708ec80b5**** |
| VpcId |
string |
VPC ID。 |
vpc-2ze0cez8106f2n85c2d7i |
| RunMode |
string |
叢集的運行模式:
|
shared_data |
| SpecType |
string |
計算群組規格類型。包括以下類型:
|
standard |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-aekzd7frphchx3a |
| Version |
string |
叢集版本。 |
3.3 |
| MinorVersion |
string |
小版本版本號碼。 |
3.3.13-1.0-1.7.2 |
| NodeGroups |
array<object> |
計算群組資訊。 |
|
|
object |
|||
| ComponentType |
string |
計算群組類型。包含以下取值:
|
FE |
| Cu |
integer |
CU 數量。CU (Compute Unit) 是服務的基本計量單元,1 CU=1 核 CPU+4GiB 記憶體,僅在 SpecType 為記憶體增強型時 1 CU=1 核 CPU+8GiB 記憶體。 |
4 |
| StorageSize |
integer |
儲存大小。單位為 GiB。 |
200 |
| StoragePerformanceLevel |
string |
雲端硬碟的效能層級。包含以下取值:
|
pl1 |
| DiskNumber |
string |
磁碟數量。 |
2 |
| ResidentNodeNumber |
string |
節點數量。 |
3 |
| SpecType |
string |
計算群組規格類型。包括以下類型:
|
standard |
| LocalStorageInstanceType |
string |
節點群組本地 SSD 執行個體規格, 僅在基於 Ecs 執行個體且 SpecType 為本地 SSD/大規格儲存時該值才有意義。 |
null |
| RegionId |
string |
執行個體所屬地區 ID。 |
cn-beijing |
| Tags |
array<object> |
標籤資訊。 |
|
|
object |
標籤鍵。 |
||
| Key |
string |
標籤鍵。 |
bk-time |
| Value |
string |
標籤值。 |
1747708000 |
| Total |
integer |
查詢結果總數。 |
1 |
樣本
正常返回樣本
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
"Success": false,
"ErrCode": "Success",
"ErrMessage": "Invalid params: [instance not exists].\n",
"Data": [
{
"RegionId": "cn-hangzhou",
"InstanceId": "c-d4be777ff5e8cXXX",
"Size": 100,
"Status": "RUNNING",
"Description": "任務描述",
"SubTasks": [
{
"StartTime": 1747708190,
"FinishedTime": 1747718190,
"SnapshotName": "2025-02-10_backup",
"DataBase": "test1",
"Table": "cdc_ods_t2030_lcpf_api_topic_msg",
"Size": 1,
"Status": "success",
"Detail": "[]"
}
],
"BackupStartTime": 1742179018000,
"BackupFinishedTime": 1742179028000,
"ExpireTime": 1742189008000,
"BackupTaskId": "bt-12sui21312dd",
"BackupType": "FullBackup",
"InstanceSnapshot": {
"InstanceName": "c-37708ec80b5****",
"VpcId": "vpc-2ze0cez8106f2n85c2d7i",
"RunMode": "shared_data",
"SpecType": "standard",
"ResourceGroupId": "rg-aekzd7frphchx3a",
"Version": "3.3",
"MinorVersion": "3.3.13-1.0-1.7.2",
"NodeGroups": [
{
"ComponentType": "FE",
"Cu": 4,
"StorageSize": 200,
"StoragePerformanceLevel": "pl1",
"DiskNumber": "2",
"ResidentNodeNumber": "3",
"SpecType": "standard",
"LocalStorageInstanceType": "null"
}
],
"RegionId": "cn-beijing",
"Tags": [
{
"Key": "bk-time",
"Value": "1747708000"
}
]
}
}
],
"Total": 1
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。