文档首页/ 分布式缓存服务 DCS/ API参考/ API V2(推荐)/ 后台任务管理/ 查询后台任务列表 - ListBackgroundTask
更新时间:2025-10-22 GMT+08:00
分享

查询后台任务列表 - ListBackgroundTask

功能介绍

查询后台任务列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcs:instance:getBackgroundTask

    Read

    instance *

    g:EnterpriseProjectId

    -

    -

URI

GET /v2/{project_id}/instances/{instance_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

偏移量,表示生成的列表从此偏移量开始显示,例如偏移量为3时,生成的列表从第4条开始。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0

limit

Integer

参数解释

每页显示的条目数量。

约束限制

不涉及。

取值范围

1-1000

默认取值

10

start_time

String

参数解释

查询开始时间。

约束限制

时间为UTC时间。格式:yyyyMMddHHmmss,如:20200609160000。

取值范围

不涉及。

默认取值

不涉及。

end_time

String

参数解释

查询结束时间。

约束限制

时间为UTC时间。格式:yyyyMMddHHmmss,如:20200609160000。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

task_count

String

参数解释

后台任务个数。

取值范围

不涉及。

tasks

Array of SingleBackgroundTask objects

参数解释

任务详情。

表4 SingleBackgroundTask

参数

参数类型

描述

id

String

参数解释

后台任务ID。

取值范围

不涉及。

name

String

参数解释

后台任务名。

取值范围

  • EXTEND:变更规格

  • BindEip:开启公网访问

  • UnBindEip:关闭公网访问

  • AddReplica:添加副本

  • DelReplica:删除副本

  • AddWhitelist:设置IP白名单

  • UpdatePort:修改端口

  • RemoveIpFromDns:域名摘除IP

  • masterStandbySwapJob: 主备切换任务

  • modify:修改密码

details

DetailsBody object

参数解释

详细信息。

取值范围

不涉及。

user_name

String

参数解释

用户名。

取值范围

不涉及。

user_id

String

参数解释

用户ID。

取值范围

不涉及。

params

String

参数解释

任务相关参数。

取值范围

不涉及。

status

String

参数解释

任务状态。

取值范围

不涉及。

created_at

String

参数解释

任务启动时间,格式为2020-06-17T07:38:42.503Z。

取值范围

不涉及。

updated_at

String

参数解释

任务结束时间,格式为2020-06-17T07:38:42.503Z。

取值范围

不涉及。

enable_show

Boolean

参数解释

是否有详细任务进展,可以展开查看。

取值范围

不涉及。

表5 DetailsBody

参数

参数类型

描述

old_capacity

String

参数解释

变更前的容量,仅在变更规格时有值。

取值范围

不涉及。

new_capacity

String

参数解释

变更后的容量,仅在变更规格时有值。

取值范围

不涉及。

enable_public_ip

Boolean

参数解释

是否开启公网访问。

取值范围

  • true:公网访问已开启。

  • false:公网访问未开启。

public_ip_id

String

参数解释

公网IP的ID。

取值范围

不涉及。

public_ip_address

String

参数解释

公网IP地址。

取值范围

不涉及。

enable_ssl

Boolean

参数解释

是否开启SSL。

取值范围

  • true:SSL已开启。

  • false:SSL未开启。

old_cache_mode

String

参数解释

变更前的缓存类型,仅在变更规格时有值。

取值范围

不涉及。

new_cache_mode

String

参数解释

变更后的缓存类型,仅在变更规格时有值。

取值范围

不涉及。

old_resource_spec_code

String

参数解释

变更前的规格参数,仅在变更规格时有值。

取值范围

不涉及。

new_resource_spec_code

String

参数解释

变更后的规格参数,仅在变更规格时有值。

取值范围

不涉及。

old_replica_num

Integer

参数解释

变更前的副本数量,仅在变更规格时有值。

取值范围

不涉及。

new_replica_num

Integer

参数解释

变更后的副本数量,仅在变更规格时有值。

取值范围

不涉及。

old_cache_type

String

参数解释

变更前的缓存类型,仅在变更规格时有值。

取值范围

不涉及。

new_cache_type

String

参数解释

变更后的规格类型,仅在变更规格时有值。

取值范围

不涉及。

replica_ip

String

参数解释

副本IP。

取值范围

不涉及。

replica_az

String

参数解释

副本所在可用区。

取值范围

不涉及。

group_name

String

参数解释

实例分片组名。

取值范围

不涉及。

old_port

Integer

参数解释

旧端口。

取值范围

不涉及。

new_port

Integer

参数解释

新端口。

取值范围

不涉及。

is_only_adjust_charging

Boolean

参数解释

是否只是调整计费模式。

取值范围

  • true:只调整计费模式。

  • false:有其他变更内容或未调整计费模式。

account_name

String

参数解释

账号名称。

取值范围

不涉及。

source_ip

String

参数解释

源IP。

取值范围

不涉及。

target_ip

String

参数解释

目标IP。

取值范围

不涉及。

node_name

String

参数解释

节点信息。

取值范围

不涉及。

rename_commands

Array of strings

参数解释

重命名的指令。

updated_config_length

Integer

参数解释

更新配置项的长度。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks?offset=0&limit=10&begin_time=20200609160000&end_time=20200617155959

响应示例

状态码:200

查询后台任务列表成功。

{
  "task_count" : 1,
  "tasks" : [ {
    "id" : "8abf6e1e72c12e7c0172c15b508500aa",
    "name" : "EXTEND",
    "user_name" : "dcs_000_02",
    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
    "details" : {
      "old_cache_mode" : "single",
      "new_cache_mode" : "single",
      "old_capacity" : "0.125",
      "new_capacity" : "0.25",
      "old_resource_spec_code" : "redis.single.xu1.tiny.125",
      "new_resource_spec_code" : "redis.single.xu1.tiny.256",
      "old_replica_num" : 1,
      "new_replica_num" : 1,
      "old_cache_type" : "single",
      "new_cache_type" : "single",
      "replica_ip" : "192.192.0.1",
      "replica_az" : "az01",
      "group_name" : "group1",
      "old_port" : 6379,
      "new_port" : 6379,
      "is_only_adjust_charging" : false,
      "account_name" : "account1",
      "source_ip" : "192.192.0.0",
      "target_ip" : "192.192.0.1",
      "node_name" : "node1",
      "rename_commands" : [ ],
      "updated_config_length" : 0
    },
    "enable_show" : false,
    "status" : "SUCCESS",
    "created_at" : "2020-06-17T08:18:06.597Z",
    "updated_at" : "2020-06-17T08:18:10.106Z"
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;


public class ListBackgroundTaskSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListBackgroundTaskRequest request = new ListBackgroundTaskRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListBackgroundTaskResponse response = client.listBackgroundTask(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListBackgroundTaskRequest()
        request.instance_id = "{instance_id}"
        response = client.list_background_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListBackgroundTaskRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListBackgroundTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询后台任务列表成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码

相关文档