# 获取即时任务列表 - ListImmediateJobs #### 功能介绍 获取即时任务列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:task:list | List | - | - | gaussdb:instance:list | - | #### URI GET /v3/{project_id}/immediate-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | status | 否 | String | **参数解释**： 任务执行状态。 **约束限制**： 不涉及。 **取值范围**： - Running：表示任务正在执行。 - Completed：表示任务执行成功。 - Failed：表示任务执行失败。 - RollbackCompleted：表示任务回滚成功。 - RollbackFailed：表示任务回滚失败。 **默认取值**： 不涉及。 | | job_name | 否 | String | **参数解释**： 任务名称。 **约束限制**： 不涉及。 **取值范围**： - "CreateGaussDBforMySQLInstance"表示创建实例。 - "RestoreGaussDBforMySQLNewInstance"表示恢复新实例。 - "AddGaussDBforMySQLNodes"表示添加节点。 - "DeleteGaussDBforMySQLNode"表示删除节点。 - "RebootGaussDBforMySQLInstance"表示重启实例。 - "ModifyGaussDBforMySQLPort"表示修改实例端口。 - "ModifyGaussDBforMySQLSecurityGroup"表示修改实例安全组。 - "ResizeGaussDBforMySQLFlavor"表示实例规格变更。 - "SwitchoverGaussDBforMySQLMasterNode"表示只读升主。 - "GaussDBforMySQLBindEIP"表示绑定弹性公网IP地址。 - "GaussDBforMySQLUnbindEIP"表示解绑弹性公网IP地址。 - "RenameGaussDBforMySQLInstance"表示修改实例名称。 - "DeleteGaussDBforMySQLInstance"表示删除实例集群。 - "UpgradeGaussDBforMySQLDatabaseVersion"表示版本升级。 - "EnlargeGaussDBforMySQLProxy"表示实例的数据库代理节点扩容。 - "OpenGaussDBforMySQLProxy"表示开启实例的数据库代理。 - "CloseGaussDBforMySQLProxy"表示关闭实例的数据库代理。 - "GaussdbforMySQLModifyProxyIp"表示修改数据库代理ip。 - "ScaleGaussDBforMySQLProxy"表示实例的数据库代理节点规格变更。 - "GaussDBforMySQLModifyInstanceMetricExtend"表示实例秒级监控。 - "GaussDBforMySQLModifyInstanceDataVip"表示修改实例数据Vip。 - "GaussDBforMySQLSwitchSSL"表示切换实例SSL开关。 - "GaussDBforMySQLModifyProxyConsist"表示修改代理一致性。 - "GaussDBforMySQLModifyProxyWeight"表示修改代理权重。 **默认取值**： 不涉及。 | | job_id | 否 | String | **参数解释**： 任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | offset | 否 | String | **参数解释**： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制**： 必须为整数，不能为负数。 **取值范围**： ≥0。 **默认取值**： 0。 | | limit | 否 | String | **参数解释**： 查询记录数。 **约束限制**： 必须为整数，不能为负数。 **取值范围**： 1-100。 **默认取值**： 100。 | | start_time | 否 | String | **参数解释**： 起始时间。 **约束限制**： 起始时间不能早于31天前。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **默认取值**： 不涉及。 | | end_time | 否 | String | **参数解释**： 结束时间。 **约束限制**： 结束时间不能早于开始时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **默认取值**： 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | jobs | Array of [TaskDetailInfo] objects | **参数解释**： 任务详情。 | | total_count | Integer | **参数解释**： 任务总数。 **取值范围**： 不涉及。 | | action_names | Array of strings | **参数解释**： 支持筛选的任务名称。 **取值范围**： 不涉及。 | 表5TaskDetailInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释**： 实例ID，严格匹配UUID规则。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 | | instance_name | String | **参数解释**： 实例名称。 **取值范围**： 实例ID对应的实例名称。 | | instance_status | String | **参数解释**： 实例状态。 **取值范围**： - createfail：表示实例创建失败。 - creating：表示实例创建中。 - normal：表示实例正常。 - abnormal：表示实例异常。 - deleted：表示实例已删除。 | | job_id | String | **参数解释**： 任务ID。 **取值范围**： 不涉及。 | | order_id | String | **参数解释**： 订单ID。 **取值范围**： 不涉及。 | | job_name | String | **参数解释**： 任务名称。 **取值范围**： - CreateGaussDBforMySQLInstance：表示创建实例。 - RestoreGaussDBforMySQLNewInstance：表示恢复新实例。 - AddGaussDBforMySQLNodes：表示添加节点。 - DeleteGaussDBforMySQLNode：表示删除节点。 - RebootGaussDBforMySQLInstance：表示重启实例。 - ModifyGaussDBforMySQLPort：表示修改实例端口。 - ModifyGaussDBforMySQLSecurityGroup：表示修改实例安全组。 - ResizeGaussDBforMySQLFlavor：表示实例规格变更。 - SwitchoverGaussDBforMySQLMasterNode：表示只读升主。 - GaussDBforMySQLBindEIP：表示绑定弹性公网IP地址。 - GaussDBforMySQLUnbindEIP：表示解绑弹性公网IP地址。 - RenameGaussDBforMySQLInstance：表示修改实例名称。 - DeleteGaussDBforMySQLInstance：表示删除实例集群。 - UpgradeGaussDBforMySQLDatabaseVersion：表示版本升级。 - EnlargeGaussDBforMySQLProxy：表示实例的数据库代理节点扩容。 - OpenGaussDBforMySQLProxy：表示开启实例的数据库代理。 - CloseGaussDBforMySQLProxy：表示关闭实例的数据库代理。 - GaussdbforMySQLModifyProxyIp：表示修改数据库读写分离地址。 - ScaleGaussDBforMySQLProxy：表示实例的数据库代理节点规格变更。 - GaussDBforMySQLModifyInstanceMetricExtend：表示实例秒级监控。 - GaussDBforMySQLModifyInstanceDataVip：表示修改实例数据浮动IP。 - GaussDBforMySQLSwitchSSL：表示切换实例SSL开关。 - GaussDBforMySQLModifyProxyConsist：表示修改代理一致性。 - GaussDBforMySQLModifyProxyWeight：表示修改代理权重。 | | status | String | **参数解释**： 任务执行状态。 **取值范围**： - Running：表示任务正在执行。 - Completed：表示任务执行成功。 - Failed：表示任务执行失败。 - RollbackCompleted：表示任务回滚成功。 - RollbackFailed：表示任务回滚失败。 | | process | String | **参数解释**： 任务进度。 **取值范围**： 不涉及。 | | created_time | String | **参数解释**： 任务创建时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 | | ended_time | String | **参数解释**： 任务结束时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 | | fail_reason | String | **参数解释**： 任务失败原因。 **取值范围**： 不涉及。 | | show_detail | Boolean | **参数解释**： 是否支持通过[获取异步任务详情](https://support.huaweicloud.com/api-taurusdb/ShowTaskDetails.html)接口获取任务详情。 **取值范围**： - true：是。 - false：否。 | | extend_fields | Map\ | **参数解释**： 任务扩展字段，默认null。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 获取即时任务列表。 ``` GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/immediate-jobs ``` #### 响应示例 **状态码：200** ``` { "jobs" : [ { "instance_id" : "ede953923f06448d9be8686ef0c1378ein07", "instance_name" : "gauss-1234", "instance_status" : "deleted", "job_id" : "7155730b-a60b-4dc0-9f89-3f55897f29d6", "order_id" : "", "job_name" : "CloseGaussDBforMySQLProxy", "status" : "Completed", "process" : "", "created_time" : "2018-08-06T10:41:14+0000", "ended_time" : "2018-08-06T12:41:14+0000", "fail_reason" : null, "show_detail" : false, "extend_fields" : null }, { "instance_id" : "ede953923f06448d9be8686ef0c1378ein07", "instance_name" : "gauss-1234", "instance_status" : "deleted", "job_id" : "335ab2a4-a038-4fa9-a62c-49dd84015011", "order_id" : "", "job_name" : "ResizeGaussDBforMySQLFlavor", "status" : "Failed", "process" : "", "created_time" : "2018-08-06T11:25:23+0000", "ended_time" : "2018-08-06T11:31:12+0000", "fail_reason" : "Single task exception.", "show_detail" : false, "extend_fields" : null } ], "total_count" : 2, "action_names" : [ "CreateGaussDBforMySQLInstance", "RestoreGaussDBforMySQLNewInstance", "AddGaussDBforMySQLNodes" ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ListImmediateJobsSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); ListImmediateJobsRequest request = new ListImmediateJobsRequest(); try { ListImmediateJobsResponse response = client.listImmediateJobs(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()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = ListImmediateJobsRequest() response = client.list_immediate_jobs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.ListImmediateJobsRequest{} response, err := client.ListImmediateJobs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=ListImmediateJobs)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。