Querying the Module List of a Project
Function
This API is used to query the module list of a project.
Calling Method
For details, see Calling APIs.
URI
GET /v4/projects/{project_id}/modules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: Regular expression: [A-Za-z0-9]{32} Options: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
Yes |
Integer |
Definition: Pagination index. The offset is an integer multiple of limit. Constraints: Minimum value: 0. Options: Minimum value: 0. Maximum value: 10,000. Default value: Default value: 0. |
limit |
Yes |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A Options: Minimum value: 1. Maximum value: 1,000. Default value: 10 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
modules |
Array of ProjectModule objects |
Definition: Module list. |
total |
Integer |
Definition: Total number of modules. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
children |
Array of ProjectChildModule objects |
Definition: Child module information. |
deepth |
Integer |
Definition: Module level. Options: N/A |
is_parent |
Boolean |
Definition: Parent module or not. The options are true (parent module) and false (non–parent module). Options: true and false |
module_id |
Integer |
Definition: Module ID. Options: N/A |
module_name |
String |
Definition: Module name. Options: N/A |
owner |
ModuleOwner object |
Definition: Module owner information. |
Parameter |
Type |
Description |
---|---|---|
deepth |
Integer |
Definition: Module level. Options: N/A |
is_parent |
Boolean |
Definition: Parent module or not. The options are true (parent module) and false (non–parent module). Options: true and false |
module_id |
Integer |
Definition: Module ID. Options: N/A |
module_name |
String |
Definition: Module name. Options: N/A |
owner |
ModuleOwner object |
Definition: Template owner information. |
parent_module_id |
Integer |
Definition: Parent module ID. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
nick_name |
String |
Definition: User alias. Options: N/A |
user_id |
String |
Definition: User ID. The value is a string of 32 characters. Options: N/A |
user_name |
String |
Definition: Username. Options: N/A |
user_num_id |
Integer |
Definition: Digital ID of a user. Options: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
Get https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/modules
Example Responses
Status code: 200
OK
{ "total" : 1, "modules" : [ { "module_id" : 1, "module_name" : "demo", "owner" : { "user_id" : "09d75cde5180d4481f91c018e89cb8e2", "user_num_id" : 4091, "user_name" : "demo_user_name_06", "nick_name" : "demo" }, "deepth" : 1, "is_parent" : true, "children" : [ { "module_id" : 1, "module_name" : "demo", "owner" : { "user_id" : "09d75cde5180d4481f91c018e89cb8e2", "user_num_id" : 4091, "user_name" : "demo_user_name_06", "nick_name" : "demo" }, "deepth" : 1, "is_parent" : true, "parent_module_id" : 1 } ] } ] }
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.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ListProjectModulesSolution { 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(); ListProjectModulesRequest request = new ListProjectModulesRequest(); request.withProjectId("{project_id}"); try { ListProjectModulesResponse response = client.listProjectModules(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 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 = ListProjectModulesRequest() request.project_id = "{project_id}" response = client.list_project_modules(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" 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.ListProjectModulesRequest{} request.ProjectId = "{project_id}" response, err := client.ListProjectModules(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.
Feedback
Was this page helpful?
Provide feedbackThank 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