Listing Background Tasks

Function

This API is used to query background tasks.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. It can be viewed on the instance details page on the DCS console. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Offset, which indicates that the generated list is displayed from this offset. For example, if the offset is 3, the generated list is displayed from the fourth record. Constraints N/A Range ≥ 0 Default Value 0
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range 1–1000 Default Value 10
start_time	No	String	Definition Query start time. Constraints The time is in the UTC format. Format: yyyyMMddHHmmss, for example, 20200609160000. Range N/A Default Value N/A
end_time	No	String	Definition Query end time. Constraints The time is in the UTC format. Format: yyyyMMddHHmmss, for example, 20200609160000. Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_count	String	Definition Number of background tasks. Range N/A
tasks	Array of SingleBackgroundTask objects	Definition Task details.

**Table 4** SingleBackgroundTask
Parameter	Type	Description
id	String	Definition Background task ID. Range N/A
name	String	Definition Background task name. Range EXTEND: modifying specifications BindEip: enabling public access UnBindEip: disabling public access AddReplica: adding replicas DelReplica: deleting replicas AddWhitelist: configuring an IP whitelist UpdatePort: changing the port RemoveIpFromDns: removing IP addresses masterStandbySwapJob: master/standby switchover modify: changing the password
details	DetailsBody object	Definition Details. Range N/A
user_name	String	Definition Username. Range N/A
user_id	String	Definition User ID. Range N/A
params	String	Definition Task parameters. Range N/A
status	String	Definition Task status. Range N/A
created_at	String	Definition Task start time, in the format 2020-06-17T07:38:42.503Z. Range N/A
updated_at	String	Definition Task end time, in the format 2020-06-17T07:38:42.503Z. Range N/A
enable_show	Boolean	Definition Task details that can be expanded. Range N/A

**Table 5** DetailsBody
Parameter	Type	Description
old_capacity	String	Definition Capacity before the modification. This parameter has a value only when the specifications are modified. Range N/A
new_capacity	String	Definition Capacity after the modification. This parameter has a value only when the specifications are modified. Range N/A
enable_public_ip	Boolean	Definition Indicates whether public access has been enabled. Range true: Yes false: No
public_ip_id	String	Definition Public IP address ID. Range N/A
public_ip_address	String	Definition Public IP address. Range N/A
enable_ssl	Boolean	Definition Whether SSL is enabled. Range true: Yes false: No
old_cache_mode	String	Definition Cache type before the modification. This parameter has a value only when the specifications are modified. Range N/A
new_cache_mode	String	Definition Cache type after the modification. This parameter has a value only when the specifications are modified. Range N/A
old_resource_spec_code	String	Definition Specification parameter before the modification. This parameter has a value only when the specifications are modified. Range N/A
new_resource_spec_code	String	Definition Specification parameter after the modification. This parameter has a value only when the specifications are modified. Range N/A
old_replica_num	Integer	Definition Number of replicas before the modification. This parameter has a value only when the specifications are modified. Range N/A
new_replica_num	Integer	Definition Number of replicas after the modification. This parameter has a value only when the specifications are modified. Range N/A
old_cache_type	String	Definition Cache type before the modification. This parameter has a value only when the specifications are modified. Range N/A
new_cache_type	String	Definition Specification type after the modification. This parameter has a value only when the specifications are modified. Range N/A
replica_ip	String	Definition Replica IP address. Range N/A
replica_az	String	Definition AZ where the replica is in. Range N/A
group_name	String	Definition Instance shard group name. Range N/A
old_port	Integer	Definition Old port. Range N/A
new_port	Integer	Definition New port. Range N/A
is_only_adjust_charging	Boolean	Definition Indicates whether to only change the billing mode. Range true: Yes false: No. Other changes are made or the billing mode is not changed.
account_name	String	Definition Account name. Range N/A
source_ip	String	Definition Source IP address. Range N/A
target_ip	String	Definition Target IP address. Range N/A
node_name	String	Definition Node information. Range N/A
rename_commands	Array of strings	Definition Renamed command.
updated_config_length	Integer	Definition Length of the updated configuration item. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Example Requests

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

Example Responses

Status code: 200

Background tasks listed successfully.

{
  "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"
  } ]
}

Status Codes

Status Code	Description
200	Background tasks listed successfully.
400	Invalid request.
401	Invalid authentication information.
403	The request is rejected.
404	The requested resource is not found.
500	Internal service error.