DescribeTasks--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeTasks

最近更新时间：2025.01.22 12:04:46首次发布时间：2023.08.14 13:15:55

调用 DescribeTasks 接口查询任务。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
PageNumber	Integer	是	1	当前页页码。最小值为 1。默认值为 1。
PageSize	Integer	是	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。
InstanceId	String	否	mysql-d4942fd7****	实例 ID。
CreationStartTime	String	否	2024-01-29T15:59:59Z	任务的开始时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。说明任务时间（CreationStartTime 和 CreationEndTime）与 TaskId 两组参数，二者必选其一。任务开始时间（CreationStartTime）与任务结束时间（CreationEndTime）的最大时间间隔不能超过 7 天。
CreationEndTime	String	否	2024-01-27T16:00:00Z	任务的结束时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。说明任务时间（CreationStartTime 和 CreationEndTime）与 TaskId 两组参数，二者必选其一。任务开始时间（CreationStartTime）与任务结束时间（CreationEndTime）的最大时间间隔不能超过 7 天。
TaskId	String	否	2024012922384660DE49D5E35F6015****-b248b3	任务 ID。说明 TaskId 与任务时间（CreationStartTime 和 CreationEndTime）两组参数，二者必选其一。
TaskAction	String	否	DeleteDatabase	任务名称。
ProjectName	String	否	default	项目名称。
TaskType	String	否	Web	任务类型。取值： `Web`：控制台请求。 `OpenAPI`：OpenAPI请求。 `AssumeRole`：角色扮演请求。 `Other`：其他请求。
TaskSource	String	否	User	任务来源。取值： `User`：租户。 `System`：系统。 `SystemUser`：内部运维。 `UserMaintain`：系统/运维管理员发起的、租户可见的维护操作。
TaskStatus	String[]	否	["Running"]	任务状态。取值如下列表所示，可选多个： `WaitSwitch`: 等待切换 `WaitStart`: 等待执行 `Canceled`: 已取消 `Stopped`: 已终止 `Running_BeforeSwitch`: 运行中（切换前） `Timeout`: 执行超时 `Success`: 执行成功 `Failed`: 执行失败 `Running`: 执行中 `Stopping`: 终止中
TaskCategory	String[]	否	["BackupRecoveryManagement"]	任务分类。取值如下列表所示，可选多个： `BackupRecoveryManagement`：备份恢复管理。 `DatabaseAdminManagement`：数据库管理。 `DatabaseProxy`：数据库代理。 `HighAvailability`：高可用。 `InstanceAttribute`：实例属性。 `InstanceManagement`：实例管理。 `MonitoringPerformance`：监控和性能。 `NetworkManagement`：网络管理。 `SecurityManagement`：安全管理。 `SystemMaintainManagement`：系统运维管理。 `VersionUpgrade`：版本升级。

返回参数

参数	类型	示例值	描述
Total	Integer	1	任务数量。
Datas	Object[]	请参见返回示例。	任务信息。

示例

请求示例 1

按 CreationStartTime 和 CreationEndTime 查询指定时间段内创建的任务。

POST /?Action=DescribeTasks&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.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.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
    }
}

错误码

更多详情，请参见错误码。