Listing Background Tasks

Updated on 2022-09-19 GMT+08:00

View PDF

Function

This API is used to list background tasks.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	Integer	Number of items displayed on each page.
start_time	No	String	Query start time (UTC). Format: yyyyMMddHHmmss, for example, 20200609160000.
end_time	No	String	Query end time (UTC). Format: yyyyMMddHHmmss, for example, 20200617155959.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_count	String	Number of tasks.
tasks	Array of SingleBackgroundTask objects	Task details array.
updated_at	String	Task end time, in the format 2020-06-17T07:38:42.503Z.
created_at	String	Task start time, in the format 2020-06-17T07:38:42.503Z.
status	String	Task status. Enumeration values: SUCCESS FAILED EXECUTING CREATED WAITING

**Table 4** SingleBackgroundTask
Parameter	Type	Description
id	String	Background task ID.
name	String	Background task name. The options are as follows: ChangeInstanceSpec: 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
details	DetailsBody object	Details.
user_name	String	Username.
user_id	String	User ID.
params	String	Task parameters.
status	String	Task status.
created_at	String	Task start time, in the format 2020-06-17T07:38:42.503Z.
updated_at	String	Task end time, in the format 2020-06-17T07:38:42.503Z.

**Table 5** DetailsBody
Parameter	Type	Description
old_capacity	String	Capacity before the modification. This parameter has a value only when the specifications are modified.
new_capacity	String	Capacity after the modification. This parameter has a value only when the specifications are modified.
enable_public_ip	Boolean	Whether public access is enabled. This parameter has a value only when public access is enabled.
public_ip_id	String	ID of the IP address used for public access. This parameter has a value only when public access is enabled.
public_ip_address	String	IP address used for public access. This parameter has a value only when public access is enabled.
enable_ssl	Boolean	Whether SSL is enabled. This parameter has a value only when SSL is enabled.
old_cache_mode	String	Cache type before the modification. This parameter has a value only when the specifications are modified.
new_cache_mode	String	Cache type after the modification. This parameter has a value only when the specifications are modified.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

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" : "ChangeInstanceSpec",
    "user_name" : "paas_dcs_a00421997_02",
    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
    "details" : {
      "old_cache_mode" : "single",
      "new_cache_mode" : "single",
      "old_capacity" : 0.125,
      "new_capacity" : 0.25
    }
  } ],
  "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.