Creating a Project Module
Function
This API is used to create a project module.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
POST /v4/projects/{project_id}/module
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| description | No | String | Definition Module description. Constraints 0 to 255 characters. Range The value is a string of 0 to 255 characters. Default Value N/A |
| module_name | Yes | String | Definition Module name. Constraints A string of 1 to 30 characters, including letters, digits, hyphens (-), and underscores (_). Range 1 to 30 characters. Default Value N/A |
| owner | Yes | UserRequest object | Definition: User information. Constraints: N/A |
| parent_module_id | No | Integer | Definition Parent module ID. It is the value of module_id in the response body turned when calling the Querying the Project Module List API. Constraints A string of 1 to 10 digits. The first digit ranges from 1 to 9. Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| user_id | Yes | String | Definition 32-character UUID of a user. Obtain the value using the API for obtaining the current user information. The value of user_id in the response body is the 32-character UUID of the user. Constraints A string of 32 characters consisting of lowercase letters and digits. Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| description | String | Definition: Module description. Options: N/A |
| module_id | Integer | Definition Module ID. Range N/A |
| module_name | String | Definition: Module name. Options: N/A |
| owner | ModuleOwner object | Definition: Module owner information. |
| Parameter | Type | Description |
|---|---|---|
| nick_name | String | Definition: User alias. Options: N/A |
| user_id | String | Definition User ID, which is a string of 32 characters. Range N/A |
| user_name | String | Definition: Username. Options: N/A |
| user_num_id | Integer | Definition Digital ID of a user. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
| request_id | String | Definition Request ID, which is automatically generated by the system. Range N/A |
Example Requests
POST https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/module
{
"description" : "module demo",
"module_name" : "demo",
"parent_module_id" : 1,
"owner" : {
"user_id" : "09d75cde5180d4481f91c018e89cb8e2"
}
} Example Responses
Status code: 200
{
"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" : "Module demo"
}
} 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 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 48 49 50 51 52 53 54 55 56 57 58 59 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) 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) } } |
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 |
| 400 | Bad Request |
| 401 | Unauthorized |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot