创建项目的模块
功能介绍
查询项目的模块列表
调用方法
请参见如何调用API。
URI
POST /v4/projects/{project_id}/module
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过[查询项目列表]接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
参数解释: 模块描述。 约束限制: 正则表达式:"[\s\S]{0,255}"。 取值范围: 字符串的长度在 0 到 255 个字符之间。 默认取值: 不涉及。 |
module_name |
是 |
String |
参数解释: 模块名称。 约束限制: 正则表达式:"[a-zA-Z0-9\u4E00-\u9FA5-_]{1,30}"。 取值范围: 字符串的长度在 1 到 30 个字符之间。 默认取值: 不涉及。 |
owner |
是 |
UserRequest object |
参数解释: 用户信息。 约束限制: 不涉及。 |
parent_module_id |
否 |
Integer |
参数解释: 父模块id。用户通过[查询项目的模块列表]接口获取,响应消息体中的module_id字段的值就是模块id。 约束限制: 正则表达式:"[1-9]\d{0,9}"。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
参数解释: 模块描述。 取值范围: 不涉及。 |
module_id |
Integer |
参数解释: 模块id。 取值范围: 不涉及。 |
module_name |
String |
参数解释: 模块名称。 取值范围: 不涉及。 |
owner |
ModuleOwner object |
参数解释: 模块归属人信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
user_id |
String |
参数解释: 用户32位字符串id。 取值范围: 不涉及。 |
user_name |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
user_num_id |
Integer |
参数解释: 用户数字id。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
Post https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/modules
{
"description" : "module demo",
"module_name" : "demo",
"parent_module_id" : 1,
"owner" : {
"user_id" : "09d75cde5180d4481f91c018e89cb8e2"
}
}
响应示例
状态码:200
OK
{
"description" : "module demo",
"module_name" : "demo",
"module_id" : 46691,
"owner" : {
"user_id" : "09d75cde5180d4481f91c018e89cb8e2",
"user_num_id" : 4091,
"user_name" : "demo_user_name_06",
"nick_name" : "模块demo"
}
}
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 51 52 53 54 |
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 CreateProjectModuleSolution {
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();
CreateProjectModuleRequest request = new CreateProjectModuleRequest();
request.withProjectId("{project_id}");
CreateProjectModuleRequestBody body = new CreateProjectModuleRequestBody();
UserRequest ownerbody = new UserRequest();
ownerbody.withUserId("09d75cde5180d4481f91c018e89cb8e2");
body.withOwner(ownerbody);
body.withParentModuleId(1);
body.withModuleName("demo");
body.withDescription("module demo");
request.withBody(body);
try {
CreateProjectModuleResponse response = client.createProjectModule(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 36 37 38 39 40 |
# 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 = CreateProjectModuleRequest()
request.project_id = "{project_id}"
ownerbody = UserRequest(
user_id="09d75cde5180d4481f91c018e89cb8e2"
)
request.body = CreateProjectModuleRequestBody(
owner=ownerbody,
parent_module_id=1,
module_name="demo",
description="module demo"
)
response = client.create_project_module(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 42 43 44 45 46 47 |
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.CreateProjectModuleRequest{}
request.ProjectId = "{project_id}"
ownerbody := &model.UserRequest{
UserId: "09d75cde5180d4481f91c018e89cb8e2",
}
parentModuleIdCreateProjectModuleRequestBody:= int32(1)
descriptionCreateProjectModuleRequestBody:= "module demo"
request.Body = &model.CreateProjectModuleRequestBody{
Owner: ownerbody,
ParentModuleId: &parentModuleIdCreateProjectModuleRequestBody,
ModuleName: "demo",
Description: &descriptionCreateProjectModuleRequestBody,
}
response, err := client.CreateProjectModule(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。