Updated on 2025-09-04 GMT+08:00

Creating a Plan in a Project

Function

This API is used to create a plan in a project.

Calling Method

For details, see Calling APIs.

URI

POST /v1/projects/{project_id}/plans

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project UUID, which uniquely identifies a project. For details about how to obtain the project UUID, see Obtaining a Project ID.

Constraints

32 characters (letters and digits).

Range

N/A.

Default Value

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

assigned_id

No

String

Definition

Processor ID. If this parameter is left blank, the current user ID is used by default.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

name

Yes

String

Definition

Plan name.

Constraints

Max. 128 characters.

Range

N/A.

Default Value

N/A.

plan_cycle

Yes

PlanCycle object

Plan period.

service_id_list

Yes

Array of integers

Definition

Types of cases in the plan.

Constraints

Max. array length: 10.

Range

N/A.

Default Value

N/A.

Table 4 PlanCycle

Parameter

Mandatory

Type

Description

end_date

Yes

String

Definition

End time of the plan.

Constraints

In the UTC format. For example, 2020-03-31.

Range

N/A.

Default Value

N/A.

start_date

Yes

String

Definition

Start time of the plan.

Constraints

In the UTC format. For example, 2020-03-04.

Range

N/A.

Default Value

N/A.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

plan_id

String

Definition

Plan ID returned after the API is called successfully.

Range

N/A.

error_code

String

Definition

Error code returned after API calling fails.

Range

N/A.

error_msg

String

Definition

Error message returned after API calling fails.

Range

N/A.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code displayed after the API fails to be called.

Range

N/A.

error_msg

String

Definition

Error message displayed after the API fails to be called.

Range

N/A.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code displayed after the API fails to be called.

Range

N/A.

error_msg

String

Definition

Error message displayed after the API fails to be called.

Range

N/A.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code displayed after the API fails to be called.

Range

N/A.

error_msg

String

Definition

Error message displayed after the API fails to be called.

Range

N/A.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code displayed after the API fails to be called.

Range

N/A.

error_msg

String

Definition

Error message displayed after the API fails to be called.

Range

N/A.

Example Requests

Create a plan in a project.

post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans

{
  "assigned_id" : "efdb403066474ab08836b9eeaaa23bca",
  "name" : "Example test plan",
  "plan_cycle" : {
    "end_date" : "2020-03-31",
    "start_date" : "2020-03-04"
  },
  "service_id_list" : [ 13, 24 ]
}

Example Responses

Status code: 200

Created

{
  "plan_id" : "b66aab5469cc4ab39b0dda8e644a42a4",
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "Error message displayed after an API fails to be called"
}

SDK Sample Code

The sample code is as follows.

Java

Create a plan in a project.

 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
56
57
58
59
60
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreatePlanSolution {

    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);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        CreatePlanRequest request = new CreatePlanRequest();
        request.withProjectId("{project_id}");
        CreatePlanRequestBody body = new CreatePlanRequestBody();
        PlanCycle planCyclebody = new PlanCycle();
        planCyclebody.withStartDate("2020-03-04")
            .withEndDate("2020-03-31");
        List<Integer> listbodyServiceIdList = new ArrayList<>();
        listbodyServiceIdList.add(13);
        listbodyServiceIdList.add(24);
        body.withPlanCycle(planCyclebody);
        body.withServiceIdList(listbodyServiceIdList);
        body.withAssignedId("efdb403066474ab08836b9eeaaa23bca");
        body.withName("Example test plan");
        request.withBody(body);
        try {
            CreatePlanResponse response = client.createPlan(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

Create a plan in a project.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.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 = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePlanRequest()
        request.project_id = "{project_id}"
        planCyclebody = PlanCycle(
            start_date="2020-03-04",
            end_date="2020-03-31"
        )
        listServiceIdListbody = [
            13,
            24
        ]
        request.body = CreatePlanRequestBody(
            plan_cycle=planCyclebody,
            service_id_list=listServiceIdListbody,
            assigned_id="efdb403066474ab08836b9eeaaa23bca",
           name="Example test plan"
        )
        response = client.create_plan(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

Create a plan in a project.

 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 main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/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 := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreatePlanRequest{}
	request.ProjectId = "{project_id}"
	startDatePlanCycle:= "2020-03-04"
	endDatePlanCycle:= "2020-03-31"
	planCyclebody := &model.PlanCycle{
		StartDate: &startDatePlanCycle,
		EndDate: &endDatePlanCycle,
	}
	var listServiceIdListbody = []int32{
        int32(13),
	    int32(24),
    }
	assignedIdCreatePlanRequestBody:= "efdb403066474ab08836b9eeaaa23bca"
	request.Body = &model.CreatePlanRequestBody{
		PlanCycle: planCyclebody,
		ServiceIdList: listServiceIdListbody,
		AssignedId: &assignedIdCreatePlanRequestBody,
		Name: "Example test plan",
	}
	response, err := client.CreatePlan(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More SDK Sample Code

For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab.

Status Codes

Status Code

Description

200

Created

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

Error Codes

See Error Codes.