云数据库 MySQL 版
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
内核功能
功能
用户指南
实例管理
连接管理
管理连接终端
备份恢复
服务可用性
日志管理
数据安全管理
参数管理
跨地域备份管理
API 参考
V2（2022-01-01）
实例管理
连接管理
账号管理
数据库管理
安全加密
备份与恢复
参数管理
资源包管理
附录
开发者工具
最佳实践
相关协议
- 文档首页
云数据库 MySQL 版API 参考V2（2022-01-01）任务管理DescribeTasks - 查询任务
复制全文
下载 pdfDescribeTasks - 查询任务
文档反馈
问问助手调用 DescribeTasks 接口查询任务。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
PageNumber | Integer | 是 | 1 | 当前页页码。最小值为 1。默认值为 1。 |
PageSize | Integer | 是 | 10 | 每页记录数。最小值为 1，最大值不超过 1000。默认值为 10。 |
InstanceId | String | 否 | mysql-d4942fd7**** | 实例 ID。 |
CreationStartTime | String | 否 | 2024-01-29T15:59:59Z | 任务的开始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明
|
CreationEndTime | String | 否 | 2024-01-27T16:00:00Z | 任务的结束时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明
|
TaskId | String | 否 | 2024012922384660DE49D5E35F6015****-b248b3 | 任务 ID。 说明 TaskId 与任务时间（CreationStartTime 和 CreationEndTime）两组参数，二者必选其一。 |
TaskAction | String | 否 | DeleteDatabase | 任务名称。 |
ProjectName | String | 否 | default | 项目名称。 |
TaskType | String | 否 | Web | 任务类型。取值：
|
TaskSource | String | 否 | User | 任务来源。取值：
|
TaskStatus | Array of String | 否 | ["Running"] | 任务状态。取值如下列表所示，可选多个：
|
TaskCategory | Array of String | 否 | ["BackupRecoveryManagement"] | 任务分类。取值如下列表所示，可选多个：
|
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 1 | 任务数量。 |
Datas | 请参见返回示例。 | 任务信息。 |
TaskInfoObject
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
CostTimeMS | Long | 3391 | 任务耗时。单位为毫秒。 |
CreateTime | String | 2024-01-29T13:13:49.955Z | 任务的创建时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
FinishTime | String | 2024-01-29T12:38:29.116Z | 任务的完成时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
Progress | Integer | 45 | 任务进度。单位为百分比。 说明 仅任务状态为执行中，即 TaskStatus 的值为 Running 的任务会返回任务进度。 |
RelatedInstanceInfos | { "InstanceID": "mysql-5bde124c****" } | 任务相关的实例。 | |
ScheduledExecuteEndTime | String | 2024-12-20T17:59:00Z | 计划启动的截止时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明 仅处于“等待开始”、“等待执行”或“等待切换”状态的任务会返回该字段。 |
ScheduledExecuteStartTime | String | 2024-12-20T16:00:00Z | 计划启动的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明 仅处于“等待开始”、“等待执行”或“等待切换”状态的任务会返回该字段。 |
ScheduledSwitchEndTime | String | 2024-12-20T17:59:00Z | 计划切换的截止时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明 仅处于“等待开始”、“等待执行”或“等待切换”状态的任务会返回该字段。 |
ScheduledSwitchStartTime | String | 2024-12-20T16:00:00Z | 计划切换的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明 仅处于“等待开始”、“等待执行”或“等待切换”状态的任务会返回该字段。 |
StartTime | String | 2024-01-29T12:38:25.725Z | 任务的启动时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
TaskAction | String | CreateDBAccount | 任务名称。 |
TaskCategory | String | BackupRecoveryManagement | 任务分类。取值：
|
TaskDesc | String | 这是一段任务的描述信息。 | 任务的描述信息。 |
TaskId | String | 202401221959431F6913166F6F5A21****-682d5d | 任务 ID。 |
TaskParams | String | | 任务参数。 |
TaskSource | String | User | 任务来源。取值：
|
TaskStatus | String | Success | 任务状态，取值：
|
TaskProgress | [ { "Name": "InstanceInitialization", "StepStatus": "Success" }, { "Name": "InstanceRecoveryPreparation", "StepStatus": "Failed" }, { "Name": "DataBackupImport", "StepStatus": "UnExecuted" }, { "Name": "LogBackupBinlogAdd", "StepStatus": "UnExecuted" }, { "Name": "TaskSuccessful", "StepStatus": "UnExecuted" } ] | 进度详情。 |
RelatedInstanceInfo
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
InstanceID | String | mysql-d4942fd7**** | 实例 ID。 |
TaskProgress
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Name | String | InstanceInitialization | 步骤名称。取值：
|
StepStatus | String | Success | 步骤状态。取值：
|
StepExtraInfo | [ { "Type": "CurDataSize", "Unit": "Bytes", "Value": 7579256 }, { "Type": "RemainDataSize", "Unit": "Bytes", "Value": 0 } ] | 步骤的具体信息。 |
StepExtraInfo
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Type | String | CurDataSize | 当前阶段
|
Unit | String | Bytes | 单位。取值：
|
Value | Double | 7579256 | 与 Type 字段对应的具体的值。 |
示例
请求示例 1
按 CreationStartTime 和 CreationEndTime 查询指定时间段内创建的任务。
POST /?Action=DescribeTasks&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"CreationEndTime": "2024-12-19T21:40:00Z",
"CreationStartTime": "2024-12-19T21:30:00Z",
"PageNumber": 1,
"PageSize": 100
}
返回示例 1
{
"ResponseMetadata": {
"RequestId": "202412201138271482F328AD8C800E91A0-aceec9",
"Action": "DescribeTasks",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {
"Datas": [
{
"CostTimeMS": 5132,
"CreateTime": "2024-12-19T21:37:51.899Z",
"FinishTime": "2024-12-19T21:37:57.031Z",
"RelatedInstanceInfos": {
"InstanceID": "mysql-35444107e157"
},
"StartTime": "2024-12-19T21:37:51.899Z",
"TaskAction": "CreateBackup",
"TaskCategory": "BackupRecoveryManagement",
"TaskDesc": "",
"TaskId": "f5ecd0a0056e45e4bf9dde48211f4347",
"TaskParams": "{\"InstanceId\":\"mysql-35444107e157\",\"BackupStrategy\":\"Instance\",\"BackupType\":\"Physical\",\"BackupMode\":\"Full\",\"BackupDataType\":\"Data\"}",
"TaskReason": "DeleteDBInstance",
"TaskSource": "User",
"TaskStatus": "Success"
},
{
"CostTimeMS": 26,
"CreateTime": "2024-12-19T21:35:05.967Z",
"FinishTime": "2024-12-19T21:35:05.993Z",
"RelatedInstanceInfos": {
"InstanceID": "mysql-04af6e86****"
},
"StartTime": "2024-12-19T21:35:05.967Z",
"TaskAction": "CreateDatabase",
"TaskCategory": "DatabaseAdminManagement",
"TaskDesc": "",
"TaskId": "20241220053505D87B1953D97A39D9628A-6f2884",
"TaskParams": "{\"InstanceId\":\"mysql-04af6e86****\",\"DBName\":\"io_observe995\",\"CharacterSetName\":\"utf8\",\"DBDesc\":\"\"}",
"TaskReason": "User operation",
"TaskSource": "User",
"TaskStatus": "Success"
},
{
"CostTimeMS": 180971,
"CreateTime": "2024-12-19T21:31:45.167Z",
"FinishTime": "2024-12-19T21:34:46.138Z",
"RelatedInstanceInfos": {
"InstanceID": "mysql-5cd320d04a98"
},
"StartTime": "2024-12-19T21:31:45.167Z",
"TaskAction": "CreateDBInstance",
"TaskCategory": "InstanceManagement",
"TaskDesc": "",
"TaskId": "20241220053143A7560C55222B0AE868F5-891415",
"TaskParams": "{\"DBEngineVersion\":\"MySQL_8_0\",\"InstanceType\":\"HA\",\"ZoneId\":\"\",\"NodeSpec\":\"\",\"NodeNumber\":0,\"NodeInfo\":[{\"ZoneId\":\"cn-beijing-a\",\"NodeType\":\"Primary\",\"NodeSpec\":\"rds.mysql.1c2g\",\"NodeOperateType\":\"Create\"},{\"ZoneId\":\"cn-beijing-a\",\"NodeType\":\"Secondary\",\"NodeSpec\":\"rds.mysql.1c2g\",\"NodeOperateType\":\"Create\"}],\"StorageType\":\"LocalSSD\",\"StorageSpace\":100,\"VpcId\":\"vpc-2ze1hcaoxk5c0610wgmc5****\",\"InstanceName\":\"测试实例3\",\"SuperAccountName\":\"rootgg\",\"SuperAccountPassword\":\"******\",\"LowerCaseTableNames\":\"1\",\"DBTimeZone\":\"UTC +08:00\",\"DBParamGroupId\":\"\",\"ChargeInfo\":{\"ChargeType\":\"PostPaid\",\"Number\":1},\"ProjectName\":\"default\",\"ShardNumber\":2,\"SubnetId\":\"subnet-257k5dxe6s5j44a7cffnk****\",\"Port\":3306}",
"TaskReason": "User operation",
"TaskSource": "User",
"TaskStatus": "Success"
}
],
"Total": 3
}
}
请求示例 2
按 TaskId 查询指定任务的详情。
POST /?Action=DescribeTasks&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"TaskId": "20241219213431ABD2ADEE7A33D166****-dac037",
"PageNumber": 1,
"PageSize": 100
}
返回示例 2
{
"ResponseMetadata": {
"RequestId": "20241224141230E7B854577D989BBDE2A3-9131d9",
"Action": "DescribeTasks",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {
"Datas": [
{
"CostTimeMS": 5080,
"CreateTime": "2024-12-19T21:38:00.911Z",
"FinishTime": "2024-12-19T21:38:05.991Z",
"RelatedInstanceInfos": {
"InstanceID": "mysql-9d90c967****"
},
"StartTime": "2024-12-19T21:38:00.911Z",
"TaskAction": "CreateBackup",
"TaskCategory": "BackupRecoveryManagement",
"TaskDesc": "",
"TaskId": "61fc851b46724ff09b3236ed24d74fb0",
"TaskParams": "{\"InstanceId\":\"mysql-9d90c967****\",\"BackupStrategy\":\"Instance\",\"BackupType\":\"Physical\",\"BackupMode\":\"Full\",\"BackupDataType\":\"Data\"}",
"TaskReason": "DeleteDBInstance",
"TaskSource": "User",
"TaskStatus": "Success"
}
],
"Total": 1
}
}
错误码
最近更新时间：2026.04.09 11:58:29
这个页面对您有帮助吗？
有用
有用
无用
无用