Performing Fuzzy Search on the Job Management Page
Function
This API is used to query created jobs. You can specify a job name and creator for exact query. The job list will be returned.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/cms/job/list
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum: 32 Maximum: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. Minimum: 1 Maximum: 40960 |
Content-Type |
Yes |
String |
Content type, which is application/json. Minimum: 1 Maximum: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Job name. Minimum: 1 Maximum: 64 |
page_num |
No |
Integer |
Number of the page to be queried, which must be a positive integer. If you enter a negative number, 0, or a positive integer greater than 1000, the value will be automatically changed to 1. Default: 1. Minimum: 1 Maximum: 1000 |
page_size |
No |
Integer |
Number of records displayed on each page, which must be a positive integer. If the value is a negative number, 0, or a positive number greater than 101, the value will be automatically changed to 10. Default: 10. Minimum: 1 Maximum: 100 |
order_by_column |
Yes |
String |
Field to be sorted. Options: name, create_time, and update_time (default). Minimum: 1 Maximum: 32 |
sort_order |
Yes |
String |
Sorting order (default: DESC). Options: ASC (ascending order) and DESC (descending order). Minimum: 1 Maximum: 32 |
enterprise_project_id |
No |
String |
Enterprise project ID. Minimum: 0 Maximum: 64 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_elements |
Long |
Total number. Minimum: 0 Maximum: 9999999 |
elements |
Array of Job objects |
Job information set. Array Length: 0 - 9999999 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Job ID. Minimum: 1 Maximum: 64 |
name |
String |
Job name. Minimum: 1 Maximum: 64 |
create_time |
Long |
Time when an entity was created. Minimum: 0 Maximum: 9999999999999 |
create_by |
String |
Creator. Minimum: 1 Maximum: 64 |
update_time |
Long |
Time when the entity was last updated. Note: When a creation, modification, or deletion operation is performed, update_time will be updated. Minimum: 0 Maximum: 9999999999999 |
update_by |
String |
User who makes the modification. Minimum: 1 Maximum: 64 |
description |
String |
Job description, which can contain up to 1000 characters. Minimum: 1 Maximum: 1000 |
enterprise_project_id |
String |
Enterprise project ID. Minimum: 1 Maximum: 64 |
project_id |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum: 32 Maximum: 32 |
steps |
Array of Step objects |
Job step. Array Length: 1 - 10 |
parameters |
Array of Parameter objects |
Global parameter. Array Length: 0 - 20 |
rate_control |
RateControl object |
Execution policy. |
approve_info |
ApproveInfo object |
Approval details. |
is_latest_version |
Boolean |
Whether the job is of the latest version. |
version_number |
Integer |
Version. Minimum: 1 Maximum: 100 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Step ID. Minimum: 1 Maximum: 64 |
name |
String |
Step name. Minimum: 1 Maximum: 32 |
type |
String |
Step type. Minimum: 1 Maximum: 16 |
input |
Map<String,String> |
Step parameter. |
ignore_error |
Boolean |
Whether to automatically ignore errors. |
description |
String |
Step description. Minimum: 1 Maximum: 1000 |
Parameter |
Type |
Description |
---|---|---|
param_name |
String |
Parameter name. |
param_type |
String |
Parameter type. Minimum: 1 Maximum: 16 |
param_group |
String |
Parameter group. Minimum: 1 Maximum: 32 |
default_value |
String |
Initial value of a parameter. Minimum: 1 Maximum: 40960 |
id |
String |
Parameter ID. Minimum: 1 Maximum: 64 |
encryption |
Boolean |
Whether to encrypt the data. |
hint |
String |
Parameter prompt. Minimum: 1 Maximum: 1000 |
quote_param |
Boolean |
Whether to select a parameter from the parameter library. |
required |
Boolean |
Whether a parameter is mandatory. |
description |
String |
Parameter description. Minimum: 1 Maximum: 1000 |
Parameter |
Type |
Description |
---|---|---|
have_rate_control |
Boolean |
Whether to implement batch release. Default: false. |
time_delay |
Integer |
Interval. Minimum: 1 Maximum: 60 |
max |
Integer |
Maximum number of instances supported for batch release. Minimum: 0 Maximum: 100 |
Parameter |
Type |
Description |
---|---|---|
topic_selected |
String |
Selected topic. Minimum: 1 Maximum: 2048 |
need_approve |
Boolean |
Whether a review is needed. Options: true and false (default). |
smn_urn_list |
String |
Topic URN set. Minimum: 1 Maximum: 2048 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 1 Maximum: 32 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 1024 |
http_code |
Integer |
Returned HTTP code. Minimum: 1 Maximum: 999 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 1 Maximum: 32 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 1024 |
http_code |
Integer |
Returned HTTP code. Minimum: 1 Maximum: 999 |
Example Requests
Query the list of jobs whose name is xxx and order_by_column is create_time.
POST https://{Endpoint}/v1/{project_id}/cms/job/list { "name" : "xxx", "enterprise_project_id" : "", "page_num" : 1, "page_size" : 10, "order_by_column" : "create_time", "sort_order" : "DESC" }
Example Responses
Status code: 200
OK: The job list is returned.
{ "elements" : [ { "approve_info" : { "need_approve" : false }, "create_by" : "xxxxxx", "create_time" : 1600015045074, "description" : "", "enterprise_project_id" : "0", "id" : "xxxxxx", "is_latest_version" : true, "name" : "xxxxxx", "parameters" : [ { "default_value" : "xxxxx", "description" : "", "encryption" : false, "hint" : "", "id" : "xxxxxxx", "param_group" : "", "param_name" : "xxxxx", "param_type" : "STRING", "quote_param" : false, "required" : true }, { "default_value" : "xxxx", "description" : "", "encryption" : false, "hint" : "", "id" : "xxxxxxxx", "param_group" : "", "param_name" : "xxxxx", "param_type" : "STRING", "quote_param" : false, "required" : true }, { "default_value" : "{xxxxxxx}", "description" : "", "encryption" : false, "hint" : "", "id" : "xxxxxxxxxx", "param_group" : "ecs_instance", "param_name" : "xxxxx", "param_type" : "HOST", "quote_param" : false, "required" : true } ], "project_id" : "xxxxxxxxx", "rate_control" : { "have_rate_control" : false, "max" : 0, "time_delay" : 0 }, "steps" : [ { "description" : "", "id" : "xxxxxxxxxxx", "ignore_error" : false, "input" : { "script_param" : "{xxxxxxx}", "get_instances" : "{xxxxxxx}" }, "name" : "xxx", "type" : "script" }, { "description" : "", "id" : "xxxxxxxxxxxx", "ignore_error" : false, "input" : { "package" : "{xxxx}", "get_instances" : "{xxxx}" }, "name" : "file1", "type" : "package" } ], "update_by" : "xxxx", "update_time" : 1600015045074, "version_number" : 1 } ], "total_elements" : 1 }
Status code: 400
Bad Request: Invalid request. The client should not repeat the request without modifications.
{ "error_code" : "AOM.31003202", "error_msg" : "job parameter invalid.", "http_code" : 400 }
Status code: 401
Unauthorized: The authentication information is incorrect or invalid.
{ "error_code" : "AOM.31009019", "error_message" : "auth failed.", "http_code" : "401" }
SDK Sample Code
The SDK sample code is as follows.
Java
Query the list of jobs whose name is xxx and order_by_column is create_time.
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 50 51 52 53 |
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.aom.v1.region.AomRegion; import com.huaweicloud.sdk.aom.v1.*; import com.huaweicloud.sdk.aom.v1.model.*; public class ListAllJobByNameSolution { 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); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListAllJobByNameRequest request = new ListAllJobByNameRequest(); SearchJobsRequestBody body = new SearchJobsRequestBody(); body.withEnterpriseProjectId(""); body.withSortOrder("DESC"); body.withOrderByColumn("create_time"); body.withPageSize(10); body.withPageNum(1); body.withName("xxx"); request.withBody(body); try { ListAllJobByNameResponse response = client.listAllJobByName(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
Query the list of jobs whose name is xxx and order_by_column is create_time.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v1.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v1 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 = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAllJobByNameRequest() request.body = SearchJobsRequestBody( enterprise_project_id="", sort_order="DESC", order_by_column="create_time", page_size=10, page_num=1, name="xxx" ) response = client.list_all_job_by_name(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
Query the list of jobs whose name is xxx and order_by_column is create_time.
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/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 := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAllJobByNameRequest{} enterpriseProjectIdSearchJobsRequestBody:= "" pageSizeSearchJobsRequestBody:= int32(10) pageNumSearchJobsRequestBody:= int32(1) nameSearchJobsRequestBody:= "xxx" request.Body = &model.SearchJobsRequestBody{ EnterpriseProjectId: &enterpriseProjectIdSearchJobsRequestBody, SortOrder: "DESC", OrderByColumn: "create_time", PageSize: &pageSizeSearchJobsRequestBody, PageNum: &pageNumSearchJobsRequestBody, Name: &nameSearchJobsRequestBody, } response, err := client.ListAllJobByName(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
OK: The job list is returned. |
400 |
Bad Request: Invalid request. The client should not repeat the request without modifications. |
401 |
Unauthorized: The authentication information is incorrect or invalid. |
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