查询后台任务列表
功能介绍
查询后台任务列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0。 |
limit |
否 |
Integer |
每页显示的条目数量。 |
start_time |
否 |
String |
查询开始时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20200609160000。 |
end_time |
否 |
String |
查询结束时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20200617155959。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
task_count |
String |
任务个数。 |
tasks |
Array of SingleBackgroundTask objects |
任务详情数组。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
是否有详细任务进展,可以展开查看。 |
参数 |
参数类型 |
描述 |
---|---|---|
old_capacity |
String |
变更前的容量,仅在变更规格时有值。 |
new_capacity |
String |
变更后的容量,仅在变更规格时有值。 |
enable_public_ip |
Boolean |
是否开启公网访问,仅在开启公网访问时有值。 |
public_ip_id |
String |
公网IP的ID,仅在开启公网访问时有值。 |
public_ip_address |
String |
公网IP地址,仅在开启公网访问时有值。 |
enable_ssl |
Boolean |
是否开启SSL,仅在开启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 |
是否只是调整计费模式。 |
account_name |
String |
账号名称。 |
source_ip |
String |
源IP。 |
target_ip |
String |
目标IP。 |
node_name |
String |
节点信息。 |
rename_commands |
Array of strings |
重命名的指令。 |
updated_config_length |
Integer |
更新配置项的长度。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
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 |
内部服务错误。 |
错误码
请参见错误码。