全部产品
Search

搜索本产品

    云数据库 Tair（兼容 Redis®）：DescribeTasks - 查询实例某个时间段内所有任务信息

    文档中心

    云数据库 Tair（兼容 Redis®）：DescribeTasks - 查询实例某个时间段内所有任务信息

    更新时间：Dec 19, 2024

    查询云数据库 Tair（兼容 Redis）实例某个时间段内运行的所有任务信息。

    接口说明

    在执行某些耗时较长的操作时，您可以调用本接口查询任务的处理进度信息。您也可以通过控制台，进入目标实例的基本信息页面，单击页面右上角的任务进度图标来查看当前任务的处理进度信息。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    kvstore:DescribeTasksget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    实例 ID，可调用 DescribeInstances 接口获取。

    		r-bp1zxszhcgatnx****
    PageSizeinteger否

    每页可展示的记录数，取值： 30、50、100，默认值为 30。

    		30
    PageNumberinteger否

    页码，大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。

    		1
    StartTimestring是

    查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。

    		2020-11-20T01:00Z
    EndTimestring是

    查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。

    		2020-11-26T01:00Z
    Statusstring是

    任务状态，传入多个值时使用英文逗号（,）分隔，取值：

    • 0：等待中。
    • 1：执行中。
    • 2：已结束。
    • 4：已关闭。
    • 7：暂停。
    • 8：中断。
    		2

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		608FAEC9-485E-4C65-82DE-2E5B955E****
    PageNumberinteger

    页码。

    		1
    PageSizeinteger

    每页可展示的记录数。

    		30
    TotalRecordCountinteger

    总记录数。

    		2
    Itemsarray<object>

    任务信息详细列表。

    TaskProgressInfoobject
    Statusstring

    任务状态。

    • 0：等待中。
    • 1：执行中。
    • 2：已结束。
    • 4：已关闭。
    • 7：暂停。
    • 8：中断。
    		2
    FinishTimestring

    任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2020-11-13T06:17:18Z
    StepsInfostring

    子任务步骤信息，格式为 JSON。包含该子任务的预计剩余时间（remain）、任务名称（name）和任务进度（progress）信息。

    说明 如果不存在子步骤，不返回本参数。
    		[{\"remain\":0,\"name\":\"init_instance\",\"progress\":100},{\"remain\":107,\"name\":\"init_redis\",\"progress\":12.3},{\"remain\":1881,\"name\":\"init_config\",\"progress\":0}]
    Progressfloat

    任务进度，单位为百分比。

    		100
    BeginTimestring

    任务开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2020-11-13T06:16:54Z
    Remaininteger

    任务预计剩余时间，单位为秒。

    说明 如果任务不处于执行中，不返回本参数或返回的值为 0。
    		60
    CurrentStepNamestring

    当前的子步骤名称。

    		init_redis
    StepProgressInfostring

    任务的子步骤进度。

    说明 如果不存在子步骤，不返回本参数。
    		3/3
    TaskIdstring

    任务 ID。

    		32302****
    TaskActionstring

    任务标识。

    		ModifyDBInstanceParameter

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "608FAEC9-485E-4C65-82DE-2E5B955E****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "2",
      "FinishTime": "2020-11-13T06:17:18Z",
      "StepsInfo": "[{\\\"remain\\\":0,\\\"name\\\":\\\"init_instance\\\",\\\"progress\\\":100},{\\\"remain\\\":107,\\\"name\\\":\\\"init_redis\\\",\\\"progress\\\":12.3},{\\\"remain\\\":1881,\\\"name\\\":\\\"init_config\\\",\\\"progress\\\":0}]",
      "Progress": 100,
      "BeginTime": "2020-11-13T06:16:54Z",
      "Remain": 60,
      "CurrentStepName": "init_redis",
      "StepProgressInfo": "3/3",
      "TaskId": "32302****",
      "TaskAction": "ModifyDBInstanceParameter"
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。