查詢RDS MySQL、RDS PostgreSQL、PolarDB MySQL版實例的高級下載任務列表。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dbs:DescribeDownloadTask | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionCode | string | 是 | 實例所在地域 ID,您可以調用 DescribeDBInstanceAttribute 查詢。 | cn-hangzhou |
InstanceName | string | 否 | 實例 ID。 說明
該參數為必填項。
| rm-bp1imnmcjxdz7**** |
DatasourceId | string | 否 | 數據源 DBS 標記 ID,傳入格式為:ds-${實例 ID}_${regionId}。 | ds-rm-2ze8g2am97624****_cn-hangzhou |
BackupSetId | string | 否 | 創建下載任務時生成的備份集 ID,您可調用 DescribeBackups 接口查詢。 | 216**** |
State | string | 否 | 下載任務的狀態,取值如下:
| queueing |
TaskType | string | 否 | 下載任務類型,取值如下:
| full |
StartTime | string | 否 | 按創建時間區間的起始點查詢,Long 類型時間戳形式,單位為毫秒(ms)。 | 1661941554000 |
EndTime | string | 否 | 按創建時間區間的終止點查詢,Long 類型時間戳形式,單位為毫秒(ms)。 | 1661941556000 |
PageSize | string | 否 | 每頁的記錄數。 | 50 |
CurrentPage | string | 否 | 當前頁碼。 | 1 |
OrderDirect | string | 否 | 排序方向,取值如下:
| desc |
OrderColumn | string | 否 | 默認按創建時間排序,取值:gmt_create。 | gmt_create |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
"ErrCode": "DBS.InternalError",
"Success": "true",
"ErrMessage": "instanceName can not be empty",
"Code": "DBS.InternalError",
"Message": "instanceName can not be empty",
"Data": {
"PageNumber": 1,
"TotalPages": 2,
"Extra": "dbtest",
"TotalElements": 1,
"PageSize": 10,
"Content": {
"List": [
{
"TaskId": "dt-qxntlvgu****",
"RegionCode": "cn-hangzhou",
"Format": "csv",
"DbList": "[dbtest]",
"BakSetId": "148261****",
"DownloadStatus": "queueing",
"ExportDataSize": "0",
"ImportDataSize": "0",
"BackupSetTime": "1663162216000",
"TargetType": "URL",
"TargetPath": "test_db/path",
"Progress": "0/0",
"GmtCreate": "1663321957000"
}
]
}
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
403 | Request.Forbidden | Have no Permissions | 當前操作未被授權,請聯系主賬號在RAM控制臺進行授權后再執行操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-11-16 | OpenAPI 返回結構發生變更 | 查看變更詳情 |