Updated on 2024-06-28 GMT+08:00

Querying the Details of an Execution Plan

Function

This API is used to query the details of an execution plan based on the execution plan ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/cms/template/{template_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Minimum: 32

Maximum: 32

template_id

Yes

String

Plan ID.

Minimum: 1

Maximum: 64

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

share_type

Yes

String

Template type. Default: private. Options: public and private.

Minimum: 1

Maximum: 10

Request Parameters

Table 3 Request header 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

approve_info

ApproveInfo object

Review information.

create_by

String

User who created the template. This parameter is obtained from the token transferred during API calling.

Minimum: 1

Maximum: 64

create_time

Long

Time (UTC, in millisecond) when the template was created.

Minimum: 0

Maximum: 9999999999999

enterprise_project_id

String

Enterprise project ID.

Minimum: 1

Maximum: 64

id

String

Template ID, which is unique and generated based on project_id and template_name.

Minimum: 1

Maximum: 64

is_collect

Boolean

Whether a template is added to favorites. This parameter cannot be modified when you update the template. To change the template favorites status, call the corresponding API.

is_publish

Boolean

Whether to release as a service.

job_id

String

Job ID.

Minimum: 1

Maximum: 64

job_version

Integer

Job version.

Minimum: 1

Maximum: 999

name

String

Template name.

Minimum: 1

Maximum: 64

need_synchronize

Boolean

Whether synchronization is required.

nodes

Array of Node objects

List of parameters required for executing a task.

Array Length: 1 - 20

parameters

Array of Parameter objects

List of parameters required for executing a task.

Array Length: 0 - 20

project_id

String

Project ID.

Minimum: 32

Maximum: 32

quote

Array of strings

Referenced parameter.

Minimum: 1

Maximum: 256

Array Length: 0 - 999

rate_control

RateControl object

Execution policy.

share_type

String

Template type. Options: public (default templates) and private (custom templates).

Minimum: 1

Maximum: 16

steps

Array of Step objects

Job step.

Array Length: 1 - 20

update_by

String

User who updated the template. This parameter is obtained from the token transferred during API calling.

Minimum: 1

Maximum: 64

update_time

Long

Template update time (UTC, in milliseconds).

Minimum: 0

Maximum: 9999999999999

version

String

Template version.

Minimum: 1

Maximum: 32

Table 5 ApproveInfo

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

Table 6 Node

Parameter

Type

Description

parent_node

String

Name of the parent node.

Minimum: 1

Maximum: 64

category

String

Node type.

Minimum: 1

Maximum: 32

description

String

Node description.

Minimum: 1

Maximum: 1024

id

String

Node ID.

Minimum: 1

Maximum: 64

ignore_error

Boolean

Whether to ignore the error.

metadata

Metadata object

Metadata.

name

String

Node name, for example, Node.

Minimum: 1

Maximum: 64

task_name

String

Task name.

Minimum: 1

Maximum: 64

Table 7 Metadata

Parameter

Type

Description

type

String

Node type.

Minimum: 1

Maximum: 32

configuration

Map<String,Object>

Configuration information.

Table 8 Parameter

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

Table 9 RateControl

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

Table 10 Step

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

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Example Requests

Query the details of an execution plan based on template_id and share_type. share_type: The default value is private.

https://{Endpoint}/v1/{project_id}/cms/template/{template_id}?share_type=private

Example Responses

Status code: 200

OK: The details of an execution plan are returned.

{
  "approve_info" : {
    "need_approve" : false
  },
  "create_by" : "xxxxxxxxx",
  "create_time" : 1600026634837,
  "enterprise_project_id" : "0",
  "id" : "xxxxxx",
  "is_collect" : false,
  "is_publish" : false,
  "job_id" : "xxxxxx",
  "job_version" : 1,
  "name" : "1",
  "need_synchronize" : false,
  "nodes" : [ {
    "category" : "pause",
    "description" : "xxxxxx",
    "id" : "xxxxxx",
    "ignore_error" : false,
    "metadata" : {
      "type" : "pause"
    },
    "name" : "xxx",
    "task_name" : "CMS::PAUSE"
  } ],
  "parameters" : [ {
    "default_value" : "",
    "description" : "",
    "encryption" : false,
    "hint" : "",
    "id" : "xxxxxx",
    "param_group" : "",
    "param_name" : "xxx",
    "param_type" : "STRING",
    "quote_param" : false,
    "required" : true
  }, {
    "default_value" : "",
    "description" : "xxxxxx",
    "encryption" : false,
    "hint" : "xxxxxxx",
    "id" : "xxxxxxx",
    "param_group" : "",
    "param_name" : "xxx",
    "param_type" : "STRING",
    "quote_param" : false,
    "required" : true
  } ],
  "project_id" : "xxxxxx",
  "quote" : [ ],
  "rate_control" : {
    "have_rate_control" : false,
    "max" : 0,
    "time_delay" : 0
  },
  "share_type" : "private",
  "steps" : [ {
    "description" : "xxxxxx",
    "id" : "xxxxxx",
    "ignore_error" : false,
    "input" : { },
    "name" : "xxx",
    "type" : "pause"
  } ],
  "update_by" : "xxx",
  "update_time" : 1600026634837,
  "version" : "v1"
}

Status code: 400

Bad Request: Invalid request. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.31001202",
  "error_msg" : "Invalid plan parameter.",
  "http_code" : 400
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "AOM.31009002",
  "error_message" : "auth failed.",
  "http_code" : "401"
}

SDK Sample Code

The SDK sample code is as follows.

Java

 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
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 SearchTemplateByIdSolution {

    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();
        SearchTemplateByIdRequest request = new SearchTemplateByIdRequest();
        request.withShareType("<share_type>");
        try {
            SearchTemplateByIdResponse response = client.searchTemplateById(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

 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
# 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 = SearchTemplateByIdRequest()
        request.share_type = "<share_type>"
        response = client.search_template_by_id(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

 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
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.SearchTemplateByIdRequest{}
	request.ShareType = "<share_type>"
	response, err := client.SearchTemplateById(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 details of an execution plan are 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.