Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Application Operations Management/ API Reference/ APIs/ Automation (AOM 2.0)/ Performing Fuzzy Search on the Job Management Page

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Job name.

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.

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.

order_by_column

Yes

String

Field to be sorted. Options: name, create_time, and update_time (default).

sort_order

Yes

String

Sorting order (default: DESC). Options: ASC (ascending order) and DESC (descending order).

enterprise_project_id

No

String

Enterprise project ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_elements

Long

Total number.

elements

Array of Job objects

Job information set.

Table 5 Job

Parameter

Type

Description

id

String

Job ID.

name

String

Job name.

create_time

Long

Time when an entity was created.

create_by

String

Creator.

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.

update_by

String

User who makes the modification.

description

String

Job description, which can contain up to 1000 characters.

enterprise_project_id

String

Enterprise project ID.

project_id

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

steps

Array of Step objects

Job step.

parameters

Array of Parameter objects

Global parameter.

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.

Table 6 Step

Parameter

Type

Description

id

String

Step ID.

name

String

Step name.

type

String

Step type.

input

Map<String,String>

Step parameter.

ignore_error

Boolean

Whether to automatically ignore errors.

description

String

Step description.

Table 7 Parameter

Parameter

Type

Description

param_name

String

Parameter name.

param_type

String

Parameter type.

param_group

String

Parameter group.

default_value

String

Initial value of a parameter.

id

String

Parameter ID.

encryption

Boolean

Whether to encrypt the data.

hint

String

Parameter prompt.

quote_param

Boolean

Whether to select a parameter from the parameter library.

required

Boolean

Whether a parameter is mandatory.

description

String

Parameter description.

Table 8 RateControl

Parameter

Type

Description

have_rate_control

Boolean

Whether to implement batch release. Default: false.

time_delay

Integer

Interval.

max

Integer

Maximum number of instances supported for batch release.

Table 9 ApproveInfo

Parameter

Type

Description

topic_selected

String

Selected topic.

need_approve

Boolean

Whether a review is needed. Options: true and false (default).

smn_urn_list

String

Topic URN set.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Error message.

http_code

Integer

Returned HTTP code.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Error message.

http_code

Integer

Returned HTTP code.

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
54
55
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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .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
39
# 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    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
48
49
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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback