查询正在处理的任务信息
功能介绍
查询正在处理的任务信息。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/running-tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页显示的条目数量。默认值1000。 |
offset |
否 |
Integer |
首个展示的正在处理任务信息的偏移量 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
正在处理的任务总数。 |
tasks |
Array of RunningTasks objects |
正在处理的任务列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
虚拟机ID |
operate_type |
String |
操作类型。
|
task_time |
String |
任务时间 |
server_name |
String |
虚拟机名称 |
server_id |
String |
虚拟机ID |
keypair_name |
String |
密钥对名称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码: 200
OK
{ "total" : 1, "tasks" : [ { "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c", "operate_type" : "RUNNING_RESET", "task_time" : "1523342130000", "server_name" : "Test", "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006", "keypair_name" : "KeyPair-xt" } ] }
状态码: 400
Error response
{ "error_code" : "KPS.XXX", "error_msg" : "XXX" }
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 |
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.kps.v3.region.KpsRegion; import com.huaweicloud.sdk.kps.v3.*; import com.huaweicloud.sdk.kps.v3.model.*; public class ListRunningTaskSolution { 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); KpsClient client = KpsClient.newBuilder() .withCredential(auth) .withRegion(KpsRegion.valueOf("<YOUR REGION>")) .build(); ListRunningTaskRequest request = new ListRunningTaskRequest(); request.withLimit(<limit>); request.withOffset(<offset>); try { ListRunningTaskResponse response = client.listRunningTask(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 huaweicloudsdkkps.v3.region.kps_region import KpsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkps.v3 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"] credentials = BasicCredentials(ak, sk) client = KpsClient.new_builder() \ .with_credentials(credentials) \ .with_region(KpsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRunningTaskRequest() request.limit = <limit> request.offset = <offset> response = client.list_running_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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/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 := kps.NewKpsClient( kps.KpsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRunningTaskRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListRunningTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Error response |
错误码
请参见错误码。