Listing Background Tasks
Function
This API is used to query background tasks.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
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
Parameter |
Type |
Description |
---|---|---|
task_count |
String |
Number of tasks. |
tasks |
Array of SingleBackgroundTask objects |
Task details array. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Background task ID. |
name |
String |
Background task name. The options are as follows: 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 |
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. |
enable_show |
Boolean |
Task details that can be expanded. |
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 to enable public access. 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 to enable SSL. 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. |
old_resource_spec_code |
String |
Specification parameter before the modification. This parameter has a value only when the specifications are modified. |
new_resource_spec_code |
String |
Specification parameter after the modification. This parameter has a value only when the specifications are modified. |
old_replica_num |
Integer |
Number of replicas before the modification. This parameter has a value only when the specifications are modified. |
new_replica_num |
Integer |
Number of replicas after the modification. This parameter has a value only when the specifications are modified. |
old_cache_type |
String |
Cache type before the modification. This parameter has a value only when the specifications are modified. |
new_cache_type |
String |
Specification type after the modification. This parameter has a value only when the specifications are modified. |
replica_ip |
String |
Replica IP address. |
replica_az |
String |
AZ where the replica is in. |
group_name |
String |
Group name. |
old_port |
Integer |
Old port. |
new_port |
Integer |
New port. |
is_only_adjust_charging |
Boolean |
Indicates whether to only change the billing mode. |
account_name |
String |
Account name. |
source_ip |
String |
Source IP address. |
target_ip |
String |
Target IP address. |
node_name |
String |
Node information. |
rename_commands |
Array of strings |
Renamed command. |
updated_config_length |
Integer |
Length of the updated configuration item. |
Status code: 400
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
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
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
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
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" : "EXTEND", "user_name" : "paas_dcs_000_02", "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", "details" : { "old_cache_mode" : "single", "new_cache_mode" : "single", "old_capacity" : "0.125", "new_capacity" : "0.25" }, "enable_show" : false, "status" : "SUCCESS", "created_at" : "2020-06-17T08:18:06.597Z", "updated_at" : "2020-06-17T08:18:10.106Z" } ] }
SDK Sample Code
The SDK sample code is as follows.
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 49 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ListBackgroundTaskRequest request = new ListBackgroundTaskRequest(); request.withOffset(<offset>); request.withLimit(<limit>); request.withStartTime("<start_time>"); request.withEndTime("<end_time>"); 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 33 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListBackgroundTaskRequest() request.offset = <offset> request.limit = <limit> request.start_time = "<start_time>" request.end_time = "<end_time>" 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 39 40 41 42 43 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListBackgroundTaskRequest{} offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest startTimeRequest:= "<start_time>" request.StartTime = &startTimeRequest endTimeRequest:= "<end_time>" request.EndTime = &endTimeRequest response, err := client.ListBackgroundTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot