文档中心

缓存数据库 Redis 版

任务中心

DescribeTasks

DescribeTasks

调用 DescribeTasks 查询任务。

请求类型

同步请求。

注意事项

仅支持查看创建时间在最近 30 天内的任务。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
PageNumber	Integer	是	1	任务列表页码，取值为大于等于 1 的正整数。
PageSize	Integer	是	10	每页记录数。取值为 1~100 间的整数。
CreationStartTime	String	否	2025-01-02T15:04:05Z	以任务创建时间进行查询时的时间范围的起点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若未指定 TaskId，则必须同时传入 CreationStartTime 和 CreationEndTime。
CreationEndTime	String	否	2025-01-02T15:14:05Z	以任务创建时间进行查询时的时间范围的终点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若未指定 TaskId，则必须同时传入 CreationStartTime 和 CreationEndTime。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID。
InstanceName	String	否	test	实例名称。
TaskId	String	否	4027864	任务 ID。用于查询具体某个任务。说明若未指定 TaskId，则必须同时传入 CreationStartTime 和 CreationEndTime。
TaskName	String	否	ModifyDBInstanceShardNumber	任务的操作。
ProjectName	String	否	default	项目名称。

返回参数

参数	类型	示例值	描述
Tasks	Array of OpTask	请参见返回示例。	任务列表。
Total	Integer	1	符合查询条件的结果总数。

OpTask

参数	类型	示例值	描述
CostTimeMS	Long	120000	操作耗时，单位为毫秒。
CreateTime	String	2025-01-02T15:05:00Z	任务的创建时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC）。
FinishTime	String	2025-01-02T15:07:05Z	任务的完成时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC）。
InstanceInfo	Object of RelatedInstanceInfo	请参见返回示例。	任务执行后实例的相关信息。
InstanceName	String	test	实例名称。
OriginInstanceInfo	Object of RelatedInstanceInfo	请参见返回示例。	任务执行前实例的相关信息。
Progress	Integer	100	任务的执行进度。单位为百分比。
StartTime	String	2025-01-02T15:05:05Z	任务开始执行的时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC）。
TaskAction	String	ModifyDBInstanceShardNumber	任务操作。
TaskDesc	String	test	任务的描述信息。
TaskId	String	4027864	任务 ID。
TaskName	String	ModifyDBInstanceShardNumber	任务名称。
TaskParams	String	1111	任务参数。
TaskStatus	String	"Running"	任务状态。
TaskStepInfo	Array of TaskStepInfo	请参见返回示例。	任务各阶段的进度信息。

RelatedInstanceInfo

参数	类型	示例值	描述
ConfigureNodes	Array of String	["cn-beijing-a"]	可用区分布详情。
EngineVersion	String	6.0	实例的数据库版本号。
InstanceID	String	redis-cn0212gzmh2xs****	实例 ID。
InstanceName	String	test	实例名称。
NodeNumber	Integer	2	副本数。
ProxyVersion	String	1.512.0	Proxy 的小版本。说明该参数仅在升级实例小版本的任务中返回。
ServerVersion	String	7.512.0	Server 的小版本。说明该参数仅在升级实例小版本的任务中返回。
ShardCapacity	Long	1024	分片容量，单位 MiB。
ShardedCluster	Integer	1	当前实例是否已启用分片集群，取值范围如下： 0：不启用（即实例中仅包含了 1 个分片）。 1：启用（即实例中包含了 1 个以上的分片）。
ShardNumber	Integer	3	分片数。
SubnetId	String	subnet-rrz4zdgdv20wv0x58h****	实例所属子网的子网 ID
VpcId	String	vpc-rs5811nceqyov0x****	私有网络的 ID
ZoneIds	Array of String	["cn-beijing-a"]	实例可用区

TaskStepInfo

参数	类型	示例值	描述
Name	String	任务初始化	阶段名称。
StepStatus	String	Running	阶段状态。
ProgressDesc	String	任务初始化	进度描述。
StepProgress	Integer	10	阶段进度。单位为百分比。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.10.19 15:55:50

这个页面对您有帮助吗？

有用

有用

无用

无用