创建项目
功能介绍
创建项目
调用方法
请参见如何调用API。
URI
POST /v4/project
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
参数解释: 项目描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
enterprise_id |
否 |
String |
参数解释: 项目要绑定的企业项目ID,可以通过[获取项目详情]接口获取,响应消息体中的enterprise_id字段的值就是项目要绑定的企业项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_name |
是 |
String |
参数解释: 项目名称。 约束限制: 最小长度:1,最大长度:128。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_type |
是 |
String |
参数解释: 项目类型。 约束限制: 正则表达式:"scrum|normal|xboard|basic|phoenix|ipd"。 取值范围: scrum(scrum项目) normal(normal项目) xboard(看板项目) basic(basic项目) phoenix(凤凰项目) ipd(IPD项目template_id必传) 默认取值: 不涉及。 |
source |
否 |
String |
参数解释: 项目来源。 约束限制: 包含0到64个字符,字符可以是字母、数字、中文字符、空白字符以及特定的特殊字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
template_id |
否 |
Integer |
参数解释: 用户创建的项目模板id。 约束限制: 当project_type字段值为ipd时,template_id可选值为10001,10002,10003,分别对应IPD-系统设备类,IPD-独立软件类,IPD-自运营软件/云服务类 取值范围: 10001(IPD-系统设备类) 10002(IPD-独立软件类) 10003(IPD-自运营软件/云服务类) 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
参数解释: 项目描述。 取值范围: 不涉及。 |
project_id |
String |
参数解释: 项目id。 取值范围: 不涉及。 |
project_name |
String |
参数解释: 项目名。 取值范围: 不涉及。 |
project_num_id |
Integer |
参数解释: 项目数字id。 取值范围: 不涉及。 |
project_type |
String |
参数解释: 项目类型。 取值范围: 不涉及。 |
user_num_id |
Integer |
参数解释: 创建者的数字id。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
Post https://{endpoint}/v4/project
{
"project_name" : "TestDemo",
"description" : "modify testxxxxx",
"project_type" : "scrum"
}
响应示例
状态码:200
OK
{
"description" : "this is demo",
"project_id" : "2e76d6f0b2c5403796e36bf63c5d5561",
"project_name" : "testdemo",
"project_num_id" : 708168641,
"project_type" : "scrum",
"user_num_id" : 700145037
}
状态码:400
Bad Request
{
"error_code" : "PM.00000001",
"error_msg" : "param error"
}
SDK代码示例
SDK代码示例如下。
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 47 48 49 50 |
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.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;
public class CreateProjectV4Solution {
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);
ProjectManClient client = ProjectManClient.newBuilder()
.withCredential(auth)
.withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
.build();
CreateProjectV4Request request = new CreateProjectV4Request();
CreateProjectV4RequestBody body = new CreateProjectV4RequestBody();
body.withProjectType("scrum");
body.withDescription("modify testxxxxx");
body.withProjectName("TestDemo");
request.withBody(body);
try {
CreateProjectV4Response response = client.createProjectV4(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 32 33 34 35 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 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 = ProjectManClient.new_builder() \
.with_credentials(credentials) \
.with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateProjectV4Request()
request.body = CreateProjectV4RequestBody(
project_type="scrum",
description="modify testxxxxx",
project_name="TestDemo"
)
response = client.create_project_v4(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 37 38 39 40 41 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/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 := projectman.NewProjectManClient(
projectman.ProjectManClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateProjectV4Request{}
descriptionCreateProjectV4RequestBody:= "modify testxxxxx"
request.Body = &model.CreateProjectV4RequestBody{
ProjectType: "scrum",
Description: &descriptionCreateProjectV4RequestBody,
ProjectName: "TestDemo",
}
response, err := client.CreateProjectV4(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。